session

Documentation

Overview

Package session implements session objects to be used with MQTT clients and brokers.

Index

• type Direction
• type IDCounter
  • func NewIDCounter() *IDCounter
  • func NewIDCounterWithNext(next packet.ID) *IDCounter
  • func (c *IDCounter) NextID() packet.ID
  • func (c *IDCounter) Reset()
• type MemorySession
  • func NewMemorySession() *MemorySession
  • func (s *MemorySession) AllPackets(dir Direction) ([]packet.Generic, error)
  • func (s *MemorySession) DeletePacket(dir Direction, id packet.ID) error
  • func (s *MemorySession) LookupPacket(dir Direction, id packet.ID) (packet.Generic, error)
  • func (s *MemorySession) NextID() packet.ID
  • func (s *MemorySession) Reset() error
  • func (s *MemorySession) SavePacket(dir Direction, pkt packet.Generic) error
• type PacketStore
  • func NewPacketStore() *PacketStore
  • func NewPacketStoreWithPackets(packets []packet.Generic) *PacketStore
  • func (s *PacketStore) All() []packet.Generic
  • func (s *PacketStore) Delete(id packet.ID)
  • func (s *PacketStore) Lookup(id packet.ID) packet.Generic
  • func (s *PacketStore) Reset()
  • func (s *PacketStore) Save(pkt packet.Generic)

Types

type Direction

type Direction int

Direction denotes a packets direction.

const (
	// Incoming packets are being received.
	Incoming Direction = iota

	// Outgoing packets are being be sent.
	Outgoing
)

type IDCounter

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

An IDCounter continuously counts packet ids.

func NewIDCounter

func NewIDCounter() *IDCounter

NewIDCounter returns a new counter.

func NewIDCounterWithNext

func NewIDCounterWithNext(next packet.ID) *IDCounter

NewIDCounterWithNext returns a new counter that will emit the specified if id as the next id.

func (*IDCounter) NextID

func (c *IDCounter) NextID() packet.ID

NextID will return the next id.

func (*IDCounter) Reset

func (c *IDCounter) Reset()

Reset will reset the counter.

type MemorySession

type MemorySession struct {
	Counter  *IDCounter
	Incoming *PacketStore
	Outgoing *PacketStore
}

A MemorySession stores packets in memory.

func NewMemorySession

func NewMemorySession() *MemorySession

NewMemorySession returns a new MemorySession.

func (*MemorySession) AllPackets

func (s *MemorySession) AllPackets(dir Direction) ([]packet.Generic, error)

AllPackets will return all packets currently saved in the session.

func (*MemorySession) DeletePacket

func (s *MemorySession) DeletePacket(dir Direction, id packet.ID) error

DeletePacket will remove a packet from the session. The method must not return an error if no packet with the specified id does exists.

func (*MemorySession) LookupPacket

func (s *MemorySession) LookupPacket(dir Direction, id packet.ID) (packet.Generic, error)

LookupPacket will retrieve a packet from the session using a packet id.

func (*MemorySession) NextID

func (s *MemorySession) NextID() packet.ID

NextID will return the next id for outgoing packets.

func (*MemorySession) Reset

func (s *MemorySession) Reset() error

Reset will completely reset the session.

func (*MemorySession) SavePacket

func (s *MemorySession) SavePacket(dir Direction, pkt packet.Generic) error

SavePacket will store a packet in the session. An eventual existing packet with the same id gets quietly overwritten.

type PacketStore

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

PacketStore is a goroutine safe packet store.

func NewPacketStore

func NewPacketStore() *PacketStore

NewPacketStore returns a new PacketStore.

func NewPacketStoreWithPackets

func NewPacketStoreWithPackets(packets []packet.Generic) *PacketStore

NewPacketStoreWithPackets returns a new PacketStore with the provided packets.

func (*PacketStore) All

func (s *PacketStore) All() []packet.Generic

All will return all packets currently saved in the store.

func (*PacketStore) Delete

func (s *PacketStore) Delete(id packet.ID)

Delete will remove a packet from the store.

func (*PacketStore) Lookup

func (s *PacketStore) Lookup(id packet.ID) packet.Generic

Lookup will retrieve a packet from the store.

func (*PacketStore) Reset

func (s *PacketStore) Reset()

Reset will reset the store.

func (*PacketStore) Save

func (s *PacketStore) Save(pkt packet.Generic)

Save will store a packet in the store. An eventual existing packet with the same id gets quietly overwritten.