Module: sip-router Branch: master Commit: b19bc8a5c15707289e2d46c211fda4585257397c URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=b19bc8a5...
Author: Olle E. Johansson oej@edvina.net Committer: Olle E. Johansson oej@edvina.net Date: Wed Sep 17 12:50:05 2014 +0200
evapi: update docs
---
modules/evapi/README | 17 +++++++++++++---- modules/evapi/doc/evapi_admin.xml | 20 +++++++++++++++----- 2 files changed, 28 insertions(+), 9 deletions(-)
diff --git a/modules/evapi/README b/modules/evapi/README index e6fb812..d62b7f4 100644 --- a/modules/evapi/README +++ b/modules/evapi/README @@ -85,7 +85,15 @@ Chapter 1. Admin Guide
1. Overview
- This module pushes event details to remote applications, via TCP. + The EVAPI module can be used to create an event message flow from + Kamailio to any application that can connect to a TCP socket. The + remote application can also issue messages received by Kamailio. + + There is no protocol definition, it is all up to the author of the + routing script. Events can be generated for any event in Kamailio. For + 3rd party transaction control, a transaction can be automatically + suspended when sending the event, to be resumed at a later point, maybe + triggered by an incoming message on the event socket.
2. Dependencies
@@ -134,7 +142,8 @@ modparam("evapi", "bind_addr", "1.2.3.4:8228")
3.3. netstring_format (int)
- Control if messages from clients are encapsulated in netstring format. + Control if messages on the socket (to and from clients) are + encapsulated in netstring format.
Default value is 1 (netstring format).
@@ -182,7 +191,7 @@ evapi_relay("{ "event": "test",\n "data": { "fU": "$fU" }\n}");
Example 1.6. evapi_async_relay usage ... -evapi_relay("{ "event": "suspend",\n "data":" +evapi_async_relay("{ "event": "suspend",\n "data":" " { "index": "$T(id_index)", "label": "$T(id_label)" }\n}"); ...
@@ -243,7 +252,7 @@ event_route[evapi:message-received] { * $evapi(srcaddr) - source ip * $evapi(srcport) - source port * $evapi(msg) - received event message - * $evapi(conidx) - internal connexion index + * $evapi(conidx) - internal connection index
Exported pseudo-variables are documented at http://www.kamailio.org/wiki/. diff --git a/modules/evapi/doc/evapi_admin.xml b/modules/evapi/doc/evapi_admin.xml index 90ad065..281e4d3 100644 --- a/modules/evapi/doc/evapi_admin.xml +++ b/modules/evapi/doc/evapi_admin.xml @@ -16,7 +16,17 @@ <section> <title>Overview</title> <para> - This module pushes event details to remote applications, via TCP. + The EVAPI module can be used to create an event message flow + from Kamailio to any application that can connect to a TCP + socket. The remote application can also issue messages received + by Kamailio. + </para> + <para> + There is no protocol definition, it is all up to the author of + the routing script. Events can be generated for any event in + Kamailio. For 3rd party transaction control, a transaction can + be automatically suspended when sending the event, to be resumed + at a later point, maybe triggered by an incoming message on the event socket. </para> </section>
@@ -95,8 +105,8 @@ modparam("evapi", "bind_addr", "1.2.3.4:8228") <section id="evapi.p.netstring_format"> <title><varname>netstring_format</varname> (int)</title> <para> - Control if messages from clients are encapsulated in netstring - format. + Control if messages on the socket (to and from clients) + are encapsulated in netstring format. </para> <para> <emphasis> @@ -168,7 +178,7 @@ evapi_relay("{ "event": "test",\n "data": { "fU": "$fU" }\n}"); <title><function>evapi_async_relay</function> usage</title> <programlisting format="linespecific"> ... -evapi_relay("{ "event": "suspend",\n "data":" +evapi_async_relay("{ "event": "suspend",\n "data":" " { "index": "$T(id_index)", "label": "$T(id_label)" }\n}"); ... </programlisting> @@ -267,7 +277,7 @@ event_route[evapi:message-received] { <emphasis>$evapi(msg)</emphasis> - received event message </para></listitem> <listitem><para> - <emphasis>$evapi(conidx)</emphasis> - internal connexion index + <emphasis>$evapi(conidx)</emphasis> - internal connection index </para></listitem> </itemizedlist> <para>