Interface Guzzle\Http\Curl\CurlMultiInterface

ExtendsCountable, Guzzle\Common\HasDispatcherInterface
Implemented byGuzzle\Http\Curl\CurlMulti, Guzzle\Http\Curl\CurlMultiProxy

Interface for sending a pool of {@see RequestInterface} objects in parallel

Public Methods

Hide inherited methods

MethodDescriptionDefined By
add() Add a request to the pool. Guzzle\Http\Curl\CurlMultiInterface
addSubscriber() Add an event subscriber to the dispatcher Guzzle\Common\HasDispatcherInterface
all() Get an array of attached {@see RequestInterface} objects Guzzle\Http\Curl\CurlMultiInterface
dispatch() Helper to dispatch Guzzle events and set the event name on the event Guzzle\Common\HasDispatcherInterface
getAllEvents() Get a list of all of the events emitted from the class Guzzle\Common\HasDispatcherInterface
getEventDispatcher() Get the EventDispatcher of the request Guzzle\Common\HasDispatcherInterface
remove() Remove a request from the pool. Guzzle\Http\Curl\CurlMultiInterface
reset() Reset the state and remove any attached RequestInterface objects Guzzle\Http\Curl\CurlMultiInterface
send() Send a pool of {@see RequestInterface} requests. Guzzle\Http\Curl\CurlMultiInterface
setEventDispatcher() Set the EventDispatcher of the request Guzzle\Common\HasDispatcherInterface

Method Details

add() public abstract method

Add a request to the pool.

public abstract Guzzle\Http\Curl\CurlMultiInterface add ( Guzzle\Http\Message\RequestInterface $request )
$request Guzzle\Http\Message\RequestInterface

Request to add

all() public abstract method

Get an array of attached {@see RequestInterface} objects

public abstract array all ( )
remove() public abstract method

Remove a request from the pool.

public abstract bool remove ( Guzzle\Http\Message\RequestInterface $request )
$request Guzzle\Http\Message\RequestInterface

Request to remove

return bool

Returns true on success or false on failure

reset() public abstract method

Reset the state and remove any attached RequestInterface objects

public abstract void reset ( $hard false )
$hard bool

Set to true to close and reopen any open multi handles

send() public abstract method

Send a pool of {@see RequestInterface} requests.

public abstract void send ( )
throws Guzzle\Common\Exception\ExceptionCollection

if any requests threw exceptions during the transfer.