udpswarm

Documentation

Index

• Constants
• type Addr
  • func FromNetAddr(x net.UDPAddr) Addr
  • func ParseAddr(x []byte) (Addr, error)
  • func (a Addr) AsNetAddr() net.UDPAddr
  • func (a Addr) GetIP() netip.Addr
  • func (a Addr) Key() string
  • func (a Addr) MapIP(fn func(netip.Addr) netip.Addr) Addr
  • func (a Addr) MarshalText() ([]byte, error)
  • func (a Addr) Network() string
  • func (a Addr) String() string
  • func (a *Addr) UnmarshalText(x []byte) error
• type Swarm
  • func New(laddr string) (*Swarm, error)
  • func (s *Swarm) Close() error
  • func (s *Swarm) LocalAddrs() []Addr
  • func (s *Swarm) MTU() int
  • func (s *Swarm) ParseAddr(x []byte) (Addr, error)
  • func (s *Swarm) Receive(ctx context.Context, th func(p2p.Message[Addr])) error
  • func (s *Swarm) Tell(ctx context.Context, a Addr, data p2p.IOVec) error

Constants

const (
	IPv4MTU = 576
	IPv6MTU = 1280

	TheoreticalMTU = (1 << 16) - 1
)

Types

type Addr

type Addr struct {
	IP   netip.Addr
	Port uint16
}

func FromNetAddr

func FromNetAddr(x net.UDPAddr) Addr

func ParseAddr

func ParseAddr(x []byte) (Addr, error)

func (Addr) AsNetAddr

func (a Addr) AsNetAddr() net.UDPAddr

func (Addr) GetIP

func (a Addr) GetIP() netip.Addr

func (Addr) Key

func (a Addr) Key() string

func (Addr) MapIP

func (a Addr) MapIP(fn func(netip.Addr) netip.Addr) Addr

func (Addr) MarshalText

func (a Addr) MarshalText() ([]byte, error)

func (Addr) Network

func (a Addr) Network() string

func (Addr) String

func (a Addr) String() string

func (*Addr) UnmarshalText

func (a *Addr) UnmarshalText(x []byte) error

type Swarm

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

Swarm implements p2p.Swarm using the User Datagram Protocol

WARNING: This implementation is not secure. It does not encrypt traffic, does not verify identity of peers, and (therefore) does not implement p2p.SecureSwarm.

It is included as a transport for secure swarms to be built on.

func New

func New(laddr string) (*Swarm, error)

func (*Swarm) Close

func (s *Swarm) Close() error

func (*Swarm) LocalAddrs

func (s *Swarm) LocalAddrs() []Addr

func (*Swarm) MTU

func (s *Swarm) MTU() int

func (*Swarm) ParseAddr

func (s *Swarm) ParseAddr(x []byte) (Addr, error)

func (*Swarm) Receive

func (s *Swarm) Receive(ctx context.Context, th func(p2p.Message[Addr])) error

func (*Swarm) Tell

func (s *Swarm) Tell(ctx context.Context, a Addr, data p2p.IOVec) error