← Back to branch summary

~ubuntu-branches/debian/sid/kamailio/sid

« back to all changes in this revision

Viewing changes to modules/utils/doc/utils_admin.xml

  • Committer: Package Import Robot
  • Author(s): Victor Seva
  • Date: 2014-01-06 11:47:13 UTC
  • mfrom: (1.1.5)
  • Revision ID: package-import@ubuntu.com-20140106114713-t8xidp4arzrnyeya
Tags: 4.1.1-1
http://bugs.debian.org/728915
* New upstream release
* debian/patches:
  - add upstream fixes
* Added tls outbound websocket autheph dnssec modules
  - openssl exception added to their license
* removing sparc and ia64 from supported archs
  for mono module (Closes: #728915)

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/utils/doc/utils_admin.xml
72
72
        
73
73
        <section>
74
74
                <title>Parameters</title>
75
 
                <section>
 
75
                <section id="utils.p.http_query_timeout">
76
76
                        <title><varname>http_query_timeout</varname> (int)</title>
77
77
                        <para>
78
78
                        Defines in seconds how long &kamailio; waits for response
93
93
                                </programlisting>
94
94
                        </example>
95
95
                </section>
96
 
                <section>
 
96
                <section id="utils.p.forward_active">
97
97
                        <title><varname>forward_active</varname> (int)</title>
98
98
                        <para>
99
99
                                Defines if the forwarding callback should be installed.
112
112
                                </programlisting>
113
113
                        </example>
114
114
                </section>
115
 
                <section>
 
115
                <section id="utils.p.pres_db_url">
116
116
                        <title><varname>pres_db_url</varname> (string)</title>
117
117
                        <para>
118
118
                        Defines presence server database URL. If not
132
132
                                </programlisting>
133
133
                        </example>
134
134
                </section>
135
 
                <section>
 
135
                <section id="utils.p.xcap_table">
136
136
                        <title><varname>xcap_table</varname> (string)</title>
137
137
                        <para>
138
138
                        Defines the name of the xcap table in the presence server database.
156
156
 
157
157
        <section>
158
158
        <title>Functions</title>
159
 
                <section>
 
159
                <section id="utils.f.http_query">
160
160
                        <title>
161
 
                                <function moreinfo="none">http_query(url, result)</function>
 
161
                                <function moreinfo="none">http_query(url, [post-data], result)</function>
162
162
                        </title>
163
163
                        <para>
164
 
                        Sends HTTP GET request according to URL given in
 
164
                        Sends HTTP GET or POST request according to URL given in
165
165
                        <quote>url</quote> parameter, which is a string that may
166
166
                        contain pseudo variables.
167
167
                        </para>
 
168
                        <para>
 
169
                        If you want to make a POST-Request, you have to define
 
170
                        the <quote>post</quote>-data, that should be submitted
 
171
                        in that request as the second parameter.
 
172
                        </para>
168
173
                        <para>
169
174
                        If HTTP server returns a class 2xx or 3xx reply,
170
175
                        the first line of the reply's body (if any) is
183
188
                                <title><function>http_query()</function> usage</title>
184
189
                                <programlisting format="linespecific">
185
190
...
 
191
# GET-Request
186
192
http_query("http://tutpro.com/index.php?r_uri=$(ru{s.escape.param})&amp;f_uri=$(fu{s.escape.param})",
187
193
           "$var(result)")
188
194
switch ($retcode) {
190
196
}
191
197
...
192
198
                                </programlisting>
 
199
                                <programlisting format="linespecific">
 
200
...
 
201
# POST-Request
 
202
http_query("http://tutpro.com/index.php", "r_uri=$(ru{s.escape.param})&amp;f_uri=$(fu{s.escape.param})",
 
203
           "$var(result)")
 
204
switch ($retcode) {
 
205
       ...
 
206
}
 
207
...
 
208
                                </programlisting>
193
209
                        </example>
194
210
                </section>
195
 
                <section>
 
211
                <section id="utils.f.xcap_auth_status">
196
212
                        <title>
197
213
                                <function moreinfo="none">xcap_auth_status(watcher_uri, presentity_uri)</function>
198
214
                        </title>
235
251
        <section>
236
252
            <title><acronym>MI</acronym> Commands</title>
237
253
                
238
 
                <section>
 
254
        <section id="utils.m.forward_list">
239
255
            <title><function moreinfo="none">forward_list</function></title>
240
256
            <para>
241
257
                List active forward rules.
253
269
...
254
270
                </programlisting>
255
271
            </example>
256
 
                </section>
257
 
                <section>
 
272
        </section>
 
273
        <section id="utils.m.forward_switch">
258
274
            <title><function moreinfo="none">forward_switch</function></title>
259
275
            <para>
260
276
                This command can be used to activate or deactivate forwarding rules.
268
284
...
269
285
                </programlisting>
270
286
            </example>
271
 
                </section>
272
 
                
273
 
                <section>
 
287
        </section>
 
288
        <section id="utils.m.forward_filter">
274
289
            <title><function moreinfo="none">forward_filter</function></title>
275
290
            <para>
276
291
                Can be used to specify the filter for a certain id. Messages will only be
298
313
...
299
314
                </programlisting>
300
315
            </example>
301
 
                </section>
302
 
 
303
 
                <section>
 
316
        </section>
 
317
        <section id="utils.m.forward_proxy">
304
318
            <title><function moreinfo="none">forward_proxy</function></title>
305
319
            <para>
306
320
                This command can be used to configure forwarding rules. Specifies