api

package

v1.0.5 Latest Latest Go to latest Published: Nov 20, 2020 License: GPL-3.0 Imports: 24 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.

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