memory

Documentation

Index

• Variables
• type Store
  • func New() *Store
  • func (m *Store) Delete(id uint16) error
  • func (m *Store) Get(packetID uint16) (io.ReadCloser, error)
  • func (m *Store) List() ([]uint16, error)
  • func (m *Store) Put(packetID uint16, packetType byte, w io.WriterTo) error
  • func (m *Store) Quarantine(id uint16) error
  • func (m *Store) Reset() error
  • func (m *Store) String() string

Variables

var (
	ErrNotInStore = errors.New("the requested ID was not found in the store") // Returned when requested ID not found
)

Types

type Store

type Store struct {
	// server store - holds packets where the message ID was generated on the server
	sync.Mutex
	// contains filtered or unexported fields
}

Store is an implementation of a Store that stores the data in memory

func New

func New() *Store

New creates a Store

func (*Store) Delete

func (m *Store) Delete(id uint16) error

Delete removes the message with the specified store ID

func (*Store) Get

func (m *Store) Get(packetID uint16) (io.ReadCloser, error)

func (*Store) List

func (m *Store) List() ([]uint16, error)

List returns packet IDs in the order they were Put

func (*Store) Put

func (m *Store) Put(packetID uint16, packetType byte, w io.WriterTo) error

Put stores the packet

func (*Store) Quarantine

func (m *Store) Quarantine(id uint16) error

Quarantine is called if a corrupt packet is detected. There is little we can do other than deleting the packet.

func (*Store) Reset

func (m *Store) Reset() error

Reset clears the store (deleting all messages)

func (*Store) String

func (m *Store) String() string

String is for debugging purposes; it dumps the content of the store in a readable format