Browse code

evapi: readme regenerated

Daniel-Constantin Mierla authored on 17/12/2015 09:27:50
Showing 1 changed files
... ...
@@ -160,8 +160,16 @@ modparam("evapi", "netstring_format", 0)
160 160
 
161 161
 4.1. evapi_relay(evdata)
162 162
 
163
-   Relay the event data give as parameter to connected applications. The
164
-   format on the network is netstring with evdata payload.
163
+   Relay the event data given as parameter to connected applications.
164
+
165
+   The format on the network is netstring with evdata payload if
166
+   netstring_format parameter is set to 1 or bare evdata if
167
+   netstring_format parameter is set to 0.
168
+
169
+   The function is passing the task to evapi dispatcher process, therefore
170
+   the SIP worker process is not blocked. Also, it doesn't wait for any
171
+   response, therefore the processing of the configuration continues very
172
+   fast when executing evapi_relay().
165 173
 
166 174
    This function can be used from ANY_ROUTE.
167 175
 
... ...
@@ -182,10 +190,17 @@ evapi_relay("{ \"event\": \"test\",\n \"data\": { \"fU\": \"$fU\" }\n}");
182 190
 
183 191
 4.2. evapi_async_relay(evdata)
184 192
 
185
-   Relay the event data give as parameter to connected applications. The
186
-   format on the network is netstring with evdata payload. Before
187
-   evaluating the parameter, the request processing is suspended using tm
188
-   module.
193
+   Relay the event data given as parameter to connected applications.
194
+   Before evaluating the parameter, the request processing is suspended
195
+   using tm module (using the t_suspend()/t_continue() framework). The
196
+   routing of the SIP request can be continued once
197
+   event_route[evapi:message-received] is triggered. After
198
+   evapi_async_relay() returns true, no relaying should happen in
199
+   request_route(), it should be followed by exit;.
200
+
201
+   The format on the network is netstring with evdata payload if
202
+   netstring_format parameter is set to 1 or bare evdata if
203
+   netstring_format parameter is set to 0.
189 204
 
190 205
    This function can be used from REQUEST_ROUTE.
191 206