buffer

Documentation

Index

• func ContainsString(a []string, x string) bool
• func MissingStrings(a []string, b []string) []string
• type Buffer
  • func NewBuffer(size int) *Buffer
  • func (buf *Buffer) Add(el Element) error
  • func (buf *Buffer) Digest() []string
  • func (buf *Buffer) ElementsFromIDs(digest []string) []Element
  • func (buf *Buffer) IncrementGossipCount()
  • func (buf *Buffer) Length() int
  • func (buf *Buffer) Messages(withInternals bool) []any
• type Element
  • func NewElement(msg any, cbType string, internal bool) (Element, error)

Functions

func ContainsString

func ContainsString(a []string, x string) bool

ContainsString tells whether a contains x.

func MissingStrings

func MissingStrings(a []string, b []string) []string

MissingStrings returns the disjunction between given slices: a - b.

Types

type Buffer

type Buffer struct {
	Elements []Element     `json:"elements"`
	Len      int           `json:"len"` // Length of the Buffer. When the buffer is full, oldest element will be removed.
	Mux      *sync.RWMutex `json:"mux"`
}

Buffer is the buffer with messages.

func NewBuffer

func NewBuffer(size int) *Buffer

NewBuffer creates new buffer.

func (*Buffer) Add

func (buf *Buffer) Add(el Element) error

Add adds the given element in buffer. When the buffer is full, oldest element will be removed.

func (*Buffer) Digest

func (buf *Buffer) Digest() []string

Digest returns a slice with elements ids.

func (*Buffer) ElementsFromIDs

func (buf *Buffer) ElementsFromIDs(digest []string) []Element

ElementsFromIDs returns a slice with elements from given IDs list.

func (*Buffer) IncrementGossipCount

func (buf *Buffer) IncrementGossipCount()

IncrementGossipCount increments gossip count for each elements from buffer.

func (*Buffer) Length

func (buf *Buffer) Length() int

Length returns number of elements in buffer.

func (*Buffer) Messages

func (buf *Buffer) Messages(withInternals bool) []any

Messages returns a slice with messages for each element in buffer. If withInternals parameter is false, Messages returns only user (not internal) messages.

type Element

type Element struct {
	ID           string    `json:"id"`
	Timestamp    time.Time `json:"timestamp"`
	Msg          any       `json:"msg"`
	CallbackType string    `json:"callbackType"`
	GossipCount  int64     `json:"gossipCount"` // number of rounds since the element is in buffer
	Internal     bool      `json:"internal"`    // true if the element is an internal element, not a user element
}

Element is an element from messages buffer.

func NewElement

func NewElement(msg any, cbType string, internal bool) (Element, error)

NewElement creates new buffer element with given message and callback type.