queue

Documentation

Index

• type Job
  • func (j Job) GetName() string
  • func (j Job) Run() error
• type Queue
  • func NewQueue(name string, limit int) *Queue
  • func (q *Queue) AddJob(job Job)
• type Worker
  • func NewWorker(queue *Queue) *Worker
  • func (w *Worker) DoWork() bool

Types

type Job

type Job struct {
	Name    string
	Payload []byte
	Action  func(payload []byte) error
}

Job - holds logic to perform some operations during queue execution.

func (Job) GetName

func (j Job) GetName() string

func (Job) Run

func (j Job) Run() error

Run performs job execution.

type Queue

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

Queue holds name, list of jobs and context with cancel.

func NewQueue

func NewQueue(name string, limit int) *Queue

NewQueue instantiates new queue.

func (*Queue) AddJob

func (q *Queue) AddJob(job Job)

AddJob sends job to the channel.

type Worker

type Worker struct {
	Queue *Queue
}

Worker responsible for queue serving.

func NewWorker

func NewWorker(queue *Queue) *Worker

NewWorker initializes a new Worker.

func (*Worker) DoWork

func (w *Worker) DoWork() bool

DoWork processes jobs from the queue (jobs channel).