[sr-dev] git:master:b7c7976d: modules: readme files regenerated - dlgs ... [skip ci]

Module: kamailio Branch: master Commit: b7c7976d3e84ac648b689e5e496e619f587a4eb9 URL: https://github.com/kamailio/kamailio/commit/b7c7976d3e84ac648b689e5e496e619… Author: Kamailio Dev <kamailio.dev(a)kamailio.org> Committer: Kamailio Dev <kamailio.dev(a)kamailio.org> Date: 2020-06-29T07:46:20+02:00 modules: readme files regenerated - dlgs ... [skip ci] --- Modified: src/modules/dlgs/README --- Diff: https://github.com/kamailio/kamailio/commit/b7c7976d3e84ac648b689e5e496e619… Patch: https://github.com/kamailio/kamailio/commit/b7c7976d3e84ac648b689e5e496e619… --- diff --git a/src/modules/dlgs/README b/src/modules/dlgs/README index 83cf48594e..837db4330b 100644 --- a/src/modules/dlgs/README +++ b/src/modules/dlgs/README @@ -10,7 +10,7 @@ Daniel-Constantin Mierla <miconda(a)gmail.com> - Copyright © 2020 asipto.com + Copyright © 2020 asipto.com __________________________________________________________________ Table of Contents @@ -25,18 +25,27 @@ Daniel-Constantin Mierla 3. Parameters - 3.1. lifetime (int) + 3.1. active_lifetime (int) 3.2. timer_interval (int) 4. Functions - 4.1. dlgs_manage(src, dst, data) + 4.1. dlgs_init(src, dst, data) + 4.2. dlgs_update(src) + + 5. RPC Commands + + 5.1. rpc.list + 5.2. rpc.stats List of Examples - 1.1. Set lifetime parameter + 1.1. Set active_lifetime parameter 1.2. Set timer_interval parameter - 1.3. dlgs_manage usage + 1.3. dlgs_init usage + 1.4. dlgs_update usage + 1.5. dlgs.list usage + 1.6. dlgs.stats usage Chapter 1. Admin Guide @@ -50,12 +59,18 @@ Chapter 1. Admin Guide 3. Parameters - 3.1. lifetime (int) + 3.1. active_lifetime (int) 3.2. timer_interval (int) 4. Functions - 4.1. dlgs_manage(src, dst, data) + 4.1. dlgs_init(src, dst, data) + 4.2. dlgs_update(src) + + 5. RPC Commands + + 5.1. rpc.list + 5.2. rpc.stats 1. Overview @@ -90,18 +105,18 @@ Chapter 1. Admin Guide 3. Parameters - 3.1. lifetime (int) + 3.1. active_lifetime (int) 3.2. timer_interval (int) -3.1. lifetime (int) +3.1. active_lifetime (int) The lifetime in seconds of a dialog in memory. Default value is 10800 (3 hours). - Example 1.1. Set lifetime parameter + Example 1.1. Set active_lifetime parameter ... -modparam("dlgs", "lifetime", 3600) +modparam("dlgs", "active_lifetime", 3600) ... 3.2. timer_interval (int) @@ -118,22 +133,63 @@ modparam("dlgs", "timer_interval", 60) 4. Functions - 4.1. dlgs_manage(src, dst, data) + 4.1. dlgs_init(src, dst, data) + 4.2. dlgs_update(src) -4.1. dlgs_manage(src, dst, data) +4.1. dlgs_init(src, dst, data) - Track the dialog corresponding to the current SIP message. It has to be - used for INVITE messages. + Start 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 + Example 1.3. dlgs_init usage ... request_route { ... if(is_method("INVITE")) { - dlgs_manage("$fu", "$tu", "my data"); + dlgs_init("$fu", "$tu", "my data"); + } + ... +} +... + +4.2. dlgs_update(src) + + Update dialog state. + + This function can be used from ONSEND_ROUTE. + + Example 1.4. dlgs_update usage +... +onsend_route { + ... + if(is_method("INVITE|ACK|BYE")) { + dlgs_init("$fu", "$tu", "my data"); } ... } ... + +5. RPC Commands + + 5.1. rpc.list + 5.2. rpc.stats + +5.1. rpc.list + + List dialog records. + + Example 1.5. dlgs.list usage +... +kamctl rpc dlgs.list +... + +5.2. rpc.stats + + Return dialog statistics. + + Example 1.6. dlgs.stats usage +... +kamctl rpc dlgs.stats +...