zerocopy

Dec 3, 2024

Changes in this version

+ var ErrAcceptRequiresNetConn = errors.New("rawRW is required to implement net.Conn")

Jun 20, 2023

Changes in this version

+ func NoopClose() error

type ServerUnpacker

+ NewPacker func() (ServerPacker, error)

type UDPClientInfo

+ MTU int

+ type UDPClientSession struct

+ Close func() error

+ MaxPacketSize int

+ Packer ClientPacker

+ Unpacker ClientUnpacker

type UDPNATServer

+ NewUnpacker func() (ServerUnpacker, error)

type UDPSessionServerInfo

+ MinNATTimeout time.Duration

Mar 24, 2023

Changes in this version

type UDPClientInfo

+ ListenConfig tfo.ListenConfig

Feb 16, 2023

Changes in this version

+ var ErrAcceptRequiresTCPConn = errors.New("rawRW is required to be a *net.TCPConn")

type ClientPacker

+ ClientPackerInfo func() ClientPackerInfo

+ type ClientPackerInfo struct

+ Headroom Headroom

type ClientUnpacker

+ ClientUnpackerInfo func() ClientUnpackerInfo

+ type ClientUnpackerInfo struct

+ Headroom Headroom

type Headroom

+ Front int

+ Rear int

+ func MaxHeadroom(first, second Headroom) Headroom

+ func UDPRelayHeadroom(packerHeadroom, unpackerHeadroom Headroom) Headroom

type Reader

+ ReaderInfo func() ReaderInfo

+ type ReaderInfo struct

+ Headroom Headroom

+ MinPayloadBufferSizePerRead int

type ServerPacker

+ ServerPackerInfo func() ServerPackerInfo

+ type ServerPackerInfo struct

+ Headroom Headroom

type ServerUnpacker

+ ServerUnpackerInfo func() ServerUnpackerInfo

+ type ServerUnpackerInfo struct

+ Headroom Headroom

+ type SessionServerUnpacker interface

+ NewPacker func() (ServerPacker, error)

type SimpleUDPClient

+ func (c *SimpleUDPClient) Info() UDPClientInfo

type TCPClient

+ Info func() TCPClientInfo

+ type TCPClientInfo struct

+ Name string

+ NativeInitialPayload bool

type TCPServer

+ Info func() TCPServerInfo

+ type TCPServerInfo struct

+ DefaultTCPConnCloser TCPConnCloser

+ NativeInitialPayload bool

type UDPClient

+ Info func() UDPClientInfo

+ type UDPClientInfo struct

+ Fwmark int

+ MaxPacketSize int

+ Name string

+ PackerHeadroom Headroom

type UDPNATServer

+ Info func() UDPNATServerInfo

+ type UDPNATServerInfo struct

+ UnpackerHeadroom Headroom

type UDPSessionServer

+ Info func() UDPSessionServerInfo

+ type UDPSessionServerInfo struct

+ UnpackerHeadroom Headroom

type Writer

+ WriterInfo func() WriterInfo

+ type WriterInfo struct

+ Headroom Headroom

+ MaxPayloadSizePerWrite int

Nov 30, 2022

Changes in this version

+ type DirectReader interface

+ DirectReader func() io.Reader

+ type DirectWriter interface

+ DirectWriter func() io.Writer

Oct 30, 2022

Changes in this version

type SimpleUDPClient

+ func (c *SimpleUDPClient) String() string

Oct 15, 2022

Changes in this version

+ const JumboPayloadOptionLength

+ func ClientServerPackerUnpackerTestFunc(t tester, clientPacker ClientPacker, clientUnpacker ClientUnpacker, ...)

+ func DirectTwoWayRelay(left, right DirectReadWriteCloser) (nl2r, nr2l int64, err error)

Sep 29, 2022

Changes in this version

+ func JustClose(conn *net.TCPConn, serverName, listenAddress, clientAddress string, ...)

+ type DirectReadWriteCloserOpener interface

+ Open func(b []byte) (DirectReadWriteCloser, error)

+ type SimpleDirectReadWriteCloserOpener struct

+ func (o *SimpleDirectReadWriteCloserOpener) Open(b []byte) (DirectReadWriteCloser, error)

+ type TCPConnOpener struct

+ func NewTCPConnOpener(dialer tfo.Dialer, network, address string) *TCPConnOpener

+ func (o *TCPConnOpener) Open(b []byte) (DirectReadWriteCloser, error)

Sep 10, 2022

Changes in this version

+ func ReplyWithGibberish(conn *net.TCPConn, serverName, listenAddress, clientAddress string, ...)

Aug 11, 2022

Changes in this version

+ func ClientServerPackUnpackerTestFunc(t *testing.T, c ClientPackUnpacker, s ServerPackUnpacker)

+ type ClientPackUnpacker interface

+ type ClientPacker interface

+ PackInPlace func(b []byte, targetAddr conn.Addr, payloadStart, payloadLen int) (destAddrPort netip.AddrPort, packetStart, packetLen int, err error)

+ type ClientUnpacker interface

+ UnpackInPlace func(b []byte, packetSourceAddrPort netip.AddrPort, packetStart, packetLen int) (payloadSourceAddrPort netip.AddrPort, payloadStart, payloadLen int, err error)

type CopyReadWriter

+ func (rw *CopyReadWriter) ReadFrom(r io.Reader) (n int64, err error)

+ type ServerPackUnpacker interface

+ type ServerPacker interface

