Browse code

xhttp: added section ids

Daniel-Constantin Mierla authored on 16/04/2017 07:48:40
Showing 1 changed files
... ...
@@ -10,13 +10,13 @@
10 10
 <!-- Module User's Guide -->
11 11
 
12 12
 <chapter>
13
-	
13
+
14 14
 	<title>&adminguide;</title>
15
-	
15
+
16 16
 	<section>
17 17
 	<title>Overview</title>
18 18
 	<para>
19
-		This module provides basic HTTP/1.0 server functionality inside 
19
+		This module provides basic HTTP/1.0 server functionality inside
20 20
 		&kamailio;. SIP and HTTP are very similar protocols, so, practically, the
21 21
 		SIP parser can easily handle HTTP requests just by adding a fake
22 22
 		Via header.
... ...
@@ -36,32 +36,32 @@
36 36
 	<title>Note on Latency</title>
37 37
 	<para>
38 38
 		Because HTTP requests in <emphasis>xhttp</emphasis> are handled
39
-		by the same, finite number of SIP worker processes that operate on 
40
-		SIP messages, the same general principles regarding script execution 
41
-		speed and throughput should be observed by the writer in 
39
+		by the same, finite number of SIP worker processes that operate on
40
+		SIP messages, the same general principles regarding script execution
41
+		speed and throughput should be observed by the writer in
42 42
 		<emphasis>event_route[xhttp:request]</emphasis> as in any other
43
-		part of the route script.  
43
+		part of the route script.
44 44
 	</para>
45 45
 	<para>
46 46
 		For example, if you initiate a database query in the HTTP request route
47 47
 		that takes a long time to return rows, the SIP worker process in which
48
-		the request is handled will be blocked for that time and unable to 
48
+		the request is handled will be blocked for that time and unable to
49 49
 		process other SIP messages.  In most typical installations, there are
50
-		only a few of these worker processes running.  
50
+		only a few of these worker processes running.
51 51
 	</para>
52 52
 	<para>
53 53
 		Therefore, it is highly inadvisable to execute particularly slow things in the
54
-		<emphasis>event_route[xhttp:request]</emphasis>, because the request is not 
55
-		handled in an asynchronous manner or otherwise peripherally to general 
56
-		SIP processing.  SIP worker threads will block, pending the outcome of the 
57
-		event route just like any other config script route.  
54
+		<emphasis>event_route[xhttp:request]</emphasis>, because the request is not
55
+		handled in an asynchronous manner or otherwise peripherally to general
56
+		SIP processing.  SIP worker threads will block, pending the outcome of the
57
+		event route just like any other config script route.
58 58
 	</para>
59 59
 	<para>
60
-		This is no more or less true for <emphasis>xhttp</emphasis> than it is for 
61
-		any other block of script in any other scenario, and does not warrant any 
62
-		extraordinary concern.  It nevertheless bears mention here because some 
63
-		processes with embedded HTTP servers have the request processing take place 
64
-		"outside" of the main synchronous event sequence, whether by creating 
60
+		This is no more or less true for <emphasis>xhttp</emphasis> than it is for
61
+		any other block of script in any other scenario, and does not warrant any
62
+		extraordinary concern.  It nevertheless bears mention here because some
63
+		processes with embedded HTTP servers have the request processing take place
64
+		"outside" of the main synchronous event sequence, whether by creating
65 65
 		separate threads or by some other asynchronous handling.  That is not the
66 66
 		case with <emphasis>xhttp</emphasis>.
67 67
 	</para>
... ...
@@ -114,7 +114,7 @@
114 114
 	</section>
115 115
 	<section>
116 116
 	<title>Parameters</title>
117
-	<section>
117
+	<section id="xhttp.p.url_skip">
118 118
 		<title><varname>url_skip</varname> (str)</title>
119 119
 		<para>
120 120
 			Regular expression to match the HTTP URL. If there is a match,
... ...
@@ -134,7 +134,7 @@ modparam("xhttp", "url_skip", "^/RPC2")
134 134
 </programlisting>
135 135
 		</example>
136 136
 	</section>
137
-	<section>
137
+	<section id="xhttp.p.url_match">
138 138
 		<title><varname>url_match</varname> (str)</title>
139 139
 		<para>
140 140
 			Regular expression to match the HTTP URL. If there is no match,
... ...
@@ -160,7 +160,7 @@ modparam("xhttp", "url_match", "^/sip/")
160 160
 
161 161
 	<section>
162 162
 	<title>Functions</title>
163
- 	<section>
163
+	<section id="xhttp.f.xhttp_reply">
164 164
 	    <title>
165 165
 		<function moreinfo="none">xhttp_reply(code, reason, ctype, body)</function>
166 166
 	    </title>