Table of Contents
List of Tables
List of Examples
This is a module which provides a UNIX/UDP SOCKET transport layer implementation for the Management Interface.
The external commands issued via DATAGRAM interface must follow the following syntax:
request = first_line (argument '\n')*
first_line = ':'command_name':''\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 a UNIX SOCKET or an IP address. The UNIX datagram or UDP socket will be created using this parameter in order to read the external commands. Both IPv4 and IPv6 are supported.
Default value is NONE.
Example 1.1. Set socket_name parameter
...
modparam("mi_datagram", "socket_name", "/tmp/opensips.sock")
...
modparam("mi_datagram", "socket_name", "udp:192.168.2.133:8080")
...
The number of child processes to be created. Each child process will be a datagram server.
Default value is 1.
Permission to be used for creating the listening UNIX datagram socket. Not necessary for a UDP socket. It follows the UNIX conventions.
Default value is 0660 (rw-rw----).
Example 1.3. Set unix_socket_mode parameter
...
modparam("mi_datagram", "unix_socket_mode", 0600)
...
Group to be used for creating the listening UNIX socket.
Default value is the inherited one.
Example 1.4. Set unix_socket_group parameter
...
modparam("mi_datagram", "unix_socket_group", 0)
modparam("mi_datagram", "unix_socket_group", "root")
...
User to be used for creating the listening UNIX socket.
Default value is the inherited one.
Example 1.5. Set unix_socket_user parameter
...
modparam("mi_datagram", "unix_socket_user", 0)
modparam("mi_datagram", "unix_socket_user", "root")
...
The reply will expire after trying to sent it for socket_timeout milliseconds.
Default value is 2000.
2.1. | Both UNIX and UDP type of socket can be created simultaneusly? |
This version supports only one kind of socket at a time. If there are more than one value set for socket_name the last one will take effect. | |
2.2. | Is there a limit in the datagram request's size? |
The maximum length of a datagram request or reply is 65457 bytes. | |
2.3. | Where can I find more about OpenSIPS? |
Take a look at http://www.opensips.org/. | |
2.4. | Where can I post a question about this module? |
First at all check if your question was already answered on one of our mailing lists:
E-mails regarding any stable OpenSIPS release should be sent to
If you want to keep the mail private, send it to
| |
2.5. | How can I report a bug? |
Please follow the guidelines provided at: https://github.com/OpenSIPS/opensips/issues. |
Table 3.1. Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
| Name | DevScore | Commits | Lines ++ | Lines -- | |
|---|---|---|---|---|---|
| 1. | Bogdan-Andrei Iancu (@bogdan-iancu) | 41 | 32 | 317 | 299 |
| 2. | Ancuta Onofrei | 26 | 2 | 2423 | 252 |
| 3. | Daniel-Constantin Mierla (@miconda) | 9 | 7 | 18 | 16 |
| 4. | Razvan Crainea (@razvancrainea) | 6 | 4 | 10 | 14 |
| 5. | Liviu Chircu (@liviuchircu) | 6 | 4 | 7 | 36 |
| 6. | Henning Westerholt (@henningw) | 5 | 3 | 9 | 11 |
| 7. | Klaus Darilion | 3 | 1 | 4 | 4 |
| 8. | Walter Doekes (@wdoekes) | 3 | 1 | 4 | 4 |
| 9. | Julián Moreno Patiño | 3 | 1 | 3 | 3 |
| 10. | Konstantin Bokarius | 3 | 1 | 2 | 6 |
All remaining contributors: Dusan Klinec, Edson Gellert Schubert.
(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
Table 3.2. Most recently active contributors(1) to this module
| Name | Commit Activity | |
|---|---|---|
| 1. | Bogdan-Andrei Iancu (@bogdan-iancu) | Jun 2007 - Feb 2019 |
| 2. | Liviu Chircu (@liviuchircu) | Mar 2014 - Jun 2018 |
| 3. | Razvan Crainea (@razvancrainea) | Oct 2011 - Feb 2016 |
| 4. | Julián Moreno Patiño | Feb 2016 - Feb 2016 |
| 5. | Dusan Klinec | Dec 2015 - Dec 2015 |
| 6. | Walter Doekes (@wdoekes) | May 2014 - May 2014 |
| 7. | Henning Westerholt (@henningw) | Aug 2007 - Jul 2008 |
| 8. | Klaus Darilion | Jul 2008 - Jul 2008 |
| 9. | Daniel-Constantin Mierla (@miconda) | Mar 2008 - Mar 2008 |
| 10. | Konstantin Bokarius | Mar 2008 - Mar 2008 |
All remaining contributors: Edson Gellert Schubert, Ancuta Onofrei.
(1) including any documentation-related commits, excluding merge commits
Last edited by: Bogdan-Andrei Iancu (@bogdan-iancu), Liviu Chircu (@liviuchircu), Julián Moreno Patiño, Razvan Crainea (@razvancrainea), Klaus Darilion, Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Ancuta Onofrei.
doc copyrights:
Copyright © 2007 Voice Sistem SRL