Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vardius/worker-pool
Go simple async worker pool
https://github.com/vardius/worker-pool
async worker-pool
Last synced: about 2 months ago
JSON representation
Go simple async worker pool
- Host: GitHub
- URL: https://github.com/vardius/worker-pool
- Owner: vardius
- License: mit
- Created: 2017-10-04T09:18:31.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-01-17T02:27:13.000Z (almost 4 years ago)
- Last Synced: 2024-10-14T06:09:02.634Z (2 months ago)
- Topics: async, worker-pool
- Language: Go
- Homepage:
- Size: 47.9 KB
- Stars: 92
- Watchers: 5
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-go - worker-pool - goworker is a Go simple async worker pool. (Goroutines / Search and Analytic Databases)
- awesome-go - worker-pool - Go simple async worker pool - β 19 (Goroutines)
- awesome-go-extra - worker-pool - 10-04T09:18:31Z|2021-01-17T02:27:13Z| (Goroutines / Advanced Console UIs)
README
π¨βπ§ worker-pool
================
[](https://travis-ci.org/vardius/worker-pool)
[](https://goreportcard.com/report/github.com/vardius/worker-pool)
[](https://codecov.io/gh/vardius/worker-pool)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fvardius%2Fworker-pool?ref=badge_shield)
[](https://pkg.go.dev/github.com/vardius/worker-pool)
[](https://github.com/vardius/worker-pool/blob/master/LICENSE.md)
Go simple async worker pool.
π ABOUT
==================================================
Worker pool is a software design pattern for achieving concurrency of task execution. Maintains multiple workers waiting for tasks to be allocated for concurrent execution. By maintaining a pool of workers, the model increases performance and avoids latency in execution. The number of available workers might be tuned to the computing resources available.
You can read more about worker pools in Go [here](https://brandur.org/go-worker-pool).
Contributors:
* [RafaΕ Lorenz](http://rafallorenz.com)
Want to contribute ? Feel free to send pull requests!
Have problems, bugs, feature ideas?
We are using the github [issue tracker](https://github.com/vardius/worker-pool/issues) to manage them.
## π Documentation
For __examples__ **visit [godoc#pkg-examples](http://godoc.org/github.com/vardius/worker-pool#pkg-examples)**
For **GoDoc** reference, **visit [pkg.go.dev](https://pkg.go.dev/github.com/vardius/worker-pool)**
π HOW TO USE
==================================================
## π
Benchmark
**CPU: 3,3 GHz Intel Core i7**
**RAM: 16 GB 2133 MHz LPDDR3**
```bash
β worker-pool git:(master) β go test -bench=. -cpu=4 -benchmem
goos: darwin
goarch: amd64
pkg: github.com/vardius/worker-pool/v2
BenchmarkWorker1-4 3944299 284 ns/op 56 B/op 3 allocs/op
BenchmarkWorker1Parallel-4 7394715 138 ns/op 48 B/op 2 allocs/op
BenchmarkWorker100-4 1657569 693 ns/op 56 B/op 3 allocs/op
BenchmarkWorker100Parallel-4 3673483 368 ns/op 48 B/op 2 allocs/op
BenchmarkWorkerNumCPU-4 2590293 445 ns/op 56 B/op 3 allocs/op
BenchmarkWorkerNumCPUParallel-4 3591553 298 ns/op 48 B/op 2 allocs/op
PASS
ok github.com/vardius/worker-pool/v2 9.511s
```
## π« Basic example
```go
package main
import (
"fmt"
"sync"
"github.com/vardius/worker-pool/v2"
)
func main() {
var wg sync.WaitGroup
poolSize := 1
jobsAmount := 3
workersAmount := 2
// create new pool
pool := workerpool.New(poolSize)
out := make(chan int, jobsAmount)
worker := func(i int) {
defer wg.Done()
out <- i
}
for i := 1; i <= workersAmount; i++ {
if err := pool.AddWorker(worker); err != nil {
panic(err)
}
}
wg.Add(jobsAmount)
for i := 0; i < jobsAmount; i++ {
if err := pool.Delegate(i); err != nil {
panic(err)
}
}
go func() {
// stop all workers after jobs are done
wg.Wait()
close(out)
pool.Stop() // stop removes all workers from pool, to resume work add them again
}()
sum := 0
for n := range out {
sum += n
}
fmt.Println(sum)
// Output:
// 3
}
```
π [License](LICENSE.md)
-------
This package is released under the MIT license. See the complete license in the package
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fvardius%2Fworker-pool?ref=badge_large)