package
0.0.0-20240720002214-37b2b8227b91
Repository: https://github.com/progrium/go-netstack.git
Documentation: pkg.go.dev
# Functions
NewEndpoint is a convenience function that returns an initialized Endpoint allocated on the heap.
NewPacketWindowAllocator is a convenience function that returns an initialized PacketWindowAllocator allocated on the heap.
PacketWindowLengthForDataCap returns the minimum packet window size required to accommodate datagrams of the given size in bytes.
# Constants
ClientSide indicates that an Endpoint is a client (initially-active; first method call should be Connect).
PacketHeaderBytes is the size of a flipcall packet header in bytes.
ServerSide indicates that an Endpoint is a server (initially-inactive; first method call should be RecvFirst.).
# Structs
DatagramReader implements io.Reader by reading a datagram from an Endpoint's packet window.
DatagramWriter implements io.Writer by writing a datagram to an Endpoint's packet window.
An Endpoint provides the ability to synchronously transfer data and control to a connected peer Endpoint, which may be in another process.
A PacketWindowAllocator owns a shared memory file, and allocates packet windows from it.
PacketWindowDescriptor represents a packet window, a range of pages in a shared memory file that is used to exchange packets between partner Endpoints.
ShutdownError is returned by most Endpoint methods after Endpoint.Shutdown() has been called.
# Interfaces
An EndpointOption configures an Endpoint.
# Type aliases
EndpointSide indicates which side of a connection an Endpoint belongs to.