jabber_user.sgml

性能优秀的SIP Proxy

		<title>Set <varname>jaddress</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("jabber", "jaddress", "1.2.3.4")
...
</programlisting>
		</example>
	</section>

	<section>
		<title><varname>jport</varname> (integer)</title>
		<para>
		Port number of Jabber server.
		</para>
		<para>
		<emphasis>
			Default value is <quote>5222</quote>.
		</emphasis>
		</para>
		<example>
		<title>Set <varname>jport</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("jabber", "jport", 1234)
...
</programlisting>
		</example>
	</section>

	<section>
		<title><varname>jdomain</varname> (string)</title>
		<para>
		Format: jabber.sipserver.com=&lt;delim&gt;. If the destination is for Jabber network
		the &uri; should be like: username&lt;delim&gt;jabber_server@jdomain or
		nickname&lt;delim&gt;roomname&lt;delim&gt;conference_server@jdomain
		</para>
		<para>
		&lt;delim&gt; must be a un-reserved character. By default this character is * .  The
		destination will be transformed to username@jabber_server or
		roomname@conference_server/nickname before the message is sent to Jabber server.
		</para>
		<para>
		<emphasis>
			Default value is none.
		</emphasis>
		</para>
		<example>
		<title>Set <varname>jdomain</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("jabber", "jdomain", "jabber.sipserver.com=*")
...
</programlisting>
		</example>
	</section>

	<section>
		<title><varname>aliases</varname> (string)</title>
		<para>
		Aliases for &im; networks.
		</para>
		<para>
		Format: <quote>N;alias1=&lt;delim1&gt;;...;aliasN=&lt;delimN&gt;;</quote>
		Destinations like '*@aliasX' could have other format than those specified for Jabber
		network.  All &lt;delim&gt; from user part of the destination address will be
		changed to &lt;delimX&gt; if the destination address contains &lt;aliasX&gt;.
		</para>
		<para>
		(Ex: jdomain is 'jabber.x.com=*' and msn_alias is 'msn.x.com=%'. The destination
		address forM <acronym>MSN</acronym> Network, on &sip; side, is like
		'username*[e-mail]'. The destination address will be transformed to
		'[e-mail]'.  'msn.x.com' must be the same as the
		<acronym>JID</acronym> associated with <acronym>MSN</acronym> transport in Jabber
		configuration file (usually is 'jabberd.xml'))
		</para>
		<para>
		<emphasis>
			Default value is none.
		</emphasis>
		</para>
		<example>
		<title>Set <varname>jdomain</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("jabber", "aliases", "1;msn.x.com=%")
...
</programlisting>
		</example>
	</section>

	<section>
		<title><varname>proxy</varname> (string)</title>
		<para>
		Outbound proxy address.
		</para>
		<para>
		Format: ip_address:port hostname:port
		</para>
		<para>
		All &sip; messages generated by gateway will be sent to that address. If is
		missing, the message will be delivered to the hostname of the destination address
		</para>
		<para>
		Default value is none.
		</para>
		<example>
		<title>Set <varname>proxy</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("jabber", "proxy", "10.0.0.1:5060 sipserver.com:5060")
...
</programlisting>
		</example>
	</section>

	<section>
		<title><varname>registrar</varname> (string)</title>
		<para>
		The address in whose behalf the INFO and ERROR messages are sent.
		</para>
		<para>
		<emphasis>
			Default value is <quote>jabber_gateway@127.0.0.1</quote>.
		</emphasis>
		</para>
		<example>
		<title>Set <varname>registrar</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("jabber", "registrar", "jabber_gateway@127.0.0.1")
...
</programlisting>
		</example>
	</section>

	<section>
		<title><varname>workers</varname> (integer)</title>
		<para>
		Number of workers.
		</para>
		<para>
		<emphasis>
			Default value is 2.
		</emphasis>
		</para>
		<example>
		<title>Set <varname>workers</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("jabber", "workers", 2)
...
</programlisting>
		</example>
	</section>

	<section>
		<title><varname>max_jobs</varname> (integer)</title>
		<para>
		Maximum jobs per worker.
		</para>
		<para>
		<emphasis>
			Default value is 10.
		</emphasis>
		</para>
		<example>
		<title>Set <varname>max_jobs</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("jabber", "max_jobs", 10)
