mi_fifo Module

Bogdan-Andrei Iancu

OpenSIPS Solutions

Edited by

Bogdan-Andrei Iancu

Revision History
Revision $Revision: 8740 $$Date$

Table of Contents

1. Admin Guide
1.1. Overview
1.2. FIFO command syntax
1.3. Dependencies
1.3.1. OpenSIPS Modules
1.3.2. External Libraries or Applications
1.4. Exported Parameters
1.4.1. fifo_name (string)
1.4.2. fifo_mode (integer)
1.4.3. fifo_group (integer) fifo_group (string)
1.4.4. fifo_user (integer) fifo_group (string)
1.4.5. reply_dir (string)
1.4.6. reply_indent (string)
1.4.7. trace_destination (string)
1.4.8. trace_bwlist (string)
1.5. Exported Functions
1.6. Example

List of Examples

1.1. Set fifo_name parameter
1.2. Set fifo_mode parameter
1.3. Set fifo_group parameter
1.4. Set fifo_user parameter
1.5. Set reply_dir parameter
1.6. Set reply_indent parameter
1.7. Set trace_destination parameter
1.8. Set trace_destination parameter
1.9. FIFO request

Chapter 1. Admin Guide

1.1. Overview

This is a module which provides a FIFO transport layer implementation for Management Interface. It receives the command over a FIFO file and returns the output through the reply_fifo specified.

The module checks every 30 seconds if the FIFO file exists, and if it was deleted, it recreates it. If one wants to force the fifo file recreation, it should send a SIGHUP signal to the MI process PID.

1.2. FIFO command syntax

The external commands issued via FIFO interface must follow the following syntax:

  • request = first_line argument*

  • first_line = ':'command_name':'reply_fifo'\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}

1.3. Dependencies

1.3.1. OpenSIPS Modules

The following modules must be loaded before this module:

  • No dependencies on other OpenSIPS modules.

1.3.2. External Libraries or Applications

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

  • none

1.4. Exported Parameters

1.4.1. fifo_name (string)

The name of the FIFO file to be created for listening and reading external commands.

Default value is NONE.

Example 1.1. Set fifo_name parameter

modparam("mi_fifo", "fifo_name", "/tmp/opensips_fifo")

1.4.2. fifo_mode (integer)

Permission to be used for creating the listening FIFO file. It follows the UNIX conventions.

Default value is 0660 (rw-rw----).

Example 1.2. Set fifo_mode parameter

modparam("mi_fifo", "fifo_mode", 0600)

1.4.3. fifo_group (integer) fifo_group (string)

Group to be used for creating the listening FIFO file.

Default value is the inherited one.

Example 1.3. Set fifo_group parameter

modparam("mi_fifo", "fifo_group", 0)
modparam("mi_fifo", "fifo_group", "root")

1.4.4. fifo_user (integer) fifo_group (string)

User to be used for creating the listening FIFO file.

Default value is the inherited one.

Example 1.4. Set fifo_user parameter

modparam("mi_fifo", "fifo_user", 0)
modparam("mi_fifo", "fifo_user", "root")

1.4.5. reply_dir (string)

Directory to be used for creating the reply FIFO files.

Default value is /tmp/

Example 1.5. Set reply_dir parameter

modparam("mi_fifo", "reply_dir", "/home/opensips/tmp/")

1.4.6. reply_indent (string)

Strings to be used for line indentation. As the MI data structure is tree oriendeted, the depth level will printed as indentation.

Default value is "\t" (TAB).

Example 1.6. Set reply_indent parameter

modparam("mi_fifo", "reply_indent", "    ")

1.4.7. trace_destination (string)

Trace destination as defined in the tracing module. Currently the only tracing module is proto_hep. This is where traced mi messages will go.

WARNING: A tracing module must be loaded in order for this parameter to work. (for example proto_hep).

Default value is none(not defined).

Example 1.7. Set trace_destination parameter

modparam("proto_hep", "trace_destination", "[hep_dest];transport=tcp;version=3")

modparam("mi_fifo", "trace_destination", "hep_dest")

1.4.8. trace_bwlist (string)

Filter traced mi commands based on a blacklist or a whitelist. trace_destination must be defined for this parameter to have any purpose. Whitelists can be defined using 'w' or 'W', blacklists using 'b' or 'B'. The type is separate by the actual blacklist by ':'. The mi commands in the list must be separated by ','.

Defining a blacklists means all the commands that are not blacklisted will be traced. Defining a whitelist means all the commands that are not whitelisted will not be traced. WARNING: One can't define both a whitelist and a blacklist. Only one of them is allowed. Defining the parameter a second time will just overwrite the first one.

WARNING: A tracing module must be loaded in order for this parameter to work. (for example proto_hep).

Default value is none(not defined).

Example 1.8. Set trace_destination parameter

## blacklist ps and which mi commands
## all the other commands shall be traced
modparam("mi_fifo", "trace_bwlist", "b: ps, which")
## allow only sip_trace mi command
## all the other commands will not be traced
modparam("mi_fifo", "trace_bwlist", "w: sip_trace")

1.5. Exported Functions

No function exported to be used from configuration file.

1.6. Example

This is an example showing the FIFO format for the get_statistics dialog: tm: MI commad: response.

Example 1.9. FIFO request