README
¶
Routinepool
Routinepool is a simple Go library to start a worker pool. The example provided in the test illustrates everything what this worker pool can do. e.g. See number of active jobs, pending jobs, stop worker pool etc.
- Start worker pool
- Push tasks/work to the pool
- See active number of tasks
- See pending tasks
Methods available
New()- returns a new Pool pointer with all the configurations set, ready to be usedp.Start()- starts the workerpool and waits for tasks to be pushedp.Push(<task>)- pushes a work/task to the queuep.Active()- returns the number of tasks which are actively runningp.Pending()- returns the number of tasks which are pending in the queuep.Stop()- gracefully shutsdown the workerpool, i.e. waits for the queue to be empty and shutdown
Documentation
¶
Overview ¶
Package routinepool lets you create a workerpool made of Go routines.
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrShutdown = errors.New("Shutdown in progress")
ErrShutdown is the error returned if the pool shutdown is already in progress And you try calling Stop()
Functions ¶
This section is empty.
Types ¶
type Pool ¶
type Pool struct {
// contains filtered or unexported fields
}
Pool is the struct which handles the worker pool
Example ¶
var completed uint64
const (
jobs = 32
poolsize = 4
)
p := New(poolsize, jobs)
//Start the routine pool and wait for jobs/tasks
p.Start()
for i := 0; i < jobs; i++ {
go p.Push(func() {
time.Sleep(time.Millisecond * 50)
atomic.AddUint64(&completed, 1)
})
}
//Gracefully shutdown the routine pool.
p.Stop()
fmt.Println("Active jobs:", p.Active(), "Pending jobs:", p.Pending(), "Completed:", completed, "out of", jobs)
Output: Active jobs: 0 Pending jobs: 0 Completed: 32 out of 32
Source Files
Click to show internal directories.
Click to hide internal directories.