Browse code

Updating docs

Olle E. Johansson authored on 04/08/2015 14:45:31
Showing 2 changed files
... ...
@@ -42,7 +42,7 @@ Carsten Bock
42 42
 
43 43
         4. Functions
44 44
 
45
-              4.1. http_query(url, [post-data], result)
45
+              4.1. curl_http_query(url, [post-data], result)
46 46
 
47 47
         5. Pseudovariables
48 48
 
... ...
@@ -64,7 +64,7 @@ Carsten Bock
64 64
    1.6. Set tlscacert parameter
65 65
    1.7. Set tlsverifyserver parameter
66 66
    1.8. Set curlcon parameter
67
-   1.9. http_query() usage
67
+   1.9. curl_http_query() usage
68 68
 
69 69
 Chapter 1. Admin Guide
70 70
 
... ...
@@ -89,7 +89,7 @@ Chapter 1. Admin Guide
89 89
 
90 90
    4. Functions
91 91
 
92
-        4.1. http_query(url, [post-data], result)
92
+        4.1. curl_http_query(url, [post-data], result)
93 93
 
94 94
    5. Pseudovariables
95 95
 
... ...
@@ -267,9 +267,9 @@ timeout=12")
267 267
 
268 268
 4. Functions
269 269
 
270
-   4.1. http_query(url, [post-data], result)
270
+   4.1. curl_http_query(url, [post-data], result)
271 271
 
272
-4.1. http_query(url, [post-data], result)
272
+4.1. curl_http_query(url, [post-data], result)
273 273
 
274 274
    Sends HTTP GET or POST request according to URL given in "url"
275 275
    parameter, which is a string that may contain pseudo variables.
... ...
@@ -287,11 +287,15 @@ timeout=12")
287 287
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
288 288
    FAILURE_ROUTE, and BRANCH_ROUTE.
289 289
 
290
-   Example 1.9. http_query() usage
290
+   Note that this function is based on the http_query function in the
291
+   utils module. It is changed to use the same base library and settings
292
+   as the rest of the functions in this module.
293
+
294
+   Example 1.9. curl_http_query() usage
291 295
 ...
292 296
 # GET-Request
293
-http_query("http://tutpro.com/index.php?r_uri=$(ru{s.escape.param})&f_uri=$(fu{s
294
-.escape.param})",
297
+curl_http_query("http://tutpro.com/index.php?r_uri=$(ru{s.escape.param})&f_uri=$
298
+(fu{s.escape.param})",
295 299
            "$var(result)")
296 300
 switch ($retcode) {
297 301
        ...
... ...
@@ -299,8 +303,8 @@ switch ($retcode) {
299 299
 ...
300 300
 ...
301 301
 # POST-Request
302
-http_query("http://tutpro.com/index.php", "r_uri=$(ru{s.escape.param})&f_uri=$(f
303
-u{s.escape.param})",
302
+curl_http_query("http://tutpro.com/index.php", "r_uri=$(ru{s.escape.param})&f_ur
303
+i=$(fu{s.escape.param})",
304 304
            "$var(result)")
305 305
 switch ($retcode) {
306 306
        ...
... ...
@@ -264,9 +264,9 @@ modparam("curl", "curlcon", "apifour=>http://stockholm.example.com/api/getstuff;
264 264
 
265 265
 	<section>
266 266
 	<title>Functions</title>
267
-		<section id="curl.f.http_query">
267
+		<section id="curl.f.curl_http_query">
268 268
 			<title>
269
-				<function moreinfo="none">http_query(url, [post-data], result)</function>
269
+				<function moreinfo="none">curl_http_query(url, [post-data], result)</function>
270 270
 			</title>
271 271
 			<para>
272 272
 			Sends HTTP GET or POST request according to URL given in
... ...
@@ -292,12 +292,16 @@ modparam("curl", "curlcon", "apifour=>http://stockholm.example.com/api/getstuff;
292 292
 			This function can be used from REQUEST_ROUTE,
293 293
 			ONREPLY_ROUTE, FAILURE_ROUTE, and BRANCH_ROUTE.
294 294
 			</para>
295
+			<para>
296
+			Note that this function is based on the http_query function in the utils module.
297
+			It is changed to use the same base library and settings as the rest of the functions in this module.
298
+			</para>
295 299
 			<example>
296
-				<title><function>http_query()</function> usage</title>
300
+				<title><function>curl_http_query()</function> usage</title>
297 301
 				<programlisting format="linespecific">
298 302
 ...
299 303
 # GET-Request
300
-http_query("http://tutpro.com/index.php?r_uri=$(ru{s.escape.param})&amp;f_uri=$(fu{s.escape.param})",
304
+curl_http_query("http://tutpro.com/index.php?r_uri=$(ru{s.escape.param})&amp;f_uri=$(fu{s.escape.param})",
301 305
            "$var(result)")
302 306
 switch ($retcode) {
303 307
        ...
... ...
@@ -307,7 +311,7 @@ switch ($retcode) {
307 307
 				<programlisting format="linespecific">
308 308
 ...
309 309
 # POST-Request
310
-http_query("http://tutpro.com/index.php", "r_uri=$(ru{s.escape.param})&amp;f_uri=$(fu{s.escape.param})",
310
+curl_http_query("http://tutpro.com/index.php", "r_uri=$(ru{s.escape.param})&amp;f_uri=$(fu{s.escape.param})",
311 311
            "$var(result)")
312 312
 switch ($retcode) {
313 313
        ...