tun

Sep 19, 2026

Changes in this version

+ type ReadRetry struct

+ func (r *ReadRetry) Reset()

+ func (r *ReadRetry) Wait(err error)

Sep 19, 2026

Changes in this version

+ func IsRecoverableReadError(err error) bool

Aug 30, 2026

Changes in this version

+ const DNSModeDisabled

+ const DNSModeHijack

+ const DNSModeNative

+ func BuildUnreachable(packet []byte, source netip.Addr, headroom int) ([]byte, bool)

+ type FlowAction uint8

+ const ActionAccept

+ const ActionBypass

+ const ActionDrop

+ const ActionFlow

+ const ActionHijackDNS

+ type FlowCloseReason uint8

+ const FlowCloseFinished

+ const FlowCloseReset

+ const FlowCloseTimeout

+ func (r FlowCloseReason) String() string

+ type FlowHandle interface

+ CloseFlow func()

+ type FlowTracker interface

+ AttachFlow func(handle FlowHandle)

+ CloseFlow func(reason FlowCloseReason)

+ CountForward func(n int)

+ CountReverse func(n int)

+ FlowEstablished func()

+ type FlowVerdict struct

+ Action FlowAction

+ Destination netip.AddrPort

+ NewTracker func() FlowTracker

+ Port Port

+ UDPTimeout time.Duration

+ type ForwardDispatcher struct

+ func NewForwardDispatcher(handler Handler, writeback ForwardWriteback, logger logger.Logger, ...) *ForwardDispatcher

+ func (d *ForwardDispatcher) Close()

+ func (d *ForwardDispatcher) Dispatch(packet []byte) bool

+ func (d *ForwardDispatcher) Flush()

+ func (d *ForwardDispatcher) ResetNetwork()

+ type ForwardWriteback interface

+ ReturnHeadroom func() int

+ WriteReturnPackets func(packets [][]byte) error

type Handler

+ JudgeFlow func(network uint8, source netip.AddrPort, destination netip.AddrPort, ...) FlowVerdict

+ NewDNSPacket func(payload []byte, source M.Socksaddr, destination M.Socksaddr, ...)

+ type NATFiltering uint8

+ const NATFilteringAddressAndPortDependent

+ const NATFilteringAddressDependent

+ const NATFilteringEndpointIndependent

+ type NATMapping uint8

+ const NATMappingAddressAndPortDependent

+ const NATMappingAddressDependent

+ const NATMappingEndpointIndependent

type Options

+ DNSAddress []netip.Addr

+ DNSMode string

+ ExcludeMACAddress []net.HardwareAddr

+ IncludeMACAddress []net.HardwareAddr

+ NetNs string

+ func (o *Options) DNSModeOrDefault() string

+ func (o *Options) DNSServerAddress() ([]netip.Addr, error)

+ func (o *Options) Inet4DNSAddress() ([]netip.Addr, error)

+ func (o *Options) Inet6DNSAddress() ([]netip.Addr, error)

+ type Port interface

+ AttachReturn func(returnPath Return) error

+ DetachReturn func(returnPath Return) error

+ PortAddresses func() (v4 netip.Addr, v6 netip.Addr)

+ PortMTU func() uint32

+ WritePackets func(packets [][]byte) error

+ type PortWithSelectorRange interface

+ PortSelectorRange func() (start uint16, count uint16)

+ type Return interface

+ ReturnHeadroom func() int

+ ReturnPackets func(packets [][]byte) [][]byte

type Stack

+ ResetNetwork func()

type StackOptions

+ UDPFiltering NATFiltering

+ UDPMapping NATMapping

+ UDPNATMax uint32

type System

+ func (s *System) ResetNetwork()

type TCPNat

+ func (n *TCPNat) Purge()

+ type UDPEgressConn struct

+ func NewUDPEgressConn(anchor *net.UDPConn, pool *UDPEgressPool) *UDPEgressConn

+ func (c *UDPEgressConn) Close() error

+ func (c *UDPEgressConn) LocalAddr() net.Addr

+ func (c *UDPEgressConn) ReadFromUDPAddrPort(buffer []byte) (int, netip.AddrPort, error)

+ func (c *UDPEgressConn) SetDeadline(t time.Time) error

+ func (c *UDPEgressConn) SetReadDeadline(t time.Time) error

+ func (c *UDPEgressConn) SetWriteDeadline(t time.Time) error

+ func (c *UDPEgressConn) WriteToUDPAddrPort(buffer []byte, destination netip.AddrPort) (int, error)

+ type UDPEgressPool struct

