q

README

q

q is a queue used to concurrently process jobs.

// buffer size for the queue to hold jobs on. 
Queue = q.New(buff)

Returns a new q.Queue.

// n is the number of workers which will
Queue.Start(n)

Initializes the workers, now the Queue is ready to start processing jobs.

// j is a Job, anything which implements the Run() method
Queue.Push(j)

Pushes jobs onto the queue. A Job is anything thing that implements Run() which is responsible for Processing the job.

If you want to halt the Queue to prevent an additional jobs from being processed Queue.Quit <- true will halt the queue. However after the Queue has halted any Jobs that were processing will complete.

Documentation

Index

• type Job
• type Queue
  • func New(buff int) Queue
  • func (q *Queue) Push(j Job)
  • func (q *Queue) Start(n int)
• type Worker

Types

type Job

type Job interface {
	Run()
}

type Queue

type Queue struct {
	Quit chan bool
	// contains filtered or unexported fields
}

func New

func New(buff int) Queue

func (*Queue) Push

func (q *Queue) Push(j Job)

func (*Queue) Start

func (q *Queue) Start(n int)

type Worker

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