www

Documentation

Index

• func NewWSActions(dClient *data.Client) map[string]WSAction
• type Server
  • func New(cert, key, host string, port int, dStore datastore.Datastore) (*Server, error)
  • func (s *Server) Run() error
• type WS
  • func NewWS(bufferSize int, actions map[string]WSAction) *WS
  • func (ws *WS) HandleServerError(res http.ResponseWriter, req *http.Request, err error)
  • func (ws *WS) HandleUpgrades(res http.ResponseWriter, req *http.Request)
  • func (ws *WS) HandleWSError(conn *websocket.Conn, err error)
  • func (ws *WS) Route(conn *websocket.Conn)
• type WSAction

Functions

func NewWSActions

func NewWSActions(dClient *data.Client) map[string]WSAction

Types

type Server

type Server struct {
	http.Server
}

func New

func New(cert, key, host string, port int, dStore datastore.Datastore) (*Server, error)

TODO load a config to choose a datastore

func (*Server) Run

func (s *Server) Run() error

type WS

type WS struct {
	Upgrader *websocket.Upgrader
	Logger   *log.Logger
	Actions  map[string]WSAction
}

WS is the struct resprenting a websocket server handler

func NewWS

func NewWS(bufferSize int, actions map[string]WSAction) *WS

NewWS returns a pointer to a WS instance

func (*WS) HandleServerError

func (ws *WS) HandleServerError(res http.ResponseWriter, req *http.Request, err error)

HandleServerError handles WS server errors by logging them and sending a response back of the error itself

func (*WS) HandleUpgrades

func (ws *WS) HandleUpgrades(res http.ResponseWriter, req *http.Request)

HandleUpgrades handles a HTTP upgrade to a websocket

func (*WS) HandleWSError

func (ws *WS) HandleWSError(conn *websocket.Conn, err error)

HandleWSError handles errors once the connection has been upgraded

func (*WS) Route

func (ws *WS) Route(conn *websocket.Conn)

Route routes messages between a websocket connection

type WSAction

type WSAction func(conn *websocket.Conn, msg *wsOuterMessage) error

WSAction is a type of function that handles a WS message