git:master: textops(k): readme regenerated - sr-dev

23 Jan 2011

Module: sip-router
Branch: master
Commit: 4c927f8e3424918a35e9d7f6a1c17cd987934f38
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=4c927f8e...
Author: kamailio <kamailio@kamailio-laptop.(none)>
Committer: kamailio <kamailio@kamailio-laptop.(none)>
Date:   Sun Jan 23 22:49:24 2011 +0100
textops(k): readme regenerated
---
modules_k/textops/README |   66 ++++++++++++++++++++++++++++++----------------
 1 files changed, 43 insertions(+), 23 deletions(-)

diff --git a/modules_k/textops/README b/modules_k/textops/README
index 7cad37b..3d1ed29 100644
--- a/modules_k/textops/README
+++ b/modules_k/textops/README
@@ -72,10 +72,11 @@ Juha Heinanen
               3.27. remove_hf(hname)
               3.28. remove_hf_re(re)
               3.29. has_body(), has_body(mime)
-              3.30. is_privacy(privacy_type)
-              3.31. cmp_str(str1, str2)
-              3.32. cmp_istr(str1, str2)
-              3.33. starts_with(str1, str2)
+              3.30. is_audio_on_hold()
+              3.31. is_privacy(privacy_type)
+              3.32. cmp_str(str1, str2)
+              3.33. cmp_istr(str1, str2)
+              3.34. starts_with(str1, str2)
4. Known Limitations
@@ -116,10 +117,11 @@ Juha Heinanen
    1.27. remove_hf usage
    1.28. remove_hf_re usage
    1.29. has_body usage
-   1.30. is_privacy usage
-   1.31. cmp_str usage
+   1.30. is_audio_on_hold usage
+   1.31. is_privacy usage
    1.32. cmp_str usage
-   1.33. starts_with usage
+   1.33. cmp_str usage
+   1.34. starts_with usage
Chapter 1. Admin Guide
@@ -165,10 +167,11 @@ Chapter 1. Admin Guide
         3.27. remove_hf(hname)
         3.28. remove_hf_re(re)
         3.29. has_body(), has_body(mime)
-        3.30. is_privacy(privacy_type)
-        3.31. cmp_str(str1, str2)
-        3.32. cmp_istr(str1, str2)
-        3.33. starts_with(str1, str2)
+        3.30. is_audio_on_hold()
+        3.31. is_privacy(privacy_type)
+        3.32. cmp_str(str1, str2)
+        3.33. cmp_istr(str1, str2)
+        3.34. starts_with(str1, str2)
4. Known Limitations
@@ -237,10 +240,11 @@ From: medabeda
    3.27. remove_hf(hname)
    3.28. remove_hf_re(re)
    3.29. has_body(), has_body(mime)
-   3.30. is_privacy(privacy_type)
-   3.31. cmp_str(str1, str2)
-   3.32. cmp_istr(str1, str2)
-   3.33. starts_with(str1, str2)
+   3.30. is_audio_on_hold()
+   3.31. is_privacy(privacy_type)
+   3.32. cmp_str(str1, str2)
+   3.33. cmp_istr(str1, str2)
+   3.34. starts_with(str1, str2)
3.1.  search(re)
@@ -818,7 +822,23 @@ if(has_body("application/sdp"))
 }
 ...
-3.30.  is_privacy(privacy_type)
+3.30.  is_audio_on_hold()
+
+   The function returns true if the SIP message has a body attached and at
+   least one audio stream in on hold.
+
+   This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
+   FAILURE_ROUTE and BRANCH_ROUTE.
+
+   Example 1.30. is_audio_on_hold usage
+...
+if(is_audio_on_hold())
+{
+    # do interesting stuff here
+}
+...
+
+3.31.  is_privacy(privacy_type)
The function returns true if the SIP message has a Privacy header field
    that includes the given privacy_type among its privacy values. See
@@ -828,7 +848,7 @@ if(has_body("application/sdp"))
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    FAILURE_ROUTE and BRANCH_ROUTE.
-   Example 1.30. is_privacy usage
+   Example 1.31. is_privacy usage
 ...
 if(is_privacy("id"))
 {
@@ -836,7 +856,7 @@ if(is_privacy("id"))
 }
 ...
-3.31.  cmp_str(str1, str2)
+3.32.  cmp_str(str1, str2)
The function returns true if the two parameters matches as string case
    sensitive comparison.
@@ -844,7 +864,7 @@ if(is_privacy("id"))
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    FAILURE_ROUTE and BRANCH_ROUTE.
-   Example 1.31. cmp_str usage
+   Example 1.32. cmp_str usage
 ...
 if(cmp_str("$rU", "kamailio"))
 {
@@ -852,7 +872,7 @@ if(cmp_str("$rU", "kamailio"))
 }
 ...
-3.32.  cmp_istr(str1, str2)
+3.33.  cmp_istr(str1, str2)
The function returns true if the two parameters matches as string case
    insensitive comparison.
@@ -860,7 +880,7 @@ if(cmp_str("$rU", "kamailio"))
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    FAILURE_ROUTE and BRANCH_ROUTE.
-   Example 1.32. cmp_str usage
+   Example 1.33. cmp_str usage
 ...
 if(cmp_istr("$rU@you", "kamailio@YOU"))
 {
@@ -868,7 +888,7 @@ if(cmp_istr("$rU@you", "kamailio@YOU"))
 }
 ...
-3.33.  starts_with(str1, str2)
+3.34.  starts_with(str1, str2)
The function returns true if the first string starts with the second
    string.
@@ -876,7 +896,7 @@ if(cmp_istr("$rU@you", "kamailio@YOU"))
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    FAILURE_ROUTE and BRANCH_ROUTE.
-   Example 1.33. starts_with usage
+   Example 1.34. starts_with usage
 ...
 if (starts_with("$rU", "+358"))
 {

    