waiter

Documentation

Index

• func Wait(checker checker.Checker, opts ...Option) error
• func WaitContext(ctx context.Context, checker checker.Checker, opts ...Option) error
• func WaitParallel(checkers []checker.Checker, opts ...Option) error
• func WaitParallelContext(ctx context.Context, checkers []checker.Checker, opts ...Option) error
• func WaitWithContext(ctx context.Context, checker checker.Checker, opts ...Option) error
• type Check
• type Option
  • func WithInterval(interval time.Duration) Option
  • func WithInvertCheck(invertCheck bool) Option
  • func WithLogger(logger *logr.Logger) Option
  • func WithTimeout(timeout time.Duration) Option

Functions

func Wait

func Wait(checker checker.Checker, opts ...Option) error

Wait waits for end up of check execution.

func WaitContext

func WaitContext(ctx context.Context, checker checker.Checker, opts ...Option) error

WaitContext waits for end up of check execution.

func WaitParallel

func WaitParallel(checkers []checker.Checker, opts ...Option) error

WaitParallel waits for end up all of checks execution.

func WaitParallelContext

func WaitParallelContext(ctx context.Context, checkers []checker.Checker, opts ...Option) error

WaitParallelContext waits for end up all of checks execution.

func WaitWithContext

func WaitWithContext(ctx context.Context, checker checker.Checker, opts ...Option) error

WaitWithContext waits for end up of check execution. Deprecated: The function will be removed in v3.0.0, please use the WaitContext.

Types

type Check

type Check func(ctx context.Context) error

Check represents the checker's check method.

type Option

type Option func(s *options)

Option configures an options

func WithInterval

func WithInterval(interval time.Duration) Option

WithInterval configures time duration for each of checking interval

func WithInvertCheck

func WithInvertCheck(invertCheck bool) Option

WithInvertCheck configures invert checking

func WithLogger

func WithLogger(logger *logr.Logger) Option

WithLogger configures waiter logger

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout configures a time limit for whole of checking