relay

Jul 24, 2026

Changes in this version

type FeatureType

+ const FeatureMetadata

+ type MetadataFeature struct

+ KVs map[string]string

+ func (f *MetadataFeature) Decode(b []byte) error

+ func (f *MetadataFeature) Encode() ([]byte, error)

+ func (f *MetadataFeature) Type() FeatureType

Jun 21, 2026

Changes in this version

+ type OpaqueFeature struct

+ func (f *OpaqueFeature) Decode(b []byte) error

+ func (f *OpaqueFeature) Encode() ([]byte, error)

+ func (f *OpaqueFeature) Type() FeatureType

May 20, 2026

Changes in this version

+ var ErrBadConnectorID = errors.New("bad connector id")

+ var ErrBadNetworkID = errors.New("bad network id")

+ var ErrBadTunnelID = errors.New("bad tunnel id")

Jan 28, 2024

Changes in this version

type ConnectorID

+ func (cid ConnectorID) SetUDP(udp bool) ConnectorID

+ func (cid ConnectorID) SetWeight(weight uint8) ConnectorID

+ func (cid ConnectorID) Weight() uint8

type FeatureType

+ const FeatureNetwork

+ type NetworkFeature struct

+ Network NetworkID

+ func (f *NetworkFeature) Decode(b []byte) error

+ func (f *NetworkFeature) Encode() ([]byte, error)

+ func (f *NetworkFeature) Type() FeatureType

+ type NetworkID uint16

+ const NetworkIP

+ const NetworkSerial

+ const NetworkTCP

+ const NetworkUDP

+ const NetworkUnix

+ func (p NetworkID) String() string

type TunnelID

+ func (tid TunnelID) SetPrivate(private bool) TunnelID

+ func (tid TunnelID) SetWeight(weight uint8) TunnelID

+ func (tid TunnelID) Weight() uint8

Feb 2, 2023

Changes in this version

+ const ConnectorUDP

+ type ConnectorFlag uint32

type ConnectorID

+ func NewConnectorID(v []byte) (cid ConnectorID)

+ func NewUDPConnectorID(v []byte) (cid ConnectorID)

+ func (cid ConnectorID) Equal(x ConnectorID) bool

+ func (cid ConnectorID) ID() (id [connectorIDLen]byte)

+ func (cid ConnectorID) IsUDP() bool

+ func (cid ConnectorID) IsZero() bool

+ func (cid ConnectorID) String() string

type TunnelID

+ func (tid TunnelID) ID() (id [connectorIDLen]byte)

Jan 29, 2023

Changes in this version

+ type TunnelFlag uint32

+ const TunnelPrivate

type TunnelID

+ func NewPrivateTunnelID(v []byte) (tid TunnelID)

+ func NewTunnelID(v []byte) (tid TunnelID)

+ func (tid TunnelID) Equal(x TunnelID) bool

+ func (tid TunnelID) IsPrivate() bool

Jan 14, 2023

Changes in this version

+ const StatusBadRequest

+ const StatusForbidden

+ const StatusHostUnreachable

+ const StatusInternalServerError

+ const StatusNetworkUnreachable

+ const StatusOK

+ const StatusServiceUnavailable

+ const StatusTimeout

+ const StatusUnauthorized

+ const Version1

+ var ErrBadAddrType = errors.New("bad address type")

+ var ErrBadVersion = errors.New("bad version")

+ var ErrShortBuffer = errors.New("short buffer")

+ type AddrFeature struct

+ AType AddrType

+ Host string

+ Port uint16

+ func (f *AddrFeature) Decode(b []byte) error

+ func (f *AddrFeature) Encode() ([]byte, error)

+ func (f *AddrFeature) ParseFrom(address string) error

+ func (f *AddrFeature) Type() FeatureType

+ type AddrType uint8

+ const AddrDomain

+ const AddrIPv4

+ const AddrIPv6

+ type CmdType uint8

+ const CmdAssociate

+ const CmdBind

+ const CmdConnect

+ const CmdMask

+ const FUDP

+ type ConnectorID = TunnelID

+ type Feature interface

+ Decode func([]byte) error

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

+ Type func() FeatureType

+ func NewFeature(t FeatureType, data []byte) (f Feature, err error)

+ func ReadFeature(r io.Reader) (Feature, error)

+ type FeatureType uint8

+ const FeatureAddr

+ const FeatureTunnel

+ const FeatureUserAuth

+ type Request struct

+ Cmd CmdType

+ Features []Feature

+ Version uint8

+ func (req *Request) ReadFrom(r io.Reader) (n int64, err error)

+ func (req *Request) WriteTo(w io.Writer) (n int64, err error)

+ type Response struct

+ Features []Feature

+ Status uint8

+ Version uint8

+ func (resp *Response) ReadFrom(r io.Reader) (n int64, err error)

+ func (resp *Response) WriteTo(w io.Writer) (n int64, err error)

+ type TunnelFeature struct

+ ID TunnelID

+ func (f *TunnelFeature) Decode(b []byte) error

+ func (f *TunnelFeature) Encode() ([]byte, error)

+ func (f *TunnelFeature) Type() FeatureType

+ type TunnelID [16]byte

+ func (tid TunnelID) IsZero() bool

+ func (tid TunnelID) String() string

+ type UserAuthFeature struct

+ Password string

+ Username string

+ func (f *UserAuthFeature) Decode(b []byte) error

+ func (f *UserAuthFeature) Encode() ([]byte, error)

+ func (f *UserAuthFeature) Type() FeatureType