Module: sip-router
Branch: master
Commit: dab956c0f9faca63dde6b2ce25386ca42ddc33e7
URL:
http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=dab956c…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: Mon Jul 21 12:41:01 2014 +0200
corex: docs for send_data() function
---
modules/corex/README | 17 +++++++++++++++++
modules/corex/doc/corex_admin.xml | 23 +++++++++++++++++++++++
2 files changed, 40 insertions(+), 0 deletions(-)
diff --git a/modules/corex/README b/modules/corex/README
index 9c1aecf..5d63316 100644
--- a/modules/corex/README
+++ b/modules/corex/README
@@ -32,6 +32,7 @@ Daniel-Constantin Mierla
4.1. append_branch([ uri, [ q ] ])
4.2. send([ host [ :port ] ])
4.3. send_tcp([ host [ :port ] ])
+ 4.4. send_data(uri, data)
5. RPC Commands
@@ -45,6 +46,7 @@ Daniel-Constantin Mierla
1.1. Set alias_subdomains parameter
1.2. append_branch usage
1.3. send usage
+ 1.4. send_data usage
Chapter 1. Admin Guide
@@ -65,6 +67,7 @@ Chapter 1. Admin Guide
4.1. append_branch([ uri, [ q ] ])
4.2. send([ host [ :port ] ])
4.3. send_tcp([ host [ :port ] ])
+ 4.4. send_data(uri, data)
5. RPC Commands
@@ -126,6 +129,7 @@ modparam("corex", "alias_subdomains",
"udp:sip-router.org:5060")
4.1. append_branch([ uri, [ q ] ])
4.2. send([ host [ :port ] ])
4.3. send_tcp([ host [ :port ] ])
+ 4.4. send_data(uri, data)
4.1. append_branch([ uri, [ q ] ])
@@ -176,6 +180,19 @@ modparam("corex", "alias_subdomains",
"udp:sip-router.org:5060")
This function is identical to send() described above, except that it
sends the SIP message using the TCP protocol instead of UDP.
+4.4. send_data(uri, data)
+
+ Send the data to address specified by uri. Both parameters can contain
+ pseudo-variables. The uri parameter has to be a valid SIP URI. The data
+ parameter can by any arbitrary content.
+
+ This function can be used from ANY_ROUTE.
+
+ Example 1.4. send_data usage
+...
+ send("sip:example.com:5070;transport=sctp", "Message at
$Ts");
+...
+
5. RPC Commands
5.1. corex.list_sockets
diff --git a/modules/corex/doc/corex_admin.xml b/modules/corex/doc/corex_admin.xml
index e7a75a5..964fdf1 100644
--- a/modules/corex/doc/corex_admin.xml
+++ b/modules/corex/doc/corex_admin.xml
@@ -178,6 +178,29 @@ modparam("corex", "alias_subdomains",
"udp:sip-router.org:5060")
TCP protocol instead of UDP.
</para>
</section>
+
+ <section>
+ <title>
+ <function moreinfo="none">send_data(uri, data)</function>
+ </title>
+ <para>
+ Send the data to address specified by uri. Both parameters can
+ contain pseudo-variables. The uri parameter has to be a valid
+ SIP URI. The data parameter can by any arbitrary content.
+ </para>
+ <para>
+ This function can be used from ANY_ROUTE.
+ </para>
+ <example>
+ <title><function>send_data</function> usage</title>
+ <programlisting format="linespecific">
+...
+ send("sip:example.com:5070;transport=sctp", "Message at $Ts");
+...
+</programlisting>
+ </example>
+ </section>
+
</section>
<section>