Browse code

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

Kamailio Dev authored on 24/03/2021 16:46:10
Showing 1 changed files
... ...
@@ -10,7 +10,7 @@ Daniel-Constantin Mierla
10 10
 
11 11
    <miconda@gmail.com>
12 12
 
13
-   Copyright � 2021 asipto.com
13
+   Copyright © 2021 asipto.com
14 14
      __________________________________________________________________
15 15
 
16 16
    Table of Contents
... ...
@@ -28,6 +28,7 @@ Daniel-Constantin Mierla
28 28
               3.1. protocol (str)
29 29
               3.2. timeout_init (int)
30 30
               3.3. timeout_read (int)
31
+              3.4. verbosity (int)
31 32
 
32 33
         4. Functions
33 34
 
... ...
@@ -43,9 +44,10 @@ Daniel-Constantin Mierla
43 44
    1.1. Set protocol parameter
44 45
    1.2. Set timeout_init parameter
45 46
    1.3. Set timeout_read parameter
46
-   1.4. lwsc_notify usage
47
-   1.5. lwsc_request usage
48
-   1.6. $lwsc(name) usage
47
+   1.4. Set verbosity parameter
48
+   1.5. lwsc_notify usage
49
+   1.6. lwsc_request usage
50
+   1.7. $lwsc(name) usage
49 51
 
50 52
 Chapter 1. Admin Guide
51 53
 
... ...
@@ -62,6 +64,7 @@ Chapter 1. Admin Guide
62 64
         3.1. protocol (str)
63 65
         3.2. timeout_init (int)
64 66
         3.3. timeout_read (int)
67
+        3.4. verbosity (int)
65 68
 
66 69
    4. Functions
67 70
 
... ...
@@ -102,6 +105,7 @@ Chapter 1. Admin Guide
102 105
    3.1. protocol (str)
103 106
    3.2. timeout_init (int)
104 107
    3.3. timeout_read (int)
108
+   3.4. verbosity (int)
105 109
 
106 110
 3.1. protocol (str)
107 111
 
... ...
@@ -138,12 +142,25 @@ modparam("lwsc", "timeout_init", 4000000)
138 142
 modparam("lwsc", "timeout_init", 1000000)
139 143
 ...
140 144
 
145
+3.4. verbosity (int)
146
+
147
+   Control the verbosity of debug messages on libwebsockets events, higher
148
+   value means more debug messages. It has to be a positive number,
149
+   currently 2 or higher results in maximum verbosity.
150
+
151
+   Default value is 0.
152
+
153
+   Example 1.4. Set verbosity parameter
154
+...
155
+modparam("lwsc", "verbosity", 1)
156
+...
157
+
141 158
 4. Functions
142 159
 
143 160
    4.1. lwsc_notify(wsurl, data)
144 161
    4.2. lwsc_request(wsurl, data)
145 162
 
146
-4.1. lwsc_notify(wsurl, data)
163
+4.1.  lwsc_notify(wsurl, data)
147 164
 
148 165
    Send data via websockets to the address specified by wsurl, no response
149 166
    is expected.
... ...
@@ -156,13 +173,13 @@ modparam("lwsc", "timeout_init", 1000000)
156 173
 
157 174
    This function can be used from ANY_ROUTE.
158 175
 
159
-   Example 1.4. lwsc_notify usage
176
+   Example 1.5. lwsc_notify usage
160 177
 ...
161 178
     jwt_notify("ws://10.1.1.10:8080/log",
162 179
         "caller=$fU;callee=$tU;callid=$ci");
163 180
 ...
164 181
 
165
-4.2. lwsc_request(wsurl, data)
182
+4.2.  lwsc_request(wsurl, data)
166 183
 
167 184
    Send data via websockets to the address specified by wsurl, a response
168 185
    is expected and made available in $lwsc(rdata).
... ...
@@ -175,7 +192,7 @@ modparam("lwsc", "timeout_init", 1000000)
175 192
 
176 193
    This function can be used from ANY_ROUTE.
177 194
 
178
-   Example 1.5. lwsc_request usage
195
+   Example 1.6. lwsc_request usage
179 196
 ...
180 197
     jwt_request("ws://10.1.1.10:8080/log",
181 198
         "caller=$fU;callee=$tU;srcip=$si");
... ...
@@ -185,7 +202,7 @@ modparam("lwsc", "timeout_init", 1000000)
185 202
 
186 203
    5.1. $lwsc(key)
187 204
 
188
-5.1. $lwsc(key)
205
+5.1.  $lwsc(key)
189 206
 
190 207
    Get the values and attributes after using LWSC functions.
191 208
 
... ...
@@ -193,7 +210,7 @@ modparam("lwsc", "timeout_init", 1000000)
193 210
      * rdata - the response retrieved after lwsc_request().
194 211
      * status - the status of verification after a failed jwt_verify().
195 212
 
196
-   Example 1.6. $lwsc(name) usage
213
+   Example 1.7. $lwsc(name) usage
197 214
 ...
198 215
   jwt_request("ws://10.1.1.10:8080/log",
199 216
         "caller=$fU;callee=$tU;srcip=$si");