camWebsocket

Documentation

Index

• type WebsocketComponent
  • func (comp *WebsocketComponent) Init(configI camStatics.ComponentConfigInterface)
  • func (comp *WebsocketComponent) Start()
• type WebsocketComponentConfig
  • func NewWebsocketComponentConfig(port uint16) *WebsocketComponentConfig
• type WebsocketContext
  • func (ctx *WebsocketContext) GetConn() *websocket.Conn
  • func (ctx *WebsocketContext) GetMessage() *camStructs.RecvMessage
  • func (ctx *WebsocketContext) GetRecv() []byte
  • func (ctx *WebsocketContext) SetConn(conn *websocket.Conn)
  • func (ctx *WebsocketContext) SetMessage(msg *camStructs.RecvMessage)
  • func (ctx *WebsocketContext) SetRecv(recv []byte)
• type WebsocketContextInterface
• type WebsocketController
  • func (ctrl *WebsocketController) GetConn() *websocket.Conn
  • func (ctrl *WebsocketController) GetWebsocketContext() WebsocketContextInterface
• type WebsocketSession
  • func NewWebsocketSession() *WebsocketSession
  • func (sess *WebsocketSession) Del(key string)
  • func (sess *WebsocketSession) Destroy()
  • func (sess *WebsocketSession) Get(key string) interface{}
  • func (sess *WebsocketSession) GetSessionId() string
  • func (sess *WebsocketSession) Set(key string, value interface{})
  • func (sess *WebsocketSession) SetSessionId(sessId string)

Types

type WebsocketComponent

type WebsocketComponent struct {
	component.Component
	camRouter.RouterPlugin
	camContext.ContextPlugin
	camMiddleware.MiddlewarePlugin
	// contains filtered or unexported fields
}

func (*WebsocketComponent) Init

func (comp *WebsocketComponent) Init(configI camStatics.ComponentConfigInterface)

init

func (*WebsocketComponent) Start

func (comp *WebsocketComponent) Start()

start

type WebsocketComponentConfig

type WebsocketComponentConfig struct {
	component.ComponentConfig
	camTls.TlsPluginConfig
	camRouter.RouterPluginConfig
	camContext.ContextPluginConfig
	camMiddleware.MiddlewarePluginConfig

	Port uint16 // server port
}

websocket server 所需的配置

func NewWebsocketComponentConfig

func NewWebsocketComponentConfig(port uint16) *WebsocketComponentConfig

new websocket component

type WebsocketContext

type WebsocketContext struct {
	camContext.Context
	camContext.MessageContext
	// contains filtered or unexported fields
}

func (*WebsocketContext) GetConn

func (ctx *WebsocketContext) GetConn() *websocket.Conn

func (*WebsocketContext) GetMessage

func (ctx *WebsocketContext) GetMessage() *camStructs.RecvMessage

func (*WebsocketContext) GetRecv

func (ctx *WebsocketContext) GetRecv() []byte

func (*WebsocketContext) SetConn

func (ctx *WebsocketContext) SetConn(conn *websocket.Conn)

func (*WebsocketContext) SetMessage

func (ctx *WebsocketContext) SetMessage(msg *camStructs.RecvMessage)

func (*WebsocketContext) SetRecv

func (ctx *WebsocketContext) SetRecv(recv []byte)

type WebsocketContextInterface

type WebsocketContextInterface interface {
	camStatics.ContextInterface
	camContext.MessageContextInterface
	SetConn(conn *websocket.Conn)
	GetConn() *websocket.Conn
	SetRecv(recv []byte)
	GetRecv() []byte
}

websocket context

type WebsocketController

type WebsocketController struct {
	camRouter.Controller
}

func (*WebsocketController) GetConn

func (ctrl *WebsocketController) GetConn() *websocket.Conn

get *websocket.Conn

func (*WebsocketController) GetWebsocketContext

func (ctrl *WebsocketController) GetWebsocketContext() WebsocketContextInterface

get WebsocketContextInterface

type WebsocketSession

type WebsocketSession struct {
	camStatics.SessionInterface
	// contains filtered or unexported fields
}

websocket session

func NewWebsocketSession

func NewWebsocketSession() *WebsocketSession

new websocket session

func (*WebsocketSession) Del

func (sess *WebsocketSession) Del(key string)

delete key

func (*WebsocketSession) Destroy

func (sess *WebsocketSession) Destroy()

destroy session

func (*WebsocketSession) Get

func (sess *WebsocketSession) Get(key string) interface{}

get session value

func (*WebsocketSession) GetSessionId

func (sess *WebsocketSession) GetSessionId() string

get sessionId

func (*WebsocketSession) Set

func (sess *WebsocketSession) Set(key string, value interface{})

set session value

func (*WebsocketSession) SetSessionId

func (sess *WebsocketSession) SetSessionId(sessId string)

set sessionId