wsroom

wsroom

wsroom is a lightweight WebSocket room hub for Go applications. It manages room membership, targeted sends, broadcasts, reconnect grace periods, and hook-based lifecycle/message handling.

Install

go get github.com/a-sam-randall/wsroom@latest

Quick Start

package main

import (
	"context"
	"log"
	"net/http"
	"time"

	"github.com/a-sam-randall/wsroom"
)

type hooks struct{}

func (h *hooks) OnJoin(ctx context.Context, jc wsroom.JoinContext, client wsroom.Client) error {
	return nil
}

func (h *hooks) OnMessage(ctx context.Context, room wsroom.RoomID, p wsroom.ParticipantID, msg wsroom.Envelope) error {
	return nil
}

func (h *hooks) OnLeave(ctx context.Context, room wsroom.RoomID, p wsroom.ParticipantID, reason error) {}

func main() {
	hub := wsroom.NewHub(&hooks{}, wsroom.ReconnectPolicy{
		GracePeriod:      30 * time.Second,
		MaxQueuedPerConn: 64,
	})

	http.HandleFunc("/ws", func(w http.ResponseWriter, r *http.Request) {
		err := hub.HandleWS(w, r, wsroom.RoomID("game-1"), wsroom.Identity{}, func(ctx context.Context, room wsroom.RoomID, identity wsroom.Identity) (wsroom.ParticipantID, error) {
			return wsroom.ParticipantID("player-1"), nil
		})
		if err != nil {
			log.Printf("ws error: %v", err)
		}
	})

	log.Fatal(http.ListenAndServe(":8080", nil))
}

Versioning

This module follows semantic versioning. Starting from v1.0.0, breaking API changes require a new major version.