transport

type ControlPacket[Type any] struct {
	C *int `json:"c,omitzero"`
	P Type `json:"p,omitzero"`
}

type Handler func(tr Transport) (err error)

type HandshakeResponse struct {
	Ok            bool `json:"ok"`
	MaxPacketSize int  `json:"max_packet_size"`
	RateLimit     int  `json:"rate_limit"`
	RateBurst     int  `json:"rate_burst"`
}

type SMuxCall func(ctx context.Context, arg any) (tr Transport)

type SocketOpts struct {
	// MaxPacketSize is the maximum size of a JSON packet we accept.
	// Defaults to DefaultMaxPacketSize if zero.
	MaxPacketSize int

	// InMessageBuffer allows for this many packets to be pending before we close the connection.
	// Defaults to DefaultInMessageBuffer if zero.
	InMessageBuffer int

	// RateLimit is the number of messages per second we allow.
	// This is how much the 'bucket' refills per second.
	// Defaults to DefaultRateLimit if zero.
	RateLimit int

	// RateBurst is the maximum burst of messages we allow.
	// This is the total capacity of the 'bucket'.
	// Defaults to DefaultRateBurst if zero.
	RateBurst int

	// PingEvery sends a ping every ~duration, +/- a small random variability.
	PingEvery time.Duration

	// SubProto, if set, must be provided by the client for this socket to connect properly.
	SubProto string
}

type Transport interface {
	// Context returns the underlying Context for the physical transport, e.g., of the HTTP connection.
	Context() (ctx context.Context)

	// ReadJSON reads JSON from the transport into the given target.
	// It will also return an error if the underlying Transport has shut down.
	ReadJSON(v any) (err error)

	// WriteJSON writes JSON from the given data to the transport.
	// Implementations may queue sends and never return an error.
	WriteJSON(v any) (err error)
}

type TransportError struct {
	Code   int
	Reason string
}

type TypeTransport[X any] interface {
	// Context returns the underlying Context for the physical transport, e.g., of the HTTP connection.
	Context() (ctx context.Context)

	// Read reads from this TypeTransport.
	Read() (x X, err error)

	// Write writes into this TypeTransport.
	Write(x X) (err error)
}