README
¶
WaitObjectGroup
株式会社ナレッジワークさんの3daysインターン 「Enablement Internship for Gophers 」 で開発した、Goの並行処理を使ったOSSを開発するという課題の成果物です。
概要
sync.waitGroupやerrorGroupのような、ゴルーチンの終了の待ち合わせをしたい時に使えます。
実行開始時に返り値としてオブジェクトを受け取り、そのオブジェクトをWait関数の引数に渡すことで、渡したオブジェクトに対応するゴルーチン処理全てが終了するのを待機することができます。
使用方法
go install github.com/n-hizume/waitobjectgroup
を実行することで、このライブラリをinstallできます。
使用例1
import "github.com/n-hizume/waitobjectgroup"
func main() {
var wog waitobjectgroup.WaitObjectGroup
hoge1 := wog.Go(func(){...})
hoge2 := wog.Go(func(){...})
hoge3 := wog.Go(func(){...})
hoge4 := wog.Go(func(){...})
hoge5 := wog.Go(func(){...})
wog.Wait(hoge1)
fmt.Println("Wait1 Finished")
wog.Wait(hoge2, hoge4)
fmt.Println("Wait2&4 Finished")
wog.WaitAll()
fmt.Println("WaitAll Finished")
}
このように WaitObjectGroupのGo()関数の引数にfunc型を渡すことでgoroutineとして実行され、返り値としてオブジェクト(WaitObjectID型)を受け取ります。
このオブジェクトをWait()関数に一つ以上渡すことで、対応する全てのゴルーチンの処理の終了を待機することができ、sync.WaitGroupで行うような待ち合わせ処理が簡単に行えます。
また、Go()で実行した全ての処理を待ちたい場合は、WaitAll()関数を使うことができます。
使用例2
errorGroup.WithCountext のように、panicが起きた時にコンテキストをキャンセルすることもできます。
下の例のように、waitobjectgroup.CreateGroup(ctx)として初期化してください。
これにより、Go()で実行中のゴルーチンのどれかでpanicが起きると、<- ctx.Done()でキャンセルを知ることができます。
func main() {
wog, ctx := waitobjectgroup.CreateGroup(context.TODO())
wog.Go(func() {
for {
select {
case <-ctx.Done():
fmt.Println("context Cancel")
return
case <-time.After(100 * time.Millisecond):
fmt.Println("Wait...")
}
}
})
wog.Go(func(){ panic("hogePanic") })
wog.WaitAll()
}
使用例3
下の例のように、Go()関数自体をゴルーチン内で呼び出すこともできます。
WaitObjectGroupの内部情報が適切に排他制御されているためです。
ただし、下の例ではWaitAll()が処理を待たずに終了する可能性があることに注意してください。
ゴルーチン内のGo()関数が実行されるよりも先に、WaitAll()が実行される可能性があるためです。
func main() {
wog, _ := CreateGroup(context.TODO())
go wog.Go(func(){...})
go wog.Go(func(){...})
wog.WaitAll()
}
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type WaitObject ¶
type WaitObject struct {
// contains filtered or unexported fields
}
type WaitObjectGroup ¶
type WaitObjectGroup struct {
// contains filtered or unexported fields
}
idをkeyとしてchを保持, userには渡さない
func CreateGroup ¶
func CreateGroup(ctx context.Context) (*WaitObjectGroup, context.Context)
func (*WaitObjectGroup) Go ¶
func (wog *WaitObjectGroup) Go(f func()) WaitObjectID
goroutineの実行と、chリスト(≒groutineリスト)への登録 closeしたらidをdelete ユーザのch操作は許容しないためidのみ返す
func (*WaitObjectGroup) Wait ¶
func (wog *WaitObjectGroup) Wait(idList ...WaitObjectID)
引数で受け取ったchに対応するgroutineが全て終わるまで待機
Source Files