AbstractResourceWaiter
extends AbstractWaiter
in package
implements
ResourceWaiterInterface
Abstract waiter implementation used to wait on resources
Table of Contents
Interfaces
- ResourceWaiterInterface
- Interface used in conjunction with clients to wait on a resource
Properties
- $attempts : mixed
- $client : AwsClientInterface
- $config : mixed
- $eventDispatcher : EventDispatcherInterface
Methods
- addSubscriber() : self
- Add an event subscriber to the dispatcher
- dispatch() : Event
- Helper to dispatch Guzzle events and set the event name on the event
- getAllEvents() : array<string|int, mixed>
- Get a list of all of the events emitted from the class
- getEventDispatcher() : EventDispatcherInterface
- Get the EventDispatcher of the request
- getInterval() : int
- Get the amount of time in seconds to delay between attempts
- getMaxAttempts() : int
- The max attempts allowed by the waiter
- setClient() : self
- Set the client associated with the waiter
- setConfig() : self
- Set config options associated with the waiter
- setEventDispatcher() : self
- Set the EventDispatcher of the request
- setInterval() : self
- Set the amount of time to interval between attempts
- setMaxAttempts() : self
- Set the maximum number of attempts to make when waiting
- wait() : mixed
- Begin the waiting loop
- doWait() : bool
- Method to implement in subclasses
Properties
$attempts
protected
mixed
$attempts
= 0
$client
protected
AwsClientInterface
$client
$config
protected
mixed
$config
= array()
$eventDispatcher
protected
EventDispatcherInterface
$eventDispatcher
Methods
addSubscriber()
Add an event subscriber to the dispatcher
public
addSubscriber(EventSubscriberInterface $subscriber) : self
Parameters
- $subscriber : EventSubscriberInterface
-
Event subscriber
Return values
selfdispatch()
Helper to dispatch Guzzle events and set the event name on the event
public
dispatch(mixed $eventName[, array<string|int, mixed> $context = array() ]) : Event
Parameters
- $eventName : mixed
-
Name of the event to dispatch
- $context : array<string|int, mixed> = array()
-
Context of the event
Return values
Event —Returns the created event object
getAllEvents()
Get a list of all of the events emitted from the class
public
static getAllEvents() : array<string|int, mixed>
Return values
array<string|int, mixed>getEventDispatcher()
Get the EventDispatcher of the request
public
getEventDispatcher() : EventDispatcherInterface
Return values
EventDispatcherInterfacegetInterval()
Get the amount of time in seconds to delay between attempts
public
getInterval() : int
Return values
intgetMaxAttempts()
The max attempts allowed by the waiter
public
getMaxAttempts() : int
Return values
intsetClient()
Set the client associated with the waiter
public
setClient(AwsClientInterface $client) : self
Parameters
- $client : AwsClientInterface
-
Client to use with the waiter
Return values
selfsetConfig()
Set config options associated with the waiter
public
setConfig(array<string|int, mixed> $config) : self
Parameters
- $config : array<string|int, mixed>
-
Options to set
Return values
selfsetEventDispatcher()
Set the EventDispatcher of the request
public
setEventDispatcher(EventDispatcherInterface $eventDispatcher) : self
Parameters
- $eventDispatcher : EventDispatcherInterface
Return values
selfsetInterval()
Set the amount of time to interval between attempts
public
setInterval(mixed $interval) : self
Parameters
- $interval : mixed
-
Interval in seconds
Return values
selfsetMaxAttempts()
Set the maximum number of attempts to make when waiting
public
setMaxAttempts(mixed $maxAttempts) : self
Parameters
- $maxAttempts : mixed
-
Max number of attempts
Return values
selfwait()
Begin the waiting loop
public
wait() : mixed
doWait()
Method to implement in subclasses
protected
abstract doWait() : bool
Return values
bool —Return true when successful, false on failure