tide

package module

Go to main page

Versions in this module

v0

v0.2.0

Aug 6, 2026

Changes in this version

type ClientConfig

+ Congestion string

type PaddingPhase

+ const PhaseOff

type ServerConfig

+ Congestion string

v0.1.0

Aug 6, 2026

Changes in this version

+ const ChannelBindingLabel

+ const DefaultIdleProbeInterval

+ const DefaultMaxStreams

+ const DefaultPathDeadAfter

+ const DefaultProbeInterval

+ const DefaultProbeTimeout

+ const DefaultSessionGrace

+ const DefaultSessionWindow

+ const DefaultStreamWindow

+ const DefaultTicketCount

+ const FlagEnd

+ const FlagPad

+ const FlagPush

+ const MaxFrameBody

+ const MaxPayload

+ const MaxVarint

+ const ProtocolVersion

+ const TicketLifetime

+ const TimestampTolerance

+ var ErrBadTicket = errors.New("tide: ticket invalid or already consumed")

+ var ErrChannelBinding = errors.New("tide: channel binding mismatch")

+ var ErrClosed = errors.New("tide: session closed")

+ var ErrFlowControl = errors.New("tide: peer exceeded flow-control window")

+ var ErrFrameTooLarge = errors.New("tide: frame exceeds max size")

+ var ErrNoPath = errors.New("tide: no usable path")

+ var ErrProtocol = errors.New("tide: protocol violation")

+ var ErrSessionGone = errors.New("tide: session grace period expired")

+ var ErrStaleTimestamp = errors.New("tide: timestamp outside tolerance window")

+ var ErrStreamClosed = errors.New("tide: stream closed")

+ var ErrStreamReset = errors.New("tide: stream reset by peer")

+ var ErrTicketExhausted = errors.New("tide: no unconsumed tickets left")

+ var ErrTooManyStreams = errors.New("tide: stream limit reached")

+ var ErrVersion = errors.New("tide: unsupported version")

+ func AppendFrame(b []byte, t FrameType, flags uint8, streamID uint64, payload []byte, pad int) []byte

+ func AppendVarint(b []byte, v uint64) []byte

+ func DefaultHandler(ctx context.Context, st *Stream)

+ func DefaultPacketHandler(ctx context.Context, ps *PacketStream)

+ func ReadVarint(b []byte) (v uint64, n int)

+ func UserIDFromPassword(password string) [16]byte

+ func VarintLen(v uint64) int

+ type Client struct

+ func NewClient(cfg *ClientConfig) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) CloseSession()

+ func (c *Client) CurrentSession() *Session

+ func (c *Client) DialContext(ctx context.Context, network, addr string) (net.Conn, error)

+ func (c *Client) DialPacket(ctx context.Context, addr string) (*PacketStream, error)

+ func (c *Client) Session(ctx context.Context) (*Session, error)

+ func (c *Client) TicketsRemaining() int

+ func (c *Client) TicketsTaken() uint64

+ type ClientConfig struct

+ Bare bool

+ Dial DialFunc

+ EnableQUIC bool

+ ProbeInterval time.Duration

+ PublicKey *PublicKey

+ QUICPort int

+ Redundancy bool

+ Server string

+ ServerName string

+ SessionGrace time.Duration

+ StreamWindow uint64

+ TLSConfig *tls.Config

+ UserID [16]byte

+ type Datagram struct

+ Addr string

+ Assoc uint64

+ Data []byte

+ type DialFunc func(ctx context.Context, network, addr string) (net.Conn, error)

+ type Frame struct

+ Flags uint8

+ Payload []byte

+ StreamID uint64

+ Type FrameType

+ type FrameType uint8

+ const FrameAccept

+ const FrameClose

+ const FrameDatagram

+ const FrameHello

+ const FramePadding

+ const FramePathAck

+ const FramePathMigrate

+ const FramePathProbe

+ const FrameStreamAck

+ const FrameStreamData

+ const FrameStreamFin

+ const FrameStreamOpen

+ const FrameStreamRst

+ const FrameTicketRepl

+ const FrameTicketReq

+ const FrameZeroRTT

+ func (t FrameType) String() string

+ type MemTicketStore struct

+ func NewMemTicketStore() *MemTicketStore

+ func (s *MemTicketStore) Consume(user [16]byte, id uint64) ([32]byte, bool)

