memory

Documentation

Index

• type Queue
  • func New() *Queue
  • func (q *Queue) Enqueue(p io.Reader) error
  • func (q *Queue) Leave() error
  • func (q *Queue) Peek() (queue.Entry, error)
  • func (q *Queue) Quarantine() error
  • func (q *Queue) Reader() (io.Reader, error)
  • func (q *Queue) Remove() error
  • func (q *Queue) Wait() chan struct{}
  • func (q *Queue) WaitForEmpty() chan struct{}

Types

type Queue

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

Queue - basic memory based queue

func New

func New() *Queue

New creates a new memory-based queue

func (*Queue) Enqueue

func (q *Queue) Enqueue(p io.Reader) error

Enqueue add item to the queue.

func (*Queue) Leave

func (q *Queue) Leave() error

Leave implements Entry.Leave - the entry (will be returned on subsequent calls to Peek)

func (*Queue) Peek

func (q *Queue) Peek() (queue.Entry, error)

Peek retrieves the oldest item from the queue (without removing it)

func (*Queue) Quarantine

func (q *Queue) Quarantine() error

Quarantine implements Entry.Quarantine - Flag that this entry has an error (remove from queue, potentially retaining data with error flagged)

func (*Queue) Reader

func (q *Queue) Reader() (io.Reader, error)

Reader implements Entry.Reader - As the entry will always be the first item in the queue this is implemented against Queue rather than as a separate struct.

func (*Queue) Remove

func (q *Queue) Remove() error

Remove implements Entry.Remove this entry from the queue

func (*Queue) Wait

func (q *Queue) Wait() chan struct{}

Wait returns a channel that is closed when there is something in the queue

func (*Queue) WaitForEmpty

func (q *Queue) WaitForEmpty() chan struct{}

WaitForEmpty returns a channel which will be closed when the queue is empty