kamailio/misc/obsolete/cpl-c/doc/cpl-c.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="cpl-c" xmlns:xi="http://www.w3.org/2001/XInclude">
    <sectioninfo>
	<authorgroup>
	    <author>
		<firstname>Bogdan-Andrei</firstname>
		<surname>Iancu</surname>
		<affiliation><orgname>FhG FOKUS</orgname></affiliation>
		<address>
		    <email>[email protected]</email>
		</address>
	    </author>
	</authorgroup>
	<copyright>
	    <year>2003</year>
	    <holder>FhG FOKUS</holder>
	</copyright>
    </sectioninfo>
    
    <title>CPL Module</title>

    <section id="cpl-c.overview">
	<title>Overview</title>
	<para>
	    cpl-c modules implements a CPL (Call Processing Language)
	    interpreter. Support for uploading/downloading/removing scripts via
	    SIP REGISTER method is implemented.
	</para>
    </section>
    
    <section id="cpl-c.dep">
	<title>Dependencies</title>
	<section id="cpl-c.modules">
	    <title>SER Modules</title>
	    <para>
		The following modules must be loaded before this module:
		<itemizedlist>
		    <listitem>
			<formalpara>
			    <title>tm</title> 
			    <para>
				Transaction Manager, used for proxying/forking
				requests.
			    </para>
			</formalpara>
		    </listitem>
		    <listitem>
			<formalpara>
			    <title>sl</title>
			    <para>
				StateLess module - used for sending stateless 
				reply when responding to REGISTER request or for sending back 
				error responses.
			    </para>
			</formalpara>
		    </listitem>
		    <listitem>
			<formalpara>
			    <title>usrloc</title>
			    <para>
				User location module - used for implementing
				lookup("registration") (adding into location set of the
				users' contact)
			    </para>
			</formalpara>
		    </listitem>
		</itemizedlist>
	    </para>
	</section>
	
	<section id="libraries">
	    <title>External Libraries or Applications</title>
	    <para>
		The following libraries or applications must be installed
		before running SER with this module loaded:
		<itemizedlist>
		    <listitem>
			<formalpara>
			    <title>libxml2</title>
			    <para>
				This library contains an engine for XML
 				parsing, DTD validation and DOM manipulation.
			    </para>
			</formalpara>
		    </listitem>
		</itemizedlist>
	    </para>
	</section>
    </section>

    <xi:include href="params.xml"/>
    <xi:include href="functions.xml"/>

</section>