[sr-dev] git:master: sdpops: documented sdp_get() function

[Daniel-Constantin Mierla]

Module: sip-router
Branch: master
Commit: 61050f35d1d617ef6e1cefab44a36e26ffa44479
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=61050f35d1d617ef6e1cefab44a36e26ffa44479

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Fri Jun  8 22:55:40 2012 +0200

sdpops: documented sdp_get() function

---

 modules/sdpops/README               |   16 ++++++++++++++++
 modules/sdpops/doc/sdpops_admin.xml |   20 ++++++++++++++++++++
 2 files changed, 36 insertions(+), 0 deletions(-)

diff --git a/modules/sdpops/README b/modules/sdpops/README
index 7bad70c..9d32c78 100644
--- a/modules/sdpops/README
+++ b/modules/sdpops/README
@@ -35,6 +35,7 @@ Daniel-Constantin Mierla
               4.7. sdp_with_codecs_by_id(list)
               4.8. sdp_with_codecs_by_name(list)
               4.9. sdp_print(level)
+              4.10. sdp_get(avpvar)
 
    List of Examples
 
@@ -47,6 +48,7 @@ Daniel-Constantin Mierla
    1.7. sdp_with_codecs_by_id usage
    1.8. sdp_with_codecs_by_name usage
    1.9. sdp_print usage
+   1.10. sdp_get usage
 
 Chapter 1. Admin Guide
 
@@ -70,6 +72,7 @@ Chapter 1. Admin Guide
         4.7. sdp_with_codecs_by_id(list)
         4.8. sdp_with_codecs_by_name(list)
         4.9. sdp_print(level)
+        4.10. sdp_get(avpvar)
 
 1. Overview
 
@@ -112,6 +115,7 @@ Chapter 1. Admin Guide
    4.7. sdp_with_codecs_by_id(list)
    4.8. sdp_with_codecs_by_name(list)
    4.9. sdp_print(level)
+   4.10. sdp_get(avpvar)
 
 4.1. sdp_remove_codecs_by_id(list)
 
@@ -263,3 +267,15 @@ if(sdp_with_codecs_by_id("PCMU,PCMA,GSM")) { ... }
 # print the SDP
 sdp_print("1");
 ...
+
+4.10. sdp_get(avpvar)
+
+   Store the SDP part of message body in an AVP. Return 1 if SDP is found,
+   -1 on error and -2 if there is no SDP part in the message body.
+
+   This function can be used from ANY_ROUTE.
+
+   Example 1.10. sdp_get usage
+...
+sdp_get("$avp(sdp)");
+...
diff --git a/modules/sdpops/doc/sdpops_admin.xml b/modules/sdpops/doc/sdpops_admin.xml
index 85df224..8681d03 100644
--- a/modules/sdpops/doc/sdpops_admin.xml
+++ b/modules/sdpops/doc/sdpops_admin.xml
@@ -299,6 +299,26 @@ sdp_print("1");
 </programlisting>
 	    </example>
 	</section>
+	<section>
+	    <title>
+		<function moreinfo="none">sdp_get(avpvar)</function>
+	    </title>
+	    <para>
+		Store the SDP part of message body in an AVP. Return 1 if SDP is found,
+		-1 on error and -2 if there is no SDP part in the message body.
+	    </para>
+		<para>
+			This function can be used from ANY_ROUTE.
+	    </para>
+		<example>
+		<title><function>sdp_get</function> usage</title>
+		<programlisting format="linespecific">
+...
+sdp_get("$avp(sdp)");
+...
+</programlisting>
+	    </example>
+	</section>
 	</section>
 </chapter>