track

Documentation

Index

• Variables
• type Context
• type Track
  • func (sf *Track) Cancel(err error) error
  • func (sf *Track) Close() error
  • func (sf *Track) Done() chan struct{}
  • func (sf *Track) Err() error

Variables

var ErrDying = errors.New("track: dying")

ErrDying is the error returned by Context.Err when the context is canceled.

Types

type Context

type Context interface {
	// Done returns a channel that's closed when work done on behalf of this
	// context should be closed. Successive calls to Done return the same value.
	// The close of the Done channel may happen asynchronously after the close or
	// cancel function called.
	// a Done channel for cancellation.
	Done() <-chan struct{}
	// Err returns the err for the goroutine death provided via Close
	// If Done is not yet closed, Err returns nil.
	// If Done is closed, Err returns ErrDying.
	// If Done is closed with Cancel function, Err returns custom error.
	Err() error
	// Close flags the goroutine as dying.
	Close() error
	// Cancel flags the goroutine as dying with custom error.
	// if error is nil, it will use ErrDying.
	Cancel(err error) error
}

Context Context's methods may be called by multiple goroutines simultaneously.

type Track

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

Track tracks the lifecycle of a goroutine as alive, dying.

func (*Track) Cancel

func (sf *Track) Cancel(err error) error

Cancel flags the goroutine as dying with custom error. if error is nil, it will use ErrDying.

func (*Track) Close

func (sf *Track) Close() error

Close flags the goroutine as dying.

func (*Track) Done

func (sf *Track) Done() chan struct{}

Done a Done channel for cancellation.

func (*Track) Err

func (sf *Track) Err() error

Err returns the err for the goroutine death provided via Close If Done is not yet closed, Err returns nil. If Done is closed, Err returns ErrDying.