svn commit: r293206 - in /httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request: Hook/Hook.pod Parser/Parser.pod

[jo...@apache.org]

Author: joes
Date: Sun Oct  2 19:09:49 2005
New Revision: 293206

URL: http://svn.apache.org/viewcvs?rev=293206&view=rev
Log:
Document exposed parsers and hooks.

Modified:
    httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Hook/Hook.pod
    httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Parser/Parser.pod

Modified: httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Hook/Hook.pod
URL: http://svn.apache.org/viewcvs/httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Hook/Hook.pod?rev=293206&r1=293205&r2=293206&view=diff
==============================================================================
--- httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Hook/Hook.pod (original)
+++ httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Hook/Hook.pod Sun Oct  2 19:09:49 2005
@@ -28,8 +28,39 @@
 
 
 
-=head2 make
+=head2 disable_uploads
 
+    APR::Request::Hook->disable_uploads($pool)
+    APR::Request::Hook->disable_uploads($pool, $next)
+
+Hook which returns APREQ_ERROR_GENERAL 
+if a file upload field is detected. $pool
+is an APR::Pool object; $next (if present)
+is the next APR::Request::Hook in the chain.
+
+
+
+
+=head2 apr_xml_parser
+
+    APR::Request::Hook->apr_xml_parser($pool)
+    APR::Request::Hook->apr_xml_parser($pool, $next)
+
+Xml parser hook.  $pool is an APR::Pool object;
+$next (if present) is the next APR::Request::Hook
+in the chain.
+
+
+
+
+=head2 discard_brigade
+
+    APR::Request::Hook->discard_brigade($pool)
+    APR::Request::Hook->discard_brigade($pool, $next)
+
+Hook which discards the brigade it receives from the parser.
+$pool is an APR::Pool object; $next (if present) is the next
+APR::Request::Hook in the chain.
 
 
 

Modified: httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Parser/Parser.pod
URL: http://svn.apache.org/viewcvs/httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Parser/Parser.pod?rev=293206&r1=293205&r2=293206&view=diff
==============================================================================
--- httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Parser/Parser.pod (original)
+++ httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Parser/Parser.pod Sun Oct  2 19:09:49 2005
@@ -28,8 +28,82 @@
 
 
 
-=head2 make
+=head2 generic
 
+    APR::Request::Parser->generic($pool, $ba, $ct)
+    APR::Request::Parser->generic($pool, $ba, $ct, $blim)
+    APR::Request::Parser->generic($pool, $ba, $ct, $blim, $tdir)
+    APR::Request::Parser->generic($pool, $ba, $ct, $blim, $tdir, $hook)
+
+Noop-parser that collects everything into a single,
+internal parameter.  Here $pool is an APR::Pool object, $ba is
+an APR::BucketAlloc object, and $ct is the Content-Type
+header of the request.  Optionally $blim is the brigade in-memory limit,
+$tdir is the path to the temporary directory, and $hook is an 
+APR::Request::Hook object.
+
+
+
+
+=head2 headers
+
+    APR::Request::Parser->headers($pool, $ba, $ct)
+    APR::Request::Parser->headers($pool, $ba, $ct, $blim)
+    APR::Request::Parser->headers($pool, $ba, $ct, $blim, $tdir)
+    APR::Request::Parser->headers($pool, $ba, $ct, $blim, $tdir, $hook)
+
+RFC 822 header parser.  Here $pool is an APR::Pool object, $ba is
+an APR::BucketAlloc object, and $ct is the Content-Type
+header of the request.  Optionally $blim is the brigade in-memory limit,
+$tdir is the path to the temporary directory, and $hook is an 
+APR::Request::Hook object.
+
+
+
+
+=head2 urlencoded
+
+    APR::Request::Parser->urlencoded($pool, $ba, $ct)
+    APR::Request::Parser->urlencoded($pool, $ba, $ct, $blim)
+    APR::Request::Parser->urlencoded($pool, $ba, $ct, $blim, $tdir)
+    APR::Request::Parser->urlencoded($pool, $ba, $ct, $blim, $tdir, $hook)
+
+x-www-form-urlencoded parser.  Here $pool is an APR::Pool object, $ba is
+an APR::BucketAlloc object, and $ct is the Content-Type
+header of the request.  Optionally $blim is the brigade in-memory limit,
+$tdir is the path to the temporary directory, and $hook is an 
+APR::Request::Hook object.
+
+
+
+=head2 multipart
+
+    APR::Request::Parser->multipart($pool, $ba, $ct)
+    APR::Request::Parser->multipart($pool, $ba, $ct, $blim)
+    APR::Request::Parser->multipart($pool, $ba, $ct, $blim, $tdir)
+    APR::Request::Parser->multipart($pool, $ba, $ct, $blim, $tdir, $hook)
+
+Multipart parser.  Here $pool is an APR::Pool object, $ba is
+an APR::BucketAlloc object, and $ct is the Content-Type
+header of the request.  Optionally $blim is the brigade in-memory limit,
+$tdir is the path to the temporary directory, and $hook is an 
+APR::Request::Hook object.
+
+
+
+
+=head2 default
+
+    APR::Request::Parser->default($pool, $ba, $ct)
+    APR::Request::Parser->default($pool, $ba, $ct, $blim)
+    APR::Request::Parser->default($pool, $ba, $ct, $blim, $tdir)
+    APR::Request::Parser->default($pool, $ba, $ct, $blim, $tdir, $hook)
+
+Default parser.  Here $pool is an APR::Pool object, $ba is
+an APR::BucketAlloc object, and $ct is the Content-Type
+header of the request.  Optionally $blim is the brigade in-memory limit,
+$tdir is the path to the temporary directory, and $hook is an 
+APR::Request::Hook object.