wrtcip

Documentation

Index

• Variables
• type Adapter
  • func NewAdapter(signaler string, key string, ice []string, config *AdapterConfig, ...) *Adapter
  • func (a *Adapter) Close() error
  • func (a *Adapter) Open() error
  • func (a *Adapter) Wait() error
• type AdapterConfig

Variables

var (
	ErrMissingIPs = errors.New("no IPs provided")
)

Types

type Adapter

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

Adapter provides an IP service

func NewAdapter

func NewAdapter(
	signaler string,
	key string,
	ice []string,
	config *AdapterConfig,
	ctx context.Context,
) *Adapter

NewAdapter creates the adapter

func (*Adapter) Close

func (a *Adapter) Close() error

Close disconnects the adapter from the signaler and closes the TUN device

func (*Adapter) Open

func (a *Adapter) Open() error

Open connects the adapter to the signaler

func (*Adapter) Wait

func (a *Adapter) Wait() error

Wait starts the transmission loop

type AdapterConfig

type AdapterConfig struct {
	*wrtcconn.NamedAdapterConfig
	Device             string       // Name to give to the TUN device
	OnSignalerConnect  func(string) // Handler to be called when the adapter has connected to the signaler
	OnPeerConnect      func(string) // Handler to be called when the adapter has connected to a peer
	OnPeerDisconnected func(string) // Handler to be called when the adapter has received a message
	CIDRs              []string     // IPv4 & IPv6 networks to join
	MaxRetries         int          // Maximum amount of IP address to try and claim before giving up
	Parallel           int          // Maximum amount of goroutines to use to unmarshal IP packets
	Static             bool         // Claim the exact IP specified in the CIDR notation instead of selecting a random one from the networks
}

AdapterConfig configures the adapter