CAS_Request_CurlMultiRequest Class Reference

This interface defines a class library for performing multiple web requests in batches. More...

Inheritance diagram for CAS_Request_CurlMultiRequest:

Collaboration diagram for CAS_Request_CurlMultiRequest:

Public Member Functions
	addRequest (CAS_Request_RequestInterface $request)
	Add a new Request to this batch. More...
	getNumRequests ()
	Retrieve the number of requests added to this batch. More...
	send ()
	Perform the request. More...
Public Member Functions inherited from CAS_Request_MultiRequestInterface
	addRequest (CAS_Request_RequestInterface $request)
	Add a new Request to this batch. More...
	getNumRequests ()
	Retrieve the number of requests added to this batch. More...
	send ()
	Perform the request. More...

Private Attributes
	$_requests = array()
	$_sent = false

Detailed Description

This interface defines a class library for performing multiple web requests in batches.

Implementations of this interface may perform requests serially or in parallel.

Definition at line 42 of file CurlMultiRequest.php.

Member Function Documentation

addRequest()

CAS_Request_CurlMultiRequest::addRequest

(

CAS_Request_RequestInterface

$request

)

Add a new Request to this batch.

Note, implementations will likely restrict requests to their own concrete class hierarchy.

Parameters

CAS_Request_RequestInterface

$request

reqest to add

Returns

void

Exceptions

CAS_OutOfSequenceException	If called after the Request has been sent.
CAS_InvalidArgumentException	If passed a Request of the wrong implmentation.

Definition at line 64 of file CurlMultiRequest.php.

    {
        if ($this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has already been sent cannot '.__METHOD__
            );
        }
        if (!$request instanceof CAS_Request_CurlRequest) {
            throw new CAS_InvalidArgumentException(
                'As a CAS_Request_CurlMultiRequest, I can only work with CAS_Request_CurlRequest objects.'
            );
        }

        $this->_requests[] = $request;
    }

getNumRequests()

CAS_Request_CurlMultiRequest::getNumRequests

(

)

Retrieve the number of requests added to this batch.

Returns

number of request elements

Definition at line 85 of file CurlMultiRequest.php.

    {
        if ($this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has already been sent cannot '.__METHOD__
            );
        }
        return count($this->_requests);
    }

send()

CAS_Request_CurlMultiRequest::send

(

)

Perform the request.

After sending, all requests will have their responses poulated.

Returns

bool TRUE on success, FALSE on failure.

Exceptions

CAS_OutOfSequenceException

If called multiple times.

Definition at line 106 of file CurlMultiRequest.php.

References $i, and array.

    {
        if ($this->_sent) {
            throw new CAS_OutOfSequenceException(
                'Request has already been sent cannot send again.'
            );
        }
        if (!count($this->_requests)) {
            throw new CAS_OutOfSequenceException(
                'At least one request must be added via addRequest() before the multi-request can be sent.'
            );
        }

        $this->_sent = true;

        // Initialize our handles and configure all requests.
        $handles = array();
        $multiHandle = curl_multi_init();
        foreach ($this->_requests as $i => $request) {
            $handle = $request->initAndConfigure();
            curl_setopt($handle, CURLOPT_RETURNTRANSFER, true);
            $handles[$i] = $handle;
            curl_multi_add_handle($multiHandle, $handle);
        }

        // Execute the requests in parallel.
        do {
            curl_multi_exec($multiHandle, $running);
        } while ($running > 0);

        // Populate all of the responses or errors back into the request objects.
        foreach ($this->_requests as $i => $request) {
            $buf = curl_multi_getcontent($handles[$i]);
            $request->_storeResponseBody($buf);
            curl_multi_remove_handle($multiHandle, $handles[$i]);
            curl_close($handles[$i]);
        }

        curl_multi_close($multiHandle);
    }

Field Documentation

$_requests

CAS_Request_CurlMultiRequest::$_requests = array()

private

Definition at line 45 of file CurlMultiRequest.php.

$_sent

CAS_Request_CurlMultiRequest::$_sent = false

private

Definition at line 46 of file CurlMultiRequest.php.

---

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

• Services/CAS/lib/CAS/Request/CurlMultiRequest.php