chat

Documentation

Index

• func JoinRequest(_ *goyave.Request) v.RuleSet
• type Client
• type Hub
  • func NewHub() *Hub
  • func (h *Hub) Broadcast(message []byte)
  • func (h *Hub) RegisterRoute(router *goyave.Router, handler goyave.Handler)
  • func (h *Hub) Run()
  • func (h *Hub) Serve(c *websocket.Conn, request *goyave.Request) error

Functions

func JoinRequest

func JoinRequest(_ *goyave.Request) v.RuleSet

JoinRequest the query validation rules joining the chat room.

Types

type Client

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

Client is a middleman between the websocket connection and the hub.

type Hub

type Hub struct {
	goyave.Component
	// contains filtered or unexported fields
}

Hub maintains the set of active clients and broadcasts messages to the clients.

func NewHub

func NewHub() *Hub

NewHub create a new chat Hub.

func (*Hub) Broadcast

func (h *Hub) Broadcast(message []byte)

Broadcast send a message to all connected clients. This method is concurrently safe and doesn't do anything is the Hub's context is canceled.

func (*Hub) RegisterRoute

func (h *Hub) RegisterRoute(router *goyave.Router, handler goyave.Handler)

RegisterRoute regsiters the websocket route with validation.

func (*Hub) Run

func (h *Hub) Run()

Run the Hub loop. Should be run in a goroutine. This method should not be called more than once.

Registers a shutdown hook, ensuring the hub shutdowns properly and closes all active connections before goyave.Start() returns.

func (*Hub) Serve

func (h *Hub) Serve(c *websocket.Conn, request *goyave.Request) error

Serve is the websocket Handler for the chat clients.