websocket

Documentation

Index

• Constants
• type Acceptor
  • func NewAcceptor(option *AcceptorOption) *Acceptor
  • func (acceptor *Acceptor) Broadcast(msg interface{})
  • func (acceptor *Acceptor) BroadcastRaw(raw []byte)
  • func (acceptor *Acceptor) Count() int64
  • func (acceptor *Acceptor) Run()
  • func (acceptor *Acceptor) State() network.State
  • func (acceptor *Acceptor) Stop()
• type AcceptorOption
• type Connector
  • func NewConnector(option *ConnectorOption) *Connector
  • func (connector *Connector) Connected() bool
  • func (connector *Connector) Run()
  • func (connector *Connector) Send(msg interface{}) error
  • func (connector *Connector) SendRaw(raw []byte) error
  • func (connector *Connector) Stop()
• type ConnectorOption
• type Session
  • func (session *Session) Addr() string
  • func (session *Session) Close()
  • func (session *Session) ID() session.ID
  • func (session *Session) Send(msg interface{}) error
  • func (session *Session) SendRaw(raw []byte) error
• type SessionOption

Constants

const KeyURL = "ws"

Types

type Acceptor

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

func NewAcceptor

func NewAcceptor(option *AcceptorOption) *Acceptor

func (*Acceptor) Broadcast

func (acceptor *Acceptor) Broadcast(msg interface{})

func (*Acceptor) BroadcastRaw

func (acceptor *Acceptor) BroadcastRaw(raw []byte)

func (*Acceptor) Count

func (acceptor *Acceptor) Count() int64

func (*Acceptor) Run

func (acceptor *Acceptor) Run()

func (*Acceptor) State

func (acceptor *Acceptor) State() network.State

func (*Acceptor) Stop

func (acceptor *Acceptor) Stop()

type AcceptorOption

type AcceptorOption struct {
	Name     string                   // 名称
	Addr     string                   // 侦听地址
	Verify   func(*gin.Context) error // 连接验证
	Upgrader *websocket.Upgrader      // 连接升级
	Level    logis.Level              // 日志等级
	Session  SessionOption            // 连接配置
}

type Connector

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

func NewConnector

func NewConnector(option *ConnectorOption) *Connector

func (*Connector) Connected

func (connector *Connector) Connected() bool

func (*Connector) Run

func (connector *Connector) Run()

func (*Connector) Send

func (connector *Connector) Send(msg interface{}) error

func (*Connector) SendRaw

func (connector *Connector) SendRaw(raw []byte) error

func (*Connector) Stop

func (connector *Connector) Stop()

type ConnectorOption

type ConnectorOption struct {
	Name      string            // 名称
	Addr      string            // 地址
	Reconnect bool              // 自动重连
	Header    http.Header       // 请求header
	Dialer    *websocket.Dialer // 连接器
	Delays    []time.Duration   // 重连延迟
	Level     logis.Level       // 日志等级
	Session   SessionOption     // session配置
}

type Session

type Session struct {
	sync.Map // 附加信息
	// contains filtered or unexported fields
}

func (*Session) Addr

func (session *Session) Addr() string

func (*Session) Close

func (session *Session) Close()

func (*Session) ID

func (session *Session) ID() session.ID

func (*Session) Send

func (session *Session) Send(msg interface{}) error

func (*Session) SendRaw

func (session *Session) SendRaw(raw []byte) error

type SessionOption

type SessionOption struct {
	ReadLimit int64           // 读取数据流大小限制
	Timeout   time.Duration   // 超时时间
	QueueLen  int             // 写缓冲区长度
	Encoder   encoder.Maker   // 编码器
	Cipher    cipher.Maker    // 加密器
	Invoker   invoker.Invoker // 消息调用器
}