api

package

v1.0.5 Latest Latest Go to latest Published: Nov 20, 2020 License: GPL-3.0 Imports: 24 Imported by: 0

Details

This section is empty.

This section is empty.

func New(app types.App) http.Handler

New creates a new API handler

type API struct {
	types.App
	*Hub
	*mux.Router
}

API exposes endpoints for the webapp to perform HTTP RESTFull actions

func (a *API) ServeHTTP(w http.ResponseWriter, r *http.Request)

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

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

type Error interface {
	error
	Status() int
}

Error is an error occurring in an API endpoint

func NewError(err error, status int) Error

NewError returns a new error

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

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

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

Broadcast sends a message to all connected clients

func (h *Hub) Register(ws *websocket.Conn)

Register registers a new client in the hub