You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kamailio/modules_s/options/doc/options.xml

59 lines
1.6 KiB

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<section id="options" xmlns:xi="http://www.w3.org/2001/XInclude">
<sectioninfo>
<authorgroup>
<author>
<firstname>Nils</firstname>
<surname>Ohlmeier</surname>
<affiliation><orgname>FhG Fokus</orgname></affiliation>
<address>
<email>nils@iptel.org</email>
</address>
</author>
</authorgroup>
<copyright>
<year>2003</year>
<holder>FhG Fokus</holder>
</copyright>
</sectioninfo>
<title>Options Module</title>
<section id="options.overview">
<title>Overview</title>
<para>
This module provides a function to answer OPTIONS requests which
are directed to the server itself. This means an OPTIONS request
which has the address of the server in the request URI, and no
username in the URI. The request will be answered with a 200 OK
which the capabilities of the server.
</para>
<para>
To answer OPTIONS request directed to your server is the easiest
way for is-alive-tests on the SIP (application) layer from remote
(similar to ICMP echo requests, also known as "ping", on the
network layer).
</para>
</section>
<section id="options.dep">
<title>Dependencies</title>
<para>
The following modules must be loaded before this module:
<itemizedlist>
<listitem>
<para>
<emphasis>sl</emphasis> - Stateless replies.
</para>
</listitem>
</itemizedlist>
</para>
</section>
<xi:include href="params.xml"/>
<xi:include href="functions.xml"/>
</section>