queue

Documentation

Index

• func WaitForClose(q Instance, timeout time.Duration) error
• type BackoffTask
• type DelayQueueOption
  • func DelayQueueBuffer(bufferSize int) DelayQueueOption
  • func DelayQueueWorkers(workers int) DelayQueueOption
• type Delayed
  • func NewDelayed(opts ...DelayQueueOption) Delayed
• type Instance
  • func NewBackOffQueue(backoff *backoff.ExponentialBackOff) Instance
  • func NewQueue(errorDelay time.Duration) Instance
  • func NewQueueWithID(errorDelay time.Duration, name string) Instance
• type Task

Functions

func WaitForClose

func WaitForClose(q Instance, timeout time.Duration) error

WaitForClose blocks until the Instance has stopped processing tasks or the timeout expires. If the timeout is zero, it will wait until the queue is done processing. WaitForClose an error if the timeout expires.

Types

type BackoffTask

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

type DelayQueueOption

type DelayQueueOption func(*delayQueue)

DelayQueueOption configure the behavior of the queue. Must be applied before Run.

func DelayQueueBuffer

func DelayQueueBuffer(bufferSize int) DelayQueueOption

DelayQueueBuffer sets maximum number of tasks awaiting execution. If this limit is reached, Push and PushDelayed will block until there is room.

func DelayQueueWorkers

func DelayQueueWorkers(workers int) DelayQueueOption

DelayQueueWorkers sets the number of background worker goroutines await tasks to execute. Effectively the maximum number of concurrent tasks.

type Delayed

type Delayed interface {
	Instance
	PushDelayed(t Task, delay time.Duration)
}

Delayed implements queue such that tasks are executed after a specified delay.

func NewDelayed

func NewDelayed(opts ...DelayQueueOption) Delayed

NewDelayed gives a Delayed queue with maximum concurrency specified by workers.

type Instance

type Instance interface {
	// Push a task.
	Push(task Task)
	// Run the loop until a signal on the channel
	Run(<-chan struct{})

	// Closed returns a chan that will be signaled when the Instance has stopped processing tasks.
	Closed() <-chan struct{}
}

Instance of work tickets processed using a rate-limiting loop

func NewBackOffQueue

func NewBackOffQueue(backoff *backoff.ExponentialBackOff) Instance

func NewQueue

func NewQueue(errorDelay time.Duration) Instance

NewQueue instantiates a queue with a processing function

func NewQueueWithID

func NewQueueWithID(errorDelay time.Duration, name string) Instance

type Task

type Task func() error

Task to be performed.