1.2.1. OpenSER modules

The following modules must be loaded before this module:

• TM module

• A database module like mysql, postgres or dbtext.

1.2.2. External libraries or applications

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

• none.

1.3.1. db_url (string)

URL of the database table to be used.

Default value is "mysql://openserro:openserro@localhost/openser".

...
modparam("lcr","db_url","mysql://muser:pwd@localhost/openser")
...

1.3.2. gw_table (string)

Name of the table holding the gateways definitions.

Default value is "gw".

...
modparam("lcr","gw_table","gw")
...

1.3.3. gw_name_column (string)

Name of the column holding the gateway name.

Default value is "gw_name".

...
modparam("lcr","gw_name_column","gw_name")
...

1.3.4. ip_addr_column (string)

Name of the column holding the IP address of the gateway.

Default value is "ip_addr".

...
modparam("lcr","ip_addr_column","ip_addr")
...

1.3.5. port_column (string)

Name of the column holding the port number of the gateway.

Default value is "port".

...
modparam("lcr","port_column","port")
...

1.3.6. uri_scheme_column (string)

Name of the column holding the uri scheme of the gateway.

Default value is "uri_scheme".

...
modparam("lcr","uri_scheme_column","scheme")
...

1.3.7. transport_column (string)

Name of the column holding the transport type to be used for the gateway.

Default value is "transport".

...
modparam("lcr","transport_column","transport")
...

1.3.8. grp_id_column (string)

Name of the column holding the group ID.

Default value is "grp_id".

...
modparam("lcr","grp_id_column","grp_id")
...

1.3.9. lcr_table (string)

Name of the table holding the LCR rules.

Default value is "lcr".

...
modparam("lcr","lcr_table","lcr")
...

1.3.10. strip_column (string)

Name of the column holding the number of digits to strip from the RURI before applying the prefix.

Default value is "strip".

...
modparam("lcr","strip_column","strip")
...

1.3.11. prefix_column (string)

Name of the column holding the RURI(destination) prefix.

Default value is "prefix".

...
modparam("lcr","prefix_column","prefix")
...

1.3.12. from_uri_column (string)

Name of the column holding the FROM (source) URI.

Default value is "from_uri".

...
modparam("lcr","from_uri_column","from_uri")
...

1.3.13. priority_column (string)

Name of the column holding the priority of the rule.

Default value is "priority".

...
modparam("lcr","priority_column","priority")
...

1.3.14. gw_uri_avp (string)

Overrides the name of the AVP containing URI scheme, host, port, and transport of a gateway. If the string name of the AVP contains only digits, the name of the AVP is integer value of the string.

Default value is "1400".

...
modparam("lcr","gw_uri_avp","1400")
...

1.3.15. ruri_user_avp (string)

Overrides the name of the AVP containing user part of Request-URI after the first next_gw() call. If the string name of the AVP contains only digits, the name of the AVP is integer value of the string.

Default value is "1402".

...
modparam("lcr","ruri_user_avp","500")
...

1.3.16. contact_avp (string)

Overrides the name of the AVP containing the contact. If the string name of the AVP contains only digits, the name of the AVP is integer value of the string.

Default value is "1401".

...
modparam("lcr","contact_avp","1401")

...

1.3.17. fr_inv_timer_avp (string)

Overrides the name of the AVP carrying the Final Response timeout for INVITEs.

Default value is "fr_inv_timer_avp".

...
modparam("lcr","fr_inv_timer_avp","fr_inv_timer_avp")
...

1.3.18. fr_inv_timer (integer)

Sets the value of the fist INVITE's Final Response timeout to be used during sequential forwarding:

Default value is 90.

...
modparam("lcr","fr_inv_timer",90)
...

1.3.19. fr_inv_timer_next (integer)

Sets the value of the next INVITE's Final Response timeouts to be used during sequential forwarding:

Function next_contacts() sets tm fr_inv_timer to fr_inv_timer_next value if, after next contacts, there are still lower qvalue contacts available, and to fr_inv_timer value if next contacts are the last ones left.

Default value is 30.

...
modparam("lcr","fr_inv_timer_next",30)
...

1.3.20. rpid_avp (string)

Sets the string name of the AVP containing the RPID.

Default value is "rpid".

...
modparam("lcr","rpid_avp","rpid")
...

1.3.21. db_mode (integer)

Sets the database mode of operating:

• 0 : no-caching - a db lookup is performed during each load_gws()

• 1 : regexp are used for from_uri; no db lookup is performed during load_gws(), the DB content is cached into memory;

Default value is "1".

...
modparam("lcr","db_mode",0)
...

1.4.1. load_gws(), load_gws(group-id)

Loads URI schemes, addresses, ports, and transports of gateways that match user part of Request-URI to gw_uri_avp AVPs (see Overview section). If an optional group-id is specified, only gateways belonging to this group are loaded. Returns 1 or -1 depending on success.

This function can be used from REQUEST_ROUTE.

...
if (!load_gws()) {
	sl_send_reply("500", "Server Internal Error - Cannot load gateways");
	exit;
};
...

...
if (!load_gws("1")) {
	sl_send_reply("500", "Server Internal Error - Cannot load gateways from group 1");
	exit;
};
...

1.4.2. next_gw()

If called from a route block, replaces URI scheme, host, port, and transport of Request-URI by the values stored in first gw_uri_avp AVP and destroys that AVP. Saves user part of Request-URI into ruri_user_avp AVP for use in subsequent next_gw() calls.

If called from a failure route block, appends a new branch to request, where URI scheme, host, port, and transport of Request-URI is replaced by the values stored in the first gw_uri_avp AVP and destroys that AVP. Request-URI user is taken from ruri_user_avp AVP.

Returns 1 on success and -1 if there were no gateways left or if an error occurred (see syslog).

Must be preceded by successful load_gws() call.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

...
if (!next_gw()) {
	sl_send_reply("503", "Service not available - No gateways");
	exit;
};
...

...
if (!next_gw()) {
	t_reply("503", "Service not available - No more gateways");
	exit;
};
...

1.4.3. from_gw(), from_gw(group-id)

Checks if request came from IP address of a gateway. If an optional group-id is given, only gateways belonging to this group are checked.

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

...
if (from_gw()) {
	...
	exit;
};
...

...
if (from_gw("1")) {
	...
	exit;
};
...

1.4.4. to_gw(), to_gw(group-id)

Checks if in-dialog request goes to a gateway. If an optional group-id is given, only gateways belonging to this group are checked.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

...
if (to_gw()) {
	...
	exit;
};
...

...
if (to_gw("1")) {
	...
	exit;
};
...

1.4.5. load_contacts()

Loads contacts in destination set in increasing qvalue order as values of lcr_contact AVP. If all contacts in the destination set have the same qvalue, load_contacts() does not do anything thus minimizing performance impact of sequential forking capability when it is not needed. Returns 1 if loading of contacts succeeded or there was nothing to do. Returns -1 on error (see syslog).

This function can be used from REQUEST_ROUTE.

...
if (!load_contacts()) {
	sl_send_reply("500", "Server Internal Error - Cannot load contacts");
	exit;
};
...

1.4.6. next_contacts()

If called from a route block, replaces Request-URI with the first lcr_contact AVP value, adds the remaining lcr_contact AVP values with the same qvalue as branches, and destroys those AVPs. It does nothing if there are no lcr_contact AVPs. Returns 1 if there were no errors and -1 if an error occurred (see syslog).

If called from a failure route block, adds the first lcr_contact AVP value and all following lcr_contact AVP values with the same qvalue as new branches to request and destroys those AVPs. Returns 1 if new branches were successfully added and -1 on error (see syslog) or if there were no more lcr_contact AVPs.

Must be preceded by successful load_contacts() call.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.

...
if (!next_contacts()) {
	sl_send_reply("500", "Server Internal Error");
	exit;
} else {
	t_relay();
};
...

if (next_contacts()) {
	t_relay();
};

1.5.1. lcr_reload

Causes lcr module to re-read the contents of gateway table into memory.

1.5.2. lcr_dump

Causes lcr module to dump the contents of its in-memory gateway table.