acc_user.sgml

用来作为linux中SIP SERVER,完成VOIP网络电话中服务器的功能

	    </para>
	    <para>
		Default value is 1.
	    </para>
	    <example>
		<title>db_flag example</title>
		<programlisting format="linespecific">
modparam("acc", "db_flag", 2)
</programlisting>
	    </example>
	</section>
	<section>
	    <title><varname>db_missed_flag</varname> (integer)</title>
	    <para>
		Request flag which needs to be set to account missed calls -- database specific.
	    </para>
	    <para>
		Default value is 2.
	    </para>
	    <example>
		<title>db_missed_flag example</title>
		<programlisting format="linespecific">
modparam("acc", "db_missed_flag", 3)
</programlisting>
	    </example>
	</section>

	<section>
	    <title><varname>diameter_flag</varname> (integer)</title>
	    <para>
		Request flag which needs to be set to account a transaction -- DIAMETER specific.
	    </para>
	    <para>
		Default value is 1.
	    </para>
	    <example>
		<title>diameter_flag example</title>
		<programlisting format="linespecific">
modparam("acc", "diameter_flag", 2)
</programlisting>
	    </example>
	</section>
	<section>
	    <title><varname>diameter_missed_flag</varname> (integer)</title>
	    <para>
		Request flag which needs to be set to account missed calls -- DIAMETER specific.
	    </para>
	    <para>
		Default value is 2.
	    </para>
	    <example>
		<title>diameter_missed_flag example</title>
		<programlisting format="linespecific">
modparam("acc", "diameter_missed_flag", 3)
</programlisting>
	    </example>
	</section>
	<section>
	    <title><varname>diameter_client_host</varname> (string)</title>
	    <para>
		Hostname of the machine where the DIAMETER Client is running -- DIAMETER specific.
	    </para>
	    <para>
		Default value is <quote>localhost</quote>.
	    </para>
	    <example>
		<title>diameter_client_host example</title>
		<programlisting format="linespecific">
modparam("acc", "diameter_client_host", "iptel.org")
</programlisting>
	    </example>
	</section>
	<section>
	    <title><varname>diameter_client_port</varname> (int)</title>
	    <para>
		Port number where the Diameter Client is listening -- DIAMETER specific.
	    </para>
	    <para>
		Default value is 3000.
	    </para>
	    <example>
		<title>diameter_client_host example</title>
		<programlisting format="linespecific">
