wskit

go-wskit

WebSocket hub-and-spoke server on coder/websocket with optional Redis Pub/Sub for multi-instance broadcast.

Install

go get github.com/TakuyaYagam1/go-wskit

import "github.com/TakuyaYagam1/go-wskit"

Features

• Hub — single-goroutine dispatcher with register/unregister/broadcast channels, graceful shutdown via context, atomic client count
• Client — ReadPump (drain incoming) + WritePump (send + ping/pong), safe concurrent Send with close protection
• Redis Pub/Sub — BroadcastEvent with JSON serialization, fallback to local broadcast on Redis failure, SubscribeToRedis for horizontal scaling
• Event envelope — Event{Type, Payload, Timestamp} standard JSON format, BroadcastJSON helper
• Accept helper — upgrade HTTP to WebSocket + create client + register in one call
• Functional options — configurable timeouts, buffer sizes, callbacks

Example

hub := wskit.NewHub(
    wskit.WithRedis(redisClient, "ws:events"),
    wskit.WithOnConnect(func(c *wskit.Client) {
        data, _ := json.Marshal(wskit.NewEvent("connected", nil))
        c.Send(data)
    }),
)
go hub.Run(ctx)
go hub.SubscribeToRedis(ctx)

http.HandleFunc("/ws", func(w http.ResponseWriter, r *http.Request) {
    client, err := wskit.Accept(r.Context(), w, r, hub, nil)
    if err != nil {
        return
    }
    go client.ReadPump()
    go client.WritePump()
})

hub.BroadcastJSON(ctx, "notification", map[string]string{"message": "hello"})

Options

Hub: WithRedis, WithBroadcastBuf, WithRegisterBuf, WithChannelTimeout, WithOnTimeout, WithOnConnect

Client: WithWriteWait, WithPingInterval, WithMaxMessageSize, WithSendBufSize