+ PackInPlace func(b []byte, sourceAddrPort netip.AddrPort, ...) (packetStart, packetLen int, err error)

+ type ServerUnpacker interface

+ UnpackInPlace func(b []byte, sourceAddrPort netip.AddrPort, packetStart, packetLen int) (targetAddr conn.Addr, payloadStart, payloadLen int, err error)

type SimpleUDPClient

+ func (c *SimpleUDPClient) LinkInfo() (int, int)

type UDPClient

+ LinkInfo func() (maxPacketSize, fwmark int)

+ type UDPNATServer interface

+ NewSession func() (ServerPacker, ServerUnpacker, error)

+ type UDPSessionServer interface

+ NewPacker func(csid uint64) (ServerPacker, error)

+ NewUnpacker func(b []byte, csid uint64) (ServerUnpacker, error)

+ SessionInfo func(b []byte) (csid uint64, err error)

Jul 16, 2022

Changes in this version

+ const IPv4HeaderLength

+ const IPv6HeaderLength

+ const UDPHeaderLength

+ var ErrAcceptDoneNoRelay = errors.New("the accepted connection has been handled without relaying")

+ var ErrPacketTooSmall = errors.New("packet too small to unpack")

+ var ErrPayloadTooBig = errors.New("payload too big to pack")

+ func CloseWriteDrain(conn *net.TCPConn, serverName, listenAddress, clientAddress string, ...)

+ func CopyWriteOnce(rw ReadWriter, b []byte) (n int, err error)

+ func ForceReset(conn *net.TCPConn, serverName, listenAddress, clientAddress string, ...)

+ func MaxPacketSizeForAddr(mtu int, addr netip.Addr) int

+ func PackerUnpackerTestFunc(t *testing.T, packer Packer, unpacker Unpacker)

+ func ReadWriterTestFunc(t *testing.T, l, r ReadWriter)

+ func Relay(w Writer, r Reader) (n int64, err error)

+ func TwoWayRelay(left, right ReadWriter) (nl2r, nr2l int64, err error)

+ type CloseRead interface

+ CloseRead func() error

+ type CloseWrite interface

+ CloseWrite func() error

+ type CopyReadWriter struct

+ func NewCopyReadWriter(rw ReadWriter) *CopyReadWriter

+ func (rw *CopyReadWriter) Read(b []byte) (n int, err error)

+ func (rw *CopyReadWriter) Write(b []byte) (n int, err error)

+ type DirectReadCloser interface

+ DirectReadCloser func() io.ReadCloser

+ type DirectReadWriteCloser interface

+ type DirectWriteCloser interface

+ DirectWriteCloser func() io.WriteCloser

+ type Headroom interface

+ FrontHeadroom func() int

+ RearHeadroom func() int

+ type InitialPayloader interface

+ NativeInitialPayload func() bool

+ type PackUnpacker interface

+ type Packer interface

+ PackInPlace func(b []byte, targetAddr socks5.Addr, payloadStart, payloadLen, maxPacketLen int) (packetStart, packetLen int, err error)

+ type ReadWriter interface

+ type Reader interface

+ MinPayloadBufferSizePerRead func() int

+ ReadZeroCopy func(b []byte, payloadBufStart, payloadBufLen int) (payloadLen int, err error)

+ type SimpleUDPClient struct

+ func NewSimpleUDPClient(p PackUnpacker, addrPort netip.AddrPort, hasAddrPort bool, ...) *SimpleUDPClient

+ func (c *SimpleUDPClient) AddrPort() (netip.AddrPort, int, int, bool)

+ func (c *SimpleUDPClient) FrontHeadroom() int

+ func (c *SimpleUDPClient) NewSession() (Packer, Unpacker, error)

+ func (c *SimpleUDPClient) RearHeadroom() int

+ type TCPClient interface

+ Dial func(targetAddr socks5.Addr, payload []byte) (tfoConn tfo.Conn, rw ReadWriter, err error)

+ type TCPConnCloser func(conn *net.TCPConn, serverName, listenAddress, clientAddress string, ...)

+ func ParseRejectPolicy(rejectPolicy string, server TCPServer) (TCPConnCloser, error)

+ func (c TCPConnCloser) Do(conn *net.TCPConn, serverName, listenAddress, clientAddress string, ...)

+ type TCPServer interface

+ Accept func(conn tfo.Conn) (rw ReadWriter, targetAddr socks5.Addr, payload []byte, err error)

+ DefaultTCPConnCloser func() TCPConnCloser

+ type UDPClient interface

+ AddrPort func() (addrPort netip.AddrPort, mtu, fwmark int, ok bool)

+ NewSession func() (Packer, Unpacker, error)

+ type UDPServer interface

+ NewPacker func(csid uint64) (Packer, error)

+ NewUnpacker func(b []byte, csid uint64) (Unpacker, error)

+ SessionInfo func(b []byte) (csid uint64, err error)

+ type Unpacker interface

+ UnpackInPlace func(b []byte, packetStart, packetLen int) (targetAddr socks5.Addr, hasTargetAddr bool, payloadStart, payloadLen int, ...)

+ type Writer interface

+ MaxPayloadSizePerWrite func() int

+ WriteZeroCopy func(b []byte, payloadStart, payloadLen int) (payloadWritten int, err error)

+ type ZeroHeadroom struct

+ func (z ZeroHeadroom) FrontHeadroom() int

+ func (z ZeroHeadroom) RearHeadroom() int