httpd-apreq-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From j...@apache.org
Subject svn commit: r170423 - in /httpd/apreq/trunk: glue/perl/xsbuilder/APR/Request/Param/Param.pod glue/perl/xsbuilder/APR/Request/Request.pod include/apreq_parser.h
Date Mon, 16 May 2005 18:38:01 GMT
Author: joes
Date: Mon May 16 11:38:00 2005
New Revision: 170423

URL: http://svn.apache.org/viewcvs?rev=170423&view=rev
Log:
Frivolous doc tweaks.

Modified:
    httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Param/Param.pod
    httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.pod
    httpd/apreq/trunk/include/apreq_parser.h

Modified: httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Param/Param.pod
URL: http://svn.apache.org/viewcvs/httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Param/Param.pod?rev=170423&r1=170422&r2=170423&view=diff
==============================================================================
--- httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Param/Param.pod (original)
+++ httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Param/Param.pod Mon May 16 11:38:00
2005
@@ -91,7 +91,7 @@
 
 =item 0 APREQ_CHARSET_ASCII    (7-bit us-ascii)
 
-=item 1 APREQ_CHARSET_LATIN1   (8-bit iso 8859-1)
+=item 1 APREQ_CHARSET_LATIN1   (8-bit iso-8859-1)
 
 =item 2 APREQ_CHARSET_CP1252   (8-bit Windows-1252)
 
@@ -199,6 +199,8 @@
 be treated as a non-seekable IO stream.
 
 
+
+
 =head2 upload_fh
 
 
@@ -214,6 +216,8 @@
 APR::Request::Param::Table
 
 
+
+
 =head2 param_class
 
     $table->param_class()
@@ -225,6 +229,8 @@
 from APR::Request::Param.
 
 
+
+
 =head2 get
 
     $table->get()
@@ -232,6 +238,7 @@
 
 
 
+
 =head2 FETCH
 
     $table->FETCH($name)
@@ -265,15 +272,20 @@
 APR::Request::Brigade
 
 
+
+
 =head2 new, TIEHANDLE
 
 
+
+
 =head2 READ
 
 
-=head2 READLINE
 
 
+=head2 READLINE
+
 
 
 
@@ -282,17 +294,21 @@
 APR::Request::Brigade::IO
 
 
+
+
 =head2 read
 
 
-=head2 readline
 
 
+=head2 readline
+
 
 
 
 =head1 SEE ALSO
 
+L<APR::Request>.
 
 
 

Modified: httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.pod
URL: http://svn.apache.org/viewcvs/httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.pod?rev=170423&r1=170422&r2=170423&view=diff
==============================================================================
--- httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.pod (original)
+++ httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.pod Mon May 16 11:38:00 2005
@@ -14,12 +14,16 @@
   $cookie = $req->jar("bar");
 
 
+
+
 =head1 DESCRIPTION
 
 The C<< APR::Request >> module provides the base methods
 for interfacing with libapreq2's module API.  It also provides
 a few utility functions and constants.
 
+This manpage documents the APR::Request package.
+
 
 
 
@@ -28,58 +32,95 @@
 APR::Request
 
 
+
+
 =head2 jar_status
 
 
+
+
 =head2 args_status
 
 
+
+
 =head2 body_status
 
 
+
+
 =head2 param_status
 
 
+
+
 =head2 parse
 
 
+
+
 =head2 jar
 
 
+
+
 =head2 args
 
 
+
+
 =head2 body
 
 
+
+
 =head2 param
 
 
+
+
 =head2 uploads (APR::Request::Param::Table???)
 
 
+
+
 =head2 pool
 
 
+
+
 =head2 bucket_alloc
 
 
+
+
 =head2 read_limit
 
 
+
+
 =head2 brigade_limit
 
 
+
+
 =head2 temp_dir
 
 
+
+
 =head2 disable_uploads
 
 Engage the disable_uploads hook for this request.
 
+
+
+
 =head2 upload_hook
 
 
+
+
 =head2 import
 
 
@@ -90,18 +131,53 @@
 APR::Request
 
 
+
+
 =head2 encode
 
+  encode($string)
+
+Exported sub which returns the url-encoded form of C<$string>.
+
+
+
 
 =head2 decode
 
+  decode($string)
+
+Exported sub which returns the url-decoded form of C<$string>.
+
+
+
+
+=head1 SUBCLASSING
+
+APR::Request
+
+If the instances of your subclass are hash references then you can actually
+inherit from APR::Request as long as the APR::Request object is stored in
+an attribute called "r" or "_r". (The APR::Request class effectively does the
+delegation for you automagically, as long as it knows where to find the
+APR::Request object to delegate to.)  For example:
+
+	package MySubClass;
+	use APR::Request::Custom;
+	our @ISA = qw(APR::Request);
+	sub new {
+		my($class, @args) = @_;
+		return bless { r => APR::Request::Custom->handle(@args) }, $class;
+	}
+
+
+
 
 
 
 =head1 SEE ALSO
 
-L<< APR::Request::Error >>, L<< APR::Request::Param >>,
-L<< APR::Request::Cookie >>
+L<APR::Request::Error>, L<APR::Request::Param>,
+L<APR::Request::Cookie>
 
 
 

Modified: httpd/apreq/trunk/include/apreq_parser.h
URL: http://svn.apache.org/viewcvs/httpd/apreq/trunk/include/apreq_parser.h?rev=170423&r1=170422&r2=170423&view=diff
==============================================================================
--- httpd/apreq/trunk/include/apreq_parser.h (original)
+++ httpd/apreq/trunk/include/apreq_parser.h Mon May 16 11:38:00 2005
@@ -94,13 +94,13 @@
     apreq_parser_function_t parser;
     /** the Content-Type request header */
     const char             *content_type;
-    /** a pool used by the parser */
+    /** a pool which outlasts the bucket_alloc. */
     apr_pool_t             *pool;
     /** bucket allocator used to create bucket brigades */
     apr_bucket_alloc_t     *bucket_alloc;
     /** the maximum in-memory bytes a brigade may use */
     apr_size_t              brigade_limit;
-    /** the directory used by the parser for temporary files */
+    /** the directory for generating temporary files */
     const char             *temp_dir;
     /** linked list of hooks */
     apreq_hook_t           *hook;
@@ -189,7 +189,7 @@
  * @param pfn The parser function.
  * @param brigade_limit the maximum in-memory bytes a brigade may use
  * @param temp_dir the directory used by the parser for temporary files
- * @param hook Hooks to asssociate this parser with.
+ * @param hook Hooks to associate this parser with.
  * @param ctx Parser's internal scratch pad.
  * @return New parser.
  */



Mime
View raw message