workqueue

Documentation

Index

• type Interface
• type Type
  • func NewQueue() *Type
  • func (q *Type) Add(item interface{})
  • func (q *Type) Done(item interface{})
  • func (q *Type) Get() (item interface{}, shutdown bool)
  • func (q *Type) Len() int
  • func (q *Type) ShutDown()
  • func (q *Type) ShutDownWithDrain()
  • func (q *Type) ShuttingDown() bool

Types

type Interface

type Interface interface {
	Add(item interface{})
	Len() int
	Get() (item interface{}, shutdown bool)
	Done(item interface{})
	ShutDown()
	ShuttingDown() bool
}

type Type

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

Type is a work queue (see the package comment).

func NewQueue

func NewQueue() *Type

func (*Type) Add

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

Add marks item as needing processing.

func (*Type) Done

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

func (*Type) Get

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

func (*Type) Len

func (q *Type) Len() int

func (*Type) ShutDown

func (q *Type) ShutDown()

ShutDown will cause q to ignore all new items added to it and immediately instruct the worker goroutines to exit.

func (*Type) ShutDownWithDrain

func (q *Type) ShutDownWithDrain()

ShutDownWithDrain will cause q to ignore all new items added to it. As soon as the worker goroutines have "drained", i.e: finished processing and called Done on all existing items in the queue; they will be instructed to exit and ShutDownWithDrain will return. Hence: a strict requirement for using this is; your workers must ensure that Done is called on all items in the queue once the shut down has been initiated, if that is not the case: this will block indefinitely. It is, however, safe to call ShutDown after having called ShutDownWithDrain, as to force the queue shut down to terminate immediately without waiting for the drainage.

func (*Type) ShuttingDown

func (q *Type) ShuttingDown() bool