Table of Contents
hash_size (integer)timer_interval (integer)db_url (string)table_name (string)registrar_column (string)proxy_column (string)aor_column (string)third_party_registrant_column (string)username_column (string)password_column (string)binding_URI_column (string)binding_params_column (string)expiry_column (string)forced_socket_column (string)List of Examples
hash_size parametertimer_interval parameterThe module enable OpenSIPS to register itself on a remote SIP registrar.
At startup, the registrant records are loaded into a hash table in memory and a timer is started. The hash index is computed over the AOR field.
The timer interval for checking records in a hash bucket is computed by dividing the timer_interval module param by the number of hash buckets. When the timer fires for the first time, the first hash bucket will be checked and REGISTERs will be sent out for each record that is found. On the next timeout fire, the second hash bucket will be checked and so on. If the configured timer_interval module param is lower then the number of buckets, the module will fail to start.
Example: setting the timer_interval module to 8 with a hash_size of 2, will result in having 4 hash buckets (2^2=4) and buckets will be checked one by one every 2s (8/4=2).
Each registrant has it's own state. Registranr's status can be inspected via "reg_list" MI comand.
UAC registrant states:
0 - NOT_REGISTERED_STATE - the initial state (no REGISTER has been sent out yet);
1 - REGISTERING_STATE - waiting for a reply from the registrar after a REGISTER without authentication header was sent;
2 - AUTHENTICATING_STATE - waiting for a reply from the registrar after a REGISTER with authentication header was sent;
3 - REGISTERED_STATE - the uac is successfully registered;
4 - REGISTER_TIMEOUT_STATE : no reply received from the registrar;
5 - INTERNAL_ERROR_STATE - some errors were found/encountered during the processing of a reply;
6 - WRONG_CREDENTIALS_STATE - credentials rejected by the registrar;
7 - REGISTRAR_ERROR_STATE - error reply received from the registrar;
The following modules must be loaded before this module:
uac_auth - UAC authentication module
The size of the hash table internally used to keep the registrants. A larger table distributes better the registration load in time but consumes more memory. The hash size is a power of number two.
Default value is 1.
Defines the periodic timer for checking the registrations status.
Default value is 100.
Database where to load the registrants from.
Default value is “NULL” (use default DB URL from core).
Example 1.3. Set “db_url” parameter
...
modparam("uac_registrant", "db_url", "mysql://user:passw@localhost/database")
...
The database table that holds the registrant records.
Default value is “registrant”.
Example 1.4. Set “table_name” parameter
...
modparam("uac_registrant", "table_name", "my_registrant")
...
The column's name in the database storing the URI pointing to the remote registrar (mandatory field). OpenSIPS expects a valid URI.
Default value is “registrar”.
Example 1.5. Set “registrar_column” parameter
...
modparam("uac_registrant", "registrar_column", "registranr_uri")
...
The column's name in the database storing the URI pointing to the outbond proxy (not mandatory field). An empty or NULL value means no outbound proxy, otherwise OpenSIPS expects a valid URI.
Default value is “proxy”.
Example 1.6. Set “proxy_column” parameter
...
modparam("uac_registrant", "proxy_column", "proxy_uri")
...
The column's name in the database storing the URI defining the address of record (mandatory field). The URI stored here will be used in the To URI of the REGISTER. OpenSIPS expects a valid URI.
Default value is “aor”.
The column's name in the database storing the URI defining the third party registrant (not mandatory field). The URI stored here will be used in the From URI of the REGISTER. An empty or NULL value means no third party registration (the From URI will be identical to To URI), otherwise OpenSIPS expects a valid URI.
Default value is “third_party_registrant”.
Example 1.8. Set “third_party_registrant_column” parameter
...
modparam("uac_registrant", "third_party_registrant_column", "from_uri")
...
The column's name in the database storing the username for authentication (mandatory if the registrar requires authentication).
Default value is “username”.
Example 1.9. Set “username_column” parameter
...
modparam("uac_registrant", "username_column", "auth_username")
...
The column's name in the database storing the password for authentication (mandatory if the registrar requires authntication).
Default value is “password”.
Example 1.10. Set “password_column” parameter
...
modparam("uac_registrant", "password_column", "auth_passowrd")
...
The column's name in the database storing the binding URI in REGISTER (mandatory field). The URI stored here will be used in the Contact URI of the REGISTER. OpenSIPS expects a valid URI.
Default value is “binding_URI”.
Example 1.11. Set “binding_URI_column” parameter
...
modparam("uac_registrant", "binding_URI_column", "contact_uri")
...
The column's name in the database storing the binding params in REGISTER (not mandatory field). If not NULL or not empty, the string stored here will be added as paramns to the Contact URI in REGISTER (it MUST start with “;”. There is no validation on the string stored here.
Default value is “binding_params”.
Example 1.12. Set “binding_params_column” parameter
...
modparam("uac_registrant", "binding_params_column", "contact_params")
...
The column's name in the database storing the expiration time (not mandatory).
Default value is “expiry”.
Example 1.13. Set “expiry_column” parameter
...
modparam("uac_registrant", "expiry_column", "registration_timeout")
...
The column's name in the database storing the socket for sending the REGISTER (not mandatory). If a forced socket is provided, the socket MUST be explicitely set as a global listening socket in the config (see “listen” core parameter).
Default value is “forced_socket”.
Example 1.14. Set “forced_socket_column” parameter
...
modparam("uac_registrant", "forced_socket_column", "fs")
...
Lists the registrant records and their status.
Name: reg_list
Parameters: none
MI FIFO Command Format:
:reg_list:_reply_fifo_file_ _empty_line_