Skip to content

Commit

Permalink
http_async_client: docs - removed trailing spaces
Browse files Browse the repository at this point in the history
  • Loading branch information
miconda committed Nov 13, 2023
1 parent 288fe44 commit 7019d4d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 17 deletions.
6 changes: 3 additions & 3 deletions src/modules/http_async_client/doc/http_async_client.xml
Expand Up @@ -44,8 +44,8 @@
</copyright>
</bookinfo>
<toc></toc>

<xi:include href="http_async_client_admin.xml"/>


</book>
28 changes: 14 additions & 14 deletions src/modules/http_async_client/doc/http_async_client_admin.xml
Expand Up @@ -10,9 +10,9 @@
<!-- Module User's Guide -->

<chapter>

<title>&adminguide;</title>

<section>
<title>Overview</title>
<para>
Expand Down Expand Up @@ -237,10 +237,10 @@ modparam("http_async_client", "curl_follow_redirect", 1)
</para></listitem>
</itemizedlist>
<para>
<emphasis>Note:</emphasis>
if this module is used in conjunction with another module using libcurl (http_client, utils, xcap, xcap_client),
<emphasis>Note:</emphasis>
if this module is used in conjunction with another module using libcurl (http_client, utils, xcap, xcap_client),
it must be loaded as first one for this parameter to have effect, otherwise curl will likely use the system memory allocator by default.
On the other hand if the module is loaded before any other module using libcurl, all the modules will use the memory manager specified
On the other hand if the module is loaded before any other module using libcurl, all the modules will use the memory manager specified
by this parameter.
</para>
</para>
Expand Down Expand Up @@ -392,9 +392,9 @@ modparam("http_async_client", "tcp_ka_interval", 120)
Sends HTTP(S) request asynchronously to the URL given in <quote>url</quote> parameter, which is a string that may contain pseudo variables.
</para>
<para>
Parameter <quote>route_name</quote> defines the route to be executed upon reception of HTTP reply, on error or on timeout.
Parameter <quote>route_name</quote> defines the route to be executed upon reception of HTTP reply, on error or on timeout.
If a transaction exists before calling <emphasis>http_async_query()</emphasis>, it will be paused and resumed in this route, while the routing script execution will be stopped.
If executed in a transactionless context, or if <emphasis>$http_req(suspend)</emphasis> is used not to suspend the transaction, the routing script execution will
If executed in a transactionless context, or if <emphasis>$http_req(suspend)</emphasis> is used not to suspend the transaction, the routing script execution will
continue and the query result will be available in <quote>route_name</quote>.
</para>
<para>
Expand Down Expand Up @@ -440,7 +440,7 @@ route[HTTP_REPLY] {
<title><literal>$http_req_id</literal> variable usage</title>
<programlisting format="linespecific">
...
$http_req(suspend) = 0;
$http_req(suspend) = 0;

http_async_query("https://example.com/test.php", "HTTP_REPLY");

Expand All @@ -463,7 +463,7 @@ xlog("L_INFO", "received reply for query $http_req_id\n");
<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>:
<listitem><para><emphasis>authmethod</emphasis>:
Sets the preferred authentication mode for HTTP/HTTPS requests. The value is a bitmap
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
Expand All @@ -478,7 +478,7 @@ xlog("L_INFO", "received reply for query $http_req_id\n");
<listitem><para>16 - HTTP Digest with IE flavour</para></listitem>
</itemizedlist>
Default value is 3 - BASIC and Digest authentication.
</para>
</para>
</para></listitem>
<listitem><para><emphasis>username</emphasis>: sets the username to use for authenticated requests</para></listitem>
<listitem><para><emphasis>password</emphasis>: sets the password to use for authenticated requests</para></listitem>
Expand Down Expand Up @@ -518,16 +518,16 @@ http_async_query("https://example.com/test.php", "HTTP_REPLY");
<emphasis>$http_rr</emphasis>: http reason phrase
</para></listitem>
<listitem><para>
<emphasis>$http_hdr(Name)</emphasis>: value of the <emphasis>Name</emphasis> header (the <emphasis>$(http_hdr(Name)[N])</emphasis> syntax can also be used, check the SIP $hdr() PV documentation for details)
<emphasis>$http_hdr(Name)</emphasis>: value of the <emphasis>Name</emphasis> header (the <emphasis>$(http_hdr(Name)[N])</emphasis> syntax can also be used, check the SIP $hdr() PV documentation for details)
</para></listitem>
<listitem><para>
<emphasis>$http_mb</emphasis> and <emphasis>$http_ml</emphasis>: HTTP response buffer (including headers) and length
<emphasis>$http_mb</emphasis> and <emphasis>$http_ml</emphasis>: HTTP response buffer (including headers) and length
</para></listitem>
<listitem><para>
<emphasis>$http_rb</emphasis> and <emphasis>$http_bs</emphasis>: HTTP response body and body length
</para></listitem>
<listitem><para>
<emphasis>$http_time</emphasis>: provides access to broken-down transfer time in microseconds calculated by cURL (https://curl.se/libcurl/c/curl_easy_getinfo.html).
<emphasis>$http_time</emphasis>: provides access to broken-down transfer time in microseconds calculated by cURL (https://curl.se/libcurl/c/curl_easy_getinfo.html).
<para>
<emphasis>'name'</emphasis> can be:
<itemizedlist>
Expand All @@ -539,7 +539,7 @@ http_async_query("https://example.com/test.php", "HTTP_REPLY");
<listitem><para>starttransfer - time from start until just when the first byte is received</para></listitem>
<listitem><para>redirect - time taken for all redirect steps before the final transfer.</para></listitem>
</itemizedlist>
</para>
</para>
</para></listitem>
</itemizedlist>
</section>
Expand Down

0 comments on commit 7019d4d

Please sign in to comment.