"Fossies" - the Fresh Open Source Software Archive

Member "opensips-3.0.1/modules/event_datagram/README" (1 Oct 2019, 5678 Bytes) of package /linux/misc/opensips-3.0.1.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "README": 3.0.0_vs_3.0.1.

    1 event_datagram Module
    2      __________________________________________________________
    3 
    4    Table of Contents
    5 
    6    1. Admin Guide
    7 
    8         1.1. Overview
    9         1.2. DATAGRAM events syntax
   10         1.3. DATAGRAM socket syntax
   11         1.4. Dependencies
   12 
   13               1.4.1. OpenSIPS Modules
   14               1.4.2. External Libraries or Applications
   15 
   16         1.5. Exported Parameters
   17         1.6. Exported Functions
   18         1.7. Example
   19 
   20    2. Frequently Asked Questions
   21    3. Contributors
   22 
   23         3.1. By Commit Statistics
   24         3.2. By Commit Activity
   25 
   26    4. Documentation
   27 
   28         4.1. Contributors
   29 
   30    List of Tables
   31 
   32    3.1. Top contributors by DevScore^(1), authored commits^(2) and
   33           lines added/removed^(3)
   34 
   35    3.2. Most recently active contributors^(1) to this module
   36 
   37    List of Examples
   38 
   39    1.1. E_PIKE_BLOCKED event
   40    1.2. UNIX socket
   41    1.3. UDP socket
   42 
   43 Chapter 1. Admin Guide
   44 
   45 1.1. Overview
   46 
   47    This is a module which provides a UNIX/UDP SOCKET transport
   48    layer implementation for the Event Interface.
   49 
   50 1.2. DATAGRAM events syntax
   51 
   52    The raised events will follow the following grammar:
   53      * event = event_name (argument '\n')*
   54      * event_name = non-quoted_string'\n'
   55      * argument = ((arg_name '::')? arg_value)? | (arg_value)
   56      * arg_name = not-quoted_string
   57      * arg_value = not-quoted_string | '"' string '"'
   58      * not-quoted_string = string - {',",\n,\r}
   59 
   60    The event name can contain any non-quoted string character, but
   61    it is recommended to follow the syntax:
   62    E_MODULE_NAME_EXTRA_NAME
   63 
   64 1.3. DATAGRAM socket syntax
   65 
   66    There are two types of sockets used by this module, based on
   67    the sockets type. An UNIX socket should follow this syntax:
   68 
   69    ['unix:'] unix_socket_path
   70 
   71    An UDP socket should follow this syntax:
   72 
   73    'udp:' address ':' port
   74 
   75 1.4. Dependencies
   76 
   77 1.4.1. OpenSIPS Modules
   78 
   79    The following modules must be loaded before this module:
   80      * No dependencies on other OpenSIPS modules.
   81 
   82 1.4.2. External Libraries or Applications
   83 
   84    The following libraries or applications must be installed
   85    before running OpenSIPS with this module loaded:
   86      * none
   87 
   88 1.5. Exported Parameters
   89 
   90    No parameter exported by this module.
   91 
   92 1.6. Exported Functions
   93 
   94    No function exported to be used from configuration file.
   95 
   96 1.7. Example
   97 
   98    This is an example of an event raised by the pike module when
   99    it decides an ip should be blocked:
  100 
  101    Example 1.1. E_PIKE_BLOCKED event
  102 
  103 E_PIKE_BLOCKED
  104 ip::192.168.2.11
  105 
  106 
  107    Example 1.2. UNIX socket
  108 
  109 unix:/tmp/opensips_event.sock
  110 
  111 
  112    Example 1.3. UDP socket
  113 
  114 udp:127.0.0.1:8081
  115 
  116 
  117 Chapter 2. Frequently Asked Questions
  118 
  119    2.1.
  120 
  121        Both UNIX and UDP type of socket can be used to notify the
  122        events?
  123 
  124        Yes, you can use the both types.
  125 
  126    2.2.
  127 
  128        What is the maximum lenght of a datagram event?
  129 
  130        The maximum length of a datagram event is 65457 bytes.
  131 
  132    2.3.
  133 
  134        Where can I find more about OpenSIPS?
  135 
  136        Take a look at http://www.opensips.org/.
  137 
  138    2.4.
  139 
  140        Where can I post a question about this module?
  141 
  142        First at all check if your question was already answered on one
  143        of our mailing lists:
  144          * User Mailing List -
  145            http://lists.opensips.org/cgi-bin/mailman/listinfo/users
  146          * Developer Mailing List -
  147            http://lists.opensips.org/cgi-bin/mailman/listinfo/devel
  148 
  149        E-mails regarding any stable OpenSIPS release should be sent to
  150        <users@lists.opensips.org> and e-mails regarding development
  151        versions should be sent to <devel@lists.opensips.org>.
  152 
  153        If you want to keep the mail private, send it to
  154        <users@lists.opensips.org>.
  155 
  156    2.5.
  157 
  158        How can I report a bug?
  159 
  160        Please follow the guidelines provided at:
  161        https://github.com/OpenSIPS/opensips/issues.
  162 
  163 Chapter 3. Contributors
  164 
  165 3.1. By Commit Statistics
  166 
  167    Table 3.1. Top contributors by DevScore^(1), authored
  168    commits^(2) and lines added/removed^(3)
  169      Name DevScore Commits Lines ++ Lines --
  170    1. Razvan Crainea (@razvancrainea) 24 16 854 37
  171    2. Liviu Chircu (@liviuchircu) 8 6 12 29
  172    3. Bogdan-Andrei Iancu (@bogdan-iancu) 4 2 3 1
  173    4. Peter Lemenkov (@lemenkov) 3 1 1 1
  174    5. Vlad Patrascu (@rvlad-patrascu) 2 1 1 0
  175 
  176    (1) DevScore = author_commits + author_lines_added /
  177    (project_lines_added / project_commits) + author_lines_deleted
  178    / (project_lines_deleted / project_commits)
  179 
  180    (2) including any documentation-related commits, excluding
  181    merge commits. Regarding imported patches/code, we do our best
  182    to count the work on behalf of the proper owner, as per the
  183    "fix_authors" and "mod_renames" arrays in
  184    opensips/doc/build-contrib.sh. If you identify any
  185    patches/commits which do not get properly attributed to you,
  186    please submit a pull request which extends "fix_authors" and/or
  187    "mod_renames".
  188 
  189    (3) ignoring whitespace edits, renamed files and auto-generated
  190    files
  191 
  192 3.2. By Commit Activity
  193 
  194    Table 3.2. Most recently active contributors^(1) to this module
  195                      Name                   Commit Activity
  196    1. Razvan Crainea (@razvancrainea)     May 2011 - Sep 2019
  197    2. Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2014 - Apr 2019
  198    3. Liviu Chircu (@liviuchircu)         Mar 2014 - Nov 2018
  199    4. Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018
  200    5. Vlad Patrascu (@rvlad-patrascu)     May 2017 - May 2017
  201 
  202    (1) including any documentation-related commits, excluding
  203    merge commits
  204 
  205 Chapter 4. Documentation
  206 
  207 4.1. Contributors
  208 
  209    Last edited by: Peter Lemenkov (@lemenkov), Liviu Chircu
  210    (@liviuchircu), Razvan Crainea (@razvancrainea).
  211 
  212    Documentation Copyrights:
  213 
  214    Copyright © 2011 www.opensips-solutions.com