Browse code

dispatcher: docs updated removing avp params and adding xavp params

Daniel-Constantin Mierla authored on 12/06/2018 06:37:38
Showing 1 changed files
... ...
@@ -256,7 +256,7 @@ modparam("dispatcher", "force_dst", 1)
256 256
  		<para>
257 257
 		If flag 2 is set, then failover support is enabled. The functions
258 258
 		exported by the module will store the rest of addresses from the
259
-		destination set in the AVP, and use these AVPs to contact next address if
259
+		destination set in XAPVs, and use these XAVPs to try next address if
260 260
 		the current-tried destination fails.
261 261
  		</para>
262 262
  		<para>
... ...
@@ -295,41 +295,15 @@ modparam("dispatcher", "force_dst", 1)
295 295
  </programlisting>
296 296
  		</example>
297 297
 	</section>
298
- 	<section id="dispatcher.p.dst_avp">
299
- 		<title><varname>dst_avp</varname> (str)</title>
300
- 		<para>
301
- 		The name of the avp which will hold the list with addresses, in the
302
-		order
303
-		they have been selected by the chosen algorithm. If use_default is 1,
304
-		the value of last dst_avp_id is the last address in destination set. The
305
-		first dst_avp_id is the selected destinations. All the other addresses
306
-		from the destination set will be added in the avp list to be able to
307
-		implement serial forking.
308
- 		</para>
309
-		<note>
310
- 		<para>
311
-		You must set this parameter if you want to do load balancing fail over.
312
- 		</para>
313
-		</note>
314
- 		<para>
315
- 		<emphasis>
316
- 			Default value is <quote>null</quote> - don't add AVPs.
317
- 		</emphasis>
318
- 		</para>
319
- 		<example>
320
- 		<title>Set the <quote>dst_avp</quote> parameter</title>
321
- <programlisting format="linespecific">
322
- ...
323
- modparam("dispatcher", "dst_avp", "$avp(dsdst)")
324
- ...
325
- </programlisting>
326
- 		</example>
327
- 	</section>
328
- 	<section id="dispatcher.p.grp_avp">
329
- 		<title><varname>grp_avp</varname> (str)</title>
330
- 		<para>
331
- 		The name of the avp storing the group id of the destination set. Good
332
-		to have it for later usage or checks.
298
+ 	<section id="dispatcher.p.xavp_dst">
299
+ 		<title><varname>xavp_dst</varname> (str)</title>
300
+ 		<para>
301
+ 		The name of the XAVP which will hold the list with addresses and
302
+		associated properties, in the order they have been selected by the
303
+		chosen algorithm. If use_default is 1, the values of last XAVP correspond
304
+		to the last address in destination set. The first XAVP is the current
305
+		selected destination. All the other addresses from the destination set
306
+		will be added in the XAVP list to be able to implement serial forking.
333 307
  		</para>
334 308
 		<note>
335 309
  		<para>
... ...
@@ -338,116 +312,83 @@ modparam("dispatcher", "force_dst", 1)
338 338
 		</note>
339 339
  		<para>
340 340
  		<emphasis>
341
- 			Default value is <quote>null</quote> - don't add AVP.
341
+ 			Default value is <quote>_dsdst_</quote>.
342 342
  		</emphasis>
343 343
  		</para>
344 344
  		<example>
345
- 		<title>Set the <quote>grp_avp</quote> parameter</title>
345
+ 		<title>Set the <quote>xavp_dst</quote> parameter</title>
346 346
  <programlisting format="linespecific">
347 347
  ...
348
- modparam("dispatcher", "grp_avp", "$avp(dsgrp)")
348
+ modparam("dispatcher", "xavp_dst", "_dsdst_")
349 349
  ...
350 350
  </programlisting>
351 351
  		</example>
352 352
  	</section>
353
- 	<section id="dispatcher.p.cnt_avp">
354
- 		<title><varname>cnt_avp</varname> (str)</title>
355
- 		<para>
356
- 		The name of the avp storing the number of destination addresses kept in
357
-		dst_avp AVPs.
358
- 		</para>
359
-		<note>
360
- 		<para>
361
-		You must set this parameter if you want to do load balancing fail over.
353
+ 	<section id="dispatcher.p.xavp_dst_mode">
354
+ 		<title><varname>xavp_dst_mode</varname> (int)</title>
355
+ 		<para>
356
+ 		Control what fields are added to the XAVP specified by xavp_dst
357
+		parameter. The addeded fields are: the set id (group id), the URI
358
+		address, socket pointer, and destination unique id in case of call load
359
+		distribution algorithm. The attributes are added if xavp_dst_mode does
360
+		not have the bit 1 set.
362 361
  		</para>
363
-		</note>
364 362
  		<para>
365 363
  		<emphasis>
366
- 			Default value is <quote>null</quote> - don't add AVP.
364
+ 			Default value is <quote>0</quote> (add all fields).
367 365
  		</emphasis>
