From 219a76af9caefbabe7adfc91594eb4efe752b97d Mon Sep 17 00:00:00 2001 From: Giacomo Vacca Date: Thu, 16 Jun 2016 12:11:52 +0200 Subject: [PATCH] http_async_client minor doc update --- .../doc/http_async_client_admin.xml | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/modules/http_async_client/doc/http_async_client_admin.xml b/modules/http_async_client/doc/http_async_client_admin.xml index dd5b396bb9d..4308117dcf7 100644 --- a/modules/http_async_client/doc/http_async_client_admin.xml +++ b/modules/http_async_client/doc/http_async_client_admin.xml @@ -59,7 +59,7 @@
Parameters
- <varname>workers</varname> (int) + <varname>workers</varname> (integer) Number of worker processes to be started to send HTTP requests and asynchronously handle responses. @@ -79,9 +79,9 @@ modparam("http_async_client", "workers", 2)
- <varname>connection_timeout</varname> (str) + <varname>connection_timeout</varname> (integer) - Defines in milliseconds how long &kamailio; waits for response + Defines in milliseconds how long &kamailio; waits for a response from HTTP server. @@ -99,7 +99,7 @@ modparam("http_async_client", "connection_timeout", 1000)
- <varname>hash_size</varname> (str) + <varname>hash_size</varname> (integer) The size of the hash table internally used to keep the requests. A larger table is much faster but consumes more memory. The hash size @@ -121,7 +121,7 @@ modparam("http_async_client", "hash_size", 1024)
- <varname>tls_version</varname> (int) + <varname>tls_version</varname> (integer) For HTTPS connections, what's the preferred SSL version. http://curl.haxx.se/libcurl/c/CURLOPT_SSLVERSION.html @@ -141,7 +141,7 @@ modparam("http_async_client", "tls_version", 6)
- <varname>tls_verify_host</varname> (int) + <varname>tls_verify_host</varname> (integer) For HTTPS connections, whether the client should verify the server host. http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYHOST.html @@ -161,7 +161,7 @@ modparam("http_async_client", "tls_verify_host", 0)
- <varname>tls_verify_peer</varname> (int) + <varname>tls_verify_peer</varname> (integer) For HTTPS connections, whether the client should verify the server identity. http://curl.haxx.se/libcurl/c/CURLOPT_SSL_VERIFYPEER.html @@ -181,9 +181,9 @@ modparam("http_async_client", "tls_verify_peer", 0)
- <varname>curl_verbose</varname> (int) + <varname>curl_verbose</varname> (integer) - If defined to a non-zero value, extra informations from cURL (request and response headers) + If defined to a non-zero value, extra information from cURL (request and response headers) will be included in the kamailio logs, with LM_INFO priority. @@ -235,9 +235,9 @@ modparam("http_async_client", "memory_manager", "sys")
- <varname>tls_client_cert</varname> (int) + <varname>tls_client_cert</varname> (string) - For HTTPS connections, the file path of the TLS client certificate to be used + For HTTPS connections, the file path of the TLS client certificate to be used. http://curl.haxx.se/libcurl/c/CURLOPT_SSLCERT.html @@ -255,9 +255,9 @@ modparam("http_async_client", "tls_client_cert", "/etc/kamailio/ssl/clientcert.p
- <varname>tls_client_key</varname> (int) + <varname>tls_client_key</varname> (string) - For HTTPS connections, the file path of the TLS client certificate key + For HTTPS connections, the file path of the TLS client certificate key. http://curl.haxx.se/libcurl/c/CURLOPT_SSLKEY.html @@ -275,7 +275,7 @@ modparam("http_async_client", "tls_client_key", "/etc/kamailio/ssl/clientcert.ke
- <varname>tls_ca_path</varname> (int) + <varname>tls_ca_path</varname> (string) The path of the directory holding the CA certificates. http://curl.haxx.se/libcurl/c/CURLOPT_CAPATH.html @@ -306,7 +306,7 @@ modparam("http_async_client", "tls_ca_path", "/etc/kamailio/ssl/ca/") Sends HTTP(S) request asyncronously to the URL given in url parameter, which is a string that may contain pseudo variables. - Unless a specific HTTP method was specified using http_async_set_method(), it defaults to a GET request, or to a POST request if post_data is issued as second argument. + Unless a specific HTTP method was specified using http_async_set_method(), it defaults to a GET request, or to a POST request if post_data is provided as second argument. Parameter post_data, optional, which is sent as the body of the request, may also contain pseudo variables. @@ -545,7 +545,7 @@ http_async_query("https://example.com/test.php", "HTTP_REPLY"); http_set_tls_ca_path(path) - For the next HTTP connection, what CA certificate files to use. + For the next HTTP connection, what CA certificate path to use. Default: the global value set as tls_ca_path module parameter. @@ -576,8 +576,8 @@ http_async_query("https://example.com/test.php", "HTTP_REPLY"); timeout: sets the HTTP timeout (see http_set_timeout()) tls_client_cert: sets the client certificate to use (see http_set_tls_client_cert()) tls_client_key: sets the client certificate key to use (see http_set_tls_client_key()) - tls_ca_path: sets the CA certificate files to use (see http_set_tls_ca_path()) - suspend: if set to 0 doesn't suspend the current transaction before performing the query (see http_async_suspend()) + tls_ca_path: sets the CA certificate path to use (see http_set_tls_ca_path()) + suspend: if set to 0 it doesn't suspend the current transaction before performing the query (see http_async_suspend()) <literal>$http_req(key)</literal> variable usage