Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marusama/cyclicbarrier
CyclicBarrier golang implementation
https://github.com/marusama/cyclicbarrier
barrier cyclic cyclicbarrier cyclicbarrier-golang go golang
Last synced: 9 days ago
JSON representation
CyclicBarrier golang implementation
- Host: GitHub
- URL: https://github.com/marusama/cyclicbarrier
- Owner: marusama
- License: mit
- Created: 2018-01-11T10:38:46.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-06-30T10:11:31.000Z (over 4 years ago)
- Last Synced: 2024-07-31T20:51:52.703Z (3 months ago)
- Topics: barrier, cyclic, cyclicbarrier, cyclicbarrier-golang, go, golang
- Language: Go
- Size: 15.6 KB
- Stars: 140
- Watchers: 3
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - cyclicbarrier - CyclicBarrier for golang. (Goroutines / Search and Analytic Databases)
- awesome-go - cyclicbarrier - CyclicBarrier golang implementation - ★ 20 (Goroutines)
- awesome-go-extra - cyclicbarrier - 01-11T10:38:46Z|2020-06-30T10:11:31Z| (Goroutines / Advanced Console UIs)
README
cyclicbarrier
=============
[](https://github.com/avelino/awesome-go#goroutines)
[](https://travis-ci.org/marusama/cyclicbarrier)
[](https://goreportcard.com/report/github.com/marusama/cyclicbarrier)
[](https://coveralls.io/github/marusama/cyclicbarrier?branch=master)
[](https://godoc.org/github.com/marusama/cyclicbarrier)
[](LICENSE)
CyclicBarrier is a synchronizer that allows a set of goroutines to wait for each other to reach a common execution point, also called a barrier.
Inspired by Java CyclicBarrier https://docs.oracle.com/javase/9/docs/api/java/util/concurrent/CyclicBarrier.html and C# Barrier https://msdn.microsoft.com/en-us/library/system.threading.barrier(v=vs.110).aspx
### Usage
Initiate
```go
import "github.com/marusama/cyclicbarrier"
...
b1 := cyclicbarrier.New(10) // new cyclic barrier with parties = 10
...
b2 := cyclicbarrier.NewWithAction(10, func() error { return nil }) // new cyclic barrier with parties = 10 and with defined barrier action
```
Await
```go
b.Await(ctx) // await other parties
```
Reset
```go
b.Reset() // reset the barrier
```
### Simple example
```go
// create a barrier for 10 parties with an action that increments counter
// this action will be called each time when all goroutines reach the barrier
cnt := 0
b := cyclicbarrier.NewWithAction(10, func() error {
cnt++
return nil
})
wg := sync.WaitGroup{}
for i := 0; i < 10; i++ { // create 10 goroutines (the same count as barrier parties)
wg.Add(1)
go func() {
for j := 0; j < 5; j++ {
// do some hard work 5 times
time.Sleep(100 * time.Millisecond)
err := b.Await(context.TODO()) // ..and wait for other parties on the barrier.
// Last arrived goroutine will do the barrier action
// and then pass all other goroutines to the next round
if err != nil {
panic(err)
}
}
wg.Done()
}()
}
wg.Wait()
fmt.Println(cnt) // cnt = 5, it means that the barrier was passed 5 times
```
For more documentation see https://godoc.org/github.com/marusama/cyclicbarrier