kamailio/misc/obsolete/acc_syslog/doc/functions.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="acc.functions" xmlns:xi="http://www.w3.org/2001/XInclude">
    <sectioninfo>
    </sectioninfo>
    
    <title>Functions</title>
    
    <section id="acc_log_request1">
	<title><function>acc_log_request(comment)</function></title>
	<para>
	    <function>acc_request</function> reports on a request, for example,
	    it can be used to report on missed calls to off-line users who are
	    replied 404. To avoid multiple reports on UDP request
	    retransmission, you would need to embed the action in stateful
	    processing.
	</para>
	<para>
	    Meaning of the parameters is as follows:
	</para>
	<itemizedlist>
	    <listitem>
		<para><emphasis>comment</emphasis> - Comment to be appended.
		</para>
	    </listitem>
	</itemizedlist>
	<example>
	    <title>acc_log_request usage</title>
	    <programlisting>
...
acc_log_request("Some comment");
...
	    </programlisting>
	</example>
    </section>

    <section id="acc_db_request2">
	<title><function>acc_db_request(comment, table)</function></title>
	<para>
	    Like <function>acc_log_request</function>,
	    <function>acc_db_request</function> reports on a request. The
	    report is sent to database at "db_url", in the table referred to in
	    the second action parameter
	</para>
	<para>
	    Meaning of the parameters is as follows:
	</para>
	<itemizedlist>
	    <listitem>
		<para><emphasis>comment</emphasis> - Comment to be appended.</para>
	    </listitem>
	    <listitem>
		<para><emphasis>table</emphasis> - Database table to be used.</para>
	    </listitem>
	</itemizedlist>
	<example>
	    <title>acc_db_request usage</title>
	    <programlisting>
...
acc_log_request("Some comment", "Some table");
...
	    </programlisting>
	</example>
    </section>

    <section id="acc_rad_request">
	<title><function>acc_rad_request(comment)</function></title>
	<para>
	    Like <function>acc_log_request</function>,
	    <function>acc_rad_request</function> reports on a request. It
	    reports to radius server as configured in "radius_config".
	</para>
	<para>
	    Meaning of the parameters is as follows:
	</para>
	<itemizedlist>
	    <listitem>
		<para>
		    <emphasis>comment</emphasis> - Comment to be appended.
		</para>
	    </listitem>
	</itemizedlist>
	<example>
	    <title>acc_rad_request usage</title>
	    <programlisting>
...
acc_rad_request("Some comment");
...
	    </programlisting>
	</example>
    </section>

    <section id="acc_diam_request">
	    <title><function>acc_diam_request(comment)</function></title>
	<para>
	    Like <function>acc_log_request</function>, <function
		moreinfo="none">acc_diam_request</function> reports on a
	    request. It reports to Diameter server.  
	</para>
	<para>
	    Meaning of the parameters is as follows:
	</para>
	<itemizedlist>
	    <listitem>
		<para><emphasis>comment</emphasis> - Comment to be appended.
		</para>
	    </listitem>
	</itemizedlist>
	<example>
	    <title>acc_diam_request usage</title>
	    <programlisting>
...
acc_diam_request("Some comment");
...
	    </programlisting>
	</example>
    </section>
</section>