keyed

Documentation

Index

• func NewLogExitedCallback[T comparable](le *logrus.Entry) func(key string, routine Routine, data T, err error)
• type KeyWithData
• type Keyed
  • func NewKeyed[T comparable](ctorCb func(key string) (Routine, T), ...) *Keyed[T]
  • func NewKeyedWithLogger[T comparable](ctorCb func(key string) (Routine, T), le *logrus.Entry) *Keyed[T]
  • func (k *Keyed[T]) GetKey(key string) (Routine, T)
  • func (k *Keyed[T]) GetKeys() []string
  • func (k *Keyed[T]) GetKeysWithData() []KeyWithData[T]
  • func (k *Keyed[T]) RemoveKey(key string) bool
  • func (k *Keyed[T]) ResetRoutine(key string, conds ...func(T) bool) (existed bool, reset bool)
  • func (k *Keyed[T]) SetContext(ctx context.Context, restart bool)
  • func (k *Keyed[T]) SetKey(key string, restart bool) bool
  • func (k *Keyed[T]) SyncKeys(keys []string, restart bool)
• type KeyedRef
  • func (k *KeyedRef[T]) Release()
• type KeyedRefCount
  • func NewKeyedRefCount[T comparable](ctorCb func(key string) (Routine, T), ...) *KeyedRefCount[T]
  • func NewKeyedRefCountWithLogger[T comparable](ctorCb func(key string) (Routine, T), le *logrus.Entry) *KeyedRefCount[T]
  • func (k *KeyedRefCount[T]) AddKeyRef(key string) (ref *KeyedRef[T], existed bool)
  • func (k *KeyedRefCount[T]) GetKey(key string) (Routine, T)
  • func (k *KeyedRefCount[T]) GetKeys() []string
  • func (k *KeyedRefCount[T]) GetKeysWithData() []KeyWithData[T]
  • func (k *KeyedRefCount[T]) ResetRoutine(key string, conds ...func(T) bool) (existed bool, reset bool)
  • func (k *KeyedRefCount[T]) SetContext(ctx context.Context, restart bool)
• type Routine

Functions

func NewLogExitedCallback

func NewLogExitedCallback[T comparable](le *logrus.Entry) func(key string, routine Routine, data T, err error)

NewLogExitedCallback returns a ExitedCb which logs when a controller exited.

Types

type KeyWithData

type KeyWithData[T comparable] struct {
	// Key is the key.
	Key string
	// Data is the associated data.
	Data T
}

KeyWithData is a key with associated data.

type Keyed

type Keyed[T comparable] struct {
	// contains filtered or unexported fields
}

Keyed manages a set of goroutines with associated Keys.

func NewKeyed

func NewKeyed[T comparable](
	ctorCb func(key string) (Routine, T),
	exitedCb func(key string, routine Routine, data T, err error),
) *Keyed[T]

NewKeyed constructs a new Keyed execution manager. Note: routines won't start until SetContext is called. exitedCb is called after a routine exits unexpectedly.

func NewKeyedWithLogger

func NewKeyedWithLogger[T comparable](
	ctorCb func(key string) (Routine, T),
	le *logrus.Entry,
) *Keyed[T]

NewKeyedWithLogger constructs a new keyed instance. Logs when a controller exits without being removed from the Keys set.

Note: routines won't start until SetContext is called. exitedCb is called after a routine exits unexpectedly.

func (*Keyed[T]) GetKey

func (k *Keyed[T]) GetKey(key string) (Routine, T)

GetKey returns the routine for the given key. Note: this is an instantaneous snapshot.

func (*Keyed[T]) GetKeys

func (k *Keyed[T]) GetKeys() []string

GetKeys returns the list of keys registered with the Keyed instance. Note: this is an instantaneous snapshot.

func (*Keyed[T]) GetKeysWithData

func (k *Keyed[T]) GetKeysWithData() []KeyWithData[T]

GetKeysWithData returns the keys and the data for the keys. Note: this is an instantaneous snapshot.

func (*Keyed[T]) RemoveKey

func (k *Keyed[T]) RemoveKey(key string) bool

RemoveKey removes the given key from the set, if it exists. Returns if it existed.

func (*Keyed[T]) ResetRoutine

func (k *Keyed[T]) ResetRoutine(key string, conds ...func(T) bool) (existed bool, reset bool)

ResetRoutine resets the given routine after checking the condition functions. If any return true, resets the instance.

If len(conds) == 0, always resets the given key.

func (*Keyed[T]) SetContext

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

SetContext updates the root context, restarting all running routines. If ctx == nil, stops all routines. if restart is true, all errored routines also restart

func (*Keyed[T]) SetKey

func (k *Keyed[T]) SetKey(key string, restart bool) bool

SetKey inserts the given key into the set, if it doesn't already exist. If restart=true, restarts if routines is currently in the failed state. Returns if it existed already or not.

func (*Keyed[T]) SyncKeys

func (k *Keyed[T]) 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 failed state.

type KeyedRef

type KeyedRef[T comparable] struct {
	// contains filtered or unexported fields
}

KeyedRef is a reference to a key.

func (*KeyedRef[T]) Release

func (k *KeyedRef[T]) Release()

Release releases the reference.

type KeyedRefCount

type KeyedRefCount[T comparable] struct {
	// contains filtered or unexported fields
}

KeyedRefCount manages a list of running routines with reference counts.

func NewKeyedRefCount

func NewKeyedRefCount[T comparable](
	ctorCb func(key string) (Routine, T),
	exitedCb func(key string, routine Routine, data T, err error),
) *KeyedRefCount[T]

NewKeyedRefCount constructs a new Keyed execution manager with reference counting. Note: routines won't start until SetContext is called.

func NewKeyedRefCountWithLogger

func NewKeyedRefCountWithLogger[T comparable](
	ctorCb func(key string) (Routine, T),
	le *logrus.Entry,
) *KeyedRefCount[T]

NewKeyedRefCountWithLogger constructs a new Keyed execution manager with reference counting. Logs when a controller exits without being removed from the Keys set. Note: routines won't start until SetContext is called.

func (*KeyedRefCount[T]) AddKeyRef

func (k *KeyedRefCount[T]) AddKeyRef(key string) (ref *KeyedRef[T], existed bool)

AddKeyRef adds a reference to the given key. Returns if the key already existed or not.

func (*KeyedRefCount[T]) GetKey

func (k *KeyedRefCount[T]) GetKey(key string) (Routine, T)

GetKey returns the routine for the given key. Note: this is an instantaneous snapshot.

func (*KeyedRefCount[T]) GetKeys

func (k *KeyedRefCount[T]) GetKeys() []string

GetKeys returns the list of keys registered with the Keyed instance. Note: this is an instantaneous snapshot.

func (*KeyedRefCount[T]) GetKeysWithData

func (k *KeyedRefCount[T]) GetKeysWithData() []KeyWithData[T]

GetKeysWithData returns the keys and the data for the keys. Note: this is an instantaneous snapshot.

func (*KeyedRefCount[T]) ResetRoutine

func (k *KeyedRefCount[T]) ResetRoutine(key string, conds ...func(T) bool) (existed bool, reset bool)

ResetRoutine resets the given routine after checking the condition functions. If any return true, resets the instance.

If len(conds) == 0, always resets the given key.

func (*KeyedRefCount[T]) SetContext

func (k *KeyedRefCount[T]) SetContext(ctx context.Context, restart bool)

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

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.