...
</programlisting>
		</example>
	</section>

	<section>
		<title><varname>cache_time</varname> (integer)</title>
		<para>
		Cache time of a Jabber connection.
		</para>
		<para>
		<emphasis>
			Default value is 600.
		</emphasis>
		</para>
		<example>
		<title>Set <varname>cache_time</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("jabber", "cache_time", 600)
...
</programlisting>
		</example>
	</section>

	<section>
		<title><varname>delay_time</varname> (integer)</title>
		<para>
		Time to keep a &sip; message (in seconds).
		</para>
		<para>
		<emphasis>
			Default value is 90 seconds.
		</emphasis>
		</para>
		<example>
		<title>Set <varname>delay_time</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("jabber", "delay_time", 90)
...
</programlisting>
		</example>
	</section>

	<section>
		<title><varname>sleep_time</varname> (integer)</title>
		<para>
		Time between expired Jabber connections checking (in seconds).
		</para>
		<para>
		<emphasis>
			Default value is 20 seconds.
		</emphasis>
		</para>
		<example>
		<title>Set <varname>sleep_time</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("jabber", "sleep_time", 20)
...
</programlisting>
		</example>
	</section>

	<section>
		<title><varname>check_time</varname> (integer)</title>
		<para>
		Time between checking the status of JabberGW workers (in seconds).
		</para>
		<para>
		<emphasis>
			Default value is 20 seconds.
		</emphasis>
		</para>
		<example>
		<title>Set <varname>check_time</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("jabber", "check_time", 20)
...
</programlisting>
		</example>
	</section>

	</section>
	<section>
	<title>Exported Functions</title>
	<section>
		<title>
		<function moreinfo="none">jab_send_message()</function>
		</title>
		<para>
		Converts &sip; MESSAGE message to a Jabber message and sends it to Jabber server.
		</para>
		<para>
		This function can be used from REQUEST_ROUTE.
		</para>
		<example>
		<title><function>jab_send_message()</function> usage</title>
		<programlisting format="linespecific">
...
jab_send_message();
...
</programlisting>
		</example>
	</section>
	<section>
		<title>
		<function moreinfo="none">jab_join_jconf()</function>
		</title>
		<para>
		Join a Jabber conference--the nickname, room name and conference server address
		should be included in To header as: nickname%roomname%conference_server@jdomain . If
		the nickname is missing, then the &sip; username is used.
		</para>
		<para>
		This function can be used from REQUEST_ROUTE.
		</para>
		<example>
		<title><function>jab_join_jconf()</function> usage</title>
		<programlisting format="linespecific">
...
jab_join_jconf();
...
</programlisting>
		</example>
	</section>
	<section>
		<title>
		<function moreinfo="none">jab_exit_jconf()</function>
		</title>
		<para>
		Leave a Jabber conference--the nickname, room name and conference server address
		should be included in To header as: nickname%roomname%conference_server@jdomain .
		</para>
		<para>
		This function can be used from REQUEST_ROUTE.
		</para>
		<example>
		<title><function>jab_exit_jconf()</function> usage</title>
		<programlisting format="linespecific">
...
jab_exit_jconf();
...
</programlisting>
		</example>
	</section>

	<section>
		<title>
		<function moreinfo="none">jab_go_online()</function>
		</title>
		<para>
		Register to the Jabber server with associated Jabber <abbrev>ID</abbrev> of the &sip; user.
		</para>
		<para>
		This function can be used from REQUEST_ROUTE.
		</para>
		<example>
		<title><function>jab_go_online()</function> usage</title>
		<programlisting format="linespecific">
...
jab_go_online();
...
</programlisting>
		</example>
	</section>

	<section>
		<title>
		<function moreinfo="none">jab_go_offline()</function>
		</title>
		<para>
		Log off from Jabber server the associated Jabber <abbrev>ID</abbrev> of the &sip; user.
		</para>
		<para>
		This function can be used from REQUEST_ROUTE.
		</para>
		<example>
		<title><function>jab_go_offline()</function> usage</title>
		<programlisting format="linespecific">
...
jab_go_offline();
...
</programlisting>
		</example>
	</section>
	</section>
</chapter>

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