waiter

Documentation

Index

• type CleanupFunc
• type WaitFunc
• type Waiter
  • func New(options ...WaiterOption) Waiter
• type WaiterOption
  • func CatchSignals() WaiterOption
  • func ParentContext(ctx context.Context) WaiterOption

Types

type CleanupFunc

type CleanupFunc func()

type WaitFunc

type WaitFunc func(ctx context.Context) error

type Waiter

type Waiter interface {
	// Add a function to wait for
	Add(fns ...WaitFunc)
	// Cleanup with a function after waiting
	Cleanup(fns ...CleanupFunc)
	Wait() error
	Context() context.Context
	CancelFunc() context.CancelFunc
}

func New

func New(options ...WaiterOption) Waiter

type WaiterOption

type WaiterOption func(c *waiterCfg)

func CatchSignals

func CatchSignals() WaiterOption

func ParentContext

func ParentContext(ctx context.Context) WaiterOption