<!-- Module User's Guide -->

<chapter>
	<chapterinfo>
	<revhistory>
		<revision>
		<revnumber>$Revision: 1827 $</revnumber>
		<date>$Date: 2007-03-12 17:22:53 +0200 (Mon, 12 Mar 2007) $</date>
		</revision>
	</revhistory>
	</chapterinfo>
	<title>User's Guide</title>
	
	<section>
	<title>Overview</title>
	<para>
		 The pua_usrloc is the connector between usrloc and pua modules.
		 It creates the environment to send PUBLISH requests for user
		 location records, on specific events (e.g., when new record is
		 added in usrloc, a PUBLISH with status open (online) is issued;
		 when expires, it sends closed (offline)).
	</para>
	<para>
		Using this module, phones which have no support for presence can
		be seen as online/offline. 
	</para>
	</section>
		<section>
	<title>Dependencies</title>
	<section>
		<title>&ser; Modules</title>
		<para>
		The following modules must be loaded before this module:
			<itemizedlist>
			<listitem>
			<para>
				<emphasis>usrloc</emphasis>.
			</para>
			</listitem>
			<listitem>
			<para>
				<emphasis>pua</emphasis>.
			</para>
			</listitem>
			</itemizedlist>
		</para>
	</section>
	<section>
		<title>External Libraries or Applications</title>
		<para>
		The following libraries or applications must be installed before running
		&ser; with this module loaded:
			<itemizedlist>
			<listitem>
			<para>
				<emphasis>libxml</emphasis>.
			</para>
			</listitem>
			</itemizedlist>
		</para>
	</section>
	</section>
	<section>
	<title>Exported Parameters</title>
	<section>
		<title><varname>default_domain</varname> (str)</title>
		<para>
		The default domain to use when constructing the presentity
		uri if it is missing from recorded aor. 
		</para>
		<para>
		<emphasis>Default value is <quote>NULL</quote>.	
		</emphasis>
		</para>
		<example>
		<title>Set <varname>default_domain</varname> parameter</title>
		<programlisting format="linespecific">
...
modparam("default_domain", "default_domain", "openser.org");
...

<section>
	<title>Exported Functions</title>
		<section>
				<title>
				<function moreinfo="none">pua_set_publish()</function>
				</title>
			<para>
				The function is used to mark REGISTER requests that have to
				issue a PUBLISH. The PUBLISH is issued when REGISTER is saved
				in location table.
			</para>
			<para>
			</para>
		<example>
		<title><function>pua_set_publish</function> usage</title>
	<programlisting format="linespecific">
...
if(is_method("REGISTER") && from_uri=~"john@openser.org") 
	pua_set_publish();		
...
</programlisting>
		</example>

		</section>

</section>		

</chapter>

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


