udp

Documentation

Index

• Variables
• func SetModifyDiscoConfig(modify func(cfg *DiscoConfig))
• type DiscoConfig
• type PeerState
• type PeerStore
• type RelayToPeerError
  • func (e RelayToPeerError) Error() string
  • func (e RelayToPeerError) Unwrap() error
• type UDPConfig
• type UDPConn
  • func ListenUDP(cfg UDPConfig) (*UDPConn, error)
  • func (c *UDPConn) Close() error
  • func (c *UDPConn) Datagrams() <-chan *disco.Datagram
  • func (c *UDPConn) DetectNAT(ctx context.Context, stunServers []string) (info disco.NATInfo)
  • func (c *UDPConn) Endpoints() <-chan *disco.Endpoint
  • func (c *UDPConn) Errors() <-chan error
  • func (c *UDPConn) GenerateLocalAddrsSends(peerID disco.PeerID, stunServers []string)
  • func (c *UDPConn) NATEvents() <-chan *disco.NATInfo
  • func (c *UDPConn) Peers() []PeerState
  • func (c *UDPConn) RelayTo(relay disco.PeerID, p []byte, peerID disco.PeerID) (int, error)
  • func (c *UDPConn) RestartListener() error
  • func (c *UDPConn) RunDiscoMessageSendLoop(udpAddr disco.Endpoint)
  • func (c *UDPConn) SetReadBuffer(bytes int) error
  • func (c *UDPConn) SetWriteBuffer(bytes int) error
  • func (c *UDPConn) WriteTo(p []byte, peerID disco.PeerID) (int, error)

Variables

var (
	MAGIC_TO_RELAY   = []byte{'_', 'p', 'g', 1}
	MAGIC_FROM_RELAY = []byte{'_', 'p', 'g', 3}
)

var (
	ErrUDPConnNotReady = errors.New("udpConn not ready yet")
	ErrUDPConnInactive = errors.New("udpConn inactive")
)

Functions

func SetModifyDiscoConfig

func SetModifyDiscoConfig(modify func(cfg *DiscoConfig))

Types

type DiscoConfig

type DiscoConfig struct {
	PortScanOffset            int           `yaml:"port_scan_offset"`
	PortScanCount             int           `yaml:"port_scan_count"`
	PortScanDuration          time.Duration `yaml:"port_scan_duration"`
	ChallengesRetry           int           `yaml:"challenges_retry"`
	ChallengesInitialInterval time.Duration `yaml:"challenges_initial_interval"`
	ChallengesBackoffRate     float64       `yaml:"challenges_backoff_rate"`
	IgnoredInterfaces         []string      `yaml:"ignored_interfaces"`
}

type PeerState

type PeerState struct {
	PeerID         disco.PeerID
	Addr           *net.UDPAddr
	LastActiveTime time.Time
}

type PeerStore

type PeerStore interface {
	// Peers load all peers (peers order is stable)
	Peers() []PeerState
}

type RelayToPeerError

type RelayToPeerError struct {
	PeerID disco.PeerID
	// contains filtered or unexported fields
}

func (RelayToPeerError) Error

func (e RelayToPeerError) Error() string

func (RelayToPeerError) Unwrap

func (e RelayToPeerError) Unwrap() error

type UDPConfig

type UDPConfig struct {
	Port                  int
	DisableIPv4           bool
	DisableIPv6           bool
	ID                    disco.PeerID
	PeerKeepaliveInterval time.Duration
	DiscoMagic            func() []byte
}

type UDPConn

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

func ListenUDP

func ListenUDP(cfg UDPConfig) (*UDPConn, error)

func (*UDPConn) Close

func (c *UDPConn) Close() error

func (*UDPConn) Datagrams

func (c *UDPConn) Datagrams() <-chan *disco.Datagram

func (*UDPConn) DetectNAT

func (c *UDPConn) DetectNAT(ctx context.Context, stunServers []string) (info disco.NATInfo)

func (*UDPConn) Endpoints

func (c *UDPConn) Endpoints() <-chan *disco.Endpoint

func (*UDPConn) Errors

func (c *UDPConn) Errors() <-chan error

func (*UDPConn) GenerateLocalAddrsSends

func (c *UDPConn) GenerateLocalAddrsSends(peerID disco.PeerID, stunServers []string)

func (*UDPConn) NATEvents

func (c *UDPConn) NATEvents() <-chan *disco.NATInfo

func (*UDPConn) Peers

func (c *UDPConn) Peers() []PeerState

Peers load all peers (peers order is stable)

func (*UDPConn) RelayTo

func (c *UDPConn) RelayTo(relay disco.PeerID, p []byte, peerID disco.PeerID) (int, error)

func (*UDPConn) RestartListener

func (c *UDPConn) RestartListener() error

func (*UDPConn) RunDiscoMessageSendLoop

func (c *UDPConn) RunDiscoMessageSendLoop(udpAddr disco.Endpoint)

func (*UDPConn) SetReadBuffer

func (c *UDPConn) SetReadBuffer(bytes int) error

SetReadBuffer sets the size of the operating system's receive buffer associated with the connection.

func (*UDPConn) SetWriteBuffer

func (c *UDPConn) SetWriteBuffer(bytes int) error

SetWriteBuffer sets the size of the operating system's transmit buffer associated with the connection.

func (*UDPConn) WriteTo

func (c *UDPConn) WriteTo(p []byte, peerID disco.PeerID) (int, error)