The http\Client\Curl namespace holds option value constants specific to the curl driver of the http\Client.
-## Changelog
+## Constants:
-Version | Change
---------|-------
-2.1.0 | Added $dns_interface, $dns_local_ip4, $dns_local_ip6 options, $expect_100_timeout.
-2.1.2 | Added request option constants:<br> http\Client\Curl::POSTREDIR_303,<br> http\Client\Curl::AUTH_SPNEGO,<br> http\Client\Curl::SSL_VERSION_TLSv1_0,<br> http\Client\Curl::SSL_VERSION_TLSv1_1 and<br> http\Client\Curl::SSL_VERSION_TLSv1_2
+### Features and Versions:
-## Constants:
+* FEATURES
+ Bitmask of available libcurl features.
+ See http\Client\Curl\Features namespace.
+* VERSIONS
+ List of library versions of or linked into libcurl,
+ e.g. "libcurl/7.50.0 OpenSSL/1.0.2h zlib/1.2.8 libidn/1.32 nghttp2/1.12.0".
+ See http\Client\Curl\Versions namespace.
### HTTP Protocol Version
Use HTTP/1.0 protocol version.
* HTTP_VERSION_1_1
Use HTTP/1.1 protocol version.
+* HTTP_VERSION_2_0
+ Use HTTP/2 protocol version. Available if libcurl is v7.33.0 or more recent and was built with nghttp2 support.
* HTTP_VERSION_ANY
Use any HTTP protocol version.
* SSL_VERSION_ANY
Use any encryption.
+### TLS Auth Types
+
+* TLS_AUTH_SRP
+ Use TLS SRP authentication. Available if libcurl is v7.21.4 or more recent and was built with gnutls or openssl with TLS-SRP support.
+
### DNS IP Version
* IPRESOLVE_V4
### HTTP
* int $protocol
- The HTTP protocol version. See http\Client\Curl::HTTP_VERSION_* constants.
+ The HTTP protocol version. See http\Client\Curl\HTTP_VERSION_* constants.
### Proxies
* string $proxyhost
The hostname of the proxy.
* int $proxytype
- See http\Client\Curl::PROXY_* constants.
+ See http\Client\Curl\PROXY_* constants.
* int $proxyport
The port number of the proxy.
* string $proxyauth
user:password
* int $proxyauthtype
- See http\Client\Curl::AUTH_* constants.
+ See http\Client\Curl\AUTH_* constants.
* bool $proxytunnel
Tunnel all operations through the proxy.
* string $noproxy
Comma separated list of hosts where no proxy should be used. Available if libcurl is v7.19.4 or more recent.
+* array $proxyheader
+ List of key/value pairs of headers which should only be sent to a proxy. Available if libcurl is v7.37.0 or more recent.
+* string $proxy_service_name
+ Proxy service name. The default service name is "HTTP" for HTTP based proxies and "rcmd" for SOCKS5. Available if libcurl is v7.43.0 or more recent and has built-in GSSAPI support.
### DNS
* int $dns_cache_timeout
Resolved hosts will be kept fot this number of seconds.
* int $ipresolve
- See http\Client\Curl::IPRESOLVE_* constants.
+ See http\Client\Curl\IPRESOLVE_* constants.
* array $resolve
A list of HOST:PORT:ADDRESS mappings which pre-populate the DNS cache. Available if libcurl is v7.21.3 or more recent.
* string $dns_servers
Comma separated list of custom DNS servers of the form HOST[:PORT]. Available if libcurl is v7.24.0 or more recent and has built-in c-ares support.
-* string $dns_interface
+* string $dns_interface
The name of the network interface ***name*** that the DNS resolver should bind to. Available if libcurl is v7.33.0 or more recent and has built-in c-ares support.
-* string $dns_local_ip4
+* string $dns_local_ip4
The local IPv4 ***address*** that the resolver should bind to. Available if libcurl is v7.33.0 or more recent and has built-in c-ares support.
-* string $dns_local_ip6
+* string $dns_local_ip6
The local IPv6 ***address*** that the resolver should bind to. Available if libcurl is v7.33.0 or more recent and has built-in c-ares support.
### Limits
* int $low_speed_limit
Minimum speed in bytes per second.
-* int $low_speed_time
+* int $low_speed_time
Maximum time in seconds the transfer can be below $low_speed_limit before cancelling.
* int $maxfilesize
Maximum download size.
Interval in seconds to wait between sending keepalive probes. Available if libcurl is v7.25.0 or more recent.
* bool $tcp_nodelay
Disable [Nagle's algotrithm](http://tools.ietf.org/html/rfc896).
-
+* string $unix_socket_path
+ Connect to the webserver listening at $unix_socket_path instead of opening a TCP connection to it. Available if libcurl is v7.40.0 or more recent.
+* bool $path_as_is
+ Do *not* squash sequences of "/../" or "/./" that may exist in the URL's path.
+
### Authentication
* string $httpauth
user:password
* int $httpauthtype
- See http\Client\Curl::AUTH_* constants.
+ See http\Client\Curl\AUTH_* constants.
+* string $service_name
+ The name of the service for DIGEST-MD5, SPNEGO and KERBEROS5 authentication mechanisms. The default service name is "HTTP". Available if libcurl is v7.43.0 or more recent.
### Redirection
* bool $unrestricted_auth
Whether to keep sending authentication credentials on redirects to different hosts.
* int $postredir
- See http\Client\Curl::POSTREDIR_* constants. Available if libcurl is v7.19.1 or more recent.
+ See http\Client\Curl\POSTREDIR_* constants. Available if libcurl is v7.19.1 or more recent.
### Retries
* bool $autoreferer
Whether to automatically send referers.
* string $useragent
- Custom User-Agent header.
+ Custom User-Agent header. Setting this option to NULL will use the default user agent, use the empty string to prevent this header being sent at all.
* string $etag
Custom ETag.
* bool $compress
* string $engine
Crypto engine to use for the private key.
* int $version
- See http\Client\Curl::SSL_VERSION_* constants.
+ See http\Client\Curl\SSL_VERSION_* constants.
* bool $verifypeer
Whether to apply peer verification.
* bool $verifyhost
File with the concatenation of CRL in PEM format. Available if libcurl was built with OpenSSL support.
* bool $certinfo
Enable gathering of SSL certificate chain information. Available if libcurl is v7.19.1 or more recent.
+ * string $pinned_publickey
+ File with a public key to pin. Available if libcurl is v7.39.0 or more recent.
+ * int $tlsauthtype
+ TLS_AUTH_* constant. Available if libcurl is v7.21.4 or more recent.
+ * string $tlsauthuser
+ TLS-SRP username. Available if libcurl is v7.21.4 or more recent.
+ * string $lsauthpass
+ TLS-SRP password. Available if libcurl is v7.21.4 or more recent.
+ * bool $verifystatus
+ Enable OCSP. Available if libcurl is v7.41.0 or more recent and was built with OpenSSL, GnuTLS or NSS support.
+ * bool $falsestart
+ Whether false start should be used during the TLS handshake. Available if libcurl is v7.42.0 or more recent and was built with NSS or SecureTransport support.
+
+## Configuration:
+
+* int $maxconnects
+ Size of the connection cache.
+* int $max_host_connections
+ Maximum number of connections to a single host. Available if libcurl is v7.30.0 or more recent.
+* int $max_pipeline_length
+ Maximum number of requests in a pipeline. Available if libcurl is v7.30.0 or more recent.
+* int $max_total_connections
+ Maximum number of simultaneous open connections of this client. Available if libcurl is v7.30.0 or more recent.
+* bool $pipelining
+ Whether to enable HTTP/1.1 pipelining.
+* int $chunk_length_penalty_size
+ Chunk length threshold for pipelining; no more requests on this pipeline if exceeded. Available if libcurl is v7.30.0 or more recent.
+* int $content_length_penalty_size
+ Size threshold for pipelining; no more requests on this pipeline if exceeded. Available if libcurl is v7.30.0 or more recent.
+* array $pipelining_server_bl
+ Simple list of server software names to blacklist for pipelining. Available if libcurl is v7.30.0 or more recent.
+* array $pipelining_site_bl
+ Simple list of server host names to blacklist for pipelining. Available if libcurl is v7.30.0 or more recent.
+* mixed $use_eventloop
+ Whether to use an event loop. This option accepts either bool, whether to use
+ the internal event loop, or an instance of an http\Client\Curl\User implementation.
+ The internal event loop is only available if pecl/http was built with libevent support.
+* bool $share_cookies
+ Whether to let the client share cookies between requests.
+* bool $share_ssl
+ Whether to let the client share SSL/TLS sessions between requests. Available if libcurl is v7.23.0 or more recent.
projects / mdref / mdref-http / blobdiff