+ func NewUDPEgressPool(options UDPEgressPoolOptions) *UDPEgressPool

+ func (p *UDPEgressPool) Close()

+ func (p *UDPEgressPool) LookupEgress(destination netip.AddrPort) *net.UDPConn

+ func (p *UDPEgressPool) ReceiveEgress(buffer []byte) (int, netip.AddrPort, error)

+ func (p *UDPEgressPool) SetEgressPort(port uint16) bool

+ type UDPEgressPoolOptions struct

+ Control control.Func

+ ExcludeInterface string

+ InterfaceFinder control.InterfaceFinder

+ InterfaceMonitor DefaultInterfaceMonitor

+ IsExempt func() bool

+ Logger logger.Logger

+ Network string

+ type UDPNat struct

+ func NewUDPNat(options UDPNatOptions) *UDPNat

+ func (s *UDPNat) Close() error

+ func (s *UDPNat) NewPacket(bufferSlices [][]byte, source M.Socksaddr, destination M.Socksaddr, ...)

+ func (s *UDPNat) NewPacketBatch(buffers []*buf.Buffer, sources []M.Socksaddr, destination M.Socksaddr, ...)

+ func (s *UDPNat) Purge()

+ func (s *UDPNat) PurgeExpired()

+ func (s *UDPNat) Start() error

+ type UDPNatOptions struct

+ ExcludeInterface []string

+ Filtering NATFiltering

+ Handler N.UDPConnectionHandlerEx

+ InterfaceFinder control.InterfaceFinder

+ Mapping NATMapping

+ MaxSize uint32

+ Prepare UDPNatPrepareFunc

+ Shared bool

+ Timeout time.Duration

+ type UDPNatPrepareFunc func(source M.Socksaddr, destination M.Socksaddr, userData any) (bool, context.Context, N.PacketWriter, N.CloseHandlerFunc)

Jun 3, 2026

Changes in this version

type DefaultInterfaceMonitor

+ MyInterfaces func() []string

type StackOptions

+ ICMPTimeout time.Duration

Mar 23, 2026

Changes in this version

type PackageManager

+ PackagesByID func(id uint32) ([]string, bool)

Feb 23, 2026

Changes in this version

+ const DefaultAutoRedirectNFQueue

+ const DefaultAutoRedirectResetMark

+ var ErrBypass = E.New("bypass by rule")

+ var ErrReset = E.New("reset by rule")

+ type DirectRouteContext interface

+ WritePacket func(packet []byte) error

+ type DirectRouteDestination interface

+ Close func() error

+ IsClosed func() bool

+ WritePacket func(packet *buf.Buffer) error

+ type DirectRouteMapping struct

+ func NewDirectRouteMapping(timeout time.Duration) *DirectRouteMapping

+ func (m *DirectRouteMapping) Lookup(session DirectRouteSession, ...) (DirectRouteDestination, error)

+ type DirectRouteSession struct

+ Destination netip.Addr

+ Source netip.Addr

type NativeTun — windows/amd64

+ func (t *NativeTun) ForceMTU(mtu int)

+ func (t *NativeTun) LUID() uint64

+ func (t *NativeTun) MTU() (int, error)

type Options

+ AutoRedirectNFQueue uint16

+ AutoRedirectResetMark uint32

+ EXP_ExternalConfiguration bool

+ ExcludeMPTCP bool

Jan 29, 2026

Changes in this version

+ const DefaultIPRoute2AutoRedirectFallbackRuleIndex

type Options

+ IPRoute2AutoRedirectFallbackRuleIndex int

Sep 2, 2025

Changes in this version

+ type DarwinTUN interface

+ BatchRead func() ([]*buf.Buffer, error)

+ BatchWrite func(buffers []*buf.Buffer) error

type DefaultInterfaceMonitor

+ MyInterface func() string

+ RegisterMyInterface func(interfaceName string)

type NativeTun — darwin/amd64

+ func (t *NativeTun) BatchRead() ([]*buf.Buffer, error)

+ func (t *NativeTun) BatchWrite(buffers []*buf.Buffer) error

+ func (t *NativeTun) TXChecksumOffload() bool

type Options

+ EXP_MultiPendingPackets bool

+ EXP_SendMsgX bool

+ Inet4LoopbackAddress []netip.Addr

+ Inet6LoopbackAddress []netip.Addr

Feb 6, 2025

Changes in this version

+ const FlagAndroidVPNUpdate

+ var ErrDrop = E.New("drop connections by rule")

+ func GSOSplit(in []byte, options GSOOptions, outBufs [][]byte, sizes []int, outOffset int) (int, error)

+ func PacketDestination(packet []byte) netip.Addr

+ func PacketFillHeader(packet []byte, ipVersion int)

+ func PacketIPVersion(packet []byte) int

+ type GSOOptions struct

+ CsumOffset uint16

+ CsumStart uint16

+ GSOSize uint16

+ GSOType GSOType

+ HdrLen uint16

+ NeedsCsum bool

+ type GSOType int

+ const GSONone

+ const GSOTCPv4

+ const GSOTCPv6

+ const GSOUDPL4

+ func (g GSOType) String() string

type Handler

+ PrepareConnection func(network string, source M.Socksaddr, destination M.Socksaddr) error

type NativeTun — darwin/amd64, linux/amd64, windows/amd64

+ func (t *NativeTun) Name() (string, error)

+ func (t *NativeTun) Start() error

+ func (t *NativeTun) UpdateRouteOptions(tunOptions Options) error

type Options

+ InterfaceFinder control.InterfaceFinder

+ InterfaceScope bool

type Tun

+ Name func() (string, error)

+ Start func() error

+ UpdateRouteOptions func(tunOptions Options) error

Nov 18, 2024

Changes in this version

+ const DefaultAutoRedirectInputMark

+ const DefaultAutoRedirectOutputMark

+ const DefaultIPRoute2RuleIndex

+ const DefaultIPRoute2TableIndex

+ const ProtocolRedirect — linux/amd64

+ func HasNextAddress(prefix netip.Prefix, count int) bool

+ type AutoRedirect interface

+ Close func() error

+ Start func() error

+ UpdateRouteAddressSet func()

+ func NewAutoRedirect(options AutoRedirectOptions) (AutoRedirect, error)

+ type AutoRedirectOptions struct

+ Context context.Context

+ CustomRedirectPort func() int

+ DisableNFTables bool

+ Handler Handler

+ InterfaceFinder control.InterfaceFinder

+ Logger logger.Logger

+ NetworkMonitor NetworkUpdateMonitor

+ RouteAddressSet *[]*netipx.IPSet

+ RouteExcludeAddressSet *[]*netipx.IPSet

+ TableName string

+ TunOptions *Options

type DefaultInterfaceMonitorOptions

+ InterfaceFinder control.InterfaceFinder

type Options

+ AutoRedirectInputMark uint32

+ AutoRedirectMarkMode bool

+ AutoRedirectOutputMark uint32

+ DNSServers []netip.Addr

+ EXP_DisableDNSHijack bool

+ IPRoute2RuleIndex int

+ IPRoute2TableIndex int

+ Inet4Gateway netip.Addr

+ Inet6Gateway netip.Addr

+ func (o *Options) Inet4GatewayAddr() netip.Addr

+ func (o *Options) Inet6GatewayAddr() netip.Addr

+ type PackageManagerOptions struct

+ Callback PackageManagerCallback

+ Logger logger.Logger

May 23, 2024

Changes in this version

+ var ErrIncludeAllNetworks = E.New(...)

type StackOptions

+ IncludeAllNetworks bool

Jan 7, 2024

Changes in this version

+ const OffloadOffset — darwin/amd64, js/wasm, windows/amd64

+ var ErrTooManySegments = E.New("too many segments")

+ type LinuxTUN interface

+ BatchRead func(buffers [][]byte, offset int, readN []int) (n int, err error)

+ BatchSize func() int

+ BatchWrite func(buffers [][]byte, offset int) error

+ TXChecksumOffload func() bool

type NativeTun — linux/amd64

+ func (t *NativeTun) BatchRead(buffers [][]byte, offset int, readN []int) (n int, err error)

+ func (t *NativeTun) BatchSize() int

+ func (t *NativeTun) BatchWrite(buffers [][]byte, offset int) error

+ func (t *NativeTun) FrontHeadroom() int

+ func (t *NativeTun) TXChecksumOffload() bool

+ func (t *NativeTun) WriteVectorised(buffers []*buf.Buffer) error

type Options

+ GSO bool

type StackOptions

+ TunOptions Options

Dec 12, 2023

Changes in this version

+ var ErrNetlinkBanned = E.New(...) — linux/amd64

Dec 4, 2023

Changes in this version

type Options

+ Inet4RouteExcludeAddress []netip.Prefix

+ Inet6RouteExcludeAddress []netip.Prefix

+ func (o *Options) BuildAutoRouteRanges(underNetworkExtension bool) ([]netip.Prefix, error)

Nov 6, 2023

Changes in this version

+ func BroadcastAddr(inet4Address []netip.Prefix) netip.Addr

