Client

Create a new HTTP client.

Currently only "curl" is supported as a $driver, and used by default. Persisted resources identified by $persistent_handle_id will be re-used if available.

Add custom cookies.

See http\Client::setCookies().

Add specific SSL options.

See http\Client::setSslOptions(), http\Client::setOptions() and http\Client\Curl\$ssl options.

Implements SplSubject. Attach another observer.

Attached observers will be notified with progress of each transfer.

Configure the client's low level options.

NOTE: This method has been added in v2.3.0.

Implements Countable. Retrieve the number of enqueued requests.

NOTE: The enqueued requests are counted without regard whether they are finished or not.

Dequeue the http\Client\Request $request.

See http\Client::requeue(), if you want to requeue the request, instead of calling http\Client::dequeue() and then http\Client::enqueue().

Implements SplSubject. Detach $observer, which has been previously attached.

Enable usage of an event library like libevent, which might improve performance with big socket sets.

Enable sending pipelined requests to the same host if the driver supports it.

Add another http\Client\Request to the request queue.

If the optional callback $cb returns true, the request will be automatically dequeued.

Note: The http\Client\Response object resulting from the request is always stored internally to be retrieved at a later time, even when $cb is used.

If you are about to send a lot of requests and do not need the response after executing the callback, you can use http\Client::getResponse() within the callback to keep the memory usage level as low as possible.

See http\Client::dequeue() and http\Client::send().

Get a list of available configuration options and their default values.

See f.e. the configuration options for the Curl driver.

List available drivers.

Retrieve a list of available request options and their default values.

See f.e. the request options for the Curl driver.

Get priorly set custom cookies.

See http\Client::setCookies().

Simply returns the http\Message chain representing the request/response history.

NOTE: The history is only recorded while http\Client::$recordHistory is true.

Returns the SplObjectStorage holding attached observers.

Get priorly set options.

See http\Client::setOptions().

Retrieve the progress information for $request.

Retrieve the corresponding response of an already finished request, or the last received response if $request is not set.

NOTE: If $request is NULL, then the response is removed from the internal storage (stack-like operation).

Retrieve priorly set SSL options.

See http\Client::getOptions() and http\Client::setSslOptions().

Get transfer related information for a running or finished request.

Implements SplSubject. Notify attached observers about progress with $request.

Perform outstanding transfer actions.

See http\Client::wait() for the completing interface.

Requeue an http\Client\Request.

The difference simply is, that this method, in contrast to http\Client::enqueue(), does not throw an http\Exception when the request to queue is already enqueued and dequeues it automatically prior enqueueing it again.

Reset the client to the initial state.

Send all enqueued requests.

See http\Client::once() and http\Client::wait() for a more fine grained interface.

Set custom cookies.

See http\Client::addCookies() and http\Client::getCookies().

Set client debugging callback.

NOTE: This method has been added in v2.6.0, resp. v3.1.0.

Set client options.

See http\Client\Curl.

NOTE: Only options specified prior enqueueing a request are applied to the request.

Specifically set SSL options.

See http\Client::setOptions() and http\Client\Curl\$ssl options.

Wait for $timeout seconds for transfers to provide data.

This is the completion call to http\Client::once().