interface CurlMultiInterface

Interface for sending a pool of {

Hierarchy

Expanded class hierarchy of CurlMultiInterface

All classes that implement CurlMultiInterface

See also

RequestInterface} objects in parallel

2 files declare their use of CurlMultiInterface
Client.php in drupal/core/vendor/guzzle/http/Guzzle/Http/Client.php
ClientInterface.php in drupal/core/vendor/guzzle/http/Guzzle/Http/ClientInterface.php

File

drupal/core/vendor/guzzle/http/Guzzle/Http/Curl/CurlMultiInterface.php, line 12

Namespace

Guzzle\Http\Curl
View source
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 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();

}

Members

Namesort descending Modifiers Type Description Overrides
CurlMultiInterface::add public function Add a request to the pool. 1
CurlMultiInterface::ADD_REQUEST constant
CurlMultiInterface::all public function Get an array of attached { 1
CurlMultiInterface::BEFORE_SEND constant
CurlMultiInterface::COMPLETE constant
CurlMultiInterface::getState public function Get the current state of the Pool 1
CurlMultiInterface::MULTI_EXCEPTION constant
CurlMultiInterface::POLLING_REQUEST constant
CurlMultiInterface::remove public function Remove a request from the pool. 1
CurlMultiInterface::REMOVE_REQUEST constant
CurlMultiInterface::reset public function Reset the state and remove any attached RequestInterface objects 1
CurlMultiInterface::send public function Send a pool of { 1
CurlMultiInterface::STATE_COMPLETE constant
CurlMultiInterface::STATE_IDLE constant
CurlMultiInterface::STATE_SENDING constant
HasDispatcherInterface::addSubscriber public function Add an event subscriber to the dispatcher 2
HasDispatcherInterface::dispatch public function Helper to dispatch Guzzle events and set the event name on the event 2
HasDispatcherInterface::getAllEvents public static function Get a list of all of the events emitted from the class 2
HasDispatcherInterface::getEventDispatcher public function Get the EventDispatcher of the request 2
HasDispatcherInterface::setEventDispatcher public function Set the EventDispatcher of the request 2