Documentation ¶
Index ¶
- Constants
- Variables
- func AddrPortMappedEqual(l, r netip.AddrPort) bool
- func AddrPortToSockaddr(addrPort netip.AddrPort) (name *byte, namelen uint32)
- func AddrPortToSockaddrInet4(addrPort netip.AddrPort) unix.RawSockaddrInet4
- func AddrPortToSockaddrInet6(addrPort netip.AddrPort) unix.RawSockaddrInet6
- func NewRawUDPConn(udpConn *net.UDPConn) (rawUDPConn, error)
- func ParseFlagsForError(flags int) error
- func ParsePktinfoCmsg(cmsg []byte) (netip.Addr, uint32, error)
- func ResolveIP(ctx context.Context, network, host string) (netip.Addr, error)
- func SockaddrInet4ToAddrPort(sa *unix.RawSockaddrInet4) netip.AddrPort
- func SockaddrInet6ToAddrPort(sa *unix.RawSockaddrInet6) netip.AddrPort
- func SockaddrToAddrPort(name *byte, namelen uint32) (netip.AddrPort, error)
- type Addr
- func AddrFromDomainPort(domain string, port uint16) (Addr, error)
- func AddrFromHostPort(host string, port uint16) (Addr, error)
- func AddrFromIPPort(addrPort netip.AddrPort) (addr Addr)
- func MustAddrFromDomainPort(domain string, port uint16) Addr
- func ParseAddr[T ~[]byte | ~string](s T) (Addr, error)
- func (a Addr) AppendTo(b []byte) []byte
- func (a Addr) Domain() string
- func (a Addr) Equals(b Addr) bool
- func (a Addr) Host() string
- func (a Addr) IP() netip.Addr
- func (a Addr) IPPort() netip.AddrPort
- func (a Addr) IsDomain() bool
- func (a Addr) IsIP() bool
- func (a Addr) IsValid() bool
- func (a Addr) MarshalText() ([]byte, error)
- func (a Addr) Port() uint16
- func (a Addr) ResolveIP(ctx context.Context, network string) (netip.Addr, error)
- func (a Addr) ResolveIPPort(ctx context.Context, network string) (netip.AddrPort, error)
- func (a Addr) String() string
- func (a *Addr) UnmarshalText(text []byte) error
- type ListenConfig
- type ListenConfigCache
- type ListenerSocketOptions
- type MmsgRConn
- type MmsgWConn
- type Mmsghdr
Constants ¶
const SYS_RECVMMSG = unix.SYS_RECVMMSG
const SocketControlMessageBufferSize = unix.SizeofCmsghdr + (unix.SizeofInet6Pktinfo+unix.SizeofPtr-1) & ^(unix.SizeofPtr-1)
SocketControlMessageBufferSize specifies the buffer size for receiving socket control messages.
Variables ¶
var ( // DefaultUDPServerSocketOptions is the default [ListenerSocketOptions] for UDP servers. DefaultUDPServerSocketOptions = ListenerSocketOptions{ PathMTUDiscovery: true, ReceivePacketInfo: true, } // DefaultUDPServerListenConfig is the default [ListenConfig] for UDP servers. DefaultUDPServerListenConfig = DefaultUDPServerSocketOptions.ListenConfig() // DefaultUDPClientSocketOptions is the default [ListenerSocketOptions] for UDP clients. DefaultUDPClientSocketOptions = ListenerSocketOptions{ PathMTUDiscovery: true, } // DefaultUDPClientListenConfig is the default [ListenConfig] for UDP clients. DefaultUDPClientListenConfig = DefaultUDPClientSocketOptions.ListenConfig() )
var ( ErrMessageTruncated = errors.New("the packet is larger than the supplied buffer") ErrControlMessageTruncated = errors.New("the control message is larger than the supplied buffer") )
var ALongTimeAgo = time.Unix(0, 0)
ALongTimeAgo is a non-zero time, far in the past, used for immediate deadlines.
Functions ¶
func AddrPortMappedEqual ¶ added in v1.3.0
AddrPortMappedEqual returns whether the two addresses point to the same endpoint. An IPv4 address and an IPv4-mapped IPv6 address pointing to the same endpoint are considered equal. For example, 1.1.1.1:53 and [::ffff:1.1.1.1]:53 are considered equal.
func AddrPortToSockaddr ¶ added in v1.1.0
func AddrPortToSockaddrInet4 ¶ added in v1.1.0
func AddrPortToSockaddrInet4(addrPort netip.AddrPort) unix.RawSockaddrInet4
func AddrPortToSockaddrInet6 ¶ added in v1.1.0
func AddrPortToSockaddrInet6(addrPort netip.AddrPort) unix.RawSockaddrInet6
func NewRawUDPConn ¶ added in v1.4.0
NewRawUDPConn wraps a net.UDPConn in a [rawUDPConn] for batch I/O.
func ParseFlagsForError ¶
ParseFlagsForError parses the message flags returned by the ReadMsgUDPAddrPort method and returns an error if MSG_TRUNC is set, indicating that the returned packet was truncated.
The check is skipped on Windows, because an error (WSAEMSGSIZE) is also returned when MSG_PARTIAL is set.
func ParsePktinfoCmsg ¶ added in v1.3.0
ParsePktinfoCmsg parses a single socket control message of type IP_PKTINFO or IPV6_PKTINFO, and returns the IP address and index of the network interface the packet was received from, or an error.
This function is only implemented for Linux, macOS and Windows. On other platforms, this is a no-op.
func ResolveIP ¶ added in v1.5.0
ResolveIP resolves a domain name string into an IP address.
The network must be one of "ip", "ip4" or "ip6". String representations of IP addresses are not supported.
This function always returns the first IP address returned by the resolver, because the resolver takes care of sorting the IP addresses by address family availability and preference.
func SockaddrInet4ToAddrPort ¶ added in v1.4.0
func SockaddrInet4ToAddrPort(sa *unix.RawSockaddrInet4) netip.AddrPort
func SockaddrInet6ToAddrPort ¶ added in v1.4.0
func SockaddrInet6ToAddrPort(sa *unix.RawSockaddrInet6) netip.AddrPort
Types ¶
type Addr ¶ added in v1.5.0
type Addr struct {
// contains filtered or unexported fields
}
Addr is the base address type used throughout the package.
An Addr is a port number combined with either an IP address or a domain name.
For space efficiency, the IP address and the domain string share the same space. The netip.Addr is stored in its original layout. The domain string's data pointer is stored in the ip.z field. Its length is stored at the beginning of the structure. This is essentially an unsafe "enum".
func AddrFromDomainPort ¶ added in v1.5.0
AddrFromDomainPort returns an Addr from the provided domain name and port number.
func AddrFromHostPort ¶ added in v1.5.0
AddrFromHostPort returns an Addr from the provided host string and port number. The host string may be a string representation of an IP address or a domain name.
func AddrFromIPPort ¶ added in v1.5.0
AddrFromIPPort returns an Addr from the provided netip.AddrPort.
func MustAddrFromDomainPort ¶ added in v1.5.0
MustAddrFromDomainPort calls AddrFromDomainPort and panics on error.
func ParseAddr ¶ added in v1.5.0
ParseAddr parses the provided string representation of an address and returns the parsed address or an error.
func (Addr) AppendTo ¶ added in v1.5.0
AppendTo appends the string representation of the address to the provided buffer.
If the address is zero value, nothing is appended.
func (Addr) Domain ¶ added in v1.5.0
Domain returns the domain name.
If the address is an IP address or zero value, this method panics.
func (Addr) Host ¶ added in v1.5.0
Host returns the string representation of the IP address or the domain name.
If the address is zero value, this method panics.
func (Addr) IP ¶ added in v1.5.0
IP returns the IP address.
If the address is a domain name or zero value, this method panics.
func (Addr) IPPort ¶ added in v1.5.0
IPPort returns a netip.AddrPort.
If the address is a domain name or zero value, this method panics.
func (Addr) IsValid ¶ added in v1.5.0
IsValid returns whether the address is an initialized address (not a zero value).
func (Addr) MarshalText ¶ added in v1.5.0
MarshalText implements the encoding.TextMarshaler MarshalText method.
func (Addr) ResolveIP ¶ added in v1.5.0
ResolveIP returns the IP address itself or the resolved IP address of the domain name.
The network is only used for domain name resolution and must be one of "ip", "ip4" or "ip6".
If the address is zero value, this method panics.
func (Addr) ResolveIPPort ¶ added in v1.5.0
ResolveIPPort returns the IP address itself or the resolved IP address of the domain name and the port number as a netip.AddrPort.
The network is only used for domain name resolution and must be one of "ip", "ip4" or "ip6".
If the address is zero value, this method panics.
func (Addr) String ¶ added in v1.5.0
String returns the string representation of the address.
If the address is zero value, an empty string is returned.
func (*Addr) UnmarshalText ¶ added in v1.5.0
UnmarshalText implements the encoding.TextUnmarshaler UnmarshalText method.
type ListenConfig ¶ added in v1.4.0
type ListenConfig net.ListenConfig
ListenConfig is net.ListenConfig but provides a subjectively nicer API.
func (*ListenConfig) ListenUDP ¶ added in v1.4.0
func (lc *ListenConfig) ListenUDP(ctx context.Context, network, address string) (*net.UDPConn, error)
ListenUDP wraps net.ListenConfig.ListenPacket and returns a *net.UDPConn directly.
func (*ListenConfig) ListenUDPRawConn ¶ added in v1.4.0
func (lc *ListenConfig) ListenUDPRawConn(ctx context.Context, network, address string) (rawUDPConn, error)
ListenUDPRawConn is like [ListenUDP] but wraps the *net.UDPConn in a [rawUDPConn] for batch I/O.
type ListenConfigCache ¶ added in v1.4.0
type ListenConfigCache map[ListenerSocketOptions]ListenConfig
ListenConfigCache is a map of ListenerSocketOptions to ListenConfig.
func NewListenConfigCache ¶ added in v1.4.0
func NewListenConfigCache() ListenConfigCache
NewListenConfigCache creates a new cache for ListenConfig with a few default entries.
func (ListenConfigCache) Get ¶ added in v1.4.0
func (cache ListenConfigCache) Get(lso ListenerSocketOptions) (lc ListenConfig)
Get returns a ListenConfig for the given ListenerSocketOptions.
type ListenerSocketOptions ¶ added in v1.4.0
type ListenerSocketOptions struct { // Fwmark sets the listener's fwmark on Linux, or user cookie on FreeBSD. // // Available on Linux and FreeBSD. Fwmark int // TrafficClass sets the traffic class of the listener. // // Available on most platforms except Windows. TrafficClass int // PathMTUDiscovery enables Path MTU Discovery on the listener. // // Available on Linux, macOS, FreeBSD, and Windows. PathMTUDiscovery bool // ReceivePacketInfo enables the reception of packet information control messages on the listener. // // Available on Linux, macOS, and Windows. ReceivePacketInfo bool }
ListenerSocketOptions contains listener-specific socket options.
func (ListenerSocketOptions) ListenConfig ¶ added in v1.4.0
func (lso ListenerSocketOptions) ListenConfig() ListenConfig
ListenConfig returns a ListenConfig with a control function that sets the socket options.
type MmsgRConn ¶ added in v1.4.0
type MmsgRConn struct {
// contains filtered or unexported fields
}
MmsgRConn wraps a net.UDPConn and provides the [ReadMsgs] method for reading multiple messages in a single recvmmsg(2) system call.
MmsgRConn is not safe for concurrent use. Use the [RConn] method to create a new MmsgRConn instance for each goroutine.
func (MmsgRConn) RConn ¶ added in v1.4.0
func (c MmsgRConn) RConn() *MmsgRConn
RConn returns a new MmsgRConn instance for batch reading.
type MmsgWConn ¶ added in v1.4.0
type MmsgWConn struct {
// contains filtered or unexported fields
}
MmsgWConn wraps a net.UDPConn and provides the [WriteMsgs] method for writing multiple messages in a single sendmmsg(2) system call.
MmsgWConn is not safe for concurrent use. Use the [WConn] method to create a new MmsgWConn instance for each goroutine.
func (MmsgWConn) RConn ¶ added in v1.4.0
func (c MmsgWConn) RConn() *MmsgRConn
RConn returns a new MmsgRConn instance for batch reading.