Nov 5, 2023

Changes in this version

type DefaultInterfaceMonitor

+ DefaultInterface func(destination netip.Addr) (string, int)

Sep 20, 2023

Changes in this version

+ const EventNoRoute

type NativeTun — darwin/amd64, linux/amd64, windows/amd64

+ func (t *NativeTun) CreateVectorisedWriter() N.VectorisedWriter

+ func (t *NativeTun) WriteVectorised(buffers []*buf.Buffer) error

type Options

+ ExcludeInterface []string

+ IncludeInterface []string

+ Logger logger.Logger

type Stack

+ func NewMixed(options StackOptions) (Stack, error)

type Tun

+ CreateVectorisedWriter func() N.VectorisedWriter

Jun 17, 2023

Changes in this version

type DefaultInterfaceMonitorOptions

+ UnderNetworkExtension bool

Apr 21, 2023

Changes in this version

+ type ActionBlock struct

+ func (r *ActionBlock) ActionType() ActionType

+ func (r *ActionBlock) Timeout() bool

type ActionType

+ const ActionTypeBlock

+ const ActionTypeUnknown

type StackOptions

+ ForwarderBindInterface bool

+ InterfaceFinder control.InterfaceFinder

type TCPSession

+ LastActive time.Time

Mar 23, 2023

Changes in this version

+ func ActionTypeName(actionType ActionType) string

+ func NetworkFromName(name string) uint8

+ func NetworkName(network uint8) string

+ type ActionDirect struct

+ func (r *ActionDirect) ActionType() ActionType

+ type ActionReject struct

+ func (r *ActionReject) ActionType() ActionType

+ func (r *ActionReject) Timeout() bool

+ type ActionReturn struct

+ func (r *ActionReturn) ActionType() ActionType

+ func (r *ActionReturn) Timeout() bool

+ type ActionType = uint8

+ const ActionTypeDirect

+ const ActionTypeReject

+ const ActionTypeReturn

+ func ParseActionType(action string) (ActionType, error)

+ type DirectDestination interface

+ Close func() error

+ Timeout func() bool

+ WritePacket func(buffer *buf.Buffer) error

+ type NatMapping struct

+ func NewNatMapping(ipRewrite bool) *NatMapping

+ func (m *NatMapping) CreateSession(session RouteSession, context RouteContext)

+ func (m *NatMapping) DeleteSession(session RouteSession)

+ func (m *NatMapping) WritePacket(packet []byte) (bool, error)

+ type NatWriter struct

+ func NewNatWriter(inet4Address netip.Addr, inet6Address netip.Addr) *NatWriter

+ func (w *NatWriter) RewritePacket(packet []byte)

+ type RouteAction interface

+ ActionType func() ActionType

+ Timeout func() bool

+ type RouteContext interface

+ WritePacket func(packet []byte) error

+ type RouteMapping struct

+ func NewRouteMapping(maxAge int64) *RouteMapping

+ func (m *RouteMapping) Lookup(session RouteSession, constructor func() RouteAction) RouteAction

+ type RouteSession struct

+ Destination netip.AddrPort

+ IPVersion uint8

+ Network uint8

+ Source netip.AddrPort

+ type Router interface

+ RouteConnection func(session RouteSession, context RouteContext) RouteAction

type StackOptions

+ Router Router

+ UnderPlatform bool

Mar 9, 2023

Changes in this version

type Options

+ FileDescriptor int

type Tun — darwin/amd64, linux/amd64

+ func New(options Options) (Tun, error)

type Tun — js/wasm

+ func New(config Options) (Tun, error)

type WinTun — windows/amd64

+ func New(options Options) (WinTun, error)

Nov 26, 2022

Changes in this version

+ const EventAndroidVPNUpdate

+ const EventInterfaceUpdate

+ const IN6_IFF_NODAD — darwin/amd64

+ const IN6_IFF_SECURED — darwin/amd64

+ const ND6_INFINITE_LIFETIME — darwin/amd64

+ const PacketOffset

+ const SIOCAIFADDR_IN6 — darwin/amd64

+ const WithGVisor

+ var ErrGVisorNotIncluded = E.New(`gVisor is not included in this build, rebuild with -tags with_gvisor`)

+ var ErrNoRoute = E.New("no route to internet")

+ var TunnelType = "sing-tun" — windows/amd64

+ func CalculateInterfaceName(name string) (tunName string)

+ func ContextWithNeedTimeout(ctx context.Context, need bool) context.Context

+ func NeedTimeoutFromContext(ctx context.Context) bool

+ type DefaultInterfaceMonitor interface

