event_stream Module

The following modules must be loaded before this module:

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

This parameter controls the way the event_stream module communicates with the JSON-RPC server. If enabled, (set to 1), each event is translated to a JSON-RPC request. If disabled, each event will be sent as a JSON-RPC notification - there will be no reply expected by our client.

Note that if you need a reliable communication with the JSON-RPC server, where each event sent needs to be confirmed (by a JSON-RPC response), you must set this parameter to 1/yes. If you are using this module in a failover setup (using the event_virtual module), it is recommended to set this parameter to 1/yes.

Default value is “0 (disabled)”.

...
modparam("event_stream", "reliable_mode", yes)
...

Specified the amount of milliseconds the module waits for a command to complete. In reliable_mode, it specifies the time module waits the request to be sent and a reply received. In non-reliable_mode, it represents only the time opensips takes to send the JSON-RPC notification.

NOTE that if the event is not using names for its parameters, the event will be the first parameter in the JSON-RPC command.

Default value is “1000 milliseconds = 1 second”.

...
# only wait for 200 milliseonds for a reply
modparam("event_stream", "timeout", 200)
...

By default, the name of the event subscribed to is not send in the JSON-RPC command. If one needs to send the name of the event as well, you can use this parameter to specify the name of JSON object within the params that will contain the name of the event.

Default value is “disabled” - event is not added.

...
modparam("event_stream", "event_param", "opensips_event")
# json resulted will contain the "opensips_event": EVENT token
...

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

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

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

# request
{
	"id": 915243442,
	"jsonrpc": "2.0",
	"method": "E_PIKE_BLOCKED",
	"params": {
		"ip": "192.168.2.11"
	}
}

# reply
{
	"jsonrpc": "2.0",
	"result": 8,
	"id": 915243442
}

when having the event_param set to opensips_event, the event raised by the pike module will look like the following:

# module configuration
modparam("event_stream", "event_param", "opensips_event")

# Stream socket: tcp:HOST:PORT/handle_cmd

# JSON-RPC command sent
{
	"jsonrpc": "2.0",
	"method": "handle_cmd",
	"params": {
		"opensips_event": "E_PIKE_BLOCKED"
		"ip": "192.168.2.11"
	}
}

This example contains a snippet to send a custom event from the script using the event_stream module.

Note that we are only populating values for the event, we are not assinging names to those values. Therefore, the parameters will be sent as an array.

startup_route {
	subscribe_event("E_MY_EVENT", "tcp:127.0.0.1:8080");
}

route {
	...
	$avp(attr-val) = 3;
	$avp(attr-val) = 5;
	raise_event("E_MY_EVENT", $avp(attr-val));
	...
}

# JSON-RPC command sent
{
	"jsonrpc": "2.0",
	"method": "E_MY_EVENT",
	"params": [3, 5]
}