From e93bb3dba955cb6fe1526bb1737ce0f227f4a8c7 Mon Sep 17 00:00:00 2001 From: Daniel-Constantin Mierla Date: Thu, 24 Mar 2016 14:08:32 +0100 Subject: [PATCH] dispatcher: docs for ds_select() --- modules/dispatcher/doc/dispatcher_admin.xml | 61 ++++++++++++++++++--- 1 file changed, 53 insertions(+), 8 deletions(-) diff --git a/modules/dispatcher/doc/dispatcher_admin.xml b/modules/dispatcher/doc/dispatcher_admin.xml index c79ecaa83de..8368bb76473 100644 --- a/modules/dispatcher/doc/dispatcher_admin.xml +++ b/modules/dispatcher/doc/dispatcher_admin.xml @@ -1050,19 +1050,64 @@ ds_select_dst("1", "4", "3"); If the bit 2 in 'flags' is set, the rest of the addresses from the destination set is stored in AVP list (limited with an optional 'limit' - parameter). You can use 'ds_next_domain()' to use next address to + parameter). You can use 'ds_next_domain()' to use next address to achieve serial forking to all possible destinations. This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. - -
- - <function moreinfo="none">ds_next_dst()</function> - - - Takes the next destination address from the AVPs with id 'dst_avp_id' + + <function>ds_select_domain</function> usage + +... +$var(a) = 4; +if(ds_select_domain("1", "$var(a)")) { + t_relay(); + exit; +} +... + + +
+
+ + <function moreinfo="none">ds_select(set, alg [, limit])</function> + + + The method selects a destination from addresses set and adds it + in the AVPs specified for this module. It is not updating R-URI + nor the destination URI. The parameters have same + meaning as for ds_select_dst(). + + + If the bit 2 in 'flags' is set, the rest of the addresses from the + destination set is stored in AVP list (limited with an optional 'limit' + parameter). You can execute 'ds_next_domain()' or 'ds_next_dst()' to use + next address to achieve serial forking to all possible destinations. + + + This function can be used from ANY_ROUTE. + + + <function>ds_select</function> usage + +... +$var(a) = 4; +if(ds_select("1", "$var(a)")) { + ds_next_domain(); + t_relay(); + exit; +} +... + + +
+
+ + <function moreinfo="none">ds_next_dst()</function> + + + Takes the next destination address from the AVPs with id 'dst_avp_id' and sets the dst_uri (outbound proxy address).