startgroup

Documentation

Overview

Package startgroup provides a single synchronization primitive the StartGroup.

Index

• type StartGroup
  • func MakeStartGroup() StartGroup

Types

type StartGroup

type StartGroup interface {
	//  Release all Waiting goroutines
	Release()

	// Wait for a release event
	Wait()

	// Wait for a release event for up to a timeout
	TimedWait(timeout time.Duration) bool
}

A StartGroup provides a mechanism for a collection of goroutines to wait for a release event. When released, all blocked routines simultaneously.

A typical use is when multiple routines need to know when a resource is available but do not need exclusive access to the resource.

func MakeStartGroup

func MakeStartGroup() StartGroup

Create a StartGroup.