AsyncPlugin
in package
implements
EventSubscriberInterface
Sends requests but does not wait for the response
Table of Contents
Interfaces
- EventSubscriberInterface
- An EventSubscriber knows himself what events he is interested in.
Methods
- getSubscribedEvents() : array<string|int, mixed>
- Returns an array of event names this subscriber wants to listen to.
- onBeforeSend() : mixed
- Event used to ensure that progress callback are emitted from the curl handle's request mediator.
- onCurlProgress() : mixed
- Event emitted when a curl progress function is called. When the amount of data uploaded == the amount of data to upload OR any bytes have been downloaded, then time the request out after 1ms because we're done with transmitting the request, and tell curl not download a body.
- onRequestSent() : mixed
- Event emitted when a request completes because it took less than 1ms. Add an X-Guzzle-Async header to notify the caller that there is no body in the message.
- onRequestTimeout() : mixed
- Event emitted when a curl exception occurs. Ignore the exception and set a mock response.
Methods
getSubscribedEvents()
Returns an array of event names this subscriber wants to listen to.
public
static getSubscribedEvents() : array<string|int, mixed>
The array keys are event names and the value can be:
- The method name to call (priority defaults to 0)
- An array composed of the method name to call and the priority
- An array of arrays composed of the method names to call and respective priorities, or 0 if unset
For instance:
- array('eventName' => 'methodName')
- array('eventName' => array('methodName', $priority))
- array('eventName' => array(array('methodName1', $priority), array('methodName2')))
Return values
array<string|int, mixed> —The event names to listen to
onBeforeSend()
Event used to ensure that progress callback are emitted from the curl handle's request mediator.
public
onBeforeSend(Event $event) : mixed
Parameters
- $event : Event
onCurlProgress()
Event emitted when a curl progress function is called. When the amount of data uploaded == the amount of data to upload OR any bytes have been downloaded, then time the request out after 1ms because we're done with transmitting the request, and tell curl not download a body.
public
onCurlProgress(Event $event) : mixed
Parameters
- $event : Event
onRequestSent()
Event emitted when a request completes because it took less than 1ms. Add an X-Guzzle-Async header to notify the caller that there is no body in the message.
public
onRequestSent(Event $event) : mixed
Parameters
- $event : Event
onRequestTimeout()
Event emitted when a curl exception occurs. Ignore the exception and set a mock response.
public
onRequestTimeout(Event $event) : mixed
Parameters
- $event : Event