reference.sgml

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

				loose_route
			    </entry>
			    <entry>
				rr
			    </entry>
			    <entry>
				none
			    </entry>
			    <entry>
				process loose routes in requests
			    </entry>
			</row>
			<row>
			    <entry>
				mf_process_maxfwd_header
			    </entry>
			    <entry>
				maxfwd
			    </entry>
			    <entry>
				default max_forwards value
			    </entry>
			    <entry>
				return true, if request's max_forwards value has not
				reached zero yet; if none is included in the request,
				set it to value in parameter
			    </entry>
			</row>
			<row>
			    <entry>
				proxy_authorize
			    </entry>
			    <entry>
				auth
			    </entry>
			    <entry>
				realm, subscriber table
			    </entry>
			    <entry>
				returns true if requests contains proper credentials, false
				otherwise
			    </entry>
			</row>






			<row>
			    <entry>
				proxy_challenge
			    </entry>
			    <entry>
				auth
			    </entry>
			    <entry>
				realm, qop
			    </entry>
			    <entry>
				challenge user to submit digest credentials; qop may be turned
				off for backwards compatibility with elderly implementations
			    </entry>
			</row>
			<row>
			    <entry>
				record_route
			    </entry>
			    <entry>
				rr
			    </entry>
			    <entry>
				none
			    </entry>
			    <entry>
				record-route a request
			    </entry>
			</row>
			<row>
			    <entry>
				replace
			    </entry>
			    <entry>
				textops
			    </entry>
			    <entry>
				RegExp, Substitute
			    </entry>
			    <entry>
				find the first occurrence of a string matching the regular 
				expression in header or body and replace it with a substitute
			    </entry>
			</row>
			<row>
			    <entry>
				replace_all
			    </entry>
			    <entry>
				textops
			    </entry>
			    <entry>
				RegExp, Substitute
			    </entry>
			    <entry>
				find all occurrences of a string matching the regular 
				expression in header or body and replace it with a substitute
			    </entry>
			</row>
			<row>
			    <entry>
				save
			    </entry>
			    <entry>
				usrloc
			    </entry>
			    <entry>
				table name
			    </entry>
			    <entry>
				for use in registrar: save content of Contact header fields
				in user location database and reply with 200
			    </entry>
			</row>
			<row>
			    <entry>
				search
			    </entry>
			    <entry>
				textops
			    </entry>
			    <entry>
				regular expression
			    </entry>
			    <entry>
				search for a regular expression match in request header of body
			    </entry>
			</row>

			<row>
			    <entry>
				sl_send_reply
			    </entry>
			    <entry>
				sl
			    </entry>
			    <entry>
				status code, reason phrase
			    </entry>
			    <entry>
				reply a request statelessly
			    </entry>
			</row>

			<row>
			    <entry>
				t_relay
			    </entry>
			    <entry>
				tm
			    </entry>
			    <entry>
				none
			    </entry>
			    <entry>
				stateful forwarding to locations in current destination set
			    </entry>
			</row>

			<row>
			    <entry>
				t_on_failure
			    </entry>
			    <entry>
				tm
			    </entry>
			    <entry>
				failure_route number
			    </entry>
			    <entry>
				set failure_route block which shall be entered if stateful
				forwarding fails
			    </entry>
			</row>

			<row>
			    <entry>
				t_replicate
			    </entry>
			    <entry>
				tm
			    </entry>
			    <entry>
				host, port number
			    </entry>
			    <entry>
				replicate a request to a destination
			    </entry>
			</row>


		    </tbody>
		</tgroup>
	    </table>
	</section> <!-- modules -->
	<section id="fiforeference">
	    <title>FIFO Commands Reference</title>
	    <para>
		This section lists currently supported FIFO commands. Some of them are
		built-in in <application moreinfo="none">ser</application> core, whereas
		others are exported by modules. The most important exporters are now
		tm and usrloc module. tm FIFO commands allow users to initiate transactions
		without knowledge of underlying SIP stack. usrloc FIFO commands allow
		users to access in-memory user-location database. Note that that is the
		only way how to affect content of the data-base in real-time. Changes
		to MySql database do not affect in-memory table unless <application moreinfo="none">ser</application>
		is restarted.
	    </para>
	    <table>
		
		<title>FIFO Commands</title>
		<tgroup cols="4">
		    <thead>
			<row>
			    <entry>
				Command
			    </entry>
			    <entry>
				Module
			    </entry>
			    <entry>
				Parameters
			    </entry>			    
			    <entry>
				Comments
			    </entry>
			</row>
		    </thead>
		    <tbody>
			<row>
			    <entry>
				ps
			    </entry>
			    <entry>
				core
			    </entry>
			    <entry>
				none
			    </entry>
			    <entry>
				prints running <application moreinfo="none">ser</application> processes
			    </entry>
			</row>
			<row>
			    <entry>which</entry>
			    <entry>core</entry>
			    <entry>none</entry>
			    <entry>prints list of available FIFO commands</entry>
			</row>
			<row>
			    <entry>arg</entry>
			    <entry>core</entry>
			    <entry>none</entry>
			    <entry>prints list of command-line arguments with which 
				<application moreinfo="none">ser</application> was started</entry>
			</row>
			<row>
			    <entry>pwd</entry>
			    <entry>core</entry>
			    <entry>none</entry>
			    <entry>prints <application moreinfo="none">ser</application>'s working
			    directory</entry>
			</row>
			<row>
			    <entry>version</entry>
			    <entry>core</entry>
			    <entry>none</entry>
			    <entry>prints version of <application moreinfo="none">ser</application></entry>
			</row>
			<row>
			    <entry>uptime</entry>
			    <entry>core</entry>
			    <entry>none</entry>
			    <entry>prints <application moreinfo="none">ser</application>'s running time</entry>
			</row>
			<row>
			    <entry>sl_stats</entry>
			    <entry>sl</entry>
			    <entry>none</entry>
			    <entry>prints statistics for sl module</entry>
			</row>
			<row>
			    <entry>t_stats</entry>
			    <entry>tm</entry>
			    <entry>none</entry>
			    <entry>print statistics for tm module</entry>
			</row>
			<row>
			    <entry>t_hash</entry>
			    <entry>tm</entry>
			    <entry>none</entry>
			    <entry>print occupation of transaction table (mainly for debugging)</entry>
			</row>
			<row>
			    <entry>t_uac_dlg</entry>
			    <entry>tm</entry>
			    <entry>method, request URI, outbound URI (if none, empty line with a single dot),
					dot-line-terminated header fields, optionally dot-line terminated message
					body. 
				</entry>
					
			    <entry>initiate a transaction.
					From and To header fields must be present in header field list,
					so does Content-Type if body is present. If CSeq, CallId and From-tag
					are not present, ephemeral values are generated. Content_length is
					calculated automatically if body present.
				</entry>
			</row>
			<row>
			    <entry>ul_stats</entry>
			    <entry>usrloc</entry>
			    <entry>none</entry>
			    <entry>print usrloc statistics</entry>
			</row>
			<row>
			    <entry>ul_rm</entry>
			    <entry>usrloc</entry>
			    <entry>table name, user name</entry>
			    <entry>remove all user's contacts from user-location database</entry>
			</row>
			<row>
			    <entry>ul_rm_contact</entry>
			    <entry>usrloc</entry>
			    <entry>table name, user name, contact</entry>
			    <entry>remove a user's contact from user-location database</entry>
			</row>
			<row>
			    <entry>ul_dump</entry>
			    <entry>usrloc</entry>
			    <entry>none</entry>
			    <entry>print content of in-memory user-location database</entry>
			</row>
			<row>
			    <entry>ul_flush</entry>
			    <entry>usrloc</entry>
			    <entry>none</entry>
			    <entry>flush content of in-memory user-location cache in
			    persistent database (MySQL)</entry>
			</row>
			<row>
			    <entry>ul_add</entry>
			    <entry>usrloc</entry>
			    <entry>table name, user name, contact, expiration, priority (q)</entry>
			    <entry>insert a contact address in user-location database</entry>
			</row>
			<row>
			    <entry>ul_show_contact</entry>
			    <entry>usrloc</entry>
			    <entry>table, user name</entry>
			    <entry>show user's contact addresses in user-location database</entry>
			</row>
		    </tbody>
		</tgroup>
	    </table>
	</section>
	<section>
	    <title>Used Database Tables</title>
	    <para>
		<application moreinfo="none">ser</application> includes MySQL support
		to guarantee data persistence across server reboots and storage
		of users' web environment. The data stored in
		the database include user profiles, access control lists, user location,
		etc. Note that users are not supposed to alter the data directly, as it
		could introduce inconsistency between data on persistence storage and
		in server's memory.
		The following list enumerates used tables and explains their purpose.

		<itemizedlist>
		    <listitem>
			<para>
			    subscriber -- table of users. It includes user names and
			    security credentials, as well as additional user information.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    reserved -- reserved user names. <application moreinfo="none">serweb</application>
			    does not permit creation of accounts with name on this list.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    phonebook -- user's personal phonebooks. Accessible via
			    <application moreinfo="none">serweb</application>.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    pending -- table of unconfirmed subscription requests. Used by
			    <application moreinfo="none">serweb</application>.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    missed_calls -- table of missed calls. Can be fed by acc modules
			    if mysql support is turned on. Displayed by <application moreinfo="none">serweb</application>.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    location -- user contacts. Typically updated through
			    <application moreinfo="none">ser</application>'r registrar
			    functionality.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    grp -- group membership. Used by auth module to determine
			    whether a user belongs to a group.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    event -- allows users to subscribe to additional services.
			    Currently unused.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    aliases -- keeps track of alternative user names.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    active_sessions -- keeps track of currently active web sessions.
			    For use by <application moreinfo="none">serweb</application>.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    acc -- keeps track of accounted calls.  Can be fed by acc module
			    if mysql support is turned on. Displayed by <application moreinfo="none">serweb</application>.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    config -- maintains attribute-value pairs for keeping various information.
			    Currently not used.
			</para>
		    </listitem>
		    <listitem>
			<para>
			    silo -- message store for instant messages which could not have been
			    delivered.
			</para>
		    </listitem>

		    <listitem>
			<para>
			    version -- keeps version number of each table definition.
			</para>
		    </listitem>

		    <listitem>
			<para>
			    domain -- maintains list of served domains.
			</para>
		    </listitem>

		    <listitem>
			<para>
			    server_monitoring-* -- reserved for persistent monitoring of 
				server's operation
			</para>
		    </listitem>

		    <listitem>
			<para>
			    uri -- used to keep lists of URIs "owned" by a user
				(as identified by digest identity); good for some
				PSTN interworking scenarios
			</para>
		    </listitem>


		</itemizedlist>
		
	    </para>
	</section>
    </chapter> <!-- reference -->