1.2.1. OpenSER Modules

The following modules must be loaded before this module:

• usrloc - User Location Module.

• sl - Stateless Replies.

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. default_expires (integer)

If the processed message contains neither Expires HFs nor expires contact parameters, this value will be used for newly created usrloc records. The parameter contains number of second to expire (for example use 3600 for one hour).

Default value is 3600.

...
modparam("registrar", "default_expires", 1800)
...

1.3.2. min_expires (integer)

The minimum expires value of a Contact, values lower than this minimum will be automatically set to the minimum. Value 0 disables the checking.

Default value is 60.

...
modparam("registrar", "min_expires", 60)
...

1.3.3. max_expires (integer)

The maximum expires value of a Contact, values higher than this maximum will be automatically set to the maximum. Value 0 disables the checking.

Default value is 0.

...
modparam("registrar", "max_expires", 120)
...

1.3.4. default_q (integer)

The parameter represents default q value for new contacts. Because ser doesn't support float parameter types, the value in the parameter is divided by 100 and stored as float. For example, if you want default_q to be 0.38, use value 38 here.

Default value is 0.

...
modparam("registrar", "default_q", 100)
...

1.3.5. append_branches (integer)

The parameter controls how lookup function processes multiple contacts. If there are multiple contacts for the given username in usrloc and this parameter is set to 1, Request-URI will be overwritten with the highest-q rated contact and the rest will be appended to sip_msg structure and can be later used by tm for forking. If the parameter is set to 0, only Request-URI will be overwritten with the highest-q rated contact and the rest will be left unprocessed.

Default value is 1.

...
modparam("registrar", "append_branches", 0)
...

1.3.6. use_domain (integer)

If set to 1 then the registrar will use username@domain as address of record. If the variable is set to 0 then only username will be used as the address of record.

Default value is 0.

...
modparam("registrar", "use_domain", 1)
...

1.3.7. case_sensitive (integer)

If set to 1 then AOR comparison will be case sensitive, if set to 0 then AOR comparison will be case insensitive--This is recommended.

Default value is 0.

...
modparam("registrar", "case_sensitive", 1)
...

1.3.8. desc_time_order (integer)

If set to 1 then all contacts will be ordered in descending modification time order. In this case the most recently updated/created contact will be used.

Default value is 0.

...
modparam("registrar", "desc_time_order", 1)
...

1.3.9. received_avp (integer)

Registrar will store the value of the AVP configured by this parameter in the received column in the user location database. It will leave the column empty if the AVP is empty. The AVP should contain a SIP URI consisting of the source IP, port, and protocol of the REGISTER message being processed.

The value of this parameter should be the same as the value of corresponding parameter of nathelper module.

Default value is 42.

...
modparam("registrar", "received_avp", 43)
...

1.3.10. received_param (integer)

The name of the parameter that will be appended to Contacts of 200 OK when the received URI was set by nathelper module.

Default value is "received".

...
modparam("registrar", "received_param", "rcv")
...

1.3.11. max_contacts (integer)

The parameter can be used to limit the number of contacts per AOR (Address of Record) in the user location database. Value 0 disables the check.

Default value is 0.

...
# Allow no more than 10 contacts per AOR
modparam("registrar", "max_contacts", 10)
...
		

1.3.12. retry_after (integer)

The registrar can generate 5xx reply to REGISTER in various situations. It can, for example, happen when the max_contacts parameter is set and the processing of REGISTER request would exceed the limit. In this case the registrar would generate "503 Service Unavailable" response.

If you want to add the Retry-After header field in 5xx replies, set this parameter to a value grater than zero (0 means do not add the header field). See section 20.33 of RFC3261 for more details.

Default value is 0 (disabled).

...
modparam("registrar", "retry_after", 30)
...
		

1.3.13. sock_flag (integer)

Flag to signal to register module to look into REGISTER request for a header which contains a socket description (IP:port). This socket info will be stored by register instead of the received socket info.

This make sens only in multiple replicated servers scenarios.

Default value is -1 (no flag).

...
modparam("registrar", "sock_flag", 18)
...
		

1.3.14. sock_hdr_name (string)

Header which contains a socket description (IP:port) to overide the the received socket info. The heaer will be read only if the flag sock_flag is set.

This make sens only in multiple replicated servers scenarios.

Default value is NULL.

...
modparam("registrar", "sock_hdr_name", "Sock-Info")
...
		

1.4.1. save(domain)

The function processes a REGISTER message. It can add, remove or modify usrloc records depending on Contact and Expires HFs in the REGISTER message. On success, 200 OK will be returned listing all contacts that are currently in usrloc. On an error, error message will be send with a short description in reason phrase.

Meaning of the parameters is as follows:

• domain - Logical domain within registrar. If database is used then this must be name of the table which stores the contacts.

...
save("location");
...

1.4.2. save_noreply(domain)

Same as save() but it doesn't send a reply.

Meaning of the parameters is as follows:

• domain - Logical domain within registrar. If database is used then this must be na e of the table which stores the contacts.

...
save_noreply("location");
...

1.4.3. lookup(domain)

The functions extracts username from Request-URI and tries to find all contacts for the username in usrloc. If there are no such contacts, -1 will be returned. If there are such contacts, Request-URI will be overwritten with the contact that has the highest q value and optionally the rest will be appended to the message (depending on append_branches parameter value).

Meaning of the parameters is as follows:

• domain - Name of table that should be used for the lookup.

...
lookup("location");
...

1.4.4. registered(domain)

The function returns true if the AOR in the Request-URI is registered, false otherwise. The function does not modify the message being process, it neither rewrites the Request-URI if a contact is found not append branches.

Meaning of the parameters is as follows:

• domain - Name of table that should be used for the lookup.

...
if (registered("location")) {
	sl_send_reply("100", "Trying");
	...
};
...

1.4.5. add_sock_hdr(hdr_name)

Adds to the current REGISTER request a new header with "hdr_name" which contains the description of the received socket (ip:port)

This make sens only in multiple replicated servers scenarios.

Meaning of the parameters is as follows:

• hdr_name - header name to be used.

...
add_sock_hdr("Sock-Info");
...