ws

package

v0.0.0-...-80b2b3e Latest Latest Go to latest Published: Nov 26, 2021 License: MIT Imports: 11 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 NewClient(hub *Hub, conn *websocket.Conn) *Client

func (cl *Client) Close()

Close will close send channel and connection once

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

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

func NewHub() *Hub

func (h *Hub) Broadcast(msg models.MessageInterface) error

func (h *Hub) GetUpgrader() *websocket.Upgrader

func (h *Hub) GracefulStop(ctx context.Context) error

TODO GracefulStop shuts down the socket.

func (h *Hub) RegisterClient(conn *websocket.Conn)

func (h *Hub) Run()

func (h *Hub) Title() string

Title returns the title.

type HubInterface interface {
	RegisterClient(*websocket.Conn)
	Broadcast(...interface{}) error
}

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

type UserMsg struct {
	Type    string          `json:"type"`
	Payload json.RawMessage `json:"payload"`
}

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

Path	Synopsis
models