connection

Documentation

Index

• Variables
• type Callbacks
• type Config
• type DisconnectParams
• type Type
  • func New(c *Config) (s *Type, err error)
  • func (s *Type) Start()
  • func (s *Type) Stop(reason packet.ReasonCode)
• type WillConfig

Variables

var (
	ErrOverflow    = errors.New("session: overflow")
	ErrPersistence = errors.New("session: error during persistence restore")
)

nolint: golint

Types

type Callbacks

type Callbacks struct {
	// OnStop called when session stopped net connection and should be either suspended or deleted
	OnStop func(string, bool)
}

Callbacks provided by sessions manager to signal session state

type Config

type Config struct {
	ID            string
	Username      string
	State         *persistenceTypes.SessionMessages
	Subscriber    subscriber.ConnectionProvider
	Auth          auth.SessionPermissions
	Messenger     types.TopicMessenger
	Metric        systree.Metric
	Conn          net.Conn
	OnDisconnect  onDisconnect
	ExpireIn      *time.Duration
	WillDelay     time.Duration
	KeepAlive     uint16
	SendQuota     uint16
	Clean         bool
	PreserveOrder bool
	Version       packet.ProtocolVersion
}

Config is system wide configuration parameters for every session

type DisconnectParams

type DisconnectParams struct {
	Will     bool
	ExpireAt *time.Duration
	State    *persistenceTypes.SessionMessages
}

DisconnectParams session state when stopped

type Type

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

Type session

func New

func New(c *Config) (s *Type, err error)

New allocate new sessions object

func (*Type) Start

func (s *Type) Start()

Start run connection

func (*Type) Stop

func (s *Type) Stop(reason packet.ReasonCode)

Stop session. Function assumed to be invoked once server about to either shutdown, disconnect or session is being replaced Effective only first invoke

type WillConfig

type WillConfig struct {
	Topic   string
	Message []byte
	Retain  bool
	QoS     packet.QosType
}

WillConfig configures session for will messages