package relayclient

Import Path
	github.com/tmc/go-iroh/internal/relayclient (on go.dev)

Dependency Relation
	imports 13 packages, and imported by one package

Involved Source Files

	  d client.go
		Package relayclient implements the client side of an iroh relay connection.
		
		A client dials a relay server over a secure WebSocket (standard WebPKI TLS,
		wire-compatible with iroh), negotiates the relay protocol version, completes
		the authentication handshake, and then exchanges relay frames
		([relayproto.ClientToRelayMsg] / [relayproto.RelayToClientMsg]).
		
		It is a port of the client side of iroh-relay/src/client.

	    dial_options.go
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Client (struct)
		Client is a connected relay client. It is not safe for concurrent use by
		multiple senders or multiple receivers; use one goroutine for Send and one
		for Recv.

		Methods (total 4)
			(*Client) Close() error
				Close closes the relay connection.

			(*Client) Recv(ctx context.Context) (relayproto.RelayToClientMsg, error)
				Recv receives the next relay-to-client message.

			(*Client) Send(ctx context.Context, msg relayproto.ClientToRelayMsg) error
				Send sends a client-to-relay message.

			(*Client) Version() relayproto.ProtocolVersion
				Version returns the negotiated relay protocol version.

		Implements (at least 2)
			*Client : github.com/prometheus/common/expfmt.Closer
			*Client : io.Closer
		As Outputs Of (at least one exported)
			func Connect(ctx context.Context, u netaddr.RelayURL, opts Options) (*Client, error)

	 type Options (struct)
		Options configures a relay client dial.

		Fields (total 4)
			AuthToken string
				AuthToken, if set, is sent as a Bearer token in the Authorization header.

			HTTPClient *http.Client
				HTTPClient overrides the HTTP client used for the WebSocket dial.

			SecretKey key.SecretKey
				SecretKey is the client's secret key, used for the authentication
				handshake. Required.

			TLSConfig *tls.Config
				TLSConfig overrides the TLS configuration used for the WSS connection.
				If nil, the default WebPKI verification is used.

		As Inputs Of (at least one exported)
			func Connect(ctx context.Context, u netaddr.RelayURL, opts Options) (*Client, error)


Package-Level Functions (only one)

	 func Connect(ctx context.Context, u netaddr.RelayURL, opts Options) (*Client, error)
		Connect dials the relay at u and completes the protocol handshake.


Package-Level Variables (total 2)

	  var ErrBadVersionHeader error
		Errors returned when connecting to a relay.

	  var ErrHandshake error
		Errors returned when connecting to a relay.

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.