[sr-dev] git:master:cffc1159: http_async_client: small notes on $http_req(timeout) usage

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: cffc1159ce4cfc67f77c51c634f7d73c96e1371a
URL: https://github.com/kamailio/kamailio/commit/cffc1159ce4cfc67f77c51c634f7d73c96e1371a

Author: Igor Olhovskiy <IgorOlhovskiy at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2019-03-29T10:11:06+01:00

http_async_client: small notes on $http_req(timeout) usage

---

Modified: src/modules/http_async_client/README
Modified: src/modules/http_async_client/doc/http_async_client_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/cffc1159ce4cfc67f77c51c634f7d73c96e1371a.diff
Patch: https://github.com/kamailio/kamailio/commit/cffc1159ce4cfc67f77c51c634f7d73c96e1371a.patch

---

diff --git a/src/modules/http_async_client/README b/src/modules/http_async_client/README
index 1f4540b69e..45fe6f0e5f 100644
--- a/src/modules/http_async_client/README
+++ b/src/modules/http_async_client/README
@@ -425,7 +425,7 @@ xlog("L_INFO", "received reply for query $http_req_id\n");
      * method: sets the HTTP method: either "GET", "POST", "PUT" or
        "DELETE" (these are the supported methods). (Note: if the method is
        not set, curl will use GET, or POST if a body is specified)
-     * timeout: sets the HTTP timeout
+     * timeout: sets the HTTP timeout (Note, this timeout should be normally less, than tm.fr_timer timeout, cause transaction timeout has a higher priority over HTTP timeout)
      * tls_client_cert: sets the client certificate to use
      * tls_client_key: sets the client certificate key to use
      * tls_ca_path: sets the CA certificate path to use
diff --git a/src/modules/http_async_client/doc/http_async_client_admin.xml b/src/modules/http_async_client/doc/http_async_client_admin.xml
index 5a050bf424..e6219e96ec 100644
--- a/src/modules/http_async_client/doc/http_async_client_admin.xml
+++ b/src/modules/http_async_client/doc/http_async_client_admin.xml
@@ -435,12 +435,12 @@ xlog("L_INFO", "received reply for query $http_req_id\n");
 		<listitem><para><emphasis>hdr</emphasis>: sets/modifies/removes a HTTP header. N.B.: setting this variable multiple times will add several headers to the query.</para></listitem>
 		<listitem><para><emphasis>body</emphasis>: sets/modifies/removes the request body</para></listitem>
 		<listitem><para><emphasis>method</emphasis>: sets the HTTP method: either "GET", "POST", "PUT" or "DELETE" (these are the supported methods). (Note: if the method is not set, curl will use GET, or POST if a body is specified)</para></listitem>
-		<listitem><para><emphasis>timeout</emphasis>: sets the HTTP timeout</para></listitem>
+		<listitem><para><emphasis>timeout</emphasis>: sets the HTTP timeout. (Note, this timeout should be normally less, than <literal>tm.fr_timer</literal> timeout, cause transaction timeout has a higher priority over HTTP timeout)</para></listitem>
 		<listitem><para><emphasis>tls_client_cert</emphasis>: sets the client certificate to use</para></listitem>
 		<listitem><para><emphasis>tls_client_key</emphasis>: sets the client certificate key to use</para></listitem>
 		<listitem><para><emphasis>tls_ca_path</emphasis>: sets the CA certificate path to use</para></listitem>
 		<listitem><para><emphasis>authmethod</emphasis>: 
-			Sets the preferred authentication mode for HTTP/HTTPS requests. The value is a bitmap
+			Sets the preferred authentication mode for HTTP/HTTPS requests. The value is a bitmap<literal>
                         and multiple methods can be used. Note that in this case, the CURL library will make an
                         extra request to discover server-supported authentication methods. You may want to use
                         a specific value.