event

Documentation

Overview

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

Index

• type Event
  • func (event *Event) ACK()
  • func (event *Event) ACKNACK(err error)
  • func (event *Event) Error() error
  • func (event *Event) NACK()
• type Kind
• type Resp
  • func NewResp() Resp
  • func (resp Resp) ACK()
  • func (resp Resp) ACKNACK(err error)
  • func (resp Resp) ACKWait()
  • func (resp Resp) NACK()
  • func (resp Resp) Wait() error

Types

type Event

type Event struct {
	Kind Kind
	Resp Resp // channel to send an ack response on, nil to skip
	//Wg   *sync.WaitGroup // receiver barrier to Wait() for everyone else on
	Err error // store an error in our event
}

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) Error

func (event *Event) Error() error

Error returns the stored error value.

func (*Event) NACK

func (event *Event) NACK()

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

type Kind

type Kind int

Kind represents the type of event being passed.

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

The different event kinds 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.

func NewResp

func NewResp() Resp

NewResp is just a helper to return the right type of response channel.

func (Resp) ACK

func (resp Resp) ACK()

ACK sends a true value to resp.

func (Resp) ACKNACK

func (resp Resp) ACKNACK(err error)

ACKNACK sends a custom ACK or NACK. The ACK value is always nil, the NACK can be any non-nil error value.

func (Resp) ACKWait

func (resp Resp) ACKWait()

ACKWait waits for a +ive Ack from a Resp channel.

func (Resp) NACK

func (resp Resp) NACK()

NACK sends a false value to resp.

func (Resp) Wait

func (resp Resp) Wait() error

Wait waits for any response from a Resp channel and returns it.