kamailio/modules/uid_gflags/doc/xmlrpc.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<section id="gflags.xmlrpc" xmlns:xi="http://www.w3.org/2001/XInclude">
    <sectioninfo>
    </sectioninfo>

    <title>XMLRPC Interface</title>

    <para>
	The state of the global flags can be read and modified over the XMLRPC
	interface. This module implements the following XMLRPC interface commands:
    </para>
    <itemizedlist>
	<listitem>
	    <para>
		<emphasis>gflags.set</emphasis> - Set the value of a flag to
		1. The function accepts one parameter which is the number of
		the flag to be set.
	    </para>
	</listitem>
	<listitem>
	    <para>
		<emphasis>gflags.reset</emphasis> - Reset the value of a flag to
		0. The function accepts one parameter which is the number of
		the flag to be reset.
	    </para>
	</listitem>
	<listitem>
	    <para>
		<emphasis>gflags.is_set</emphasis> - Return the status of a
		flag. The FIFO function would return TRUE if the flag is set
		and FALSE if it is not set. The only parameter of this function
		is the number of the flag.
	    </para>
	</listitem>
	<listitem>
	    <para>
		<emphasis>gflags.flush</emphasis> - Flush the state of global flags
		 into database.
	    </para>
	</listitem>
	<listitem>
	    <para>
		<emphasis>gflags.dump</emphasis> - Return the status of all flags. The 
		value is TRUE if the flag is set and FALSE if the flag is not set. The 
		function has no parameters.
	    </para>
	</listitem>
	<listitem>
	    <para>
		<emphasis>global.reload</emphasis> - Reload values from global_attrs 
		DB table. This function does not have any parameters. There is no return 
		value on success.  
	    </para>
	</listitem>
    </itemizedlist>
</section>