Browse code

textops(k): readme regenerated

kamailio authored on 23/01/2011 21:49:24
Showing 1 changed files
... ...
@@ -72,10 +72,11 @@ Juha Heinanen
72 72
               3.27. remove_hf(hname)
73 73
               3.28. remove_hf_re(re)
74 74
               3.29. has_body(), has_body(mime)
75
-              3.30. is_privacy(privacy_type)
76
-              3.31. cmp_str(str1, str2)
77
-              3.32. cmp_istr(str1, str2)
78
-              3.33. starts_with(str1, str2)
75
+              3.30. is_audio_on_hold()
76
+              3.31. is_privacy(privacy_type)
77
+              3.32. cmp_str(str1, str2)
78
+              3.33. cmp_istr(str1, str2)
79
+              3.34. starts_with(str1, str2)
79 80
 
80 81
         4. Known Limitations
81 82
 
... ...
@@ -116,10 +117,11 @@ Juha Heinanen
116 117
    1.27. remove_hf usage
117 118
    1.28. remove_hf_re usage
118 119
    1.29. has_body usage
119
-   1.30. is_privacy usage
120
-   1.31. cmp_str usage
120
+   1.30. is_audio_on_hold usage
121
+   1.31. is_privacy usage
121 122
    1.32. cmp_str usage
122
-   1.33. starts_with usage
123
+   1.33. cmp_str usage
124
+   1.34. starts_with usage
123 125
 
124 126
 Chapter 1. Admin Guide
125 127
 
... ...
@@ -165,10 +167,11 @@ Chapter 1. Admin Guide
165 167
         3.27. remove_hf(hname)
166 168
         3.28. remove_hf_re(re)
167 169
         3.29. has_body(), has_body(mime)
168
-        3.30. is_privacy(privacy_type)
169
-        3.31. cmp_str(str1, str2)
170
-        3.32. cmp_istr(str1, str2)
171
-        3.33. starts_with(str1, str2)
170
+        3.30. is_audio_on_hold()
171
+        3.31. is_privacy(privacy_type)
172
+        3.32. cmp_str(str1, str2)
173
+        3.33. cmp_istr(str1, str2)
174
+        3.34. starts_with(str1, str2)
172 175
 
173 176
    4. Known Limitations
174 177
 
... ...
@@ -237,10 +240,11 @@ From: medabeda
237 240
    3.27. remove_hf(hname)
238 241
    3.28. remove_hf_re(re)
239 242
    3.29. has_body(), has_body(mime)
240
-   3.30. is_privacy(privacy_type)
241
-   3.31. cmp_str(str1, str2)
242
-   3.32. cmp_istr(str1, str2)
243
-   3.33. starts_with(str1, str2)
243
+   3.30. is_audio_on_hold()
244
+   3.31. is_privacy(privacy_type)
245
+   3.32. cmp_str(str1, str2)
246
+   3.33. cmp_istr(str1, str2)
247
+   3.34. starts_with(str1, str2)
244 248
 
245 249
 3.1.  search(re)
246 250
 
... ...
@@ -818,7 +822,23 @@ if(has_body("application/sdp"))
818 822
 }
819 823
 ...
820 824
 
821
-3.30.  is_privacy(privacy_type)
825
+3.30.  is_audio_on_hold()
826
+
827
+   The function returns true if the SIP message has a body attached and at
828
+   least one audio stream in on hold.
829
+
830
+   This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
831
+   FAILURE_ROUTE and BRANCH_ROUTE.
832
+
833
+   Example 1.30. is_audio_on_hold usage
834
+...
835
+if(is_audio_on_hold())
836
+{
837
+    # do interesting stuff here
838
+}
839
+...
840
+
841
+3.31.  is_privacy(privacy_type)
822 842
 
823 843
    The function returns true if the SIP message has a Privacy header field
824 844
    that includes the given privacy_type among its privacy values. See
... ...
@@ -828,7 +848,7 @@ if(has_body("application/sdp"))
828 848
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
829 849
    FAILURE_ROUTE and BRANCH_ROUTE.
830 850
 
831
-   Example 1.30. is_privacy usage
851
+   Example 1.31. is_privacy usage
832 852
 ...
833 853
 if(is_privacy("id"))
834 854
 {
... ...
@@ -836,7 +856,7 @@ if(is_privacy("id"))
836 856
 }
837 857
 ...
838 858
 
839
-3.31.  cmp_str(str1, str2)
859
+3.32.  cmp_str(str1, str2)
840 860
 
841 861
    The function returns true if the two parameters matches as string case
842 862
    sensitive comparison.
... ...
@@ -844,7 +864,7 @@ if(is_privacy("id"))
844 864
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
845 865
    FAILURE_ROUTE and BRANCH_ROUTE.
846 866
 
847
-   Example 1.31. cmp_str usage
867
+   Example 1.32. cmp_str usage
848 868
 ...
849 869
 if(cmp_str("$rU", "kamailio"))
850 870
 {
... ...
@@ -852,7 +872,7 @@ if(cmp_str("$rU", "kamailio"))
852 872
 }
853 873
 ...
854 874
 
855
-3.32.  cmp_istr(str1, str2)
875
+3.33.  cmp_istr(str1, str2)
856 876
 
857 877
    The function returns true if the two parameters matches as string case
858 878
    insensitive comparison.
... ...
@@ -860,7 +880,7 @@ if(cmp_str("$rU", "kamailio"))
860 880
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
861 881
    FAILURE_ROUTE and BRANCH_ROUTE.
862 882
 
863
-   Example 1.32. cmp_str usage
883
+   Example 1.33. cmp_str usage
864 884
 ...
865 885
 if(cmp_istr("$rU@you", "kamailio@YOU"))
866 886
 {
... ...
@@ -868,7 +888,7 @@ if(cmp_istr("$rU@you", "kamailio@YOU"))
868 888
 }
869 889
 ...
870 890
 
871
-3.33.  starts_with(str1, str2)
891
+3.34.  starts_with(str1, str2)
872 892
 
873 893
    The function returns true if the first string starts with the second
874 894
    string.
... ...
@@ -876,7 +896,7 @@ if(cmp_istr("$rU@you", "kamailio@YOU"))
876 896
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
877 897
    FAILURE_ROUTE and BRANCH_ROUTE.
878 898
 
879
-   Example 1.33. starts_with usage
899
+   Example 1.34. starts_with usage
880 900
 ...
881 901
 if (starts_with("$rU", "+358"))
882 902
 {