keyed

Documentation

Index

• type Constructor
• type Keyed
  • func NewKeyed(ctorCb Constructor) *Keyed
  • func (k *Keyed) SetContext(ctx context.Context, restart bool)
  • func (k *Keyed) SyncKeys(keys []string, restart bool)
• type Routine

Types

type Constructor

type Constructor func(key string) Routine

Constructor returns a function to start for the given key. If nil is returned, skips starting that routine.

type Keyed

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

Keyed manages a set of goroutines with associated Keys.

func NewKeyed

func NewKeyed(ctorCb Constructor) *Keyed

NewKeyed constructs a new Keyed execution manager. Note: routines won't start until SetContext is called.

func (*Keyed) SetContext

func (k *Keyed) SetContext(ctx context.Context, restart bool)

SetContext updates the root context, restarting all running routines. if restart is true, all errored routines also restart

func (*Keyed) SyncKeys

func (k *Keyed) SyncKeys(keys []string, restart bool)

SyncKeys synchronizes the list of running routines with the given list. If restart=true, restarts any failed routines in the list.

type Routine

type Routine func(ctx context.Context) error

Routine is a function called as a goroutine. If nil is returned, exits cleanly permanently. If an error is returned, can be restarted later.