Open Journal Systems  3.3.0
Guzzle\Plugin\Async\AsyncPlugin Class Reference
Inheritance diagram for Guzzle\Plugin\Async\AsyncPlugin:
Symfony\Component\EventDispatcher\EventSubscriberInterface

Public Member Functions

 onBeforeSend (Event $event)
 
 onCurlProgress (Event $event)
 
 onRequestSent (Event $event)
 
 onRequestTimeout (Event $event)
 

Static Public Member Functions

static getSubscribedEvents ()
 

Detailed Description

Sends requests but does not wait for the response

Definition at line 13 of file AsyncPlugin.php.

Member Function Documentation

◆ getSubscribedEvents()

static Guzzle\Plugin\Async\AsyncPlugin::getSubscribedEvents ( )
static

Returns an array of event names this subscriber wants to listen to.

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')))
Returns
array The event names to listen to

Implements Symfony\Component\EventDispatcher\EventSubscriberInterface.

Definition at line 15 of file AsyncPlugin.php.

Referenced by Guzzle\Tests\Plugin\Async\AsyncPluginTest\testSubscribesToEvents().

◆ onBeforeSend()

Guzzle\Plugin\Async\AsyncPlugin::onBeforeSend ( Event  $event)

Event used to ensure that progress callback are emitted from the curl handle's request mediator.

Parameters
Event$event

Definition at line 30 of file AsyncPlugin.php.

◆ onCurlProgress()

Guzzle\Plugin\Async\AsyncPlugin::onCurlProgress ( Event  $event)

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.

Parameters
Event$event

Definition at line 43 of file AsyncPlugin.php.

◆ onRequestSent()

Guzzle\Plugin\Async\AsyncPlugin::onRequestSent ( Event  $event)

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.

Parameters
Event$event

Definition at line 79 of file AsyncPlugin.php.

◆ onRequestTimeout()

Guzzle\Plugin\Async\AsyncPlugin::onRequestTimeout ( Event  $event)

Event emitted when a curl exception occurs. Ignore the exception and set a mock response.

Parameters
Event$event

Definition at line 64 of file AsyncPlugin.php.


The documentation for this class was generated from the following file: