Class to handle multiple HTTP requests. More...

Inheritance diagram for MultiHttpClient:

Collaboration diagram for MultiHttpClient:

[legend]

Public Member Functions
	__construct (array $options)

	__destruct ()

	run (array $req, array $opts=[])
	Execute an HTTP(S) request.

	runMulti (array $reqs, array $opts=[])
	Execute a set of HTTP(S) requests.

	setLogger (LoggerInterface $logger)
	Register a logger.

Public Attributes
const	TIMEOUT_ACCURACY_FACTOR = 0.1

Protected Member Functions
	getCurlHandle (array &$req, array $opts=[])

	getCurlMulti ()

	isCurlEnabled ()
	Determines if the curl extension is available.

Protected Attributes
string null	$caBundlePath
	SSL certificates path.

float	$connTimeout = 10

LoggerInterface	$logger

int	$maxConnsPerHost = 50

resource	$multiHandle = null

string null	$proxy
	proxy

float	$reqTimeout = 300

bool	$usePipelining = false

string	$userAgent = 'wikimedia/multi-http-client v1.0'

Private Member Functions
	getSelectTimeout ( $opts)
	Get a suitable select timeout for the given options.

	normalizeRequests (array &$reqs)
	Normalize request information.

	runMultiCurl (array $reqs, array $opts=[])
	Execute a set of HTTP(S) requests concurrently.

	runMultiHttp (array $reqs, array $opts=[])
	Execute a set of HTTP(S) requests sequentially.

Detailed Description

Class to handle multiple HTTP requests.

If curl is available, requests will be made concurrently. Otherwise, they will be made serially.

HTTP request maps are arrays that use the following format:

method : GET/HEAD/PUT/POST/DELETE
url : HTTP/HTTPS URL
query : <query parameter field/value associative array> (uses RFC 3986)
headers : <header name/value associative array>
body : source to get the HTTP request body from; this can simply be a string (always), a resource for PUT requests, and a field/value array for POST request; array bodies are encoded as multipart/form-data and strings use application/x-www-form-urlencoded (headers sent automatically)
stream : resource to stream the HTTP response body to
proxy : HTTP proxy to use
flags : map of boolean flags which supports:
- relayResponseHeaders : write out header via header() Request maps can use integer index 0 instead of 'method' and 1 instead of 'url'.

Since: 1.23

Definition at line 52 of file MultiHttpClient.php.

Constructor & Destructor Documentation

◆ __construct()

MultiHttpClient::__construct ( array $options )

Parameters

array

$options

connTimeout : default connection timeout (seconds)
reqTimeout : default request timeout (seconds)
proxy : HTTP proxy to use
usePipelining : whether to use HTTP pipelining if possible (for all hosts)
maxConnsPerHost : maximum number of concurrent connections (per host)
userAgent : The User-Agent header value to send
logger : a \Psr\Log\LoggerInterface instance for debug logging
caBundlePath : path to specific Certificate Authority bundle (if any)

Exceptions

Exception

Definition at line 89 of file MultiHttpClient.php.

References $options, and and().

◆ __destruct()

MultiHttpClient::__destruct ( )

Definition at line 606 of file MultiHttpClient.php.

References and().

Member Function Documentation

◆ getCurlHandle()

MultiHttpClient::getCurlHandle	(	array &	$req,
		array	$opts = [] )

protected

Parameters

array	&$req	HTTP request map
array	$opts	connTimeout : default connection timeout reqTimeout : default request timeout

Returns: resource

Exceptions

Exception

Definition at line 299 of file MultiHttpClient.php.

References $data, $header, $matches, $name, $query, $req, $userAgent, $value, and(), and list.

Referenced by runMultiCurl().

◆ getCurlMulti()

MultiHttpClient::getCurlMulti ( )

protected

Returns: resource

Exceptions

Exception

Definition at line 437 of file MultiHttpClient.php.

References $multiHandle, and and().

Referenced by runMultiCurl().

◆ getSelectTimeout()

MultiHttpClient::getSelectTimeout ( $opts )

private

Get a suitable select timeout for the given options.

Parameters

array $opts

Returns: float

Definition at line 581 of file MultiHttpClient.php.

References $connTimeout, $reqTimeout, and(), e, and TIMEOUT_ACCURACY_FACTOR.

Referenced by runMultiCurl().

◆ isCurlEnabled()

MultiHttpClient::isCurlEnabled ( )

protected

Determines if the curl extension is available.

Returns: bool true if curl is available, false otherwise.

Definition at line 176 of file MultiHttpClient.php.

References and().

Referenced by runMulti().

◆ normalizeRequests()

MultiHttpClient::normalizeRequests ( array & $reqs )

private

Normalize request information.

Parameters

array $reqs the requests to normalize

Definition at line 536 of file MultiHttpClient.php.

References $req, $value, and and().

Referenced by runMulti().

◆ run()

MultiHttpClient::run	(	array	$req,
		array	$opts = [] )

Execute an HTTP(S) request.

This method returns a response map of:

code : HTTP response code or 0 if there was a serious error
reason : HTTP response reason (empty if there was a serious error)
headers : <header name/value associative array>
body : HTTP response body or resource (if "stream" was set)
error : Any error string The map also stores integer-indexed copies of these values. This lets callers do:
list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $http->run( $req );

list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11

$req
this hook is for auditing only $req
Definition hooks.txt:979

Parameters

array $req HTTP request array

array $opts
connTimeout : connection timeout per request (seconds)
reqTimeout : post-connection timeout per request (seconds)
Returns
array Response array for request

Definition at line 129 of file MultiHttpClient.php.

References runMulti().

◆ runMulti()

