# &adminguide;

## Overview

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

## DATAGRAM events syntax

The raised events will follow the following grammar:

- event = event_name (argument '\n')*

- event_name = non-quoted_string'\n'

- argument = ((arg_name '::')? arg_value)? | (arg_value)

- arg_name = not-quoted_string

- arg_value = not-quoted_string | '"' string '"'

- not-quoted_string = string - {',",\n,\r}

The event name can contain any non-quoted string character, but it is recommended to follow the syntax: E_MODULE_NAME_EXTRA_NAME

## 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

## Dependencies

### &osips; Modules

The following modules must be loaded before this module:

- No dependencies on other &osips; modules.

### External Libraries or Applications

The following libraries or applications must be installed before running &osips; with this module loaded:

- none

## Exported Parameters

No parameter exported by this module.

## Exported Functions

No function exported to be used from configuration file.

## Example

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

### E_PIKE_BLOCKED event

    E_PIKE_BLOCKED
    ip::192.168.2.11

### UNIX socket

    unix:/tmp/opensips_event.sock

### UDP socket

    udp:127.0.0.1:8081