Browse code

modules: readme files regenerated - dlgs ... [skip ci]

Kamailio Dev authored on 29/06/2020 05:46:20
Showing 1 changed files
... ...
@@ -10,7 +10,7 @@ Daniel-Constantin Mierla
10 10
 
11 11
    <miconda@gmail.com>
12 12
 
13
-   Copyright � 2020 asipto.com
13
+   Copyright © 2020 asipto.com
14 14
      __________________________________________________________________
15 15
 
16 16
    Table of Contents
... ...
@@ -25,18 +25,27 @@ Daniel-Constantin Mierla
25 25
 
26 26
         3. Parameters
27 27
 
28
-              3.1. lifetime (int)
28
+              3.1. active_lifetime (int)
29 29
               3.2. timer_interval (int)
30 30
 
31 31
         4. Functions
32 32
 
33
-              4.1. dlgs_manage(src, dst, data)
33
+              4.1. dlgs_init(src, dst, data)
34
+              4.2. dlgs_update(src)
35
+
36
+        5. RPC Commands
37
+
38
+              5.1. rpc.list
39
+              5.2. rpc.stats
34 40
 
35 41
    List of Examples
36 42
 
37
-   1.1. Set lifetime parameter
43
+   1.1. Set active_lifetime parameter
38 44
    1.2. Set timer_interval parameter
39
-   1.3. dlgs_manage usage
45
+   1.3. dlgs_init usage
46
+   1.4. dlgs_update usage
47
+   1.5. dlgs.list usage
48
+   1.6. dlgs.stats usage
40 49
 
41 50
 Chapter 1. Admin Guide
42 51
 
... ...
@@ -50,12 +59,18 @@ Chapter 1. Admin Guide
50 50
 
51 51
    3. Parameters
52 52
 
53
-        3.1. lifetime (int)
53
+        3.1. active_lifetime (int)
54 54
         3.2. timer_interval (int)
55 55
 
56 56
    4. Functions
57 57
 
58
-        4.1. dlgs_manage(src, dst, data)
58
+        4.1. dlgs_init(src, dst, data)
59
+        4.2. dlgs_update(src)
60
+
61
+   5. RPC Commands
62
+
63
+        5.1. rpc.list
64
+        5.2. rpc.stats
59 65
 
60 66
 1. Overview
61 67
 
... ...
@@ -90,18 +105,18 @@ Chapter 1. Admin Guide
90 90
 
91 91
 3. Parameters
92 92
 
93
-   3.1. lifetime (int)
93
+   3.1. active_lifetime (int)
94 94
    3.2. timer_interval (int)
95 95
 
96
-3.1. lifetime (int)
96
+3.1. active_lifetime (int)
97 97
 
98 98
    The lifetime in seconds of a dialog in memory.
99 99
 
100 100
    Default value is 10800 (3 hours).
101 101
 
102
-   Example 1.1. Set lifetime parameter
102
+   Example 1.1. Set active_lifetime parameter
103 103
 ...
104
-modparam("dlgs", "lifetime", 3600)
104
+modparam("dlgs", "active_lifetime", 3600)
105 105
 ...
106 106
 
107 107
 3.2. timer_interval (int)
... ...
@@ -118,22 +133,63 @@ modparam("dlgs", "timer_interval", 60)
118 118
 
119 119
 4. Functions
120 120
 
121
-   4.1. dlgs_manage(src, dst, data)
121
+   4.1. dlgs_init(src, dst, data)
122
+   4.2. dlgs_update(src)
122 123
 
123
-4.1. dlgs_manage(src, dst, data)
124
+4.1.  dlgs_init(src, dst, data)
124 125
 
125
-   Track the dialog corresponding to the current SIP message. It has to be
126
-   used for INVITE messages.
126
+   Start track the dialog corresponding to the current SIP message. It has
127
+   to be used for INVITE messages.
127 128
 
128 129
    This function can be used from ANY_ROUTE.
129 130
 
130
-   Example 1.3. dlgs_manage usage
131
+   Example 1.3. dlgs_init usage
131 132
 ...
132 133
 request_route {
133 134
     ...
134 135
     if(is_method("INVITE")) {
135
-        dlgs_manage("$fu", "$tu", "my data");
136
+        dlgs_init("$fu", "$tu", "my data");
137
+    }
138
+    ...
139
+}
140
+...
141
+
142
+4.2.  dlgs_update(src)
143
+
144
+   Update dialog state.
145
+
146
+   This function can be used from ONSEND_ROUTE.
147
+
148
+   Example 1.4. dlgs_update usage
149
+...
150
+onsend_route {
151
+    ...
152
+    if(is_method("INVITE|ACK|BYE")) {
153
+        dlgs_init("$fu", "$tu", "my data");
136 154
     }
137 155
     ...
138 156
 }
139 157
 ...
158
+
159
+5. RPC Commands
160
+
161
+   5.1. rpc.list
162
+   5.2. rpc.stats
163
+
164
+5.1.  rpc.list
165
+
166
+   List dialog records.
167
+
168
+   Example 1.5. dlgs.list usage
169
+...
170
+kamctl rpc dlgs.list
171
+...
172
+
173
+5.2.  rpc.stats
174
+
175
+   Return dialog statistics.
176
+
177
+   Example 1.6. dlgs.stats usage
178
+...
179
+kamctl rpc dlgs.stats
180
+...