Module relay

Package relay implements a revised version of the Designated Encrypted Relay for Packets (DERP) protocol written by Tailscale. The relay routes packets to clients using curve25519 keys as addresses. The relay is used to proxy encrypted QUIC packets through the relay servers when a direct path cannot be found or opened. The relay is a last resort. If both sides have very aggressive NATs, or firewalls, or no IPv6, we use the relay connection. Based on tailscale/derp/derp.go

Modules

• http
  HTTP-specific constants for the relay server and client.
• serveriroh-relay
  A fully-fledged iroh-relay server over HTTP or HTTPS.

Structs

• HttpClient
  An HTTP Relay client.
• HttpClientBuilder
  Build a Client.
• HttpClientReceiver
  Receiving end of a Client.
• RelayConn
  A connection to a relay server.
• RelayMap
  Configuration of all the relay servers that can be used.
• RelayNode
  Information on a specific relay server.
• RelayUrl
  A URL identifying a relay server.

Enums

• HttpClientError
  Possible connection errors on the Client
• ReceivedMessage
  The type of message received by the Conn from a relay server.
• RelayMode
  Configuration of the relay servers for an Endpoint.

Constants

• ENV_FORCE_STAGING_RELAYSNon-test
  Environment variable to force the use of staging relays.
• MAX_PACKET_SIZE
  The maximum size of a packet sent over relay. (This only includes the data bytes visible to magicsock, not including its on-wire framing overhead)

Functions

• force_staging_infra
  Returns true if the use of staging relays is forced.