mi_xmlrpc_ng Module


Table of Contents

1. Admin Guide
1.1. Overview
1.2. Dependencies
1.2.1. External Libraries or Applications
1.2.2. OpenSIPS Modules
1.3. Exported Parameters
1.3.1. http_root(string)
1.3.2. format_version(integer)
1.4. Exported Functions
1.5. Known issues
1.6. Example
2. Contributors
2.1. By Commit Statistics
2.2. By Commit Activity
3. Documentation
3.1. Contributors

List of Tables

2.1. Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
2.2. Most recently active contributors(1) to this module

List of Examples

1.1. Set http_root parameter
1.2. Set format_version parameter
1.3. XMLRPC request

Chapter1.Admin Guide

1.1.Overview

This module implements a xmlrpc server that handles xmlrpc requests and generates xmlrpc responses. When a xmlrpc message is received a default method is executed.

At first, it looks up the MI command. If found it parses the called procedure's parameters into a MI tree and the command is executed. A MI reply tree is returned that is formatted back in xmlrpc. The response is built in two ways - like a string that contains the MI tree nodes information (name, values and attributes) or like an array whose elements are consisted of each MI tree node stored information.

1.2.Dependencies

1.2.1.External Libraries or Applications

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

  • libxml2

1.2.2.OpenSIPS Modules

The following modules must be loaded before this module:

  • httpd module.

1.3.Exported Parameters

1.3.1.http_root(string)

Specifies the root path for xmlrpc requests: http://[opensips_IP]:[opensips_httpd_port]/[http_root]

The default value is "RPC2".

Example1.1.Set http_root parameter

...
modparam("mi_xmlrpc_ng", "http_root", "opensips_mi_xmlrpc")
...

1.3.2.format_version(integer)

Specifies which formatting to be used for the output generated by the module. The value of 2 will generate a response broken in many tags which doesn't require string parsing, only xml parsing, this is the newer version. The other accepted value is 1 which will generate a long simple sting response, this is the older vesion.

The default value is 2.

Example1.2.Set format_version parameter

...
modparam("mi_xmlrpc_ng", "format_version", 1)
...

1.4.Exported Functions

No function exported to be used from configuration file.

1.5.Known issues

Commands with large responses (like ul_dump) will fail if the configured size of the httpd buffer is to small (or if there isn't enough pkg memory configured).

Future realeases of the httpd and mi_xmlrpc_ng modules will address this issue.

1.6.Example

This is an example showing the xmlrpc format for the get_statistics net: uri: MI commad: response.

Example1.3.XMLRPC request


POST /xmlrpc HTTP/1.0
Host: my.host.com
User-Agent: My xmlrpc UA
Content-Type: text/xml
Content-Length: 216

<?xml version='1.0'?>
<methodCall>
	<methodName>get_statistics</methodName>
	<params>
		<param>
			<value><string>net:</string></value>
		</param>
		<param>
			<value><string>uri:</string></value>
		</param>
	</params>
</methodCall>


HTTP/1.0 200 OK
Content-Length: 236
Content-Type: text/xml; charset=utf-8
Date: Mon, 8 Mar 2013 12:00:00 GMT

<?xml version="1.0" encoding="UTF-8"?><methodResponse><params><param><value><string>
:: net:waiting_udp = 0
:: net:waiting_tcp = 0
:: uri:positive checks = 0
:: uri:negative_checks = 0
</string></value></param></params></methodResponse>


Chapter2.Contributors

2.1.By Commit Statistics

Table2.1.Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)

NameDevScoreCommitsLines ++Lines --
1. Ovidiu Sas (@ovidiusas)28151375101
2. Ionel Cerghit (@ionel-cerghit)113515166
3. Liviu Chircu (@liviuchircu)1083341
4. Razvan Crainea (@razvancrainea)974026
5. Bogdan-Andrei Iancu (@bogdan-iancu)8611854
6. Ionut Ionita (@ionutrazvanionita)426111
7. Vlad Paiu (@vladpaiu)3206
8. Vlad Patrascu (@rvlad-patrascu)31204

(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

2.2.By Commit Activity

Table2.2.Most recently active contributors(1) to this module

NameCommit Activity
1. Bogdan-Andrei Iancu (@bogdan-iancu)Oct 2014 - Jun 2018
2. Liviu Chircu (@liviuchircu)Jul 2014 - Jun 2018
3. Vlad Patrascu (@rvlad-patrascu)May 2018 - May 2018
4. Ionut Ionita (@ionutrazvanionita)May 2016 - Jun 2016
5. Razvan Crainea (@razvancrainea)Nov 2014 - Feb 2016
6. Vlad Paiu (@vladpaiu)Mar 2014 - Jan 2016
7. Ionel Cerghit (@ionel-cerghit)Aug 2015 - Aug 2015
8. Ovidiu Sas (@ovidiusas)Mar 2013 - Jun 2015

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

Chapter3.Documentation

3.1.Contributors

Last edited by: Bogdan-Andrei Iancu (@bogdan-iancu), Liviu Chircu (@liviuchircu), Ionel Cerghit (@ionel-cerghit), Ovidiu Sas (@ovidiusas).

doc copyrights:

Copyright 2013 VoIP Embedded, Inc.