Class AbstractWaiter
Abstract wait implementation
- Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
-
Aws\Common\Waiter\AbstractWaiter
implements
Aws\Common\Waiter\WaiterInterface
Direct known subclasses
Aws\Common\Waiter\AbstractResourceWaiter,
Aws\Common\Waiter\CallableWaiter
Indirect known subclasses
Aws\Common\InstanceMetadata\Waiter\ServiceAvailable,
Aws\Common\Waiter\ConfigResourceWaiter
Methods summary
-
public staticgetAllEvents ( )Get a list of all of the events emitted from the class
-
publicgetMaxAttempts ( )The max attempts allowed by the waiter
-
publicgetInterval ( )Get the amount of time in seconds to delay between attempts
-
publicsetMaxAttempts ( int $maxAttempts )Set the maximum number of attempts to make when waiting
-
publicsetInterval ( int $interval )Set the amount of time to interval between attempts
-
publicsetConfig ( array $config )Set config options associated with the waiter
-
publicwait ( )Begin the waiting loop
-
abstract protecteddoWait ( )Method to implement in subclasses
Methods detail
Get a list of all of the events emitted from the class
Returns
arrayOverrides
The max attempts allowed by the waiter
Returns
integerGet the amount of time in seconds to delay between attempts
Returns
integerSet the maximum number of attempts to make when waiting
Parameters
- $maxAttempts
integer
$maxAttempts Max number of attempts
Returns
Implementation of
Set the amount of time to interval between attempts
Parameters
- $interval
integer
$interval Interval in seconds
Returns
Implementation of
Set config options associated with the waiter
Parameters
- $config
array
$config Options to set
Returns
Implementation of
Method to implement in subclasses
Returns
booleanReturn true when successful, false on failure
Methods inherited from Guzzle\Common\AbstractHasDispatcher
addSubscriber(),
dispatch(),
getEventDispatcher(),
setEventDispatcher()
Magic methods summary
Constants summary
Constants inherited from Aws\Common\Waiter\WaiterInterface
Properties summary
protected
integer
|
$attempts | |
protected
array
|
$config |