conn

Documentation

Overview

Package conn implements underlay sockets.

Index

• type Config
• type Conn
  • func New(listen, remote netip.AddrPort, cfg *Config) (Conn, error)
• type Messages
  • func NewReadMessages(n int) Messages

Types

type Config

type Config struct {
	// SendBufferSize is the size of the operating system send buffer, in bytes.
	// If zero, the operating system default is used.
	SendBufferSize int
	// ReceiveBufferSize is the size of the operating system receive buffer, in
	// bytes.
	ReceiveBufferSize int
}

Config customizes the behavior of an underlay socket.

type Conn

type Conn interface {
	ReadBatch(Messages) (int, error)
	WriteTo([]byte, netip.AddrPort) (int, error)
	WriteBatch(Messages, int) (int, error)
	LocalAddr() netip.AddrPort
	RemoteAddr() netip.AddrPort
	SetReadDeadline(time.Time) error
	SetWriteDeadline(time.Time) error
	SetDeadline(time.Time) error
	Close() error
}

Conn describes the API for an underlay socket

func New

func New(listen, remote netip.AddrPort, cfg *Config) (Conn, error)

New opens a new underlay socket on the specified addresses.

The config can be used to customize socket behavior.

type Messages

type Messages []ipv4.Message

Messages is a list of ipX.Messages. It is necessary to hide the type alias between ipv4.Message, ipv6.Message and socket.Message.

func NewReadMessages

func NewReadMessages(n int) Messages

NewReadMessages allocates memory for reading IPv4 Linux network stack messages.