1.3.1. OpenSER Modules

The following modules must be loaded before this module:

• TM - Transaction module

• RR - Record-Route module

1.3.2. External Libraries or Applications

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

• None.

1.4.1. enable_stats (integer)

If the statistics support should be enabled or not. Via statistic variables, the module provide information about the dialog processing. Set it to zero to disable or to non-zero to enable it.

Default value is "1 (enabled)".

...
modparam("dialog", "enable_stats", 0)
...

1.4.2. hash_size (integer)

The size of the hash table internally used to keep the dialogs. A larger table is much faster but consumes more memory. The hash size must be a power of 2 number.

Default value is "4096".

...
modparam("dialog", "hash_size", 1024)
...

1.4.3. rr_param (string)

Name of the Record-Route parameter to be added with the dialog cookie. It is used for fast dialog matching of the sequential requests.

Default value is "did".

...
modparam("dialog", "rr_param", "xyz")
...

1.4.4. dlg_flag (integer)

Flag to be used for marking if a dialog should be constructed for the current request (make sense only for initial requests).

Default value is "none".

...
modparam("dialog", "dlg_flag", 4)
...

1.4.5. timeout_avp (string)

The specification of an AVP to contain a custom timeout (in seconds) for the dialog. It may be used only in a request (initial or sequential) context

Default value is "none".

...
modparam("dialog", "timeout_avp", "$avp(i:10)")
...

1.4.6. default_timeout (integer)

The default dialog timeout (in seconds) if no custom one is set.

Default value is "43200 (12 hours)".

...
modparam("dialog", "default_timeout", 21600)
...

1.4.7. use_tight_match (integer)

If tight matching should be use dialog matching of sequential requests. By default, the matching is done only on the RR cookie; tight matching extra checks the callid. Set it to zero to disable or to non-zero to enable it.

Default value is "0 (disabled)".

...
modparam("dialog", "use_tight_match", 1)
...

1.6.1. active_dialogs

Returns the number of current active dialogs (may be confirmed or not).

1.6.2. processed_dialogs

Returns the total number of processed dialogs (terminated, expired or active) from the startup.

1.6.3. expired_dialogs

Returns the total number of expired dialogs from the startup.

1.7.1. $dlg_count

Returns the number of current active dialogs (may be confirmed or not).

2.1.1. register_dlgcb (dialog, type, cb, param)

Register a new callback to the dialog.

Meaning of the parameters is as follows:

• struct dlg_cell* dlg - dialog to register callback to. If maybe NULL only for DLG_CREATED callback type, which is not a per dialog type.

• int type - types of callbacks; more types may be register for the same callback function; only DLG_CREATED must be register alone. Possible types:

  • DLG_CREATED - called when a new dialog is created - it's a global type (not associated to any dialog)

  • DLG_FAILED - called when the dialog was negatively replied (non-2xx) - it's a per dialog type.

  • DLG_CONFIRMED - called when the dialog is confirmed (2xx replied) - it's a per dialog type.

  • DLG_REQ_WITHIN - called when the dialog matches a sequential request - it's a per dialog type.

  • DLG_TERMINATED - called when the dialog is terminated via BYE - it's a per dialog type.

  • DLG_EXPIRED - called when the dialog expires without receiving a BYE - it's a per dialog type.

• dialog_cb f - callback function to be called. Prototype is: "void (dialog_cb) (struct dlg_cell* dlg, int type, struct sip_msg* msg, void** param);"

• void *param - parameter to be passed to the callback function.