queue

Documentation

Overview

Package queue contains types to create queues.

Index

• type Queue
  • func New(concurrency int) *Queue
  • func (q *Queue) Do(job func())
  • func (q *Queue) DoError(job func() error) error
  • func (q *Queue) DoErrorHi(task func() error) error
  • func (q *Queue) DoHi(task func())
  • func (q *Queue) Work(ctx context.Context) error

Types

type Queue

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

Queue is a simple queue with concurency support.

func New

func New(concurrency int) *Queue

New creates a queue with given concurrency.

func (*Queue) Do

func (q *Queue) Do(job func())

Do puts a job at the end of the queue and blocks until executed.

func (*Queue) DoError

func (q *Queue) DoError(job func() error) error

DoError puts a job that can return an error at the end of the queue and blocks until executed.

func (*Queue) DoErrorHi

func (q *Queue) DoErrorHi(task func() error) error

DoErrorHi puts a task that can return an error at the end of the hi-priority queue and blocks until executed.

func (*Queue) DoHi

func (q *Queue) DoHi(task func())

DoHi puts a task at the end of the hi-priority queue and blocks until executed.

func (*Queue) Work

func (q *Queue) Work(ctx context.Context) error

Work tells the queue to start executing jobs.

It blocks until the context is canceled.