1.1 --- a/opensips/modules/enum/doc/enum_admin.xml Mon Jan 18 19:47:23 2010 +0100
1.2 +++ b/opensips/modules/enum/doc/enum_admin.xml Mon Jan 18 19:59:51 2010 +0100
1.3 @@ -75,6 +75,24 @@
1.4 and -1 if not.
1.5 </para>
1.6 <para>
1.7 + In addition to standard ENUM, support for ISN (ITAD Subscriber
1.8 + Numbers) is provided as well. To allow ISN lookups to resolve,
1.9 + a different formatting algorithm is expected by the DNS server.
1.10 + Whereas a ENUM NAPTR record expects a DNS query of the form
1.11 + 9.8.7.6.5.4.3.2.1.<suffix>, ISN method expects a DNS query of
1.12 + the form 6.5.1212.<suffix>. That is, a valid ISN number includes
1.13 + a prefix of '56' in the example. The rest of the number is a
1.14 + ITAD (Internet Telephony Administrative Domain) as defined
1.15 + in RFCs 3872 and 2871, and as allocated by the IANA in
1.16 + http://www.iana.org/assignments/trip-parameters. The ITAD is
1.17 + left intact and not refersed as ENUM requires. To learn more
1.18 + about ISN please refer to documents at www.freenum.org.
1.19 + </para>
1.20 + <para>
1.21 + To complete a ISN lookup on the user part of the Request-URI,
1.22 + isn_query() is used instead of enum_query().
1.23 + </para>
1.24 + <para>
1.25 Enum module also implements is_from_user_enum function.
1.26 This function does an enum lookup on the from user and
1.27 returns true if found, false otherwise.
1.28 @@ -153,6 +171,22 @@
1.29 </example>
1.30 </section>
1.31 <section>
1.32 + <title><varname>isn_suffix</varname> (string)</title>
1.33 + <para>
1.34 + The domain suffix to be used for isn_query() lookups. Can
1.35 + be overridden by a parameter to isn_query.
1.36 + </para>
1.37 + <para>
1.38 + Default value is <quote>freenum.org.</quote>
1.39 + </para>
1.40 + <example>
1.41 + <title>Setting isn_suffix module parameter</title>
1.42 + <programlisting format="linespecific">
1.43 +modparam("enum", "isn_suffix", "freenum.org.")
1.44 +</programlisting>
1.45 + </example>
1.46 + </section>
1.47 + <section>
1.48 <title><varname>branchlabel</varname> (string)</title>
1.49 <para>
1.50 This parameter determines which label i_enum_query() will use
1.51 @@ -162,7 +196,7 @@
1.52 Default value is <quote>"i"</quote>
1.53 </para>
1.54 <example>
1.55 - <title>Setting brachlabel module parameter</title>
1.56 + <title>Setting branchlabel module parameter</title>
1.57 <programlisting format="linespecific">
1.58 modparam("enum", "branchlabel", "i")
1.59 </programlisting>
1.60 @@ -353,6 +387,53 @@
1.61 </section>
1.62
1.63 <section>
1.64 + <title>
1.65 + <function moreinfo="none">isn_query(["suffix"[,"service"]])</function>
1.66 + </title>
1.67 + <para>
1.68 + The function performs a ISN query and rewrites the Request-URI with
1.69 + the result of the query. See <xref linkend="sec-overview"/> for more
1.70 + information.
1.71 + </para>
1.72 + <para>Meaning of the parameters is as follows:</para>
1.73 + <itemizedlist>
1.74 + <listitem>
1.75 + <para><emphasis>suffix</emphasis> - Suffix to be appended to the
1.76 + domain name.
1.77 + </para>
1.78 + </listitem>
1.79 + <listitem>
1.80 + <para><emphasis>service</emphasis> - Service string to be used in
1.81 + the service field.
1.82 + </para>
1.83 + </listitem>
1.84 + </itemizedlist>
1.85 + <para>
1.86 + This function can be used from REQUEST_ROUTE.
1.87 + </para>
1.88 + <para>
1.89 + See ftp://www.ietf.org/rfc/rfc3872.txt and
1.90 + ftp://www.ietf.org/rfc/rfc2871.txt for information
1.91 + regarding the ITAD part of the ISN string.
1.92 + </para>
1.93 + <example>
1.94 + <title><function moreinfo="none">isn_query</function> usage</title>
1.95 + <programlisting format="linespecific">
1.96 +...
1.97 +# search for "e2u+sip" in freenum.org
1.98 +isn_query("freenum.org.");
1.99 +...
1.100 +# search for "e2u+sip" in default tree (configured as parameter)
1.101 +isn_query();
1.102 +...
1.103 +# search for "e2u+voice:sip" in freenum.org
1.104 +isn_query("freenum.org.","voice");
1.105 +...
1.106 +</programlisting>
1.107 + </example>
1.108 + </section>
1.109 +
1.110 + <section>
1.111 <title><function moreinfo="none">is_from_user_enum()</function></title>
1.112 <para>
1.113 Checks if the user part of from <abbrev>URI</abbrev>
