event_route Module

This module provides a simple way for capturing and handling directly in the OpenSIPS script of different events triggered through the OpenSIPS Event Interface

If you want to capture and handle a certian event, you need to define a dedicated route (event_route) into the OpenSIPS script, route having as name the name/code of the desired event. The route is triggered (and executed) by the module when the corresponding event is raised by the OpenSIPS

NOTE that the triggered event_route is run asyncronus (and in a different process) in regards to the code or process that generated the actual event.

NOTE that inside the event_route you should NOT rely on anything more than the content provide by the event itself (see below variable). DO NOT assume to have access to any other variable or context, not even to a SIP message.

In order to retrieve the parameters of an event, the $param(name) variable has to be used. It's name can be the parameter's name, or, if an integer is specified, its index inside the parameter's list.

Example:

xlog("first parameters is $param(1)\n");
xlog("Pike Blocking IP is $param(ip)\n");

NOTE: An event may be triggered within a different event, leading to nested processing. This function will retrieve the parameters of the currently processed event.

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

In order to handle the E_PIKE_BLOCKED event, the following snippet can be used:

	event_route[E_PIKE_BLOCKED] {
		xlog("IP $param(ip) has been blocked\n");
	}
					

As the OpenSIPS Event Interface requires, the event_route module uses a specific socket syntax:

'route:' event_name

Example:

route:E_PIKE_BLOCKED

The module does not export parameters to be used in configuration script.

The function does not export any function.

All remaining contributors: Walter Doekes (@wdoekes).

(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

All remaining contributors: Walter Doekes (@wdoekes).

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

Last edited by: Razvan Crainea (@razvancrainea), Bogdan-Andrei Iancu (@bogdan-iancu), Peter Lemenkov (@lemenkov), Liviu Chircu (@liviuchircu), Ionut Ionita (@ionutrazvanionita), Ovidiu Sas (@ovidiusas).