queue

Documentation

Index

• Variables
• type Queue
  • func NewQueue[Element any](configuration configuration.Queue) *Queue[Element]
  • func (q *Queue[Element]) Append(element Element) uint64
  • func (q *Queue[Element]) GetAll() []Element
  • func (q *Queue[Element]) GetByOffset(offset uint64) (Element, uint64, error)
  • func (q *Queue[Element]) GetLast() (Element, uint64, error)

Variables

var (
	OffsetNotFoundError = queueEB(errors.New("offset not found"))
	IsEmpty             = queueEB(errors.New("queue is empty"))
)

Types

type Queue

type Queue[Element any] struct {
	// contains filtered or unexported fields
}

Queue - sized queue. All public operations:

- GetAll - GetByOffset - Append

execs synchronously using sync.RWMutex to prevent race condition.

func NewQueue

func NewQueue[Element any](configuration configuration.Queue) *Queue[Element]

NewQueue - Queue constructor.

func (*Queue[Element]) Append

func (q *Queue[Element]) Append(element Element) uint64

Append - put an element to the queues tail and delete oldest

func (*Queue[Element]) GetAll

func (q *Queue[Element]) GetAll() []Element

GetAll - return all queued elements.

func (*Queue[Element]) GetByOffset

func (q *Queue[Element]) GetByOffset(offset uint64) (Element, uint64, error)

GetByOffset - return an element by its offset. If the offset too old and not represent at the queue returns the oldest element and its offset. If the offset gte q.max returns error and last element offset.

func (*Queue[Element]) GetLast

func (q *Queue[Element]) GetLast() (Element, uint64, error)

GetLast - returns the last element or error if queue is empty