websocket

package
v1.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 2, 2026 License: AGPL-3.0 Imports: 24 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildTLSConfig added in v1.13.0 

func BuildTLSConfig(certFile, keyFile string, caFiles []string, pkcs12File string) (*tls.Config, error)

BuildTLSConfig creates a *tls.Config from the provided certificate files. Pass empty strings / nil slice for fields that are not used. Returns nil, nil when no TLS credentials are provided.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(clientType string, ID, secret string, endpoint string, pingInterval time.Duration, opts ...ClientOption) (*Client, error)

NewClient creates a new websocket client

func (*Client) Close 

func (c *Client) Close() error

Close closes the WebSocket connection gracefully

func (*Client) Connect 

func (c *Client) Connect() error

Connect establishes the WebSocket connection

func (*Client) EnsureProvisioned added in v1.14.0 

func (c *Client) EnsureProvisioned() error

EnsureProvisioned exchanges a provisioning key for permanent credentials synchronously, if one is configured and credentials aren't already present. Callers that need the resolved ID/Secret before Connect() runs (which only provisions lazily, in the background, on first connection attempt) should call this first.

func (*Client) GetConfig 

func (c *Client) GetConfig() *Config

func (*Client) GetConfigFilePath added in v1.13.0 

func (c *Client) GetConfigFilePath() string

GetConfigFilePath returns the resolved path to the config file used by this client.

func (*Client) GetConfigVersion added in v1.11.0 

func (c *Client) GetConfigVersion() int64

GetConfigVersion returns the latest config version received from server

func (*Client) GetServerVersion added in v1.8.0 

func (c *Client) GetServerVersion() string

func (*Client) MetricsContext 

func (c *Client) MetricsContext() context.Context

MetricsContext exposes the context used for telemetry emission when a connection is active.

func (*Client) OnConnect 

func (c *Client) OnConnect(callback func() error)

func (*Client) OnTokenUpdate 

func (c *Client) OnTokenUpdate(callback func(token string))

func (*Client) RegisterHandler 

func (c *Client) RegisterHandler(messageType string, handler MessageHandler)

RegisterHandler registers a handler for a specific message type

func (*Client) SendMessage 

func (c *Client) SendMessage(messageType string, data interface{}) error

SendMessage sends a message through the WebSocket connection

func (*Client) SendMessageInterval 

func (c *Client) SendMessageInterval(messageType string, data interface{}, interval time.Duration) (stop func())

func (*Client) SendMessageNoLog added in v1.8.0 

func (c *Client) SendMessageNoLog(messageType string, data interface{}) error

SendMessage sends a message through the WebSocket connection

func (*Client) WasJustProvisioned added in v1.11.0 

func (c *Client) WasJustProvisioned() bool

WasJustProvisioned reports whether the client exchanged a provisioning key for permanent credentials during the most recent connection attempt. It consumes the flag – subsequent calls return false until provisioning occurs again (which, in practice, never happens once credentials are persisted).

type ClientOption 

type ClientOption func(*Client)

func WithBaseURL 

func WithBaseURL(url string) ClientOption

WithBaseURL sets the base URL for the client

func WithConfigFile added in v1.11.0 

func WithConfigFile(path string) ClientOption

WithTLSConfig sets the TLS configuration for the client

func WithTLSConfig 

func WithTLSConfig(config TLSConfig) ClientOption

type Config 

type Config struct {
	ID              string `json:"id"`
	Secret          string `json:"secret"`
	Endpoint        string `json:"endpoint"`
	TlsClientCert   string `json:"tlsClientCert"`
	ProvisioningKey string `json:"provisioningKey,omitempty"`
	Name            string `json:"name,omitempty"`
	Blocked         bool   `json:"blocked,omitempty"`
}

type MessageHandler 

type MessageHandler func(message WSMessage)

type ProvisioningResponse added in v1.11.0 

type ProvisioningResponse struct {
	Data struct {
		NewtID string `json:"newtId"`
		Secret string `json:"secret"`
	} `json:"data"`
	Success bool   `json:"success"`
	Message string `json:"message"`
}

type TLSConfig 

type TLSConfig struct {
	// New separate certificate support
	ClientCertFile string
	ClientKeyFile  string
	CAFiles        []string

	// Existing PKCS12 support (deprecated)
	PKCS12File string
}

TLSConfig holds TLS configuration options

type TokenResponse 

type TokenResponse struct {
	Data struct {
		Token         string `json:"token"`
		ServerVersion string `json:"serverVersion"`
	} `json:"data"`
	Success bool   `json:"success"`
	Message string `json:"message"`
}

type WSMessage 

type WSMessage struct {
	Type          string      `json:"type"`
	Data          interface{} `json:"data"`
	ConfigVersion int64       `json:"configVersion,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.