Interface WaiterInterface
WaiterInterface used to wait on something to be in a particular state
Direct known implementers
Aws\Common\Waiter\AbstractWaiter
,
Aws\Common\Waiter\ResourceWaiterInterface
Indirect known implementers
Aws\Common\InstanceMetadata\Waiter\ServiceAvailable
,
Aws\Common\Waiter\AbstractResourceWaiter
,
Aws\Common\Waiter\CallableWaiter
,
Aws\Common\Waiter\ConfigResourceWaiter
Methods summary
-
public
setMaxAttempts ( int $maxAttempts )
Set the maximum number of attempts to make when waiting
-
public
setInterval ( int $interval )
Set the amount of time to interval between attempts
-
public
setConfig ( array $config )
Set configuration options associated with the waiter
-
public
wait ( )
Begin the waiting loop
Methods detail
Set the maximum number of attempts to make when waiting
Parameters
- $maxAttempts
integer
$maxAttempts Max number of attempts
Returns
Set the amount of time to interval between attempts
Parameters
- $interval
integer
$interval Interval in seconds
Returns
Set configuration options associated with the waiter
Parameters
- $config
array
$config Configuration options to set
Returns
Begin the waiting loop
Throw
RuntimeException if the method never resolves to true
Magic methods summary
Constants summary
string |
INTERVAL |
'waiter.interval' |
|
string |
MAX_ATTEMPTS |
'waiter.max_attempts' |