368 366
  		</para>
369 367
  		<example>
370
- 		<title>Set the <quote>cnt_avp</quote> parameter</title>
368
+ 		<title>Set the <quote>xavp_dst_mode</quote> parameter</title>
371 369
  <programlisting format="linespecific">
372 370
  ...
373
- modparam("dispatcher", "cnt_avp", "$avp(dscnt)")
371
+ modparam("dispatcher", "xavp_dst_mode", 1)
374 372
  ...
375 373
  </programlisting>
376 374
  		</example>
377 375
  	</section>
378
- 	<section id="dispatcher.p.dstid_avp">
379
- 		<title><varname>dstid_avp</varname> (str)</title>
380
- 		<para>
381
-		The name of the avp storing the destination unique ID used for
382
-		call load based dispatching.
383
- 		</para>
384
-		<note>
376
+ 	<section id="dispatcher.p.xavp_ctx">
377
+ 		<title><varname>xavp_ctx</varname> (str)</title>
385 378
  		<para>
386
-		You must set this parameter if you want to do load balancing on
387
-		call load (alg 10).
379
+ 		The name of the XAVP which will hold some attributes specific to
380
+		dispatcher routing context. The XAVP can hold the next fields: cnt -
381
+		the number of addresses selected for routing.
388 382
  		</para>
389
-		</note>
390 383
  		<para>
391 384
  		<emphasis>
392
- 			Default value is <quote>null</quote> - don't add AVP.
385
+ 			Default value is <quote>_dsctx_</quote>.
393 386
  		</emphasis>
394 387
  		</para>
395 388
  		<example>
396
- 		<title>Set the <quote>dstid_avp</quote> parameter</title>
389
+ 		<title>Set the <quote>xavp_ctx</quote> parameter</title>
397 390
  <programlisting format="linespecific">
398 391
  ...
399
- modparam("dispatcher", "dstid_avp", "$avp(dsdstid)")
392
+ modparam("dispatcher", "xavp_ctx", "_dsctx_")
400 393
  ...
401 394
  </programlisting>
402 395
  		</example>
403 396
  	</section>
404
- 	<section id="dispatcher.p.attrs_avp">
405
- 		<title><varname>attrs_avp</varname> (str)</title>
397
+ 	<section id="dispatcher.p.xavp_ctx_mode">
398
+ 		<title><varname>xavp_ctx_mode</varname> (int)</title>
406 399
  		<para>
407
-		The name of the avp storing destination's attributes value.
400
+ 		Control what fields are added to the XAVP specified by xavp_ctx
401
+		parameter. The cnt field is added if xavp_cnt_mode does not have the
402
+		bit 1 set.
408 403
  		</para>
409
-		<note>
410
-		</note>
411 404
  		<para>
412 405
  		<emphasis>
413
- 			Default value is <quote>null</quote> - don't add AVP.
406
+ 			Default value is <quote>0</quote> (add all fields).
414 407
  		</emphasis>
415 408
  		</para>
416 409
  		<example>
417
- 		<title>Set the <quote>attrs_avp</quote> parameter</title>
410
+ 		<title>Set the <quote>xavp_ctx_mode</quote> parameter</title>
418 411
  <programlisting format="linespecific">
419 412
  ...
420
- modparam("dispatcher", "attrs_avp", "$avp(dsattrs)")
413
+ modparam("dispatcher", "xavp_ctx_mode", 1)
421 414
  ...
422 415
  </programlisting>
423 416
  		</example>
424 417
  	</section>
425
-	<section id="dispatcher.p.sock_avp">
426
-		<title><varname>sock_avp</varname> (str)</title>
427
-		<para>
428
-			The name of the avp which will hold the list with the sockets
429
-			associated to the addresses stored in dst_avp avp.
430
-		</para>
431
-		<note>
432
-		<para>
433
-			If you want to do load balancing fail over, you have to set
434
-			this parameter to use the correct socket for each gateway.
435
-		</para>
436
-		</note>
437
-		<para>
438
-		<emphasis>
439
-			Default value is <quote>null</quote> - don't add AVPs.
440
-		</emphasis>
441
-		</para>
442
-		<example>
443
-		<title>Set the <quote>sock_avp</quote> parameter</title>
444
- <programlisting format="linespecific">
445
- ...
446
- modparam("dispatcher", "sock_avp", "$avp(dssocket)")
447
- ...
448
- </programlisting>
449
-		</example>
450
-	</section>
451 418
  	<section id="dispatcher.p.hash_pvar">
452 419
  		<title><varname>hash_pvar</varname> (str)</title>
453 420
  		<para>
... ...
@@ -979,8 +920,8 @@ end
979 979
  		<title><varname>ds_attrs_none</varname> (int)</title>
980 980
  		<para>
