websocket

Documentation

Index

• type ChannelContext
  • func (ctx *ChannelContext) Read(out interface{}) error
  • func (ctx *ChannelContext) Send(data interface{}) error
• 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 struct {
	mojito.WebSocketContext

	Channel *string
	Payload json.RawMessage
}

func (*ChannelContext) Read

func (ctx *ChannelContext) Read(out interface{}) error

func (*ChannelContext) Send

func (ctx *ChannelContext) Send(data interface{}) error

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