Interface for sending a pool of {
Expanded class hierarchy of CurlMultiInterface
All classes that implement CurlMultiInterface
RequestInterface} objects in parallel
interface CurlMultiInterface extends HasDispatcherInterface, \Countable {
const BEFORE_SEND = 'curl_multi.before_send';
const POLLING_REQUEST = 'curl_multi.polling_request';
const COMPLETE = 'curl_multi.complete';
const ADD_REQUEST = 'curl_multi.add_request';
const REMOVE_REQUEST = 'curl_multi.remove_request';
const MULTI_EXCEPTION = 'curl_multi.exception';
const BLOCKING = 'curl_multi.blocking';
const STATE_IDLE = 'idle';
const STATE_SENDING = 'sending';
const STATE_COMPLETE = 'complete';
/**
* Add a request to the pool.
*
* @param RequestInterface $request Request to add
*
* @return CurlMultiInterface
*/
public function add(RequestInterface $request);
/**
* Get an array of attached {@see RequestInterface} objects
*
* @return array
*/
public function all();
/**
* Get the current state of the Pool
*
* @return string
*/
public function getState();
/**
* Remove a request from the pool.
*
* @param RequestInterface $request Request to remove
*
* @return CurlMultiInterface
*/
public function remove(RequestInterface $request);
/**
* Reset the state and remove any attached RequestInterface objects
*
* @param bool $hard Set to true to close and reopen any open multi handles
*/
public function reset($hard = false);
/**
* Send a pool of {@see RequestInterface} requests.
*
* @throws ExceptionCollection if any requests threw exceptions during the transfer.
*/
public function send();
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CurlMultiInterface:: |
public | function | Add a request to the pool. | 1 |
CurlMultiInterface:: |
constant | |||
CurlMultiInterface:: |
public | function | Get an array of attached { | 1 |
CurlMultiInterface:: |
constant | |||
CurlMultiInterface:: |
constant | |||
CurlMultiInterface:: |
constant | |||
CurlMultiInterface:: |
public | function | Get the current state of the Pool | 1 |
CurlMultiInterface:: |
constant | |||
CurlMultiInterface:: |
constant | |||
CurlMultiInterface:: |
public | function | Remove a request from the pool. | 1 |
CurlMultiInterface:: |
constant | |||
CurlMultiInterface:: |
public | function | Reset the state and remove any attached RequestInterface objects | 1 |
CurlMultiInterface:: |
public | function | Send a pool of { | 1 |
CurlMultiInterface:: |
constant | |||
CurlMultiInterface:: |
constant | |||
CurlMultiInterface:: |
constant | |||
HasDispatcherInterface:: |
public | function | Add an event subscriber to the dispatcher | 3 |
HasDispatcherInterface:: |
public | function | Helper to dispatch Guzzle events and set the event name on the event | 3 |
HasDispatcherInterface:: |
public static | function | Get a list of all of the events emitted from the class | 3 |
HasDispatcherInterface:: |
public | function | Get the EventDispatcher of the request | 3 |
HasDispatcherInterface:: |
public | function | Set the EventDispatcher of the request | 3 |