[sr-dev] git:4.2:2a802634: evapi: readme regenerated

[Daniel-Constantin Mierla]

Module: kamailio
Branch: 4.2
Commit: 2a802634cfd176ce6920f827fb3bb2a2749e3d84
URL: https://github.com/kamailio/kamailio/commit/2a802634cfd176ce6920f827fb3bb2a2749e3d84

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2015-12-17T10:27:50+01:00

evapi: readme regenerated

---

Modified: modules/evapi/README

---

Diff:  https://github.com/kamailio/kamailio/commit/2a802634cfd176ce6920f827fb3bb2a2749e3d84.diff
Patch: https://github.com/kamailio/kamailio/commit/2a802634cfd176ce6920f827fb3bb2a2749e3d84.patch

---

diff --git a/modules/evapi/README b/modules/evapi/README
index 6035cce..4d61f8e 100644
--- a/modules/evapi/README
+++ b/modules/evapi/README
@@ -160,8 +160,16 @@ modparam("evapi", "netstring_format", 0)
 
 4.1. evapi_relay(evdata)
 
-   Relay the event data give as parameter to connected applications. The
-   format on the network is netstring with evdata payload.
+   Relay the event data given as parameter to connected applications.
+
+   The format on the network is netstring with evdata payload if
+   netstring_format parameter is set to 1 or bare evdata if
+   netstring_format parameter is set to 0.
+
+   The function is passing the task to evapi dispatcher process, therefore
+   the SIP worker process is not blocked. Also, it doesn't wait for any
+   response, therefore the processing of the configuration continues very
+   fast when executing evapi_relay().
 
    This function can be used from ANY_ROUTE.
 
@@ -182,10 +190,17 @@ evapi_relay("{ \"event\": \"test\",\n \"data\": { \"fU\": \"$fU\" }\n}");
 
 4.2. evapi_async_relay(evdata)
 
-   Relay the event data give as parameter to connected applications. The
-   format on the network is netstring with evdata payload. Before
-   evaluating the parameter, the request processing is suspended using tm
-   module.
+   Relay the event data given as parameter to connected applications.
+   Before evaluating the parameter, the request processing is suspended
+   using tm module (using the t_suspend()/t_continue() framework). The
+   routing of the SIP request can be continued once
+   event_route[evapi:message-received] is triggered. After
+   evapi_async_relay() returns true, no relaying should happen in
+   request_route(), it should be followed by exit;.
+
+   The format on the network is netstring with evdata payload if
+   netstring_format parameter is set to 1 or bare evdata if
+   netstring_format parameter is set to 0.
 
    This function can be used from REQUEST_ROUTE.