MultiHttpClient::runMulti	(	array	$reqs,
		array	$opts = [] )

Execute a set of HTTP(S) requests.

If curl is available, requests will be made concurrently. Otherwise, they will be made serially.

The maps are returned by this method with the 'response' field set to a map of:

code : HTTP response code or 0 if there was a serious error
reason : HTTP response reason (empty if there was a serious error)
headers : <header name/value associative array>
body : HTTP response body or resource (if "stream" was set)
error : Any error string The map also stores integer-indexed copies of these values. This lets callers do:
list( $rcode, $rdesc, $rhdrs, $rbody, $rerr ) = $req['response'];

All headers in the 'headers' field are normalized to use lower case names. This is true for the request headers and the response headers. Integer-indexed method/URL entries will also be changed to use the corresponding string keys.

Parameters

array	$reqs	Map of HTTP request arrays
array	$opts	connTimeout : connection timeout per request (seconds) reqTimeout : post-connection timeout per request (seconds) usePipelining : whether to use HTTP pipelining if possible maxConnsPerHost : maximum number of concurrent connections (per host)

Returns: array $reqs With response array populated for each

Exceptions

Exception

Definition at line 162 of file MultiHttpClient.php.

References isCurlEnabled(), normalizeRequests(), runMultiCurl(), and runMultiHttp().

Referenced by run().

◆ runMultiCurl()

MultiHttpClient::runMultiCurl	(	array	$reqs,
		array	$opts = [] )

private

Execute a set of HTTP(S) requests concurrently.

See also: MultiHttpClient::runMulti()

Parameters

array	$reqs	Map of HTTP request arrays
array	$opts	connTimeout : connection timeout per request (seconds) reqTimeout : post-connection timeout per request (seconds) usePipelining : whether to use HTTP pipelining if possible maxConnsPerHost : maximum number of concurrent connections (per host)

Returns: array $reqs With response array populated for each

Exceptions

Exception

Definition at line 196 of file MultiHttpClient.php.

References $batch, $req, and(), getCurlHandle(), getCurlMulti(), and getSelectTimeout().

Referenced by runMulti().

◆ runMultiHttp()

MultiHttpClient::runMultiHttp	(	array	$reqs,
		array	$opts = [] )

private

Execute a set of HTTP(S) requests sequentially.

See also: MultiHttpClient::runMulti()

Todo: Remove dependency on MediaWikiServices: use a separate HTTP client library or copy code from PhpHttpRequest

Parameters

array	$reqs	Map of HTTP request arrays
array	$opts	connTimeout : connection timeout per request (seconds) reqTimeout : post-connection timeout per request (seconds)

Returns: array $reqs With response array populated for each

Exceptions

Exception

Definition at line 464 of file MultiHttpClient.php.

References $caBundlePath, $connTimeout, $logger, $proxy, $query, $req, $reqTimeout, $userAgent, and and().

Referenced by runMulti().

◆ setLogger()

MultiHttpClient::setLogger ( LoggerInterface $logger )

Register a logger.

Parameters

LoggerInterface $logger

Definition at line 602 of file MultiHttpClient.php.

References $logger.

Member Data Documentation

◆ $caBundlePath

string null MultiHttpClient::$caBundlePath

protected

SSL certificates path.

Definition at line 56 of file MultiHttpClient.php.

Referenced by runMultiHttp().

◆ $connTimeout

float MultiHttpClient::$connTimeout = 10

protected

Definition at line 58 of file MultiHttpClient.php.

Referenced by getSelectTimeout(), and runMultiHttp().

◆ $logger

LoggerInterface MultiHttpClient::$logger

protected

Definition at line 70 of file MultiHttpClient.php.

Referenced by runMultiHttp(), and setLogger().

◆ $maxConnsPerHost

int MultiHttpClient::$maxConnsPerHost = 50

protected

Definition at line 64 of file MultiHttpClient.php.

◆ $multiHandle

resource MultiHttpClient::$multiHandle = null

protected

Definition at line 54 of file MultiHttpClient.php.

Referenced by getCurlMulti().

◆ $proxy

string null MultiHttpClient::$proxy

protected

proxy

Definition at line 66 of file MultiHttpClient.php.

Referenced by runMultiHttp().

◆ $reqTimeout

float MultiHttpClient::$reqTimeout = 300

protected

Definition at line 60 of file MultiHttpClient.php.

Referenced by getSelectTimeout(), and runMultiHttp().

◆ $usePipelining

bool MultiHttpClient::$usePipelining = false

protected

Definition at line 62 of file MultiHttpClient.php.

◆ $userAgent

string MultiHttpClient::$userAgent = 'wikimedia/multi-http-client v1.0'

protected

Definition at line 68 of file MultiHttpClient.php.

Referenced by getCurlHandle(), and runMultiHttp().

◆ TIMEOUT_ACCURACY_FACTOR

const MultiHttpClient::TIMEOUT_ACCURACY_FACTOR = 0.1

Definition at line 75 of file MultiHttpClient.php.

Referenced by getSelectTimeout().

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

includes/libs/MultiHttpClient.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ getCurlHandle()

◆ getCurlMulti()

◆ getSelectTimeout()

◆ isCurlEnabled()

◆ normalizeRequests()

◆ run()

◆ runMulti()

◆ runMultiCurl()

◆ runMultiHttp()

◆ setLogger()

Member Data Documentation

◆ $caBundlePath

◆ $connTimeout

◆ $logger

◆ $maxConnsPerHost

◆ $multiHandle

◆ $proxy

◆ $reqTimeout

◆ $usePipelining

◆ $userAgent

◆ TIMEOUT_ACCURACY_FACTOR