+ func (s *MemTicketStore) ConsumeAny(id uint64) ([32]byte, [16]byte, bool)

+ func (s *MemTicketStore) Issue(user [16]byte, count uint16) (uint64, [32]byte, error)

+ func (s *MemTicketStore) Remaining(user [16]byte) int

+ func (s *MemTicketStore) Sweep(now time.Time)

+ type PacketStream struct

+ func (ps *PacketStream) Assoc() uint64

+ func (ps *PacketStream) Close() error

+ func (ps *PacketStream) LocalAddr() net.Addr

+ func (ps *PacketStream) ReadFrom() (*Datagram, error)

+ func (ps *PacketStream) SetReadDeadline(t time.Time) error

+ func (ps *PacketStream) WriteTo(b []byte, addr string) (int, error)

+ type PaddingPhase uint8

+ const PhaseBulk

+ const PhaseDecay

+ const PhaseDecision

+ func (p PaddingPhase) String() string

+ type PathInfo struct

+ Age time.Duration

+ ID uint32

+ Kind string

+ Loss float64

+ Pad string

+ RTT time.Duration

+ RX uint64

+ State string

+ TX uint64

+ type PrivateKey struct

+ func GenerateKey() (*PrivateKey, error)

+ func ParsePrivateKey(s string) (*PrivateKey, error)

+ func (k *PrivateKey) Public() *PublicKey

+ func (k *PrivateKey) Seed() []byte

+ func (k *PrivateKey) String() string

+ type PublicKey struct

+ func ParsePublicKey(s string) (*PublicKey, error)

+ func ParsePublicKeyBytes(b []byte) (*PublicKey, error)

+ func (p *PublicKey) Bytes() []byte

+ func (p *PublicKey) String() string

+ type Server struct

+ Handler func(ctx context.Context, st *Stream)

+ PacketHandler func(ctx context.Context, ps *PacketStream)

+ func NewServer(cfg *ServerConfig) (*Server, error)

+ func (s *Server) Close() error

+ func (s *Server) Serve(l net.Listener) error

+ func (s *Server) ServeQUIC(addr string) error

+ type ServerConfig struct

+ AllowBare bool

+ CoverAddr string

+ MaxStreams int

+ PrivateKey *PrivateKey

+ SessionGrace time.Duration

+ StreamWindow uint64

+ TLSConfig *tls.Config

+ TicketCount uint16

+ TicketStore TicketStore

+ Users map[[16]byte]string

+ type Session struct

+ func (s *Session) AcceptStream(ctx context.Context) (*Stream, error)

+ func (s *Session) Close() error

+ func (s *Session) Done() <-chan struct{}

+ func (s *Session) ID() [16]byte

+ func (s *Session) KillAllPaths() int

+ func (s *Session) LocalAddr() net.Addr

+ func (s *Session) OpenPacket(ctx context.Context, dst string) (*PacketStream, error)

+ func (s *Session) OpenStream(ctx context.Context, dst string) (*Stream, error)

+ func (s *Session) PathCount() int

+ func (s *Session) Paths() []PathInfo

+ func (s *Session) PathsEstablished() uint64

+ type Stream struct

+ func (st *Stream) Close() error

+ func (st *Stream) CloseWrite() error

+ func (st *Stream) ID() uint64

+ func (st *Stream) LocalAddr() net.Addr

+ func (st *Stream) Read(p []byte) (int, error)

+ func (st *Stream) RemoteAddr() net.Addr

+ func (st *Stream) SetDeadline(t time.Time) error

+ func (st *Stream) SetReadDeadline(t time.Time) error

+ func (st *Stream) SetWriteDeadline(t time.Time) error

+ func (st *Stream) Write(p []byte) (int, error)

+ type StreamError uint32

+ const StreamErrCanceled

+ const StreamErrFlowControl

+ const StreamErrNone

+ const StreamErrProtocol

+ const StreamErrRefused

+ const StreamErrSessionClose

+ func (e StreamError) Error() string

+ type TicketStore interface

+ Consume func(user [16]byte, id uint64) (seed [32]byte, ok bool)

+ Issue func(user [16]byte, count uint16) (base uint64, seed [32]byte, err error)

+ Remaining func(user [16]byte) int

+ Sweep func(now time.Time)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL