From: Michael Wallner Date: Thu, 18 Aug 2016 20:37:02 +0000 (+0200) Subject: thanks git X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=3bf080fbfef8496240a6d42d4a2d4c08c04cf8fd;p=mdref%2Fmdref-http thanks git --- diff --git a/http/Client.md b/http/Client.md index ba66dc0..639af26 100644 --- a/http/Client.md +++ b/http/Client.md @@ -4,17 +4,17 @@ The HTTP client. See http\Client\Curl's [options](http/Client/Curl#Options:) whi ## Constants: -* DEBUG_INFO +* DEBUG_INFO Debug callback's $data contains human readable text. -* DEBUG_IN +* DEBUG_IN Debug callback's $data contains data received. -* DEBUG_OUT +* DEBUG_OUT Debug callback's $data contains data sent. -* DEBUG_HEADER +* DEBUG_HEADER Debug callback's $data contains headers. -* DEBUG_BODY +* DEBUG_BODY Debug callback's $data contains a body part. -* DEBUG_SSL +* DEBUG_SSL Debug callback's $data contains SSL data. ## Properties: diff --git a/http/Client/Curl.md b/http/Client/Curl.md index 12fc7f9..eefb02d 100644 --- a/http/Client/Curl.md +++ b/http/Client/Curl.md @@ -6,12 +6,12 @@ The http\Client\Curl namespace holds option value constants specific to the curl ### Features and Versions: -* FEATURES - Bitmask of available libcurl features. +* 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". +* 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 @@ -126,7 +126,7 @@ The option names used here are more or less derived from the corresponding CURLO 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 +* 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 @@ -182,7 +182,7 @@ The option names used here are more or less derived from the corresponding CURLO 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 +* bool $path_as_is Do *not* squash sequences of "/../" or "/./" that may exist in the URL's path. ### Authentication @@ -191,7 +191,7 @@ The option names used here are more or less derived from the corresponding CURLO user:password * int $httpauthtype See http\Client\Curl\AUTH_* constants. -* string $service_name +* 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 @@ -300,7 +300,7 @@ The option names used here are more or less derived from the corresponding CURLO 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 + * 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: @@ -323,11 +323,11 @@ The option names used here are more or less derived from the corresponding CURLO 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 +* 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 +* bool $share_cookies Whether to let the client share cookies between requests. -* bool $share_ssl +* bool $share_ssl Whether to let the client share SSL/TLS sessions between requests. Available if libcurl is v7.23.0 or more recent. diff --git a/http/Client/Curl/Features.md b/http/Client/Curl/Features.md index 06fbd85..d8c497b 100644 --- a/http/Client/Curl/Features.md +++ b/http/Client/Curl/Features.md @@ -7,39 +7,39 @@ CURL feature constants. ## Constants: -* ASYNCHDNS +* ASYNCHDNS Whether libcurl supports asynchronous domain name resolution. -* GSSAPI +* GSSAPI Whether libcurl supports the Generic Security Services Application Program Interface. Available if libcurl is v7.38.0 or more recent. -* GSSNEGOTIATE +* GSSNEGOTIATE Whether libcurl supports HTTP Generic Security Services negotiation. -* HTTP2 +* HTTP2 Whether libcurl supports the HTTP/2 protocol. Available if libcurl is v7.33.0 or more recent. -* IDN +* IDN Whether libcurl supports international domain names. -* IPV6 +* IPV6 Whether libcurl supports IPv6. -* KERBEROS4 +* KERBEROS4 Whether libcurl supports the old Kerberos protocol. -* KERBEROS5 +* KERBEROS5 Whether libcurl supports the more recent Kerberos v5 protocol. Available if libcurl is v7.40.0 or more recent. -* LARGEFILE +* LARGEFILE Whether libcurl supports large files. -* LIBZ +* LIBZ Whether libcurl supports gzip/deflate compression. -* NTLM +* NTLM Whether libcurl supports the NT Lan Manager authentication. -* NTLM_WB +* NTLM_WB Whether libcurl supports NTLM delegation to a winbind helper. Available if libcurl is v7.22.0 or more recent. -* PSL +* PSL Whether libcurl supports the Public Suffix List for cookie host handling. Available if libcurl is v7.47.0 or more recent. -* SPNEGO +* SPNEGO Whether libcurl supports the Simple and Protected GSSAPI Negotiation Mechanism. -* SSL +* SSL Whether libcurl supports SSL/TLS protocols. -* SSPI +* SSPI Whether libcurl supports the Security Support Provider Interface. -* TLSAUTH_SRP +* TLSAUTH_SRP Whether libcurl supports TLS Secure Remote Password authentication. Available if libcurl is v7.21.4 or more recent. -* UNIX_SOCKETS +* UNIX_SOCKETS Whether libcurl supports connections to unix sockets. Available if libcurl is v7.40.0 or more recent. diff --git a/http/Client/Curl/User.md b/http/Client/Curl/User.md index 7eb455b..19249a7 100644 --- a/http/Client/Curl/User.md +++ b/http/Client/Curl/User.md @@ -2,18 +2,18 @@ Interface to an user event loop implementation for http\Client::configure()'s $use_eventloop option. -> ***NOTE:*** +> ***NOTE:*** > This interface was added in v2.6.0, resp. v3.1.0. ## Constants: -* POLL_NONE +* POLL_NONE No action. -* POLL_IN +* POLL_IN Poll for read readiness. -* POLL_OUT +* POLL_OUT Poll for write readiness. -* POLL_INOUT +* POLL_INOUT Poll for read/write readiness. -* POLL_REMOVE +* POLL_REMOVE Stop polling for activity on this descriptor. diff --git a/http/Client/Curl/User/init.md b/http/Client/Curl/User/init.md index 45afb55..ba98e97 100644 --- a/http/Client/Curl/User/init.md +++ b/http/Client/Curl/User/init.md @@ -5,9 +5,9 @@ Initialize the event loop. ## Params: -* callable $run as function(http\Client $c, resource $s = null, int $action = http\Client\Curl\User::POLL_NONE) : int +* callable $run as function(http\Client $c, resource $s = null, int $action = http\Client\Curl\User::POLL_NONE) : int Internal callback returning the number of unfinished requests pending. -> ***NOTE***: +> ***NOTE***: > The callback should be run when a timeout occurs or a watched socket needs action. diff --git a/http/Client/Curl/User/once.md b/http/Client/Curl/User/once.md index 0c3aa58..4b620bb 100644 --- a/http/Client/Curl/User/once.md +++ b/http/Client/Curl/User/once.md @@ -2,7 +2,7 @@ Run the loop as long as it does not block. -> ***NOTE:*** +> ***NOTE:*** > This method is called by http\Client::once(), so it does not need to have an actual implementation if http\Client::once() is never called. diff --git a/http/Client/Curl/User/send.md b/http/Client/Curl/User/send.md index 9bd3c35..dc07de9 100644 --- a/http/Client/Curl/User/send.md +++ b/http/Client/Curl/User/send.md @@ -2,7 +2,7 @@ Run the loop. -> ***NOTE:*** +> ***NOTE:*** > This method is called by http\Client::send(), so it does not need to have an actual implementation if http\Client::send() is never called. ## Params: diff --git a/http/Client/Curl/User/socket.md b/http/Client/Curl/User/socket.md index 4ef660d..e5b3498 100644 --- a/http/Client/Curl/User/socket.md +++ b/http/Client/Curl/User/socket.md @@ -4,7 +4,7 @@ Register (or deregister) a socket watcher. ## Params: -* resource $socket +* resource $socket The socket descriptor to watch. -* int $poll +* int $poll http\Client\Curl\User::POLL_* constant. diff --git a/http/Client/Curl/User/timer.md b/http/Client/Curl/User/timer.md index 2205799..34984d8 100644 --- a/http/Client/Curl/User/timer.md +++ b/http/Client/Curl/User/timer.md @@ -4,5 +4,5 @@ Register a timeout watcher. ## Params: -* int $timeout_ms +* int $timeout_ms Desired maximum timeout in milliseconds. diff --git a/http/Client/Curl/User/wait.md b/http/Client/Curl/User/wait.md index 06ee274..6a5fabf 100644 --- a/http/Client/Curl/User/wait.md +++ b/http/Client/Curl/User/wait.md @@ -2,10 +2,10 @@ Wait/poll/select (block the loop) until events fire. -> ***NOTE:*** +> ***NOTE:*** > This method is called by http\Client::wait(), so it does not need to have an actual implementation if http\Client::wait() is never called. ## Params: -* Optional int $timeout_ms = null +* Optional int $timeout_ms = null Block for at most this milliseconds. diff --git a/http/Client/Curl/Versions.md b/http/Client/Curl/Versions.md index 794fe2e..0ddbd2e 100644 --- a/http/Client/Curl/Versions.md +++ b/http/Client/Curl/Versions.md @@ -7,13 +7,13 @@ CURL version constants. ## Constants: -* CURL +* CURL Version string of libcurl, e.g. "7.50.0". -* SSL +* SSL Version string of the SSL/TLS library, e.g. "OpenSSL/1.0.2h". -* LIBZ +* LIBZ Version string of the zlib compression library, e.g. "1.2.8". -* ARES +* ARES Version string of the c-ares library, e.g. "1.11.0". -* IDN +* IDN Version string of the IDN library, e.g. "1.32". diff --git a/http/Client/setDebug.md b/http/Client/setDebug.md index 9ca4ba8..16d5cf1 100644 --- a/http/Client/setDebug.md +++ b/http/Client/setDebug.md @@ -7,7 +7,7 @@ Set client debugging callback. ## Params: -* callable $callback as function(http\Client $c, http\Client\Request $r, int $type, string $data) +* callable $callback as function(http\Client $c, http\Client\Request $r, int $type, string $data) The debug callback. For $type see http\Client::DEBUG_* constants. ## Returns: diff --git a/http/Params.md b/http/Params.md index e1679b5..4349769 100644 --- a/http/Params.md +++ b/http/Params.md @@ -22,9 +22,9 @@ Parse, interpret and compose HTTP (header) parameters. Parse sub dimensions indicated by square brackets. * PARSE_QUERY Parse URL querystring (same as http\Params::PARSE_URLENCODED|http\Params::PARSE_DIMENSION). -* PARSE_RFC5987 +* PARSE_RFC5987 Parse [RFC5987](http://tools.ietf.org/html/rfc5987) style encoded character set and language information embedded in HTTP header params. -* PARSE_RFC5988 +* PARSE_RFC5988 Parse [RFC5988](http://tools.ietf.org/html/rfc5988) (Web Linking) tags of Link headers. ## Properties: diff --git a/http/Url/__construct.md b/http/Url/__construct.md index cb1f771..ee3ec33 100644 --- a/http/Url/__construct.md +++ b/http/Url/__construct.md @@ -13,7 +13,7 @@ See also http\Env\Url. Initial URL parts. Either an array, object, http\Url instance or string to parse. * Optional mixed $new_url = NULL Overriding URL parts. Either an array, object, http\Url instance or string to parse. -* Optional int $flags = 0 +* Optional int $flags = 0 The modus operandi of constructing the url. See http\Url constants. ## Throws: