domain Module

This is URL of the database to be used.

Default value is “mysql://opensipsro:opensipsro@localhost/opensips”

modparam("domain", "db_url", "mysql://ser:pass@db_host/ser")

Database mode: 0 means non-caching, 1 means caching.

Default value is 0 (non-caching).

modparam("domain", "db_mode", 1)   # Use caching

Name of table containing names of local domains that the proxy is responsible for. Local users must have in their sip uri a host part that is equal to one of these domains.

Default value is “domain”.

modparam("domain", "domain_table", "new_name")

Name of column containing domains in domain table.

Default value is “domain”.

modparam("domain", "domain_col", "domain_name")

Name of column containing attributes in domain table.

Default value is “attrs”.

modparam("domain", "attrs_col", "attributes")

Checks based on domain table if host part of From header uri is one of the local domains that the proxy is responsible for. The argument is optional and if present it should contain a writable pseudo variable that will be populated with the attributes from the database.

This function can be used from REQUEST_ROUTE.

...
if (is_from_local()) {
	...
};
...
if (is_from_local("$var(attrs)")) {
	xlog("Domain attributes are $var(attrs)\n");
	...
};
...
		

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. The argument is optional and if present it should contain a writable pseudo variable that will be populated with the attributes from the database.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.

...
if (is_uri_host_local()) {
	...
};
...
if (is_uri_host_local("$var(attrs)")) {
	xlog("Domain attributes are $var(attrs)\n");
	...
};
		

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:

The second argument is optional and if present it should contain a writable pseudo variable that will be populated with the attributes from the database.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE.

...
if (is_domain_local("$rd")) {
	...
};
if (is_domain_local("$fd")) {
	...
};
if (is_domain_local("$avp(some_avp_alias)")) {
	...
};
if (is_domain_local("$avp(850)")) {
	...
};
if (is_domain_local("$avp(some_avp)")) {
	...
};
if (is_domain_local("$avp(some_avp)", "$avp(attrs)")) {
	xlog("Domain attributes are $avp(attrs)\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 dump hash indexes and domain names in its cache memory.

Name: domain_dump

Parameters: none

MI FIFO Command Format:

		:domain_dump:_reply_fifo_file_
		_empty_line_
		

Checks if domain given in str* parameter is local.

The function returns 1 if domain is local and -1 if domain is not local or if an error occurred.