Table of Contents
List of Examples
Table of Contents
Domain module implements checks that based on domain table determine if a domain is “local”. A “local” domain is one that the proxy is responsible for. SIP URIs of local users must have hostpart that is equal to one of these domains.
Domain module reads the contents of domain and domain_attrs tables into cache memory when the module is loaded. Any changes in domain or domain_attrs tables must thus be followed by “domain.reload” rpc command in order to reflect them in module behavior.
Caching is implemented using a hash table. The size of the hash table is given by HASH_SIZE constant defined in domain_mod.h. Its “factory default” value is 128.
The module depends on the following modules (in the other words the listed modules must be loaded before this module):
database -- Any database module
This is URL of the database to be used.
Default value is “mysql://openserro:openserro@localhost/openser”
Name of table containing names of local domains that the proxy is responsible for.
Default value is “domain”.
Name of table containing attributes of local domains.
Default value is “domain_attrs”.
Example 1.3. Setting domain_attrs_table parameter
modparam("domain", "domain_attrs_table", "local_domain_attributes")
Name of column containing domain id (did) of domain in domain and domain_attrs tables. In domain table, a did column value may be NULL, which means that it has same value as domain column.
Default value is “did”.
Name of column containing domain name in domain table.
Default value is “domain”.
Name of column containing attribute name in domain_attrs table.
Default value is “name”.
Name of column containing attribute type in domain_attrs table. Type value 0 is integer and type value 2 is string.
Default value is “type”.
Name of column containing attribute value in domain_attrs table.
Default value is “value”.
Checks based on domain table if host part of From header uri is one of the local domains that the proxy is responsible for
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, and LOCAL_ROUTE.
If called from route or failure route block, checks based on domain table if host part of Request-URI is one of the local domains that the proxy is responsible for. If called from branch route, the test is made on host part of URI of first branch, which thus must have been appended to the transaction before is_uri_host_local() is called.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, and LOCAL_ROUTE.
This function checks if the domain contained in the pseudo_variable is local.
This function is a generalized form of the is_from_local() and is_uri_host_local() functions, being able to completely replace them and also extends them by allowing the domain to be taken from any of the above mentioned sources. The following equivalences exist:
is_domain_local("$rd") is same as is_uri_host_local()
is_domain_local("$fd") is same as is_from_local()
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, and LOCAL_ROUTE.
Example 1.12. is_domain_local usage
...
if (is_domain_local("$rd")) {
...
};
if (is_domain_local("$fd")) {
...
};
if (is_domain_local("$avp(some_avp_alias)")) {
...
};
if (is_domain_local("$avp(i:850)")) {
...
};
if (is_domain_local("$avp(s:some_avp)")) {
...
};
...
This function checks if domain given in domain argument (pseudo variable) is local and, if so, adds attributes associated with domain's id (did) to AVPs. If prefix argument (string) is given, names of attributes are prefixes by it. In addition to attributes given in domain_attrs table, AVP did containing did of domain is added.
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, and LOCAL_ROUTE.
Example 1.13. lookup_domain
...
if (lookup_domain("$fd", "from_")) {
xlog("L_INFO", "did of domain $fd is $avp(from_did)\n");
}
...
Causes domain module to re-read the contents of domain table into cache memory.
Name: domain_reload
Parameters: none
MI FIFO Command Format:
:domain_reload:_reply_fifo_file_ _empty_line_
Causes domain module to re-read the contents of domain table into cache memory.
Name: domain.reload
Parameters: none
Example:
sercmd domain.reload
Table of Contents
The module provides is_domain_local API function for use by other Kamailio modules.