sessions

Documentation

Index

• Variables
• func NewMemProvider() *memProvider
• func Register(name string, provider SessionsProvider)
• func Unregister(name string)
• type Manager
  • func NewManager(providerName string) (*Manager, error)
  • func (this *Manager) Close() error
  • func (this *Manager) Count() int
  • func (this *Manager) Del(id string)
  • func (this *Manager) Get(id string) (*Session, error)
  • func (this *Manager) New(id string) (*Session, error)
  • func (this *Manager) Save(id string) error
• type Session
  • func (this *Session) AddTopic(topic string, qos byte) error
  • func (this *Session) CleanSession() bool
  • func (this *Session) ID() string
  • func (this *Session) Init(msg *packets.ConnectPacket) error
  • func (this *Session) RemoveTopic(topic string) error
  • func (this *Session) RetainMessage(msg *packets.PublishPacket) error
  • func (this *Session) SetWillFlag(v bool)
  • func (this *Session) Topics() ([]string, []byte, error)
  • func (this *Session) Update(msg *packets.ConnectPacket) error
  • func (this *Session) WillFlag() bool
• type SessionsProvider

Variables

var (
	ErrSessionsProviderNotFound = errors.New("Session: Session provider not found")
	ErrKeyNotAvailable          = errors.New("Session: not item found for key.")
)

Functions

func NewMemProvider

func NewMemProvider() *memProvider

func Register

func Register(name string, provider SessionsProvider)

Register makes a session provider available by the provided name. If a Register is called twice with the same name or if the driver is nil, it panics.

func Unregister

func Unregister(name string)

Types

type Manager

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

func NewManager

func NewManager(providerName string) (*Manager, error)

func (*Manager) Close

func (this *Manager) Close() error

func (*Manager) Count

func (this *Manager) Count() int

func (*Manager) Del

func (this *Manager) Del(id string)

func (*Manager) Get

func (this *Manager) Get(id string) (*Session, error)

func (*Manager) New

func (this *Manager) New(id string) (*Session, error)

func (*Manager) Save

func (this *Manager) Save(id string) error

type Session

type Session struct {

	// Will message to publish if connect is closed unexpectedly
	Will *packets.PublishPacket

	// Retained publish message
	Retained *packets.PublishPacket
	// contains filtered or unexported fields
}

func (*Session) AddTopic

func (this *Session) AddTopic(topic string, qos byte) error

func (*Session) CleanSession

func (this *Session) CleanSession() bool

func (*Session) ID

func (this *Session) ID() string

func (*Session) Init

func (this *Session) Init(msg *packets.ConnectPacket) error

func (*Session) RemoveTopic

func (this *Session) RemoveTopic(topic string) error

func (*Session) RetainMessage

func (this *Session) RetainMessage(msg *packets.PublishPacket) error

func (*Session) SetWillFlag

func (this *Session) SetWillFlag(v bool)

func (*Session) Topics

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

func (*Session) Update

func (this *Session) Update(msg *packets.ConnectPacket) error

func (*Session) WillFlag

func (this *Session) WillFlag() bool

type SessionsProvider

type SessionsProvider interface {
	New(id string) (*Session, error)
	Get(id string) (*Session, error)
	Del(id string)
	Save(id string) error
	Count() int
	Close() error
}