+ AndroidVPNEnabled func() bool

+ Close func() error

+ DefaultInterfaceIndex func(destination netip.Addr) int

+ DefaultInterfaceName func(destination netip.Addr) string

+ OverrideAndroidVPN func() bool

+ RegisterCallback func(callback DefaultInterfaceUpdateCallback) *list.Element[DefaultInterfaceUpdateCallback]

+ Start func() error

+ UnregisterCallback func(element *list.Element[DefaultInterfaceUpdateCallback])

+ func NewDefaultInterfaceMonitor(networkMonitor NetworkUpdateMonitor, options DefaultInterfaceMonitorOptions) (DefaultInterfaceMonitor, error)

+ type DefaultInterfaceMonitorOptions struct

+ OverrideAndroidVPN bool

+ type DefaultInterfaceUpdateCallback = func(event int) error

+ type Handler interface

+ type NativeTun struct — darwin/amd64, linux/amd64, windows/amd64

+ func (t *NativeTun) Close() error

+ func (t *NativeTun) Read(p []byte) (n int, err error)

+ func (t *NativeTun) ReadFunc(block func(b []byte)) error

+ func (t *NativeTun) ReadPacket() ([]byte, func(), error)

+ func (t *NativeTun) Write(p []byte) (n int, err error)

+ type NetworkUpdateCallback = func() error

+ type NetworkUpdateMonitor interface

+ Close func() error

+ RegisterCallback func(callback NetworkUpdateCallback) *list.Element[NetworkUpdateCallback]

+ Start func() error

+ UnregisterCallback func(element *list.Element[NetworkUpdateCallback])

+ func NewNetworkUpdateMonitor(errorHandler E.Handler) (NetworkUpdateMonitor, error)

+ type Options struct

+ AutoRoute bool

+ ExcludePackage []string

+ ExcludeUID []ranges.Range[uint32]

+ IncludeAndroidUser []int

+ IncludePackage []string

+ IncludeUID []ranges.Range[uint32]

+ Inet4Address []netip.Prefix

+ Inet4RouteAddress []netip.Prefix

+ Inet6Address []netip.Prefix

+ Inet6RouteAddress []netip.Prefix

+ InterfaceMonitor DefaultInterfaceMonitor

+ MTU uint32

+ Name string

+ StrictRoute bool

+ TableIndex int

+ func (o *Options) BuildAndroidRules(packageManager PackageManager, errorHandler E.Handler)

+ func (o *Options) ExcludedRanges() (uidRanges []ranges.Range[uint32])

+ type PackageManager interface

+ Close func() error

+ IDByPackage func(packageName string) (uint32, bool)

+ IDBySharedPackage func(sharedPackage string) (uint32, bool)

+ PackageByID func(id uint32) (string, bool)

+ SharedPackageByID func(id uint32) (string, bool)

+ Start func() error

+ func NewPackageManager(callback PackageManagerCallback) (PackageManager, error)

+ type PackageManagerCallback interface

+ OnPackagesUpdated func(packages int, sharedUsers int)

+ type Session struct

+ DestinationAddress netip.Addr

+ DestinationPort uint16

+ SourceAddress netip.Addr

+ SourcePort uint16

+ type Stack interface

+ Close func() error

+ Start func() error

+ func NewGVisor(options StackOptions) (Stack, error)

+ func NewLWIP(options StackOptions) (Stack, error)

+ func NewStack(stack string, options StackOptions) (Stack, error)

+ func NewSystem(options StackOptions) (Stack, error)

+ type StackOptions struct

+ Context context.Context

+ EndpointIndependentNat bool

+ Handler Handler

+ Inet4Address []netip.Prefix

+ Inet6Address []netip.Prefix

+ Logger logger.Logger

+ MTU uint32

+ Name string

+ Tun Tun

+ UDPTimeout int64

+ type System struct

+ func (s *System) Close() error

+ func (s *System) Start() error

+ type TCPNat struct

+ func NewNat() *TCPNat

+ func (n *TCPNat) Lookup(source netip.AddrPort, destination netip.AddrPort) uint16

+ func (n *TCPNat) LookupBack(port uint16) *TCPSession

+ func (n *TCPNat) Revoke(natPort uint16, session *TCPSession)

+ type TCPSession struct

+ Destination netip.AddrPort

+ Source netip.AddrPort

+ type Tun interface

+ Close func() error

+ func Open(config Options) (Tun, error)

+ func Open(options Options) (Tun, error)

+ type WinTun interface

+ ReadPacket func() ([]byte, func(), error)

+ func Open(options Options) (WinTun, error)