Browse code

modules: readme files regenerated - siputils ... [skip ci]

Kamailio Dev authored on 11/05/2021 13:46:16
Showing 1 changed files
... ...
@@ -96,7 +96,7 @@ Gabriel Vasile
96 96
               4.30. is_reply()
97 97
               4.31. is_gruu([uri])
98 98
               4.32. is_supported(option)
99
-              4.33. is_first_hop()
99
+              4.33. is_first_hop([mode])
100 100
               4.34. sip_p_charging_vector(flags)
101 101
               4.35. contact_param_encode(pname, saddr)
102 102
               4.36. contact_param_decode(pname)
... ...
@@ -217,7 +217,7 @@ Chapter 1. Admin Guide
217 217
         4.30. is_reply()
218 218
         4.31. is_gruu([uri])
219 219
         4.32. is_supported(option)
220
-        4.33. is_first_hop()
220
+        4.33. is_first_hop([mode])
221 221
         4.34. sip_p_charging_vector(flags)
222 222
         4.35. contact_param_encode(pname, saddr)
223 223
         4.36. contact_param_decode(pname)
... ...
@@ -438,7 +438,7 @@ modparam("auth", "rpid_avp", "$avp(myrpid)")
438 438
    4.30. is_reply()
439 439
    4.31. is_gruu([uri])
440 440
    4.32. is_supported(option)
441
-   4.33. is_first_hop()
441
+   4.33. is_first_hop([mode])
442 442
    4.34. sip_p_charging_vector(flags)
443 443
    4.35. contact_param_encode(pname, saddr)
444 444
    4.36. contact_param_decode(pname)
... ...
@@ -994,24 +994,37 @@ if(is_gruu()) { ... }
994 994
 if (is_supported("outbound")) { ... }
995 995
 ...
996 996
 
997
-4.33.  is_first_hop()
997
+4.33.  is_first_hop([mode])
998 998
 
999 999
    The function returns true if the proxy is first hop after the original
1000
-   sender. For incoming SIP requests, it means there is only one Via
1001
-   header. For incoming SIP replies, it means that top Record-Route URI is
1002
-   'myself' and source address is not matching it (to avoid detecting in
1003
-   case of local loops). The detection is done only when Record-Route has
1004
-   an IP address in its URI (for a domain, it returns -1/false).
1000
+   sender based on a best effort estimation by checking Via and
1001
+   Record-Route headers.
1002
+
1003
+   For incoming SIP requests, it means there is only one Via header.
1004
+
1005
+   For incoming SIP replies, if mode==0, it means that top Record-Route
1006
+   URI is 'myself' and source address is not matching local IP (to avoid
1007
+   detecting in case of local loops). Therefore for mode==0 the detection
1008
+   is done only when Record-Route has an IP address in its URI (for a
1009
+   domain, it returns -1/false). If mode==1, then the check of local IP is
1010
+   no longer done, only if top Record-Route is myself, returning true also
1011
+   if there is a domain, assuming that is expected no looping can happen
1012
+   based on config rules.
1005 1013
 
1006 1014
    Note that it does not detect spirals, which can have the condition for
1007 1015
    replies true also in the case of additional SIP reply reception.
1008 1016
 
1017
+   Parameter mode is optional and can be an integer or a varaible holding
1018
+   an integer. If not provided, the behaviour is like mode==0.
1019
+
1009 1020
    This function can be used from ANY_ROUTE.
1010 1021
 
1011 1022
    Example 1.42. is_first_hop() usage
1012 1023
 ...
1013 1024
 if(is_first_hop()) { ... }
1014 1025
 ...
1026
+if(is_first_hop_mode("1")) { ... }
1027
+...
1015 1028
 
1016 1029
 4.34.  sip_p_charging_vector(flags)
1017 1030