Browse code

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

Kamailio Dev authored on 12/01/2021 11:01:20
Showing 1 changed files
... ...
@@ -27,6 +27,8 @@ Wolfgang Kampichler
27 27
               3.1. exact_type (int)
28 28
               3.2. response_time (int)
29 29
               3.3. location_type (string)
30
+              3.4. geoheader_type (int)
31
+              3.5. geoheader_order (int)
30 32
 
31 33
         4. Functions
32 34
 
... ...
@@ -41,8 +43,10 @@ Wolfgang Kampichler
41 43
    1.1. Set exact_type parameter
42 44
    1.2. Set response_time parameter
43 45
    1.3. Set location_type parameter
44
-   1.4. lost_held_query() usage
45
-   1.5. lost() usage
46
+   1.4. Set geoheader_type parameter
47
+   1.5. Set geoheader_order parameter
48
+   1.6. lost_held_query() usage
49
+   1.7. lost() usage
46 50
 
47 51
 Chapter 1. Admin Guide
48 52
 
... ...
@@ -59,6 +63,8 @@ Chapter 1. Admin Guide
59 63
         3.1. exact_type (int)
60 64
         3.2. response_time (int)
61 65
         3.3. location_type (string)
66
+        3.4. geoheader_type (int)
67
+        3.5. geoheader_order (int)
62 68
 
63 69
    4. Functions
64 70
 
... ...
@@ -131,6 +137,8 @@ Chapter 1. Admin Guide
131 137
    3.1. exact_type (int)
132 138
    3.2. response_time (int)
133 139
    3.3. location_type (string)
140
+   3.4. geoheader_type (int)
141
+   3.5. geoheader_order (int)
134 142
 
135 143
    Besides parameters listed, this module uses http_client therefore
136 144
    according parameters may apply.
... ...
@@ -182,6 +190,40 @@ Chapter 1. Admin Guide
182 190
     modparam("lost", "location_type, "civic geodetic locationURI")
183 191
     ...
184 192
 
193
+3.4. geoheader_type (int)
194
+
195
+   A Geolocation header may include a list of locationValues pointing to
196
+   either a Presence Information Data Format Location Object (PIDF-LO) in
197
+   the SIP body using a content-indirection (cid:) URI per RFC4483
198
+   (https://tools.ietf.org/html/rfc4483), or an http(s) URI pointing to an
199
+   external source. This parameter supports filtering of the following
200
+   types:
201
+     * 0 (any) - any URI (first or last)
202
+     * 1 (cid) - cid URI (aka Location-by-Value)
203
+     * 2 (http) - http URI (aka Location-by-Reference)
204
+     * 3 (https) - https URI (aka Location-by-Reference)
205
+
206
+   Default: 0 (any)
207
+
208
+   Example 1.4. Set geoheader_type parameter
209
+    ...
210
+    modparam("lost", "geoheader_type", 1)
211
+    ...
212
+
213
+3.5. geoheader_order (int)
214
+
215
+   A Geolocation header may include a list of locationValues. This
216
+   parameter sets the order of the URI used to retrieve location
217
+   information, either the first element of a certain type or the last.
218
+   Values are 0 (first) or 1 (last).
219
+
220
+   Default: 0 (first)
221
+
222
+   Example 1.5. Set geoheader_order parameter
223
+    ...
224
+    modparam("lost", "geoheader_order", 0)
225
+    ...
226
+
185 227
 4. Functions
186 228
 
187 229
    4.1. lost_held_query(con, [id,] pidf-lo, url, error)
... ...
@@ -210,7 +252,7 @@ Chapter 1. Admin Guide
210 252
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
211 253
    FAILURE_ROUTE, and BRANCH_ROUTE.
212 254
 
213
-   Example 1.4. lost_held_query() usage
255
+   Example 1.6. lost_held_query() usage
214 256
 ...
215 257
 modparam("http_client", "httpcon", "heldsrv=>http://service.org/api/held");
216 258
 ...
... ...
@@ -246,7 +288,7 @@ r(pidf)\n");
246 288
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
247 289
    FAILURE_ROUTE, and BRANCH_ROUTE.
248 290
 
249
-   Example 1.5. lost() usage
291
+   Example 1.7. lost() usage
250 292
 ...
251 293
 modparam("http_client", "httpcon", "heldsrv=>http://service.org/api/held");
252 294
 modparam("http_client", "httpcon", "lostsrv=>http://service.org/api/lost");
... ...
@@ -307,3 +349,6 @@ var(name)\n");
307 349
    Note: to test the module with a mapping service (LOST), an API key may
308 350
    be requested under the following link (search for "GET ACCESS"):
309 351
    https://gridgears.at/.
352
+
353
+   Note: in case modparam "geoheader_type" is set to 2 (http), the module
354
+   may use 3 (https) as fallback and vice versa.