1.2.1. OpenSER Modules

The following modules must be loaded before this module:

• A OpenSER database module (e.g., mysql, dbtext).

1.2.2. External Libraries or Applications

The following libraries or applications must be installed before running OpenSER with this module loaded:

• None.

1.3.1. db_url (string)

SQL URL of database--username, password, host, port and database (ex: mysql://username:password@hostname.com/database)

Default value is "mysql://root@127.0.0.1/pdt".

...
modparam("pdt", "db_url", "mysql://user:xxx@127.0.0.1/ser")
...

1.3.2. db_table (string)

Table name.

Default value is "prefix_domain".

...
modparam("pdt", "db_table", "pdt")
...

1.3.3. prefix_column (string)

Name of 'prefix' column.

Default value is "prefix".

...
modparam("pdt", "prefix_column", "code")
...

1.3.4. domain_column (string)

Name of 'domain' column.

Default value is "domain".

...
modparam("pdt", "domain_column", "hostname")
...

1.3.5. prefix (string)

Default leading prefix who denotes what URI needs to be translated - if it is NULL the module will not check the R-URI against it and the PDT prefix is considered starting from the first digit. Otherwise, the module will check first if the R-URI starts with it and will skip it to look up the domain.

Default value is NULL.

...
modparam("pdt", "prefix", "00")
...

1.3.6. hsize_2pow (integer)

Number of the hash entries = 2^hash_size.

Default value is 4.

...
modparam("pdt", "hsize_2pow", 4)
...

1.3.7. sync_time (integer)

Time in seconds to synchronize the cache of each process with the changes made through FIFO. Any prefix-domain change made through FIFO is guaranteed to have efect after this period of time past.

Default value is 600.

...
modparam("pdt", "sync_time", 300)
...

1.3.8. clean_time (integer)

Time in seconds to clean the changes inserted via FIFO. The changes will be removed from FIFO diff list only when all OpenSER processes applied these changes.

Default value is 900.

...
modparam("pdt", "clean_time", 600)
...

1.4.1. prefix2domain(mode)

Build a new URI if it is necessary. Returns 1 when the translation was made or there was nothing to translate (user part of the URI is empty, it does not match the prefix parameter or there is no domain associated with a possible prefix from user part). Returns -1 in error cases.

The "mode" parameter specifies whether to strip or not the prefix from user part. If the parameter is missing or it has the value "0", then the prefix is removed along with the leading prefix. If the value is "1", only the leading prefix is removed. If the values is "2" the user part of the URI is not changed.

...
prefix2domain();
...
prefix2domain("2");
...

1.5.1. FIFO Commands

The modules uses only the cache to look up domains. If you want to add or delete a new prefix-domain pair you have to use FIFO commands. All changes made via FIFO are applied to database. The database is loaded only at OpenSER start up time.

There are three FIFO commands to use with PDT.

• pdt_add - add a new prefix-domain pair

• pdt_delete - remove a prefix-domain pair

• pdt_list - list the prefixes and the domains

Example shell scripts for these commands are placed in './doc/' (pdt_fifo_add.sh, pdt_fifo_delete.sh, pdt_fifo_list.sh). More about, in the comments before the implementation of the functions, inside the 'pdt.c' file.