event

package

v0.0.0-...-9368c7e Latest Latest Go to latest Published: Sep 28, 2016 License: AGPL-3.0 Imports: 1 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

Repository

github.com/chaoscloud/mgmt

Links

Open Source Insights

Documentation ¶

Overview ¶

Package event provides some primitives that are used for message passing.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Event ¶

type Event struct {
	Name EventName
	Resp Resp // channel to send an ack response on, nil to skip
	//Wg   *sync.WaitGroup // receiver barrier to Wait() for everyone else on
	Msg      string // some words for fun
	Activity bool   // did something interesting happen?
}

Event is the main struct that stores event information and responses.

func (*Event) ACK ¶

func (event *Event) ACK()

ACK sends a single acknowledgement on the channel if one was requested.

func (*Event) ACKNACK ¶

func (event *Event) ACKNACK(err error)

ACKNACK sends a custom ACK or NACK message on the channel if one was requested.

func (*Event) GetActivity ¶

func (event *Event) GetActivity() bool

GetActivity returns the activity value.

func (*Event) NACK ¶

func (event *Event) NACK()

NACK sends a negative acknowledgement message on the channel if one was requested.

type EventName ¶

type EventName int

EventName represents the type of event being passed.

const (
	EventNil EventName = iota
	EventExit
	EventStart
	EventPause
	EventPoke
	EventBackPoke
)

The different event names are used in different contexts.

type Resp ¶

type Resp chan error

Resp is a channel to be used for boolean responses. A nil represents an ACK, and a non-nil represents a NACK (false). This also lets us use custom errors.