event_datagram Module
     __________________________________________________________

   Table of Contents

   1. Admin Guide

        1.1. Overview
        1.2. DATAGRAM events syntax
        1.3. DATAGRAM socket syntax
        1.4. Dependencies

              1.4.1. OpenSIPS Modules
              1.4.2. External Libraries or Applications

        1.5. Exported Parameters
        1.6. Exported Functions
        1.7. Example

   2. Frequently Asked Questions
   3. Contributors

        3.1. By Commit Statistics
        3.2. By Commit Activity

   4. Documentation

        4.1. Contributors

   List of Tables

   3.1. Top contributors by DevScore^(1), authored commits^(2) and
          lines added/removed^(3)

   3.2. Most recently active contributors^(1) to this module

   List of Examples

   1.1. E_PIKE_BLOCKED event
   1.2. UNIX socket
   1.3. UDP socket

Chapter 1. Admin Guide

1.1. Overview

   This is a module which provides a UNIX/UDP SOCKET transport
   layer implementation for the Event Interface.

1.2. DATAGRAM events syntax

   The event payload is formated as a JSON-RPC notification, with
   the event name as the method field and the event parameters as
   the params field.

1.3. DATAGRAM socket syntax

   There are two types of sockets used by this module, based on
   the sockets type. An UNIX socket should follow this syntax:

   ['unix:'] unix_socket_path

   An UDP socket should follow this syntax:

   'udp:' address ':' port

1.4. Dependencies

1.4.1. OpenSIPS Modules

   The following modules must be loaded before this module:
     * No dependencies on other OpenSIPS modules.

1.4.2. External Libraries or Applications

   The following libraries or applications must be installed
   before running OpenSIPS with this module loaded:
     * none

1.5. Exported Parameters

   No parameter exported by this module.

1.6. Exported Functions

   No function exported to be used from configuration file.

1.7. Example

   This is an example of an event raised by the pike module when
   it decides an ip should be blocked:

   Example 1.1. E_PIKE_BLOCKED event

{
  "id": null,
  "jsonrpc": "2.0",
  "method": "E_PIKE_BLOCKED",
  "params": {
    "ip": "192.168.2.11"
  }
}


   Example 1.2. UNIX socket

unix:/tmp/opensips_event.sock


   Example 1.3. UDP socket

udp:127.0.0.1:8081


Chapter 2. Frequently Asked Questions

   2.1.

       Both UNIX and UDP type of socket can be used to notify the
       events?

       Yes, you can use the both types.

   2.2.

       What is the maximum lenght of a datagram event?

       The maximum length of a datagram event is 65457 bytes.

   2.3.

       Where can I find more about OpenSIPS?

       Take a look at https://opensips.org/.

   2.4.

       Where can I post a question about this module?

       First at all check if your question was already answered on one
       of our mailing lists:
         * User Mailing List -
           http://lists.opensips.org/cgi-bin/mailman/listinfo/users
         * Developer Mailing List -
           http://lists.opensips.org/cgi-bin/mailman/listinfo/devel

       E-mails regarding any stable OpenSIPS release should be sent to
       <users@lists.opensips.org> and e-mails regarding development
       versions should be sent to <devel@lists.opensips.org>.

       If you want to keep the mail private, send it to
       <users@lists.opensips.org>.

   2.5.

       How can I report a bug?

       Please follow the guidelines provided at:
       https://github.com/OpenSIPS/opensips/issues.

Chapter 3. Contributors

3.1. By Commit Statistics

   Table 3.1. Top contributors by DevScore^(1), authored
   commits^(2) and lines added/removed^(3)
     Name DevScore Commits Lines ++ Lines --
   1. Razvan Crainea (@razvancrainea) 24 16 854 37
   2. Liviu Chircu (@liviuchircu) 8 6 12 29
   3. Vlad Patrascu (@rvlad-patrascu) 6 2 24 136
   4. Bogdan-Andrei Iancu (@bogdan-iancu) 4 2 3 1
   5. Peter Lemenkov (@lemenkov) 3 1 1 1

   (1) DevScore = author_commits + author_lines_added /
   (project_lines_added / project_commits) + author_lines_deleted
   / (project_lines_deleted / project_commits)

   (2) including any documentation-related commits, excluding
   merge commits. Regarding imported patches/code, we do our best
   to count the work on behalf of the proper owner, as per the
   "fix_authors" and "mod_renames" arrays in
   opensips/doc/build-contrib.sh. If you identify any
   patches/commits which do not get properly attributed to you,
   please submit a pull request which extends "fix_authors" and/or
   "mod_renames".

   (3) ignoring whitespace edits, renamed files and auto-generated
   files

3.2. By Commit Activity

   Table 3.2. Most recently active contributors^(1) to this module
                     Name                   Commit Activity
   1. Vlad Patrascu (@rvlad-patrascu)     May 2017 - May 2020
   2. Razvan Crainea (@razvancrainea)     May 2011 - Sep 2019
   3. Bogdan-Andrei Iancu (@bogdan-iancu) Oct 2014 - Apr 2019
   4. Liviu Chircu (@liviuchircu)         Mar 2014 - Nov 2018
   5. Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018

   (1) including any documentation-related commits, excluding
   merge commits

Chapter 4. Documentation

4.1. Contributors

   Last edited by: Vlad Patrascu (@rvlad-patrascu), Peter Lemenkov
   (@lemenkov), Liviu Chircu (@liviuchircu), Razvan Crainea
   (@razvancrainea).

   Documentation Copyrights:

   Copyright © 2011 www.opensips-solutions.com