981 981
 		If set to 1, "none=yes" is set in the attrs for those records that
982
-		have no attrs value, to ensure that corresponding avps for records do
983
-		not get mixed up.
982
+		have no attrs value, to ensure that corresponding XAVP fields for
983
+		records do not get mixed up.
984 984
  		</para>
985 985
  		<para>
986 986
  		<emphasis>
... ...
@@ -1013,7 +954,7 @@ end
1013 1013
 		</para>
1014 1014
 		<para>
1015 1015
 		If the bit 2 in 'flags' parameter is set, the rest of the addresses from
1016
-		the destination set is stored in AVP list (limited with an optional 'limit'
1016
+		the destination set are stored in XAVP list (limited with an optional 'limit'
1017 1017
 		parameter). You can use 'ds_next_dst()' to use next address in order to
1018 1018
 		achieve serial forking to all possible destinations.
1019 1019
 		</para>
... ...
@@ -1095,7 +1036,7 @@ end
1095 1095
 				<quote>10</quote> - use call load distribution. You have
1096 1096
 				to set the attribute 'duid' (as an unique string id)
1097 1097
 				per each address in destination set. Also, you must set
1098
-				parameters 'dstid_avp' and 'ds_hash_size'.
1098
+				the parameter 'ds_hash_size'.
1099 1099
 				</para>
1100 1100
 				<para>
1101 1101
 				The algorithm can be used even with stateless proxy mode,
... ...
@@ -1149,7 +1090,7 @@ end
1149 1149
 			<listitem>
1150 1150
 				<para>
1151 1151
 				<quote>12</quote> - dispatch to all destination in setid at
1152
-				once (parallel forking). Note that the AVPs are no longer set
1152
+				once (parallel forking). Note that the XAVPs are no longer set
1153 1153
 				with the values of the destination records, no re-routing
1154 1154
 				making sense in this case.
1155 1155
 				</para>
... ...
@@ -1165,7 +1106,7 @@ end
1165 1165
 		<listitem>
1166 1166
 			<para>
1167 1167
 			<emphasis>limit</emphasis> - the maximum number of items to be
1168
-			stored in AVP list for further fail-overs (the first selected
1168
+			stored in XAVP list for further fail-overs (the first selected
1169 1169
 			destination and default destination are the first to be put in
1170 1170
 			the list)
1171 1171
 			</para>
... ...
@@ -1241,7 +1182,7 @@ DEST: {
1241 1241
  		</para>
1242 1242
 		<para>
1243 1243
 		If the bit 2 in 'flags' is set, the rest of the addresses from the
1244
-		destination set is stored in AVP list (limited with an optional 'limit'
1244
+		destination set are stored in XAVP list (limited with an optional 'limit'
1245 1245
 		parameter). You can use 'ds_next_domain()' to use next address to
1246 1246
 		achieve serial forking to all possible destinations.
1247 1247
 		</para>
... ...
@@ -1267,13 +1208,13 @@ if(ds_select_domain("1", "$var(a)")) {
1267 1267
 		</title>
1268 1268
 		<para>
1269 1269
 		The method selects a destination from addresses set and adds it
1270
-		in the AVPs specified for this module. It is not updating R-URI
1270
+		in the XAVP specified for this module. It is not updating R-URI
1271 1271
 		nor the destination URI. The parameters have same
1272 1272
 		meaning as for ds_select_dst().
1273 1273
 		</para>
1274 1274
 		<para>
1275 1275
 		If the bit 2 in 'flags' is set, the rest of the addresses from the
1276
-		destination set is stored in AVP list (limited with an optional 'limit'
1276
+		destination set are stored in XAVP list (limited with an optional 'limit'
1277 1277
 		parameter). You can execute 'ds_next_domain()' or 'ds_next_dst()' to use
1278 1278
 		next address to achieve serial forking to all possible destinations.
1279 1279
 		</para>
... ...
@@ -1299,7 +1240,7 @@ if(ds_select("1", "$var(a)")) {
1299 1299
 		<function moreinfo="none">ds_next_dst()</function>
1300 1300
 		</title>
1301 1301
 		<para>
1302
-		Takes the next destination address from the AVPs with id 'dst_avp_id'
1302
+		Takes the next destination address from the corresponding XAVPs
1303 1303
 		and sets the dst_uri (outbound proxy address).
1304 1304
  		</para>
1305 1305
 		<para>
... ...
@@ -1311,7 +1252,7 @@ if(ds_select("1", "$var(a)")) {
1311 1311
  		<function moreinfo="none">ds_next_domain()</function>
1312 1312
  		</title>
1313 1313
  		<para>
1314
- 		Takes the next destination address from the AVPs with id 'dst_avp_id'
1314
+ 		Takes the next destination address from the corresponding XAVPs
1315 1315
 		and sets the domain part of the request URI.
1316 1316
  		</para>
1317 1317
 		<para>