acc_user.sgml

来自「性能优秀的SIP Proxy」· SGML 代码 · 共 1,271 行 · 第 1/3 页

		<title><varname>acc_sip_from_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the 
		<quote>sip_from</quote> value.
		</para>
		<para>
		Default value is <quote>sip_from</quote>.
		</para>
		<example>
		<title>acc_sip_from_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_sip_from_column", "sip_from")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_sip_to_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the <quote>sip_to</quote> value.
		</para>
		<para>
		Default value is <quote>sip_to</quote>.
		</para>
		<example>
		<title>acc_sip_to_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_sip_to_column", "sip_to")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_sip_status_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the 
		<quote>sip_status</quote> value.
		</para>
		<para>
		Default value is <quote>sip_status</quote>.
		</para>
		<example>
		<title>acc_sip_status_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_sip_status_column", "sip_status")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_sip_method_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the 
		<quote>sip_method</quote> value.
		</para>
		<para>
		Default value is <quote>sip_method</quote>.
		</para>
		<example>
		<title>acc_sip_method_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_sip_method_column", "sip_method")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_i_uri_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the 
		<quote>incoming_URI</quote> value.
		</para>
		<para>
		Default value is <quote>i_uri</quote>.
		</para>
		<example>
		<title>acc_i_uri_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_i_uri_column", "in_uri")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_o_uri_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the 
		<quote>outgoing_uri</quote> value.
		</para>
		<para>
		Default value is <quote>o_uri</quote>.
		</para>
		<example>
		<title>acc_o_uri_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_o_uri_column", "out_uri")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_sip_callid_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the 
		<quote>sip_callid</quote> value.
		</para>
		<para>
		Default value is <quote>sip_callid</quote>.
		</para>
		<example>
		<title>acc_sip_callid_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_sip_callid_column", "sip_callid")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_user_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the 
		<quote>username</quote> value.
		</para>
		<para>
		Default value is <quote>username</quote>.
		</para>
		<example>
		<title>acc_user_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_user_column", "username")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_time_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the <quote>time</quote> value.
		</para>
		<para>
		Default value is <quote>time</quote>.
		</para>
		<example>
		<title>acc_time_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_time_column", "time")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_from_uri_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the 
		<quote>from_uri</quote> value.
		</para>
		<para>
		Default value is <quote>from_uri</quote>.
		</para>
		<example>
		<title>acc_from_uri_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_from_uri_column", "from_uri")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_to_uri_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the <quote>to_uri</quote> value.
		</para>
		<para>
		Default value is <quote>to_uri</quote>.
		</para>
		<example>
		<title>acc_to_uri_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_to_uri_column", "to_uri")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_totag_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the <quote>to_tag</quote> value.
		</para>
		<para>
		Default value is <quote>totag</quote>.
		</para>
		<example>
		<title>acc_totag_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_totag_column", "totag")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_fromtag_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the 
		<quote>from_tag</quote> value.
		</para>
		<para>
		Default value is <quote>fromtag</quote>.
		</para>
		<example>
		<title>acc_fromtag_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_fromtag_column", "fromtag")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_domain_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the <quote>domain</quote> value.
		</para>
		<para>
		Default value is <quote>domain</quote>.
		</para>
		<example>
		<title>acc_domain_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_domain_column", "domain")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_src_leg_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the 
		<quote>source_leg</quote> value in case of multi-leg accouting.
		</para>
		<para>
		Default value is <quote>src_leg</quote>.
		</para>
		<example>
		<title>acc_src_leg_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_src_leg_column", "src_leg")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>acc_dst_leg_column</varname> (string)</title>
		<para>
		Column name in accouting table to store the 
		<quote>destination_leg</quote> value in case of multi-leg accouting.
		</para>
		<para>
		Default value is <quote>dst_leg</quote>.
		</para>
		<example>
		<title>acc_dst_leg_column example</title>
		<programlisting format="linespecific">
modparam("acc", "acc_dst_leg_column", "dst_leg")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>db_extra</varname> (string)</title>
		<para>
		Extra values to be logged into database - DB specific.
		</para>
		<para>
		Default value is NULL.
		</para>
		<example>
		<title>db_extra example</title>
		<programlisting format="linespecific">
modparam("acc", "db_extra", "ct=$hdr(Content-type); email=$avp(s:email)")
</programlisting>
		</example>
	</section>
	<section>
		<title><varname>detect_direction</varname> (integer)</title>
		<para>
		Controlles the direction detection for sequential requests. If 
		enabled (non zero value), for sequential requests with upstream
		direction (from callee to caller), the FROM and TO will be swapped
		(the direction will be preserved as in the original request).
		</para>
		<para>
		It affects all values related to TO and FROM headers (body, URI, 
		username, domain, TAG).
		</para>
		<para>
		Default value is 0 (disabled).
		</para>
		<example>
		<title>detect_direction example</title>
		<programlisting format="linespecific">
modparam("acc", "detect_direction", 1)
</programlisting>
		</example>
	</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 - Not Found. 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>
		<para>
		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
		</para>
		<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>
		<para>
		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
		</para>
		<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>
		<para>
		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
		</para>
		<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 the configured 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>
		<para>
		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
		</para>
		<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:
-->