Browse Source

corex: docs for send_data() function

Daniel-Constantin Mierla 11 years ago
parent
commit
dab956c0f9
2 changed files with 40 additions and 0 deletions
  1. 17 0
      modules/corex/README
  2. 23 0
      modules/corex/doc/corex_admin.xml

+ 17 - 0
modules/corex/README

@@ -32,6 +32,7 @@ Daniel-Constantin Mierla
               4.1. append_branch([ uri, [ q ] ])
               4.1. append_branch([ uri, [ q ] ])
               4.2. send([ host [ :port ] ])
               4.2. send([ host [ :port ] ])
               4.3. send_tcp([ host [ :port ] ])
               4.3. send_tcp([ host [ :port ] ])
+              4.4. send_data(uri, data)
 
 
         5. RPC Commands
         5. RPC Commands
 
 
@@ -45,6 +46,7 @@ Daniel-Constantin Mierla
    1.1. Set alias_subdomains parameter
    1.1. Set alias_subdomains parameter
    1.2. append_branch usage
    1.2. append_branch usage
    1.3. send usage
    1.3. send usage
+   1.4. send_data usage
 
 
 Chapter 1. Admin Guide
 Chapter 1. Admin Guide
 
 
@@ -65,6 +67,7 @@ Chapter 1. Admin Guide
         4.1. append_branch([ uri, [ q ] ])
         4.1. append_branch([ uri, [ q ] ])
         4.2. send([ host [ :port ] ])
         4.2. send([ host [ :port ] ])
         4.3. send_tcp([ host [ :port ] ])
         4.3. send_tcp([ host [ :port ] ])
+        4.4. send_data(uri, data)
 
 
    5. RPC Commands
    5. RPC Commands
 
 
@@ -126,6 +129,7 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
    4.1. append_branch([ uri, [ q ] ])
    4.1. append_branch([ uri, [ q ] ])
    4.2. send([ host [ :port ] ])
    4.2. send([ host [ :port ] ])
    4.3. send_tcp([ host [ :port ] ])
    4.3. send_tcp([ host [ :port ] ])
+   4.4. send_data(uri, data)
 
 
 4.1. append_branch([ uri, [ q ] ])
 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
    This function is identical to send() described above, except that it
    sends the SIP message using the TCP protocol instead of UDP.
    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. RPC Commands
 
 
    5.1. corex.list_sockets
    5.1. corex.list_sockets

+ 23 - 0
modules/corex/doc/corex_admin.xml

@@ -178,6 +178,29 @@ modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
 			TCP protocol instead of UDP.
 			TCP protocol instead of UDP.
 		</para>
 		</para>
 	</section>
 	</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>
 
 
 	<section>
 	<section>