Module: kamailio
Branch: master
Commit: 28f223a0a6d0e596fd140231de899233cd2ddd8c
URL: https://github.com/kamailio/kamailio/commit/28f223a0a6d0e596fd140231de89923…
Author: Giacomo Vacca <giacomo.vacca(a)gmail.com>
Committer: Giacomo Vacca <giacomo.vacca(a)gmail.com>
Date: 2017-04-25T22:36:14+02:00
http_async_client: doc review (old functions)
---
Modified: src/modules/http_async_client/doc/http_async_client_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/28f223a0a6d0e596fd140231de89923…
Patch: https://github.com/kamailio/kamailio/commit/28f223a0a6d0e596fd140231de89923…
---
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 a9598c8..b7136a8 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
@@ -308,11 +308,11 @@ modparam("http_async_client", "tls_ca_path", "/etc/kamailio/ssl/ca/")
<para>
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_async_suspend_transaction()</emphasis> or <emphasis>$http_req(suspend)</emphasis> are used to not 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>
- Return value: 0 (stop script execution) on success in transaction context, 1 (continue script execution) in transaction-less context (or if http_async_suspend_transaction(0) or $http_req(suspend) are used), -1 on error.
+ Return value: 0 (stop script execution) on success in transaction context, 1 (continue script execution) in transaction-less context (or if $http_req(suspend) is used), -1 on error.
</para>
<para>
This function can be used from ANY_ROUTE.
@@ -369,7 +369,7 @@ xlog("L_INFO", "received reply for query $http_query_id\n");
<para><literal>key</literal> can be one of:</para>
<itemizedlist>
<listitem><para><emphasis>all</emphasis>: if set to <literal>$null</literal>, resets all the parameters to their default value (the ones defined in modparam)</para></listitem>
- <listitem><para><emphasis>hdr</emphasis>: sets/modifies/removes a HTTP header (see <emphasis>http_append_header()</emphasis>). N.B.: setting this variable multiple times will add several headers to the query.</para></listitem>
+ <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>
Module: kamailio
Branch: master
Commit: f86ea960a5c5a411e19105cb694e48753ae69d9f
URL: https://github.com/kamailio/kamailio/commit/f86ea960a5c5a411e19105cb694e487…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2017-04-26T07:31:49+02:00
modules: readme files regenerated - enum ... [skip ci]
---
Modified: src/modules/enum/README
---
Diff: https://github.com/kamailio/kamailio/commit/f86ea960a5c5a411e19105cb694e487…
Patch: https://github.com/kamailio/kamailio/commit/f86ea960a5c5a411e19105cb694e487…
---
diff --git a/src/modules/enum/README b/src/modules/enum/README
index fc4451d..8cfd091 100644
--- a/src/modules/enum/README
+++ b/src/modules/enum/README
@@ -27,9 +27,9 @@ Otmar Lendl
4. Functions
- 4.1. enum_query(["suffix"[,"service"]])
- 4.2. enum_pv_query("pvar"[,"suffix"[,"service"]])
- 4.3. i_enum_query(["suffix"[,"service"]])
+ 4.1. enum_query(["suffix" [,"service"]])
+ 4.2. enum_pv_query("pvar" [,"suffix" [,"service"]])
+ 4.3. i_enum_query(["suffix" [,"service"]])
4.4. is_from_user_enum()
List of Examples
@@ -61,9 +61,9 @@ Chapter 1. Admin Guide
4. Functions
- 4.1. enum_query(["suffix"[,"service"]])
- 4.2. enum_pv_query("pvar"[,"suffix"[,"service"]])
- 4.3. i_enum_query(["suffix"[,"service"]])
+ 4.1. enum_query(["suffix" [,"service"]])
+ 4.2. enum_pv_query("pvar" [,"suffix" [,"service"]])
+ 4.3. i_enum_query(["suffix" [,"service"]])
4.4. is_from_user_enum()
1. Overview
@@ -224,12 +224,12 @@ modparam("enum", "bl_algorithm", "txt")
4. Functions
- 4.1. enum_query(["suffix"[,"service"]])
- 4.2. enum_pv_query("pvar"[,"suffix"[,"service"]])
- 4.3. i_enum_query(["suffix"[,"service"]])
+ 4.1. enum_query(["suffix" [,"service"]])
+ 4.2. enum_pv_query("pvar" [,"suffix" [,"service"]])
+ 4.3. i_enum_query(["suffix" [,"service"]])
4.4. is_from_user_enum()
-4.1. enum_query(["suffix"[,"service"]])
+4.1. enum_query(["suffix" [,"service"]])
The function performs an enum query and rewrites the Request-URI with
the result of the query. See Section 1, “Overview” for more
@@ -241,6 +241,8 @@ modparam("enum", "bl_algorithm", "txt")
* service - Service string to be used in the service field. String
may contain pseudo variables.
+ Parameters can include pseudo-variables.
+
This function can be used from REQUEST_ROUTE.
Example 1.8. enum_query usage
@@ -265,11 +267,11 @@ enum_query("e164.arpa.","voice");
enum_query("e164.arpa.","+sip+voice:sip");
...
-4.2. enum_pv_query("pvar"[,"suffix"[,"service"]])
+4.2. enum_pv_query("pvar" [,"suffix" [,"service"]])
- The function performs an enum query on E.164 number stored in its
- pseudo variable argument and rewrites the Request-URI with the result
- of the query. See Section 1, “Overview” for more information.
+ The function performs an enum query on E.164 number stored in its first
+ argument and rewrites the Request-URI with the result of the query. See
+ Section 1, “Overview” for more information.
Meaning of the parameters is as follows:
* pvar - Pseudo variable that holds an E.164 number on which enum
@@ -277,6 +279,8 @@ enum_query("e164.arpa.","+sip+voice:sip");
* suffix - Suffix to be appended to the domain name.
* service - Service string to be used in the service field.
+ Parameters can include pseudo-variables.
+
This function can be used from REQUEST_ROUTE.
Example 1.9. enum_pv_query usage
@@ -301,13 +305,15 @@ enum_pv_query("$avp(i:100)","e164.arpa.","voice");
enum_pv_query("$avp(i:100)","e164.arpa.","+sip+voice:sip");
...
-4.3. i_enum_query(["suffix"[,"service"]])
+4.3. i_enum_query(["suffix" [,"service"]])
The function performs an enum query and rewrites the Request-URI with
the result of the query. This the Infrastructure-ENUM version of
enum_query(). The only difference to enum_query() is in the calculation
of the FQDN where NAPTR records are looked for.
+ Parameters can include pseudo-variables.
+
See
ftp://ftp.rfc-editor.org/in-notes/internet-drafts/draft-haberler-carrie
r-enum-01.txt for the rationale behind this function.