file

Documentation

Index

• type Queue
  • func New(path string, prefix string, extension string) (*Queue, error)
  • func (q *Queue) Enqueue(p io.Reader) error
  • func (q *Queue) Peek() (queue.Entry, 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 file based queue

func New

func New(path string, prefix string, extension string) (*Queue, error)

New creates a new file-based queue. Note that a file is written, read and deleted as part of this process to check that the path is usable. NOTE: Order is maintained using file ModTime, so there may be issues if the interval between messages is less than the file system ModTime resolution.

func (*Queue) Enqueue

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

Enqueue add item to the queue.

func (*Queue) Peek

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

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

func (*Queue) Wait

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

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

func (*Queue) WaitForEmpty

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

WaitForEmpty returns a channel that is closed when the queue is empty