Explorar el Código

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

Kamailio Dev hace 7 años
padre
commit
9193afeb3e
Se han modificado 1 ficheros con 33 adiciones y 18 borrados
  1. 33 18
      src/modules/evapi/README

+ 33 - 18
src/modules/evapi/README

@@ -29,6 +29,7 @@ Daniel-Constantin Mierla
               3.2. bind_addr (str)
               3.3. netstring_format (int)
               3.4. event_callback (str)
+              3.5. max_clients (int)
 
         4. Functions
 
@@ -55,15 +56,16 @@ Daniel-Constantin Mierla
    1.2. Set bind_addr parameter
    1.3. Set netstring_format parameter
    1.4. Set event_callback parameter
-   1.5. evapi_relay usage
-   1.6. TCP message
-   1.7. evapi_async_relay usage
-   1.8. evapi_multicast usage
-   1.9. evapi_async_multicast usage
-   1.10. evapi_unicast usage
-   1.11. evapi_async_unicast usage
-   1.12. evapi_close usage
-   1.13. evapi_set_tag usage
+   1.5. Set max_clients parameter
+   1.6. evapi_relay usage
+   1.7. TCP message
+   1.8. evapi_async_relay usage
+   1.9. evapi_multicast usage
+   1.10. evapi_async_multicast usage
+   1.11. evapi_unicast usage
+   1.12. evapi_async_unicast usage
+   1.13. evapi_close usage
+   1.14. evapi_set_tag usage
 
 Chapter 1. Admin Guide
 
@@ -81,6 +83,7 @@ Chapter 1. Admin Guide
         3.2. bind_addr (str)
         3.3. netstring_format (int)
         3.4. event_callback (str)
+        3.5. max_clients (int)
 
    4. Functions
 
@@ -135,6 +138,7 @@ Chapter 1. Admin Guide
    3.2. bind_addr (str)
    3.3. netstring_format (int)
    3.4. event_callback (str)
+   3.5. max_clients (int)
 
 3.1. workers (int)
 
@@ -194,6 +198,17 @@ function ksr_evapi_event(evname)
 end
 ...
 
+3.5. max_clients (int)
+
+   Maximum number of clients that can connect to evapi socket.
+
+   Default value is 8.
+
+   Example 1.5. Set max_clients parameter
+...
+modparam("evapi", "max_clients", 4)
+...
+
 4. Functions
 
    4.1. evapi_relay(evdata)
@@ -220,14 +235,14 @@ end
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.5. evapi_relay usage
+   Example 1.6. evapi_relay usage
 ...
 evapi_relay("{ \"event\": \"test\",\n \"data\": { \"fU\": \"$fU\" }\n}");
 ...
 
    The above exaple will send the following message over tcp:
 
-   Example 1.6. TCP message
+   Example 1.7. TCP message
 ...
 47:{
  "event": "test",
@@ -251,7 +266,7 @@ evapi_relay("{ \"event\": \"test\",\n \"data\": { \"fU\": \"$fU\" }\n}");
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1.7. evapi_async_relay usage
+   Example 1.8. evapi_async_relay usage
 ...
 evapi_async_relay("{ \"event\": \"suspend\",\n \"data\":"
         " { \"index\": \"$T(id_index)\", \"label\": \"$T(id_label)\" }\n}");
@@ -263,7 +278,7 @@ evapi_async_relay("{ \"event\": \"suspend\",\n \"data\":"
    tag provided by etag value. The etag can be a variable. For more see
    evapi_relay() and evapi_set_tag().
 
-   Example 1.8. evapi_multicast usage
+   Example 1.9. evapi_multicast usage
 ...
 evapi_multicast("{ \"event\": \"test\",\n \"data\": { \"fU\": \"$fU\" }\n}", "ta
 gx");
@@ -275,7 +290,7 @@ gx");
    the tag provided by etag value. The etag can be a variable. For more
    see evapi_async_relay() and evapi_set_tag().
 
-   Example 1.9. evapi_async_multicast usage
+   Example 1.10. evapi_async_multicast usage
 ...
 evapi_async_multicast("{ \"event\": \"suspend\",\n \"data\":"
     " { \"index\": \"$T(id_index)\", \"label\": \"$T(id_label)\" }\n}", "tagx");
@@ -287,7 +302,7 @@ evapi_async_multicast("{ \"event\": \"suspend\",\n \"data\":"
    match the tag provided by etag value. The etag can be a variable. For
    more see evapi_relay() and evapi_set_tag().
 
-   Example 1.10. evapi_unicast usage
+   Example 1.11. evapi_unicast usage
 ...
 evapi_unicast("{ \"event\": \"test\",\n \"data\": { \"fU\": \"$fU\" }\n}", "tagx
 ");
@@ -299,7 +314,7 @@ evapi_unicast("{ \"event\": \"test\",\n \"data\": { \"fU\": \"$fU\" }\n}", "tagx
    that match the tag provided by etag value. The etag can be a variable.
    For more see evapi_async_relay() and evapi_set_tag().
 
-   Example 1.11. evapi_async_unicast usage
+   Example 1.12. evapi_async_unicast usage
 ...
 evapi_async_unicast("{ \"event\": \"suspend\",\n \"data\":"
     " { \"index\": \"$T(id_index)\", \"label\": \"$T(id_label)\" }\n}", "tagx");
@@ -311,7 +326,7 @@ evapi_async_unicast("{ \"event\": \"suspend\",\n \"data\":"
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.12. evapi_close usage
+   Example 1.13. evapi_close usage
 ...
 event_route[evapi:connection-new] {
   if($evapi(srcaddr)!="127.0.0.1") {
@@ -329,7 +344,7 @@ event_route[evapi:connection-new] {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.13. evapi_set_tag usage
+   Example 1.14. evapi_set_tag usage
 ...
 event_route[evapi:connection-new] {
   if($evapi(srcaddr)=="127.0.0.1") {