wskit

package module

Go to main page

Versions in this module

v0

v0.4.0

Jul 3, 2026

Changes in this version

+ var ErrNilConn = errors.New("wskit: websocket connection is nil")

+ var ErrNilContext = errors.New("wskit: context is nil")

+ var ErrNilHub = errors.New("wskit: hub is nil")

+ var ErrNilRequest = errors.New("wskit: http request is nil")

+ var ErrNilResponseWriter = errors.New("wskit: http response writer is nil")

+ var ErrNilSubscriber = errors.New("wskit: subscriber is nil")

+ var ErrOperationTimeout = errors.New("wskit: operation timeout")

+ var ErrRedisSubscriptionClosed = errors.New("wskit: redis subscription closed")

+ var ErrSubscriberBufferFull = errors.New("wskit: subscriber buffer is full")

+ var ErrSubscriberClosed = errors.New("wskit: subscriber is closed")

type ClientConfig

+ OnMessage MessageHandler

type ClientOption

+ func WithMessageHandler(fn MessageHandler) ClientOption

type HubOption

+ func WithOnDrop(fn func(Subscriber, []byte)) HubOption

+ func WithOnError(fn func(op string, err error)) HubOption

+ type MessageHandler func(ctx context.Context, client *Client, messageType websocket.MessageType, ...) error

type SSEClient

+ func (c *SSEClient) SendErr(data []byte) error

v0.3.0

Mar 28, 2026

Changes in this version

+ var ErrFlusherNotSupported = errors.New("wskit: http.Flusher not supported")

+ func AcceptSSE(w http.ResponseWriter, r *http.Request, hub *Hub) error

type Client

+ func (c *Client) Close()

type Hub

+ func (h *Hub) SubscriberCount() int

type HubOption

+ func WithOnDisconnect(fn func(Subscriber)) HubOption

+ type SSEClient struct

+ func NewSSEClient(hub *Hub, bufSize int) *SSEClient

+ func (c *SSEClient) Close()

+ func (c *SSEClient) Send(data []byte) bool

+ type Subscriber interface

+ Close func()

+ Send func(data []byte) bool

v0.2.0

Mar 24, 2026

Changes in this version

+ const DefaultBroadcastBuf

+ const DefaultChannelTimeout

+ const DefaultMaxMessageSize

+ const DefaultPingInterval

+ const DefaultRegisterBuf

+ const DefaultSendBufSize

+ const DefaultWriteWait

+ var ErrHubStopped = errors.New("wskit: hub is stopped")

+ type AcceptFunc func(w http.ResponseWriter, r *http.Request, opts *websocket.AcceptOptions) (*websocket.Conn, error)

+ type Client struct

+ func Accept(ctx context.Context, w http.ResponseWriter, r *http.Request, hub *Hub, ...) (*Client, error)

+ func NewClient(hub *Hub, conn *websocket.Conn, ctx context.Context, opts ...ClientOption) *Client

+ func (c *Client) ReadPump()

+ func (c *Client) Send(data []byte) (sent bool)

+ func (c *Client) SendErr(data []byte) error

+ func (c *Client) WritePump()

+ type ClientConfig struct

+ MaxMessageSize int64

+ PingInterval time.Duration

+ SendBufSize int

+ WriteWait time.Duration

+ type ClientOption func(*ClientConfig)

+ func WithMaxMessageSize(n int64) ClientOption

+ func WithPingInterval(d time.Duration) ClientOption

+ func WithSendBufSize(n int) ClientOption

+ func WithWriteWait(d time.Duration) ClientOption

+ type Conn interface

+ Close func(code websocket.StatusCode, reason string) error

+ Ping func(ctx context.Context) error

+ Read func(ctx context.Context) (websocket.MessageType, []byte, error)

+ SetReadLimit func(limit int64)

+ Writer func(ctx context.Context, typ websocket.MessageType) (io.WriteCloser, error)

+ type Event struct

+ Payload any

+ Timestamp time.Time

+ Type string

+ func NewEvent(typ string, payload any) Event

+ type Hub struct

+ func NewHub(opts ...HubOption) *Hub

+ func (h *Hub) Broadcast(data []byte)

+ func (h *Hub) BroadcastEvent(ctx context.Context, event any) error

+ func (h *Hub) BroadcastJSON(ctx context.Context, typ string, payload any) error

+ func (h *Hub) ClientCount() int

+ func (h *Hub) Register(client *Client)

+ func (h *Hub) Run(ctx context.Context)

+ func (h *Hub) SubscribeToRedis(ctx context.Context)

+ func (h *Hub) Unregister(client *Client)

+ type HubOption func(*Hub)

+ func WithBroadcastBuf(n int) HubOption

+ func WithChannelTimeout(d time.Duration) HubOption

+ func WithOnConnect(fn OnConnect) HubOption

+ func WithOnTimeout(fn func(op string)) HubOption

+ func WithRedis(client *redis.Client, channel string) HubOption

+ func WithRegisterBuf(n int) HubOption

+ type OnConnect func(client *Client)

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