sync

Documentation

Index

• func NewNopLifecycle() transport.Lifecycle
• type ErrorWaiter
  • func (ew *ErrorWaiter) Submit(f func() error)
  • func (ew *ErrorWaiter) Wait() []error
• type LifecycleOnce
  • func Once() LifecycleOnce
• type LifecycleState
  • func (i LifecycleState) String() string

Functions

func NewNopLifecycle

func NewNopLifecycle() transport.Lifecycle

NewNopLifecycle returns a new one-time no-op lifecycle

Types

type ErrorWaiter

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

ErrorWaiter is similar to a WaitGroup except it allows collecting failures from subtasks.

func (*ErrorWaiter) Submit

func (ew *ErrorWaiter) Submit(f func() error)

Submit submits a task for execution on the ErrorWaiter.

The function returns immediately.

func (*ErrorWaiter) Wait

func (ew *ErrorWaiter) Wait() []error

Wait waits until all submitted tasks have finished and returns a list of all errors that occurred during task execution in no particular order.

type LifecycleOnce

type LifecycleOnce interface {
	Start(func() error) error
	Stop(func() error) error
	LifecycleState() LifecycleState
	IsRunning() bool
	WhenRunning(context.Context) error
	Stopped() <-chan struct{}
	Started() <-chan struct{}
}

LifecycleOnce is a helper for implementing transport.Lifecycles with similar behavior.

func Once

func Once() LifecycleOnce

Once returns a lifecycle controller.

0. The observable lifecycle state must only go forward from birth to death.
1. Start() must block until the state is >= Running
2. Stop() must block until the state is >= Stopped
3. Stop() must pre-empt Start() if it occurs first
4. Start() and Stop() may be backed by a do actual work function, and that function must be called at most once.

type LifecycleState

type LifecycleState int

LifecycleState represents `states` that a lifecycle object can be in.

const (
	// Idle indicates the Lifecycle hasn't been operated on yet.
	Idle LifecycleState = iota

	// Starting indicates that the Lifecycle has begun it's "start" command
	// but hasn't finished yet.
	Starting

	// Running indicates that the Lifecycle has finished starting and is
	// available.
	Running

	// Stopping indicates that the Lifecycle 'stop' method has been called
	// but hasn't finished yet.
	Stopping

	// Stopped indicates that the Lifecycle has been stopped.
	Stopped

	// Errored indicates that the Lifecycle experienced an error and we can't
	// reasonably determine what state the lifecycle is in.
	Errored
)

func (LifecycleState) String

func (i LifecycleState) String() string