1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
<!-- Module User's Guide -->
<chapter>
<chapterinfo>
<revhistory>
<revision>
<revnumber>$Revision: 1.3 $</revnumber>
<date>$Date: 2005/10/27 17:57:25 $</date>
</revision>
</revhistory>
</chapterinfo>
<title>User's Guide</title>
<section>
<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 <quote>ping</quote>,
on the network layer).
</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>sl</emphasis> -- Stateless replies.
</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>None</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
</section>
<section>
<title>Exported Parameters</title>
<section>
<title><varname>accept</varname> (string)</title>
<para>
This parameter is the content of the Accept header field.
Note: it is not clearly written in RFC3261 if a proxy should
accept any content (the default <quote>*/*</quote>) because
it does not care about content. Or if it does not accept
any content, which is <quote></quote>.
</para>
<para>
<emphasis>
Default value is <quote>*/*</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>accept</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("options", "accept", "application/*")
...
</programlisting>
</example>
</section>
<section>
<title><varname>accept_encoding</varname> (string)</title>
<para>
This parameter is the content of the Accept-Encoding header field.
Please do not change the default value because &ser;
does not support any encodings yet.
</para>
<para>
<emphasis>
Default value is <quote></quote>.
</emphasis>
</para>
<example>
<title>Set <varname>accept_encoding</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("options", "accept_encoding", "gzip")
...
</programlisting>
</example>
</section>
<section>
<title><varname>accept_language</varname> (string)</title>
<para>
This parameter is the content of the Accept-Language header field.
You can set any language code which you prefer for error
descriptions from other devices, but presumably there are not
much devices around which support other languages then the
default English.
</para>
<para>
<emphasis>
Default value is <quote>en</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>accept_language</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("options", "accept_language", "de")
...
</programlisting>
</example>
</section>
<section>
<title><varname>support</varname> (string)</title>
<para>
This parameter is the content of the Support header field.
Please do not change the default value, because &ser; currently
does not support any of the SIP extensions registered at the IANA.
</para>
<para>
<emphasis>
Default value is <quote></quote>.
</emphasis>
</para>
<example>
<title>Set <varname>support</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("options", "support", "100rel")
...
</programlisting>
</example>
</section>
</section>
<section>
<title>Exported Functions</title>
<section>
<title>
<function moreinfo="none">options_reply()</function>
</title>
<para>
This function checks if the request method is OPTIONS and
if the request URI does not contain an username. If both
is true the request will be answered stateless with
<quote>200 OK</quote> and the capabilities from the modules
parameters.
</para>
<para>
It sends <quote>500 Server Internal Error</quote> for some errors
and returns false if it is called for a wrong request.
</para>
<para>
The check for the request method and the missing username is
optional because it is also done by the function itself. But
you should not call this function outside the myself check
because in this case the function could answer OPTIONS requests
which are sent to you as outbound proxy but with an other
destination then your proxy (this check is currently missing
in the function).
</para>
<para>
This function can be used from REQUEST_ROUTE.
</para>
<example>
<title><function>options_reply</function> usage</title>
<programlisting format="linespecific">
...
if (uri==myself) {
if ((method==OPTIONS) && (! uri=~"sip:.*[@]+.*")) {
options_reply();
}
}
...
</programlisting>
</example>
</section>
</section>
</chapter>
<!-- Keep this element at the end of the file
Local Variables:
sgml-parent-document: ("options.sgml" "Book" "chapter")
End:
-->
|
