websocket

package
v2.0.2 Latest Latest
Warning

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

Go to latest
Published: Mar 23, 2026 License: AGPL-3.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

type Config struct {
	HeartbeatInterval time.Duration `env:"HEARTBEAT_INTERVAL" json:"heartbeatInterval"`
	ReadBufferSize    int           `env:"READ_BUFFER_SIZE"   json:"readBufferSize"`
	WriteBufferSize   int           `env:"WRITE_BUFFER_SIZE"  json:"writeBufferSize"`
}

Config holds WebSocket-specific configuration.

func (*Config) ValidateWithContext

func (cfg *Config) ValidateWithContext(ctx context.Context) error

ValidateWithContext validates a Config struct.

type Upgrader

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

Upgrader upgrades HTTP connections to WebSocket event streams.

func NewUpgrader

func NewUpgrader(tracerProvider tracing.TracerProvider, cfg *Config) *Upgrader

NewUpgrader creates a new WebSocket Upgrader.

func (*Upgrader) UpgradeToBidirectionalStream

func (u *Upgrader) UpgradeToBidirectionalStream(w http.ResponseWriter, r *http.Request) (eventstream.BidirectionalEventStream, error)

UpgradeToBidirectionalStream upgrades an HTTP connection to a bidirectional WebSocket event stream.

func (*Upgrader) UpgradeToEventStream

func (u *Upgrader) UpgradeToEventStream(w http.ResponseWriter, r *http.Request) (eventstream.EventStream, error)

UpgradeToEventStream upgrades an HTTP connection to a unidirectional WebSocket event stream.

Jump to

Keyboard shortcuts

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