readiness

type Checker ¶

type Checker interface {
	Check(ctx context.Context, id fmt.Stringer, check func(context.Context) (bool, error)) (ReadyStatus, error)
}

Checker checks readiness and returns a Status. It may be a single probe, watch or a polling wait, depending on implementation.

type Poller ¶

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

Poller repeatedly calls the underlying Checker at the configured period until Ready, Error, or context cancellation/timeout. prober := readiness.NewProber(1 * time.Minute) // single-check timeout poller := readiness.NewPoller(5*time.Second, prober) // polling loop

func NewPoller(period time.Duration, checker Checker) *Poller

func (p *Poller) Check(ctx context.Context, id fmt.Stringer, waitFunc func(context.Context) (bool, error)) (ReadyStatus, error)

type Prober ¶

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

Prober performs a single readiness check and returns Ready/InProgress/Error. Each check is bounded by the timeout configured in the constructor.

Usage:

status, err := readiness.NewProber(time.Minute).Check(ctx, id, fn)

func NewProber(proberTimeout time.Duration) *Prober

func (p *Prober) Check(ctx context.Context, id fmt.Stringer, checkFunc func(context.Context) (bool, error)) (ReadyStatus, error)

type ReadyStatus ¶

type ReadyStatus int

const (
	InProgress ReadyStatus = iota
	Ready
	Error
)

func (r ReadyStatus) AsFuncResult(err error) (bool, error)

func (r ReadyStatus) Failed() bool

func (r ReadyStatus) IsNotReady() bool

func (r ReadyStatus) IsReady() bool

type Ref ¶

type Ref struct {
	Namespace string
	Name      string
}

func (r Ref) String() string