waiter

Documentation

Overview

Package waiter is a helper package use for waiting remote state is transformed into target state.

Index

• type RefreshFunc
• type StateWaiter
  • func (waiter *StateWaiter) Wait() (interface{}, error)
• type TimeoutError
  • func (e *TimeoutError) Error() string

Types

type RefreshFunc

type RefreshFunc func() (result interface{}, state string, err error)

RefreshFunc is the function to query remote resource state

type StateWaiter

type StateWaiter struct {
	Pending      []string
	Target       []string
	Refresh      RefreshFunc
	Delay        time.Duration
	Timeout      time.Duration
	MinTimeout   time.Duration
	PollInterval time.Duration
}

StateWaiter is the waiter that waiting for remote state achieve to target state

func (*StateWaiter) Wait

func (waiter *StateWaiter) Wait() (interface{}, error)

Wait watches an object and waits for it to achieve the state

type TimeoutError

type TimeoutError struct {
	LastError      error
	LastState      string
	Timeout        time.Duration
	ExpectedStates []string
}

TimeoutError is returned when WaitForState times out

func (*TimeoutError) Error

func (e *TimeoutError) Error() string