udprelay

Documentation

Overview

Package udprelay contains constructs for relaying Disco and WireGuard packets between Tailscale clients over UDP. This package is currently considered experimental.

Index

• Variables
• type ErrServerNotReady
  • func (e ErrServerNotReady) Error() string
• type Server
  • func NewServer(logf logger.Logf, port int, overrideAddrs []netip.Addr) (s *Server, err error)
  • func (s *Server) AllocateEndpoint(discoA, discoB key.DiscoPublic) (endpoint.ServerEndpoint, error)
  • func (s *Server) Close() error
  • func (s *Server) GetSessions() []status.ServerSession

Variables

var ErrServerClosed = errors.New("server closed")

Types

type ErrServerNotReady

type ErrServerNotReady struct {
	RetryAfter time.Duration
}

ErrServerNotReady indicates the server is not ready. Allocation should be requested after waiting for at least RetryAfter duration.

func (ErrServerNotReady) Error

func (e ErrServerNotReady) Error() string

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server implements an experimental UDP relay server.

func NewServer

func NewServer(logf logger.Logf, port int, overrideAddrs []netip.Addr) (s *Server, err error)

NewServer constructs a Server listening on port. If port is zero, then port selection is left up to the host networking stack. If len(overrideAddrs) > 0 these will be used in place of dynamic discovery, which is useful to override in tests.

func (*Server) AllocateEndpoint

func (s *Server) AllocateEndpoint(discoA, discoB key.DiscoPublic) (endpoint.ServerEndpoint, error)

AllocateEndpoint allocates an endpoint.ServerEndpoint for the provided pair of key.DiscoPublic's. If an allocation already exists for discoA and discoB it is returned without modification/reallocation. AllocateEndpoint returns the following notable errors:

1. ErrServerClosed if the server has been closed.
2. ErrServerNotReady if the server is not ready.

func (*Server) Close

func (s *Server) Close() error

Close closes the server.

func (*Server) GetSessions

func (s *Server) GetSessions() []status.ServerSession

GetSessions returns a slice of peer relay session statuses, with each entry containing detailed info about the server and clients involved in each session. This information is intended for debugging/status UX, and should not be relied on for any purpose outside of that.