diff --git a/src/modules/dlgs/README b/src/modules/dlgs/README new file mode 100644 index 00000000000..83cf48594e7 --- /dev/null +++ b/src/modules/dlgs/README @@ -0,0 +1,139 @@ +DLGS Module + +Daniel-Constantin Mierla + + + +Edited by + +Daniel-Constantin Mierla + + + + Copyright © 2020 asipto.com + __________________________________________________________________ + + Table of Contents + + 1. Admin Guide + + 1. Overview + 2. Dependencies + + 2.1. Kamailio Modules + 2.2. External Libraries or Applications + + 3. Parameters + + 3.1. lifetime (int) + 3.2. timer_interval (int) + + 4. Functions + + 4.1. dlgs_manage(src, dst, data) + + List of Examples + + 1.1. Set lifetime parameter + 1.2. Set timer_interval parameter + 1.3. dlgs_manage usage + +Chapter 1. Admin Guide + + Table of Contents + + 1. Overview + 2. Dependencies + + 2.1. Kamailio Modules + 2.2. External Libraries or Applications + + 3. Parameters + + 3.1. lifetime (int) + 3.2. timer_interval (int) + + 4. Functions + + 4.1. dlgs_manage(src, dst, data) + +1. Overview + + This module tracks dialogs (active calls) in stateless mode and offers + statistics about them. + + The dialogs can be tagged and the number of dialogs with the same tag + can be retrieved in configuration file. + + The module aims to be a lightweight alternative to dialog module, to + enable SIP server instances (such as an edge proxy or SBC) to know how + many active calls they route, without being a call stateful proxy. The + tracking of active calls is done without any dependency on other + modules, in other words, it does not need the tm (transaction + management) module. + +2. Dependencies + + 2.1. Kamailio Modules + 2.2. External Libraries or Applications + +2.1. Kamailio Modules + + The following modules must be loaded before this module: + * none. + +2.2. External Libraries or Applications + + The following libraries or applications must be installed before + running Kamailio with this module loaded: + * none + +3. Parameters + + 3.1. lifetime (int) + 3.2. timer_interval (int) + +3.1. lifetime (int) + + The lifetime in seconds of a dialog in memory. + + Default value is 10800 (3 hours). + + Example 1.1. Set lifetime parameter +... +modparam("dlgs", "lifetime", 3600) +... + +3.2. timer_interval (int) + + The value in secods to run the timer callback function for cleaning up + dialogs past the lifetime limit. + + Default value is 30. + + Example 1.2. Set timer_interval parameter +... +modparam("dlgs", "timer_interval", 60) +... + +4. Functions + + 4.1. dlgs_manage(src, dst, data) + +4.1. dlgs_manage(src, dst, data) + + Track the dialog corresponding to the current SIP message. It has to be + used for INVITE messages. + + This function can be used from ANY_ROUTE. + + Example 1.3. dlgs_manage usage +... +request_route { + ... + if(is_method("INVITE")) { + dlgs_manage("$fu", "$tu", "my data"); + } + ... +} +... diff --git a/src/modules/dlgs/doc/Makefile b/src/modules/dlgs/doc/Makefile new file mode 100644 index 00000000000..15a561ef2d8 --- /dev/null +++ b/src/modules/dlgs/doc/Makefile @@ -0,0 +1,4 @@ +docs = dlgs.xml + +docbook_dir = ../../../../doc/docbook +include $(docbook_dir)/Makefile.module diff --git a/src/modules/dlgs/doc/dlgs.xml b/src/modules/dlgs/doc/dlgs.xml new file mode 100644 index 00000000000..7169c239865 --- /dev/null +++ b/src/modules/dlgs/doc/dlgs.xml @@ -0,0 +1,36 @@ + + + +%docentities; + +]> + + + + DLGS Module + kamailio.org + + + Daniel-Constantin + Mierla + miconda@gmail.com + + + Daniel-Constantin + Mierla + miconda@gmail.com + + + + 2020 + asipto.com + + + + + + + diff --git a/src/modules/dlgs/doc/dlgs_admin.xml b/src/modules/dlgs/doc/dlgs_admin.xml new file mode 100644 index 00000000000..9bb7691b030 --- /dev/null +++ b/src/modules/dlgs/doc/dlgs_admin.xml @@ -0,0 +1,137 @@ + + + +%docentities; + +]> + + + + + &adminguide; + +
+ Overview + + This module tracks dialogs (active calls) in stateless mode and offers + statistics about them. + + + The dialogs can be tagged and the number of dialogs with the same tag + can be retrieved in configuration file. + + + The module aims to be a lightweight alternative to dialog module, to + enable SIP server instances (such as an edge proxy or SBC) to know how + many active calls they route, without being a call stateful proxy. The + tracking of active calls is done without any dependency on other modules, + in other words, it does not need the tm (transaction management) module. + +
+ +
+ Dependencies +
+ &kamailio; Modules + + The following modules must be loaded before this module: + + + + none. + + + + +
+
+ External Libraries or Applications + + The following libraries or applications must be installed before running + &kamailio; with this module loaded: + + + + none + + + + +
+
+
+ Parameters +
+ <varname>lifetime</varname> (int) + + The lifetime in seconds of a dialog in memory. + + + + Default value is 10800 (3 hours). + + + + Set <varname>lifetime</varname> parameter + +... +modparam("dlgs", "lifetime", 3600) +... + + +
+
+ <varname>timer_interval</varname> (int) + + The value in secods to run the timer callback function for cleaning + up dialogs past the lifetime limit. + + + + Default value is 30. + + + + Set <varname>timer_interval</varname> parameter + +... +modparam("dlgs", "timer_interval", 60) +... + + +
+
+ +
+ Functions +
+ + <function moreinfo="none">dlgs_manage(src, dst, data)</function> + + + Track the dialog corresponding to the current SIP message. It has to be + used for INVITE messages. + + + This function can be used from ANY_ROUTE. + + + <function>dlgs_manage</function> usage + +... +request_route { + ... + if(is_method("INVITE")) { + dlgs_manage("$fu", "$tu", "my data"); + } + ... +} +... + + +
+
+