modules: readme files regenerated - evrexec ... [skip ci]
authorKamailio Dev <kamailio.dev@kamailio.org>
Wed, 12 Apr 2017 19:31:23 +0000 (21:31 +0200)
committerKamailio Dev <kamailio.dev@kamailio.org>
Wed, 12 Apr 2017 19:31:23 +0000 (21:31 +0200)
src/modules/evrexec/README

index cc8a1cd..c259f43 100644 (file)
@@ -11,7 +11,7 @@ Daniel-Constantin Mierla
 
    <miconda@gmail.com>
 
-   Copyright © 2017 http://www.asipto.com
+   Copyright Â© 2017 http://www.asipto.com
      __________________________________________________________________
 
    Table of Contents
@@ -48,8 +48,9 @@ Chapter 1. Admin Guide
 
 1. Overview
 
-   The module executes even route blocks once on dedicated processes. The
-   execution can be delayed for an interval of time.
+   The module executes event route blocks or KEMI functions on dedicated
+   processes at startup. The execution can be delayed for a specified
+   interval of time.
 
    The actions in the event route should be a loop or other tasks that run
    forever.
@@ -82,7 +83,10 @@ Chapter 1. Admin Guide
 
    The parameter can be set multiple times to get more exec tasks in same
    configuration file.
-     * name - name of the event route to be executed.
+     * name - name of the event route to be executed. When used with a
+       KEMI embedded laguage, this has to be the name of a function from
+       the KEMI script. The function must have a string parameter, which
+       will retrieve the index of the works in string format.
      * workers - if set to 0 or 1 the task is executed in a dedicated
        process. Any number > 1 will create more dedicated processes, each
        of them executing the task.