server

Apr 9, 2026

Changes in this version

+ var ErrHubClosed = errors.New("wspulse: hub is closed")

type DisconnectReason

+ const DisconnectHubClose

+ type Hub interface

+ Broadcast func(roomID string, f Frame) error

+ Close func()

+ GetConnections func(roomID string) []Connection

+ Kick func(connectionID string) error

+ Send func(connectionID string, f Frame) error

+ func NewHub(connect ConnectFunc, options ...HubOption) Hub

+ type HubOption func(*hubConfig)

Apr 8, 2026

Changes in this version

+ func NewTestServer(t testing.TB, connect ConnectFunc, opts ...ServerOption) string

Mar 25, 2026

Changes in this version

+ type DisconnectReason string

+ const DisconnectDuplicate

+ const DisconnectGraceExpired

+ const DisconnectKick

+ const DisconnectNormal

+ const DisconnectServerClose

+ type MetricsCollector interface

+ ConnectionClosed func(roomID, connectionID string, duration time.Duration, reason DisconnectReason)

+ ConnectionOpened func(roomID, connectionID string)

+ FrameDropped func(roomID, connectionID string)

+ MessageBroadcast func(roomID string, sizeBytes int, fanOut int)

+ MessageReceived func(roomID string, sizeBytes int)

+ MessageSent func(roomID, connectionID string, sizeBytes int)

+ PongTimeout func(roomID, connectionID string)

+ ResumeAttempt func(roomID, connectionID string, success bool)

+ RoomCreated func(roomID string)

+ RoomDestroyed func(roomID string)

+ SendBufferUtilization func(roomID, connectionID string, used, capacity int)

+ type NoopCollector struct

+ func (NoopCollector) ConnectionClosed(_, _ string, _ time.Duration, _ DisconnectReason)

+ func (NoopCollector) ConnectionOpened(_, _ string)

+ func (NoopCollector) FrameDropped(_, _ string)

+ func (NoopCollector) MessageBroadcast(_ string, _ int, _ int)

+ func (NoopCollector) MessageReceived(_ string, _ int)

+ func (NoopCollector) MessageSent(_, _ string, _ int)

+ func (NoopCollector) PongTimeout(_, _ string)

+ func (NoopCollector) ResumeAttempt(_, _ string, _ bool)

+ func (NoopCollector) RoomCreated(_ string)

+ func (NoopCollector) RoomDestroyed(_ string)

+ func (NoopCollector) SendBufferUtilization(_, _ string, _, _ int)

+ type PanicError struct

+ Stack []byte

+ Value any

+ func (e *PanicError) Error() string

type ServerOption

+ func WithMetrics(collector MetricsCollector) ServerOption

+ func WithUpgraderBufferSize(readSize, writeSize int) ServerOption

Mar 24, 2026

Changes in this version

type ServerOption

+ func WithOnTransportDrop(fn func(Connection, error)) ServerOption

+ func WithOnTransportRestore(fn func(Connection)) ServerOption

Mar 10, 2026

Changes in this version

+ const BinaryMessage

+ const TextMessage

+ var ErrConnectionClosed = wspulse.ErrConnectionClosed

+ var ErrConnectionNotFound = errors.New("wspulse: connection not found")

+ var ErrDuplicateConnectionID = errors.New("wspulse: kicked: duplicate connection ID")

+ var ErrSendBufferFull = wspulse.ErrSendBufferFull

+ var ErrServerClosed = errors.New("wspulse: server is closed")

+ var JSONCodec = wspulse.JSONCodec

+ type Codec = wspulse.Codec

+ type ConnectFunc func(r *http.Request) (roomID, connectionID string, err error)

+ type Connection interface

+ Close func() error

+ Done func() <-chan struct{}

+ ID func() string

+ RoomID func() string

+ Send func(f Frame) error

+ type Frame = wspulse.Frame

+ type Server interface

+ Broadcast func(roomID string, f Frame) error

+ Close func()

+ GetConnections func(roomID string) []Connection

+ Kick func(connectionID string) error

+ Send func(connectionID string, f Frame) error

+ func NewServer(connect ConnectFunc, options ...ServerOption) Server

+ type ServerOption func(*serverConfig)

+ func WithCheckOrigin(fn func(r *http.Request) bool) ServerOption

+ func WithCodec(codec Codec) ServerOption

+ func WithHeartbeat(pingPeriod, pongWait time.Duration) ServerOption

+ func WithLogger(l *zap.Logger) ServerOption

+ func WithMaxMessageSize(n int64) ServerOption

+ func WithOnConnect(fn func(Connection)) ServerOption

+ func WithOnDisconnect(fn func(Connection, error)) ServerOption

+ func WithOnMessage(fn func(Connection, Frame)) ServerOption

+ func WithResumeWindow(seconds int) ServerOption

+ func WithSendBufferSize(n int) ServerOption

+ func WithWriteWait(d time.Duration) ServerOption