Table of Contents
List of Examples
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.
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}
The following modules must be loaded before this module:
No dependencies on other OpenSIPS modules.
The name of the FIFO file to be created for listening and reading external commands.
Default value is NONE.
Permission to be used for creating the listening FIFO file. It follows the UNIX conventions.
Default value is 0660 (rw-rw----).
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") ...
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") ...