api

Documentation

Index

• func New(app types.App) http.Handler
• type API
  • func (a *API) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Client
• type Error
  • func NewError(err error, status int) Error
• type Hub
  • func (h *Hub) Broadcast(msg []byte)
  • func (h *Hub) Register(ws *websocket.Conn)

Functions

func New

func New(app types.App) http.Handler

New creates a new API handler

Types

type API

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

API exposes endpoints for the webapp to perform HTTP RESTFull actions

func (*API) ServeHTTP

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

type Client

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

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

type Error

type Error interface {
	error
	Status() int
}

Error is an error occurring in an API endpoint

func NewError

func NewError(err error, status int) Error

NewError returns a new error

type Hub

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

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

func (*Hub) Broadcast

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

Broadcast sends a message to all connected clients

func (*Hub) Register

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

Register registers a new client in the hub