websocket

Documentation

Index

• type Client
• type Hub
  • func NewHub() *Hub
  • func (h *Hub) Broadcast(msgType string, data interface{}) error
  • func (h *Hub) ClientCount() int
  • func (h *Hub) Run(ctx context.Context)
  • func (h *Hub) ServeWS(w http.ResponseWriter, r *http.Request)
  • func (h *Hub) ServeWSUntil(w http.ResponseWriter, r *http.Request, expiresAt time.Time)
• type Message

Types

type Client

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

Client represents a WebSocket client connection

type Hub

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

Hub maintains active WebSocket connections and broadcasts messages

func NewHub

func NewHub() *Hub

NewHub creates a new WebSocket hub

func (*Hub) Broadcast

func (h *Hub) Broadcast(msgType string, data interface{}) error

Broadcast sends a message to all connected clients

func (*Hub) ClientCount

func (h *Hub) ClientCount() int

ClientCount returns the number of connected clients

func (*Hub) Run

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

Run starts the hub's main loop

func (*Hub) ServeWS

func (h *Hub) ServeWS(w http.ResponseWriter, r *http.Request)

ServeWS handles WebSocket requests from clients

func (*Hub) ServeWSUntil

func (h *Hub) ServeWSUntil(w http.ResponseWriter, r *http.Request, expiresAt time.Time)

ServeWSUntil closes an authorized connection at its session's absolute expiry. A zero deadline is reserved for connections that do not use sessions (local demo).

type Message

type Message struct {
	Type string      `json:"type"`
	Data interface{} `json:"data"`
}

Message types for WebSocket communication