msgstore

Documentation

Index

• type MessageStore
  • func NewMessageStore(pol common.MessageReplacingPolicy, trigger invalidationTrigger) MessageStore

Types

type MessageStore

type MessageStore interface {
	// add adds a message to the store
	// returns true or false whether the message was added to the store
	Add(msg interface{}) bool

	// size returns the amount of messages in the store
	Size() int

	// get returns all messages in the store
	Get() []interface{}
}

MessageStore adds messages to an internal buffer. When a message is received, it might:

• Be added to the buffer
• Discarded because of some message already in the buffer (invalidated)
• Make a message already in the buffer to be discarded (invalidates)

When a message is invalidated, the invalidationTrigger is invoked on that message.

func NewMessageStore

func NewMessageStore(pol common.MessageReplacingPolicy, trigger invalidationTrigger) MessageStore

NewMessageStore returns a new MessageStore with the message replacing policy and invalidation trigger passed.