finalizer

Documentation

Index

• Variables
• type Finalizer
  • func New(logger log.Logger, metricsHandler metrics.Handler) *Finalizer
  • func (f *Finalizer) Deregister(id string) (err error)
  • func (f *Finalizer) Register(id string, callback func(context.Context) error) error
  • func (f *Finalizer) Run(timeout time.Duration) int

Variables

var (
	FinalizerAlreadyDoneErr = errors.New("finalizer already finalized")
	FinalizerUnknownIdErr   = errors.New("finalizer callback not found")
	FinalizerDuplicateIdErr = errors.New("finalizer callback already registered")
)

Types

type Finalizer

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

func New

func New(
	logger log.Logger,
	metricsHandler metrics.Handler,
) *Finalizer

func (*Finalizer) Deregister

func (f *Finalizer) Deregister(
	id string,
) (err error)

Deregister removes a callback from the finalizer. Returns an error if the ID is not found, or when the finalizer is/was already running.

func (*Finalizer) Register

func (f *Finalizer) Register(
	id string,
	callback func(context.Context) error,
) error

Register adds a callback to the finalizer. Returns an error if the ID is already registered, or when the finalizer is/was already running.

func (*Finalizer) Run

func (f *Finalizer) Run(
	timeout time.Duration,
) int

Run executes all registered callback functions within the given timeout (zero timeout skips execution). It can only be invoked once; calling it again has no effect. Returns the number of completed callbacks.