kamailio/misc/obsolete/dispatcher/doc/functions.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<section id="dispatcher.functions" xmlns:xi="http://www.w3.org/2001/XInclude">
    <sectioninfo>
    </sectioninfo>

    <title>Functions</title>

    <section id="ds_select_dst">
	<title>
	    <function>ds_select_dst(set, alg)</function>
	</title>
	<para>
	    The method selects a destination from addresses set.
	</para>
	<para>Meaning of the parameters is as follows:</para>
	<itemizedlist>
	    <listitem>
		<para>
		    <emphasis>set</emphasis> - the id of the set from where to
		    pick up destination address. It is the first column in
		    destination list file.
		</para>
	    </listitem>
	    <listitem>
		<para>
		    <emphasis>alg</emphasis> - the algorithm used to select the
		    destination address.
		</para>
		<itemizedlist>
		    <listitem>
			<para>
			    "0" - hash over callid
			</para>
		    </listitem>
		    <listitem>
			<para>
			    "1" - hash over from URI.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    "2" - hash over to URI.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    "3" - hash over the Request-URI.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    "X" - if the algorithm is not implemented, the
			    first entry in set is chosen.
			</para>
		    </listitem>
		</itemizedlist>
	    </listitem>
	</itemizedlist>
	
	<example>
	    <title><function>ds_select_dst</function> usage</title>
	    <programlisting>
...
ds_select_dst("1", "0");
...
	    </programlisting>
	</example>
    </section>
    
</section>