sessions

Documentation

Index

• type Session
  • func (slf *Session) AddTopics(topic string, qos byte)
  • func (slf *Session) DoDisconnect()
  • func (slf *Session) GetClientID() string
  • func (slf *Session) OfflineMessages() []message.Message
  • func (slf *Session) PushOfflineMessage(msg message.Message) error
  • func (slf *Session) RegisterMessage(msg *message.Publish) uint16
  • func (slf *Session) RemoveTopics(topic string)
  • func (slf *Session) Topics() ([]string, []byte, error)
  • func (slf *Session) UnRefMessage(id uint16)
  • func (slf *Session) WithClientID(id string)
  • func (slf *Session) WithOnDisconnect(f func())
  • func (slf *Session) WithOnFinish(callback func(uint16, message.Message, interface{}))
  • func (slf *Session) WithOnWrite(f func(message.Message) error)
  • func (slf *Session) WriteMessage(msg message.Message) error
• type SessionGroup
  • func NewGroup() *SessionGroup
  • func (slf *SessionGroup) Get(clientID string) *Session
  • func (slf *SessionGroup) GetOrNew(clientID string, offlineLimit int) (*Session, bool)
  • func (slf *SessionGroup) New(clientID string, offlineLimit int) *Session
  • func (slf *SessionGroup) Remove(clientID string)

Types

type Session

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

Session 连接会话状态

func (*Session) AddTopics

func (slf *Session) AddTopics(topic string, qos byte)

AddTopics 添加主题

func (*Session) DoDisconnect

func (slf *Session) DoDisconnect()

DoDisconnect 执行断开连接操作

func (*Session) GetClientID

func (slf *Session) GetClientID() string

GetClientID 返回ClientID

func (*Session) OfflineMessages

func (slf *Session) OfflineMessages() []message.Message

OfflineMessages 返回所有离线消息

func (*Session) PushOfflineMessage

func (slf *Session) PushOfflineMessage(msg message.Message) error

PushOfflineMessage 插入离线消息

func (*Session) RegisterMessage

func (slf *Session) RegisterMessage(msg *message.Publish) uint16

RegisterMessage 注册一个消息到等待确认池

func (*Session) RemoveTopics

func (slf *Session) RemoveTopics(topic string)

RemoveTopics 删除一个主题

func (*Session) Topics

func (slf *Session) Topics() ([]string, []byte, error)

Topics 返回所有主题

func (*Session) UnRefMessage

func (slf *Session) UnRefMessage(id uint16)

UnRefMessage 取消一个消息的引用

func (*Session) WithClientID

func (slf *Session) WithClientID(id string)

WithClientID 设置client id

func (*Session) WithOnDisconnect

func (slf *Session) WithOnDisconnect(f func())

WithOnDisconnect 设置断开连接函数

func (*Session) WithOnFinish

func (slf *Session) WithOnFinish(callback func(uint16, message.Message, interface{}))

WithOnFinish 设置消息完成回掉函数

func (*Session) WithOnWrite

func (slf *Session) WithOnWrite(f func(message.Message) error)

WithOnWrite 设置写数据函数

func (*Session) WriteMessage

func (slf *Session) WriteMessage(msg message.Message) error

WriteMessage 写消息数据

type SessionGroup

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

SessionGroup session 管理器

func NewGroup

func NewGroup() *SessionGroup

func (*SessionGroup) Get

func (slf *SessionGroup) Get(clientID string) *Session

Get 返回一个Session

func (*SessionGroup) GetOrNew

func (slf *SessionGroup) GetOrNew(clientID string, offlineLimit int) (*Session, bool)

GetOrNew 返回一个或创建一个Session

func (*SessionGroup) New

func (slf *SessionGroup) New(clientID string, offlineLimit int) *Session

New 创建一个新的Session

func (*SessionGroup) Remove

func (slf *SessionGroup) Remove(clientID string)

Remove 删除指定的session