events

package

v0.0.0-...-0653a19 Latest Latest Go to latest Published: Nov 21, 2022 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package events allows for the registering and receiving of events.

This section is empty.

This section is empty.

This section is empty.

type Events struct {
	// contains filtered or unexported fields
}

Events maintains a mapping of unique id and channels so goroutines can register and receive events.

func New() *Events

New constructs an events for registering and receiving events.

func (evt *Events) Acquire(id string) chan string

Acquire takes a unique id and returns a channel that can be used to receive events.

func (evt *Events) Release(id string) error

Release closes and removes the channel that was provided by the call to Acquire.

func (evt *Events) Send(s string)

Send signals a message to ever registered channel. Send will not block waiting for a receiver on any given channel.

func (evt *Events) Shutdown()

Shutdown closes and removes all channels that were provided by the call to Acquire.