ws

README

socklace

Websockets stuff

Documentation

Index

• Variables
• type Connection
  • func (conn *Connection) Context() context.Context
  • func (conn *Connection) Send(id int64, topic string, data interface{}) error
• type Hook
• type Request
  • func (r *Request) Respond(data interface{}) error
• type WS
  • func NewWS(upgrader *websocket.Upgrader, errorHandler func(*Connection, error)) WS

Variables

var ErrInvalidPacket = errors.New("ws: invalid packet")

var ErrUnknownHandler = errors.New("ws: unknown handler")

Types

type Connection

type Connection struct {
	Request *http.Request
	Values  sync.Map
	// contains filtered or unexported fields
}

Connection holds all data and websocket connection

func (*Connection) Context

func (conn *Connection) Context() context.Context

func (*Connection) Send

func (conn *Connection) Send(id int64, topic string, data interface{}) error

type Hook

type Hook func(conn *Connection)

Hook is function called before main loop or after connection was closed

type Request

type Request struct {
	C *Connection `json:"-"`

	ID    int64
	Topic string
	Data  json.RawMessage
}

Request represents data sends from client to server

func (*Request) Respond

func (r *Request) Respond(data interface{}) error

Respond sends response to client and returns error if failed

type WS

type WS interface {
	// RegisterHandler register function for entered topic
	// note that handlerFn is interface{} but should be function (func(r *Request, optionalParameter string))
	RegisterHandler(topic string, handlerFn interface{})

	//AddPreHook appends pre main loop hook
	AddPreHook(hook Hook)

	//AddPostHook appends post request hook
	AddPostHook(hook Hook)

	ServeHTTP(w http.ResponseWriter, r *http.Request)
}

func NewWS

func NewWS(upgrader *websocket.Upgrader, errorHandler func(*Connection, error)) WS