Browse code

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

Kamailio Dev authored on 24/09/2021 08:46:17
Showing 1 changed files
... ...
@@ -23,15 +23,20 @@ Daniel-Constantin Mierla
23 23
               2.1. Kamailio Modules
24 24
               2.2. External Libraries or Applications
25 25
 
26
-        3. Functions
26
+        3. Parameters
27 27
 
28
-              3.1. sworker_active()
29
-              3.2. swork_task(gname)
28
+              3.1. xdata (str)
29
+
30
+        4. Functions
31
+
32
+              4.1. sworker_active()
33
+              4.2. swork_task(gname)
30 34
 
31 35
    List of Examples
32 36
 
33
-   1.1. sworker_active() usage
34
-   1.2. sworker_task() usage
37
+   1.1. xdata usage
38
+   1.2. sworker_active() usage
39
+   1.3. sworker_task() usage
35 40
 
36 41
 Chapter 1. Admin Guide
37 42
 
... ...
@@ -43,10 +48,14 @@ Chapter 1. Admin Guide
43 48
         2.1. Kamailio Modules
44 49
         2.2. External Libraries or Applications
45 50
 
46
-   3. Functions
51
+   3. Parameters
52
+
53
+        3.1. xdata (str)
47 54
 
48
-        3.1. sworker_active()
49
-        3.2. swork_task(gname)
55
+   4. Functions
56
+
57
+        4.1. sworker_active()
58
+        4.2. swork_task(gname)
50 59
 
51 60
 1. Overview
52 61
 
... ...
@@ -81,19 +90,39 @@ Chapter 1. Admin Guide
81 90
    running Kamailio with this module loaded:
82 91
      * None
83 92
 
84
-3. Functions
93
+3. Parameters
94
+
95
+   3.1. xdata (str)
96
+
97
+3.1.  xdata (str)
98
+
99
+   Name of a script variable from where to take additional data to be
100
+   passed to special worker along with the SIP message. Same variable will
101
+   be set by the special worker, therefore it has to be a writable
102
+   variable. Moreover, it must be a variable that can be set without the
103
+   SIP message structure, like $var(name), otherwise it can lead to a
104
+   crash.
105
+
106
+   Default value: not set.
107
+
108
+   Example 1.1. xdata usage
109
+...
110
+modparam("sworker", "xdata", "$var(xdata)")
111
+...
112
+
113
+4. Functions
85 114
 
86
-   3.1. sworker_active()
87
-   3.2. swork_task(gname)
115
+   4.1. sworker_active()
116
+   4.2. swork_task(gname)
88 117
 
89
-3.1.  sworker_active()
118
+4.1.  sworker_active()
90 119
 
91 120
    Return 1 (true) if the processing happens in an asyn process, or -1
92 121
    (false) if the processing is happening in a SIP receiving process.
93 122
 
94 123
    This function can be used from REQUEST_ROUTE|CORE_REPLY_ROUTE.
95 124
 
96
-   Example 1.1. sworker_active() usage
125
+   Example 1.2. sworker_active() usage
97 126
 ...
98 127
 request_route {
99 128
     ...
... ...
@@ -103,7 +132,7 @@ request_route {
103 132
 }
104 133
 ...
105 134
 
106
-3.2.  swork_task(gname)
135
+4.2.  swork_task(gname)
107 136
 
108 137
    Delegate the processing of SIP message to a group of async workers. The
109 138
    function is restricted to be used inside event_route[core:pre-routing].
... ...
@@ -119,7 +148,7 @@ request_route {
119 148
 
120 149
    This function can be used from REQUEST_ROUTE|CORE_REPLY_ROUTE.
121 150
 
122
-   Example 1.2. sworker_task() usage
151
+   Example 1.3. sworker_task() usage
123 152
 ...
124 153
 event_route[core:pre-routing] {
125 154
         if(sworker_task("default")) {