xsteadfastx/workgroups
1
0
Fork 0
Code Issues Pull Requests Projects Releases 7 Wiki Activity

docs: readme
Some checks failed
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/tag Build is failing
Details

Browse Source
This commit is contained in:
Marvin Preuss 2021-09-27 11:03:38 +02:00
parent 15e245d433
commit 1983b6bfd0
2 changed files with 24 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -6,9 +6,15 @@ with the help of sync.Errgroup.
![build](https://ci.xsfx.dev/api/badges/xsteadfastx/workgroups/status.svg)
![coverage](https://codecov.io/gh/xsteadfastx/workgroups/branch/main/graph/badge.svg?token=RZE1ZWJSYA)
![report](https://goreportcard.com/badge/go.xsfx.dev/workgroups)
![reference](https://pkg.go.dev/badge/go.xsfx.dev/workgroups.svg)
![readme](./README.gif)
![readme](https://git.xsfx.dev/xsteadfastx/workgroups/raw/branch/main/README.gif)
## Links
* [build](https://ci.xsfx.dev/xsteadfastx/workgroups)
* [coverage](https://codecov.io/github/xsteadfastx/workgroups/)
* [report](https://goreportcard.com/report/go.xsfx.dev/workgroups)
* [reference](https://pkg.go.dev/go.xsfx.dev/workgroups)
## Variables
@ -21,36 +27,36 @@ var ErrInWorker = errors.New("received error in worker")
## Types
### type [Dispatcher](/workgroups.go#L45)
### type [Dispatcher](/workgroups.go#L52)
`type Dispatcher struct { ... }`
Dispatcher carries the job queue, the errgroup and the number of workers
to start.
#### func (*Dispatcher) [Append](/workgroups.go#L95)
#### func (*Dispatcher) [Append](/workgroups.go#L102)
`func (d *Dispatcher) Append(job Job)`
Append adds a job to the work queue.
#### func (*Dispatcher) [Close](/workgroups.go#L101)
#### func (*Dispatcher) [Close](/workgroups.go#L108)
`func (d *Dispatcher) Close()`
Close closes the queue channel.
#### func (*Dispatcher) [Start](/workgroups.go#L64)
#### func (*Dispatcher) [Start](/workgroups.go#L71)
`func (d *Dispatcher) Start()`
Start starts the configured number of workers and waits for jobs.
#### func (*Dispatcher) [Wait](/workgroups.go#L106)
#### func (*Dispatcher) [Wait](/workgroups.go#L113)
`func (d *Dispatcher) Wait() error`
### type [Job](/workgroups.go#L33)
### type [Job](/workgroups.go#L40)
`type Job struct { ... }`
@ -60,7 +66,7 @@ Here is an exception, because its a short living object.
The context is only used as argument for the Work function.
Please use the NewJob function to get around this context in struct shenanigans.
### type [Work](/workgroups.go#L26)
### type [Work](/workgroups.go#L33)
`type Work func(ctx context.Context) error`

11
workgroups.go
View File

@ -4,9 +4,16 @@
// (image/build) https://ci.xsfx.dev/api/badges/xsteadfastx/workgroups/status.svg
// (image/coverage) https://codecov.io/gh/xsteadfastx/workgroups/branch/main/graph/badge.svg?token=RZE1ZWJSYA
// (image/report) https://goreportcard.com/badge/go.xsfx.dev/workgroups
// (image/reference) https://pkg.go.dev/badge/go.xsfx.dev/workgroups.svg
//
// (image/readme) ./README.gif
// (image/readme) https://git.xsfx.dev/xsteadfastx/workgroups/raw/branch/main/README.gif
//
// Links
//
// * (build) https://ci.xsfx.dev/xsteadfastx/workgroups
// * (coverage) https://codecov.io/github/xsteadfastx/workgroups/
// * (report) https://goreportcard.com/report/go.xsfx.dev/workgroups
// * (reference) https://pkg.go.dev/go.xsfx.dev/workgroups
//
package workgroups
import (