queue

Documentation

Index

• type Queue
  • func New() *Queue
  • func (q *Queue) Add(item interface{})
  • func (q *Queue) Done(item interface{})
  • func (q *Queue) Get() (item interface{}, shutdown bool)
  • func (q *Queue) Len() int
  • func (q *Queue) ShutDown()
  • func (q *Queue) ShuttingDown() bool

Types

type Queue

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

Queue is a work queue.

func New

func New() *Queue

New constructs a new workqueue.

func (*Queue) Add

func (q *Queue) Add(item interface{})

Add marks item as needing processing.

func (*Queue) Done

func (q *Queue) Done(item interface{})

Done marks item as done processing, and if it has been marked as dirty again while it was being processed, it will be re-added to the queue for re-processing.

func (*Queue) Get

func (q *Queue) Get() (item interface{}, shutdown bool)

Get blocks until it can return an item to be processed. If shutdown = true, the caller should end their goroutine. You must call Done with item when you have finished processing it.

func (*Queue) Len

func (q *Queue) Len() int

Len returns the current queue length, for informational purposes only. You shouldn't e.g. gate a call to Add() or Get() on Len() being a particular value, that can't be synchronized properly.

func (*Queue) ShutDown

func (q *Queue) ShutDown()

ShutDown will cause q to ignore all new items added to it. As soon as the worker goroutines have drained the existing items in the queue, they will be instructed to exit.

func (*Queue) ShuttingDown

func (q *Queue) ShuttingDown() bool