Public Member Functions | |
| add (RequestInterface $request) | |
| all () | |
| remove (RequestInterface $request) | |
| reset ($hard=false) | |
| send () | |
 Public Member Functions inherited from Guzzle\Common\HasDispatcherInterface | |
| addSubscriber (EventSubscriberInterface $subscriber) | |
| dispatch ($eventName, array $context=array()) | |
| getEventDispatcher () | |
| setEventDispatcher (EventDispatcherInterface $eventDispatcher) | |
Data Fields | |
| const | ADD_REQUEST = 'curl_multi.add_request' |
| const | BLOCKING = 'curl_multi.blocking' |
| const | MULTI_EXCEPTION = 'curl_multi.exception' |
| const | POLLING_REQUEST = 'curl_multi.polling_request' |
| const | REMOVE_REQUEST = 'curl_multi.remove_request' |
Additional Inherited Members | |
| Static Public Member Functions inherited from Guzzle\Common\HasDispatcherInterface | |
| static | getAllEvents () |
Detailed Description
Interface for sending a pool of {
- See also
- RequestInterface} objects in parallel
Definition at line 12 of file CurlMultiInterface.php.
Member Function Documentation
◆ add()
| Guzzle\Http\Curl\CurlMultiInterface::add | ( | RequestInterface | $request | ) |
Add a request to the pool.
- Parameters
-
RequestInterface $request Request to add
- Returns
- CurlMultiInterface
Implemented in Guzzle\Http\Curl\CurlMulti, and Guzzle\Http\Curl\CurlMultiProxy.
◆ all()
| Guzzle\Http\Curl\CurlMultiInterface::all | ( | ) |
Get an array of attached {
- See also
- RequestInterface} objects
- Returns
- array
Implemented in Guzzle\Http\Curl\CurlMulti, and Guzzle\Http\Curl\CurlMultiProxy.
◆ remove()
| Guzzle\Http\Curl\CurlMultiInterface::remove | ( | RequestInterface | $request | ) |
Remove a request from the pool.
- Parameters
-
RequestInterface $request Request to remove
- Returns
- bool Returns true on success or false on failure
Implemented in Guzzle\Http\Curl\CurlMulti, and Guzzle\Http\Curl\CurlMultiProxy.
◆ reset()
| Guzzle\Http\Curl\CurlMultiInterface::reset | ( | $hard = false | ) |
Reset the state and remove any attached RequestInterface objects
- Parameters
-
bool $hard Set to true to close and reopen any open multi handles
Implemented in Guzzle\Http\Curl\CurlMulti, and Guzzle\Http\Curl\CurlMultiProxy.
◆ send()
| Guzzle\Http\Curl\CurlMultiInterface::send | ( | ) |
Send a pool of {
- See also
- RequestInterface} requests.
- Exceptions
-
ExceptionCollection if any requests threw exceptions during the transfer.
Implemented in Guzzle\Http\Curl\CurlMulti, and Guzzle\Http\Curl\CurlMultiProxy.
Field Documentation
◆ ADD_REQUEST
| const Guzzle\Http\Curl\CurlMultiInterface::ADD_REQUEST = 'curl_multi.add_request' |
Definition at line 15 of file CurlMultiInterface.php.
Referenced by Guzzle\Tests\Http\Curl\CurlMultiProxyTest\testSendWillSendQueuedRequestsFirst().
◆ BLOCKING
| const Guzzle\Http\Curl\CurlMultiInterface::BLOCKING = 'curl_multi.blocking' |
Definition at line 18 of file CurlMultiInterface.php.
◆ MULTI_EXCEPTION
| const Guzzle\Http\Curl\CurlMultiInterface::MULTI_EXCEPTION = 'curl_multi.exception' |
Definition at line 17 of file CurlMultiInterface.php.
◆ POLLING_REQUEST
| const Guzzle\Http\Curl\CurlMultiInterface::POLLING_REQUEST = 'curl_multi.polling_request' |
Definition at line 14 of file CurlMultiInterface.php.
Referenced by Guzzle\Tests\Plugin\Backoff\BackoffPluginTest\getMockEvent(), and Guzzle\Plugin\Backoff\BackoffPlugin\getSubscribedEvents().
◆ REMOVE_REQUEST
| const Guzzle\Http\Curl\CurlMultiInterface::REMOVE_REQUEST = 'curl_multi.remove_request' |
Definition at line 16 of file CurlMultiInterface.php.
The documentation for this interface was generated from the following file:
