[sr-dev] git:master: prefix_route: readme converted to docbook

Module: sip-router Branch: master Commit: 5816239e3714fc9fcf894cb82de114435447ed92 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=5816239… Author: Daniel-Constantin Mierla <miconda(a)gmail.com> Committer: Daniel-Constantin Mierla <miconda(a)gmail.com> Date: Mon Oct 4 15:33:42 2010 +0200 prefix_route: readme converted to docbook --- modules/prefix_route/README | 127 ++++++++++++++++++++++++------------------- 1 files changed, 70 insertions(+), 57 deletions(-) diff --git a/modules/prefix_route/README b/modules/prefix_route/README index 267c315..92a9024 100644 --- a/modules/prefix_route/README +++ b/modules/prefix_route/README @@ -1,97 +1,110 @@ -Prefix route module -Alfred E. Heggestad - -Sponsored by Telio Telecom - - - +1. prefix_route Module -Overview +Alfred E. Heggestad - The prefix_route module does routing based on a set of prefixes from the - database. The prefix rule-set is loaded from the database into a binary - tree in memory, either on startup or when issuing the "prefix_route.reload" RPC - command. When calling the "prefix_route()" function from the ser.cfg - configuration script, it will try to match the user part of the request URI - with the best matching route. If a route is found, it will be used for - further processing. If not found normal processing will continue. + Telio Telecom + Copyright © 2007 Alfred E. Heggestad + Copyright © 2008 Telio Telecom AS + __________________________________________________________________ + 1.1. Overview + 1.2. Parameters -Exported Parameters + 1.2.1. db_url (string) + 1.2.2. db_table (string) - db_url (string) + 1.3. Functions - Database URL. + 1.3.1. prefix_route() - Default value is "mysql://ser@localhost/ser". + 1.4. RPC Commands - Example. Set the "db_url" parameter - ... - modparam("prefix_route", "db_url", "mysql://user:passwd@host.com/dbname") - ... + 1.4.1. prefix_route.reload + 1.4.2. prefix_route.dump + 1.5. Database Structure - db_table (string) +1.1. Overview - The name of table where to read prefix route set + The prefix_route module does routing based on a set of prefixes from + the database. The prefix rule-set is loaded from the database into a + binary tree in memory, either on startup or when issuing the + "prefix_route.reload" RPC command. When calling the "prefix_route()" + function from the ser.cfg configuration script, it will try to match + the user part of the request URI with the best matching route. If a + route is found, it will be used for further processing. If not found + normal processing will continue. - Default value is "prefix_route". + Development was sponsored by Telio Telecom. - Example. Set the "db_table" parameter - ... - modparam("prefix_route", "db_table", "prefix_route") - ... +1.2. Parameters +1.2.1. db_url (string) + This is URL of the database to be used. + Default value is "mysql://ser@localhost/ser" -Exported Functions + Example 1. Setting db_url parameter +... +modparam("prefix_route", "db_url", "mysql://ser:pass@db_host/ser") +... - prefix_route() +1.2.2. db_table (string) - This function tries to find a route from the user part of the request URI. - If a route is found, it will be used for further processing. Otherwise the - function will return false. + The name of table where to read prefix route set. - Example: + Default value is "prefix_route". - if (!prefix_route()) { - xlog("L_ERR", "prefix_route(): no matching routes\n"); - } + Example 2. Setting db_table parameter +... +modparam("prefix_route", "db_table", "new_prefix_route") +... +1.3. Functions +1.3.1. prefix_route() + This function tries to find a route from the user part of the request + URI. If a route is found, it will be used for further processing. + Otherwise the function will return false. -RPC commands + Example 3. prefix_route() usage +... + if (!prefix_route()) { + xlog("L_ERR", "prefix_route(): no matching routes\n"); + } +... - "prefix_route.reload" - Reload prefix route tree from the database. - Validation is done and the prefix route tree will - only be reloaded if there are no errors. +1.4. RPC Commands - "prefix_route.dump" - Dump the current prefix route tree. +1.4.1. prefix_route.reload + Reload prefix route tree from the database. Validation is done and the + prefix route tree will only be reloaded if there are no errors. +1.4.2. prefix_route.dump + Dump the current prefix route tree. -Database schema +1.5. Database Structure A prefix route set consists of three fields: + * prefix - varchar(64) - Prefix rule + * route - varchar(64) - Route name + * comment - varchar(64) - Free-form comment - - prefix varchar(64) Prefix rule - - route varchar(64) Route name - - comment varchar(64) Free-form comment - - - Example: - + Example 4. Sample data +... +--------+-------+---------------+ | prefix | route | comment | +--------+-------+---------------+ - | 46 | SE | Sweden | - | 47 | NO | Norway | - | 479 | NOMOB | Norway mobile | - | 49 | DE | Deutschland | - | 39 | IT | Italy | + | 46 | SE | Sweden | + | 47 | NO | Norway | + | 479 | NOMOB | Norway mobile | + | 49 | DE | Deutschland | + | 39 | IT | Italy | +--------+-------+---------------+ +...