queue

README

go-queue

Blocking queue for GoLang

See tests and godoc

Documentation

Index

• type BlockingQueue
  • func New() *BlockingQueue
  • func (bq *BlockingQueue) Close() error
  • func (bq *BlockingQueue) Closed() bool
  • func (bq *BlockingQueue) Pop() (interface{}, bool)
  • func (bq *BlockingQueue) Put(value interface{}) bool
  • func (bq *BlockingQueue) PutOrDrop(value interface{}, limit int) bool
  • func (bq *BlockingQueue) Size() int

Types

type BlockingQueue

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

BlockingQueue is a FIFO queue where Pop() operation is blocking if no items exists

func New

func New() *BlockingQueue

New instance of FIFO queue

func (*BlockingQueue) Close

func (bq *BlockingQueue) Close() error

Close queue and explicitly remove each item from queue. Also notifies all reader (they will return nil and false) Returns error if queue already closed

func (*BlockingQueue) Closed

func (bq *BlockingQueue) Closed() bool

Closed flag

func (*BlockingQueue) Pop

func (bq *BlockingQueue) Pop() (interface{}, bool)

Pop front value from queue. Returns nil and false if queue closed

func (*BlockingQueue) Put

func (bq *BlockingQueue) Put(value interface{}) bool

Put any value to queue back. Returns false if queue closed

func (*BlockingQueue) PutOrDrop

func (bq *BlockingQueue) PutOrDrop(value interface{}, limit int) bool

Put value to queue back or drop if queue full. Returns false if queue closed or queue is full

func (*BlockingQueue) Size

func (bq *BlockingQueue) Size() int

Size of queue. Performance is O(1)