websocket

Documentation

Index

• type ChannelContext
• type Context
  • func NewWebsocketContext(ctx router.Context, conn *websocket.Conn) Context
• type Message
• type WebSocket
  • func New() *WebSocket
  • func (ws *WebSocket) ToHandler() interface{}
  • func (ws *WebSocket) WithAsyncChannel(name string, handler interface{}) *WebSocket
  • func (ws *WebSocket) WithCatchAll(handler interface{}) *WebSocket
  • func (ws *WebSocket) WithChannel(name string, handler interface{}) *WebSocket

Types

type ChannelContext

type ChannelContext interface {
	router.Context
	Channel() string
	Receive(out interface{}) error
	Send(data interface{}) error
}

type Context

type Context interface {
	router.Context
	Closed() bool
	EnableReadCheck()
	Receive(out interface{}) error
	Send(data interface{}) error
}

Context defines a context for websocket functionality.

func NewWebsocketContext

func NewWebsocketContext(ctx router.Context, conn *websocket.Conn) Context

type Message

type Message struct {
	Channel *string         `json:"channel"`
	Error   string          `json:"error,omitempty"`
	Payload json.RawMessage `json:"payload"`
}

type WebSocket

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

func New

func New() *WebSocket

func (*WebSocket) ToHandler

func (ws *WebSocket) ToHandler() interface{}

func (*WebSocket) WithAsyncChannel

func (ws *WebSocket) WithAsyncChannel(name string, handler interface{}) *WebSocket

func (*WebSocket) WithCatchAll

func (ws *WebSocket) WithCatchAll(handler interface{}) *WebSocket

func (*WebSocket) WithChannel

func (ws *WebSocket) WithChannel(name string, handler interface{}) *WebSocket