modparam("acc", "diameter_client_port", 3000)
</programlisting>
	    </example>
	</section>

	<section>
	    <title><varname>db_table_acc</varname> (string)</title>
	    <para>
		Name of the table containing accounting information.
	    </para>
	    <para>
		Default value is "acc".
	    </para>
	</section>

	<section>
	    <title><varname>db_table_missed_calls</varname> (string)</title>
	    <para>
		Name of the table containing accounting information about
		missed calls.
	    </para>
	    <para>
		Default value is "missed_calls".
	    </para>
	</section>

	<section>
	    <title><varname>db_localtime</varname> (int)</title>
	    <para>
		The parameter controls how date and time information for
		accounted transactions will be stored in database. When set to
		1 all time-related information will be based on the local time
		zone. When set to 0 then acc module will use UTC.
	    </para>
	    <para>
		Default value is 0 (use UTC).
	    </para>
	</section>
	
	<section>
	    <title><varname>acc_sip_from_column</varname> (string)</title>
	    <para>
		Name of the column containing the contents of From header field.
	    </para>
	    <para>
		Default value is "sip_from".
	    </para>
	</section>

	<section>
	    <title><varname>acc_sip_to_column</varname> (string)</title>
	    <para>
		Name of the column containing the contents of To header field.
	    </para>
	    <para>
		Default value is "sip_to".
	    </para>
	</section>

	<section>
	    <title><varname>acc_sip_status_column</varname> (string)</title>
	    <para>
		Name of the column containing status code of SIP replies.
	    </para>
	    <para>
		Default value is "sip_status".
	    </para>
	</section>	
	
	<section>
	    <title><varname>acc_sip_method_column</varname> (string)</title>
	    <para>
		Name of the column containing the SIP method of the request.
	    </para>
	    <para>
		Default value is "sip_method".
	    </para>
	</section>

	<section>
	    <title><varname>acc_i_uri_column</varname> (string)</title>
	    <para>
		Name of the column containing the inbound Request-URI of the
		acccounted SIP message. This is the URI that SER received.
	    </para>
	    <para>
		Default value is "i_uri".
	    </para>
	</section>

	<section>
	    <title><varname>acc_o_uri_column</varname> (string)</title>
	    <para>
		Name of the column containing the outbound Request-URI of the
		accounted SIP message. This is the final URI, after applying
		all modifications from the configuration file. This is what the
		downstream element will receive in the Request-URI of the
		message forwarded by SER.
	    </para>
	    <para>
		Default value is "o_uri".
	    </para>
	</section>

	<section>
	    <title><varname>acc_sip_callid_column</varname> (string)</title>
	    <para>
		Name of the column containing the contents of Call-ID header field.
	    </para>
	    <para>
		Default value is "sip_callid".
	    </para>
	</section>

	<section>
	    <title><varname>acc_user_column</varname> (string)</title>
	    <para>
		Name of the column containing the username from digest credentials.
	    </para>
	    <para>
		Default value is "username".
	    </para>
	</section>

	<section>
	    <title><varname>acc_time_column</varname> (string)</title>
	    <para>
		Date and time of arrival of the final reply that finished the
		transaction.
	    </para>
	    <para>
		Default value is "time".
	    </para>
	</section>

	<section>
	    <title><varname>acc_from_uri_column</varname> (string)</title>
	    <para>
		Name of the column containing the SIP URI extracted from the
		From header field. This is usually the part enclosed in angle
		brackets.
	    </para>
	    <para>
		Default value is "from_uri".
	    </para>
	</section>		

	<section>
	    <title><varname>acc_to_uri_column</varname> (string)</title>
	    <para>
		Name of the column containing the SIP URI extracted from the
		To header field. This is usually the part enclosed in angle
		brackets.
	    </para>
	    <para>
		Default value is "to_uri".
	    </para>
	</section>

	<section>
	    <title><varname>acc_totag_column</varname> (string)</title>
	    <para>
		Name of the column containing the value of the To header field
		tag parameter.
	    </para>
	    <para>
		Default value is "totag".
	    </para>
	</section>

	<section>
	    <title><varname>acc_fromtag_column</varname> (string)</title>
	    <para>
		Name of the column containing the value of the From header
		field tag parameter.
	    </para>
	    <para>
		Default value is "fromtag".
	    </para>
	</section>

	<section>
	    <title><varname>acc_domain_column</varname> (string)</title>
	    <para>
		The name of the column containing the name of domain. This is
		used when SER is operated in multi-domain mode.
	    </para>
	    <para>
		Default value is "domain".
	    </para>
	</section>
	
    </section>
    <section>
	<title>Exported Functions</title>
	<section>
	    <title><function moreinfo="none">acc_log_request(comment)</function></title>
	    <para>
		<function moreinfo="none">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 format="linespecific">
...
acc_log_request("Some comment");
...
</programlisting>
	    </example>
	</section>
	<section>
	    <title><function moreinfo="none">acc_db_request(comment, table)</function></title>
	    <para>
		Like <function moreinfo="none">acc_log_request</function>, <function
		moreinfo="none">acc_db_request</function> reports on a request. The report is sent
		to database at <quote>db_url</quote>, 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 format="linespecific">
...
acc_log_request("Some comment", "Some table");
...
</programlisting>
	    </example>
	</section>
	<section>
	    <title><function moreinfo="none">acc_rad_request(comment)</function></title>
	    <para>
		Like <function moreinfo="none">acc_log_request</function>, 
		<function moreinfo="none">acc_rad_request</function> reports on a request. It
		reports to radius server as configured in <quote>radius_config</quote>.
	    </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 format="linespecific">
...
acc_rad_request("Some comment");
...
</programlisting>
	    </example>
	</section>
	<section>
	    <title><function moreinfo="none">acc_diam_request(comment)</function></title>
	    <para>
		Like <function moreinfo="none">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 format="linespecific">
...
acc_diam_request("Some comment");
...
</programlisting>
	    </example>
	</section>
    </section>
</chapter>

<!-- Keep this element at the end of the file
Local Variables:
sgml-parent-document: ("acc.sgml" "Book" "chapter")
End:
-->