client

package

Go to main page

Versions in this module

v0

v0.2.3

Jan 29, 2026

Changes in this version

type BackendConfig

+ FlowControl FlowControlConfig

+ type CategorizedError struct

+ Category ErrorCategory

+ Err error

+ Reason string

type Client

+ func (c *Client) Stats() Stats

+ func (c *Client) StatsDetailed() Stats

type ClientBackendConfig

+ FlowControl FlowControlConfig

+ type ConnState uint32

+ const ConnStateActive

+ const ConnStateClosed

+ const ConnStateDraining

+ const ConnStatePending

+ type ConnectionStats struct

+ BufferLevel int

+ BytesIn int64

+ BytesOut int64

+ ClientID string

+ ConnectedAt time.Time

+ Hostname string

+ IsUDP bool

+ LastActivity time.Time

+ Paused bool

+ State ConnState

+ type DisconnectReason string

+ const DisconnectBufferFull

+ const DisconnectDialFailed

+ const DisconnectLocalError

+ const DisconnectNormal

+ const DisconnectPauseViolated

+ const DisconnectSessionEnded

+ const DisconnectShutdown

+ const DisconnectTimeout

+ const DisconnectUnknown

+ type ErrorCategory int

+ const ErrorPermanent

+ const ErrorRateLimit

+ const ErrorTransient

+ type Event struct

+ ClientID string

+ Error error

+ Hostname string

+ Reason string

+ Timestamp time.Time

+ Type EventType

+ type EventHandler func(Event)

+ type EventType int

+ const EventConnected

+ const EventConnectionClosed

+ const EventConnectionOpened

+ const EventDisconnected

+ const EventError

+ const EventPaused

+ const EventReauthCompleted

+ const EventReauthStarted

+ const EventResumed

+ func (e EventType) String() string

+ type FlowControlConfig struct

+ HighWaterMark int

+ LowWaterMark int

+ MaxBuffer int

type Option

+ func WithEventHandler(handler EventHandler) Option

+ type Stats struct

+ ActiveConnections int64

+ BytesReceivedTotal int64

+ BytesSentTotal int64

+ ConnectionStats map[string]ConnectionStats

+ ControlQueueDepth int

+ DataQueueDepth int

+ DroppedConnections int64

+ DroppedEvents int64

+ EnqueueTimeouts int64

+ LastConnectedAt time.Time

+ LastUpdated time.Time

+ MessagesReceivedTotal int64

+ MessagesSentTotal int64

+ PauseViolations int64

+ PausedConnections int64

+ PendingConnections int64

+ PermanentErrors int64

+ RateLimitHits int64

+ ReconnectCount int64

+ SessionUptime time.Duration

+ TotalConnections int64

+ TransientErrors int64

+ UDPDroppedPackets int64

v0.2.2

Jan 28, 2026

Changes in this version

type BackendConfig

+ TCPPorts []int

+ UDPRoutes []UDPRouteConfig

type ClientBackendConfig

+ TCPPorts []int

+ UDPRoutes []UDPRouteConfig

type ConnectRequest

+ Transport Transport

type TokenRequest

+ TCPPorts []int

+ UDPRoutes []UDPRouteConfig

+ type Transport string

+ const TransportTCP

+ const TransportUDP

+ type UDPRouteConfig struct

+ FlowIdleTimeoutSeconds *int

+ Port int

+ func CopyUDPRoutes(in []UDPRouteConfig) []UDPRouteConfig

v0.2.1

Jan 25, 2026

v0.2.0

Oct 29, 2025

Changes in this version

+ type AttestationConfig struct

+ Args []string

+ AuthorizerStatusURI string

+ CacheHandshakeSeconds int

+ Command string

+ Env map[string]string

+ HMACSecret string

+ HMACSecretFile string

+ HandshakeMaxAgeSeconds int

+ MaintenanceGraceCapSeconds int

+ PolicyVersion string

+ ReauthGraceSeconds int

+ ReauthIntervalSeconds int

+ TimeoutSeconds int

+ TokenTTLSeconds int

+ type AttestationOptions struct

+ Args []string

+ AuthorizerStatusURI string

+ CacheHandshake time.Duration

+ Command string

+ Env map[string]string

+ HMACSecret string

+ HMACSecretFile string

+ HandshakeMaxAgeSeconds int

+ MaintenanceGraceCapSeconds int

+ PolicyVersion string

+ ReauthGraceSeconds int

+ ReauthIntervalSeconds int

+ Timeout time.Duration

+ TokenTTL time.Duration

type BackendConfig

+ Attestation AttestationConfig

+ Weight int

type ClientBackendConfig

+ Attestation AttestationOptions

+ Weight int

+ type CommandTokenProvider struct

+ func NewCommandTokenProvider(cfg AttestationOptions) (*CommandTokenProvider, error)

+ func (c *CommandTokenProvider) IssueToken(ctx context.Context, req TokenRequest) (Token, error)

+ type HMACTokenProvider struct

+ func NewHMACTokenProvider(opts AttestationOptions, backendName string, hostnames []string, weight int) (*HMACTokenProvider, error)

+ func (h *HMACTokenProvider) IssueToken(ctx context.Context, req TokenRequest) (Token, error)

type TokenProvider

+ IssueToken func(ctx context.Context, req TokenRequest) (Token, error)

+ type TokenRequest struct

+ BackendName string

+ Hostnames []string

+ SessionNonce string

+ Stage TokenStage

+ Weight int

+ type TokenStage string

+ const StageAttest

+ const StageHandshake

+ const StageReauth

v0.1.4

Oct 25, 2025

v0.1.3

Oct 18, 2025

Changes in this version

type ConnectRequest

+ IsTLS bool

v0.1.2

Oct 18, 2025

Changes in this version

type Option

+ func WithTokenProvider(provider TokenProvider) Option

+ type Token struct

+ Expiry time.Time

+ Value string

+ type TokenProvider func(ctx context.Context) (Token, error)

v0.1.1

Sep 17, 2025

Changes in this version

+ var ErrNoRoute = errors.New("client: no route configured")

+ type BackendConfig struct

+ AuthToken string

+ HealthChecks HealthCheckConfig

+ Hostname string

+ Hostnames []string

+ Name string

+ NexusAddresses []string

+ PortMappings map[int]PortMapping

+ type Client struct

+ func New(cfg ClientBackendConfig, opts ...Option) *Client

+ func (c *Client) Start(ctx context.Context)

+ func (c *Client) Stop()

+ type ClientBackendConfig struct

+ AuthToken string

+ HealthChecks HealthCheckConfig

+ Hostnames []string

+ Name string

+ NexusAddress string

+ PortMappings map[int]PortMapping

+ type Config struct

+ Backends []BackendConfig

+ func LoadConfig(path string) (*Config, error)

+ type ConnectHandler func(ctx context.Context, req ConnectRequest) (net.Conn, error)

+ type ConnectRequest struct

+ BackendName string

+ ClientID uuid.UUID

+ ClientIP string

+ Hostname string

+ OriginalHostname string

+ Port int

+ type HealthCheckConfig struct

+ Enabled bool

+ InactivityTimeout int

+ PongTimeout int

+ type Option func(*Client)

+ func WithConnectHandler(handler ConnectHandler) Option

+ type PortMapping struct

+ Default string

+ Hosts map[string]string

+ func (pm PortMapping) Resolve(hostname string) (string, bool)

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