wsbroadcast

package

v0.0.0-...-75e333b Latest Latest Go to latest Published: Jan 1, 2022 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

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

func (c *Client) CanSend(channel string) bool

CanSend checks if the client is subscribed to a channel

type HandlerFunc func(map[string]bool, chan interface{})

HandlerFunc is used for callbacks sends a list of channels the client registered to and a return channel

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

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

func NewHub(availableChannels []string) *Hub

NewHub Create a new hub for the handler

func (h *Hub) Broadcast(channel string, m interface{})

Broadcast message to the clients

func (h *Hub) OnRegister(f HandlerFunc)

OnRegister calls a handler when a client registers.

func (h *Hub) Run()

Run the hub

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

ServeWs handles websocket requests from the peer.