Author: joes
Date: Thu Apr 28 07:31:10 2005
New Revision: 165146
URL: http://svn.apache.org/viewcvs?rev=165146&view=rev
Log:
Perldoc fixes, round 2.
Modified:
httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Apache2/Apache2.pod
httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/CGI/CGI.pod
httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Cookie/Cookie.pod
httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Error/Error.pod
httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Param/Param.pod
httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.pod
Modified: httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Apache2/Apache2.pod
URL:
http://svn.apache.org/viewcvs/httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Apache2/Apache2.pod?rev=165146&r1=165145&r2=165146&view=diff
==============================================================================
--- httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Apache2/Apache2.pod
(original)
+++ httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Apache2/Apache2.pod Thu
Apr 28 07:31:10 2005
@@ -1,6 +1,6 @@
=head1 NAME
-APR::Request::Apache2
+APR::Request::Apache2 - wrapper for a mod_apreq2 handle.
@@ -15,8 +15,10 @@
=head1 DESCRIPTION
-The C<< APR::Request::Apache2 >> module provides a constructor
-for interfacing with the mod_apreq2.so Apache module.
+The APR::Request::Apache2 module provides a constructor
+for interfacing with the mod_apreq2 Apache module.
+
+This manpage documents the APR::Request::Apache2 package.
@@ -26,12 +28,14 @@
APR::Request::Apache2 - derived from C<< APR::Request >>.
+
+
=head2 handle
APR::Request::Apache2->handle($r)
-Creates an C<< APR::Request::Apache2 >> object. The argument C<< $r >>
-is the C<< Apache2::RequestRec >> object from mod_perl2.
+Creates an APR::Request::Apache2 object. The argument C<< $r >>
+is an Apache2::RequestRec object (from mod_perl2).
Modified: httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/CGI/CGI.pod
URL:
http://svn.apache.org/viewcvs/httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/CGI/CGI.pod?rev=165146&r1=165145&r2=165146&view=diff
==============================================================================
--- httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/CGI/CGI.pod (original)
+++ httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/CGI/CGI.pod Thu Apr 28
07:31:10 2005
@@ -1,6 +1,8 @@
=head1 NAME
-APR::Request::CGI
+APR::Request::CGI - wrapper for libapreq2's CGI handle.
+
+
=head1 SYNOPSIS
@@ -13,9 +15,11 @@
=head1 DESCRIPTION
-The C<< APR::Request::CGI >> module provides a constructor
+The APR::Request::CGI module provides a constructor
for accessing CGI request data associated to a pool via libapreq2.
+This manpage documents the APR::Request::CGI package.
+
@@ -24,12 +28,14 @@
APR::Request::CGI - derived from C<< APR::Request >>.
+
+
=head2 handle
APR::Request::CGI->handle($pool)
-Creates an C<< APR::Request::CGI >> object. The argument C<< $pool >>
-is an C<< APR::Pool >> object.
+Creates an APR::Request::CGI object. The argument C<< $pool >>
+is an APR::Pool object.
Modified: httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Cookie/Cookie.pod
URL:
http://svn.apache.org/viewcvs/httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Cookie/Cookie.pod?rev=165146&r1=165145&r2=165146&view=diff
==============================================================================
--- httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Cookie/Cookie.pod
(original)
+++ httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Cookie/Cookie.pod Thu Apr
28 07:31:10 2005
@@ -1,6 +1,6 @@
=head1 NAME
-APR::Request::Cookie -
+APR::Request::Cookie - wrapper for libapreq2's cookie API.
@@ -8,12 +8,48 @@
=head1 SYNOPSIS
use APR::Request::Cookie;
+ my $cookie = APR::Request::Cookie->new($req,
+ name => "foo",
+ value => "bar",
+ domain => "capricorn.com");
+
+ print "$cookie"; # prints "bar"
+
+ $cookie->domain("example.com"); # change domains
+ $cookie->version(1); # upgrade it to conform with RFC 2109/2965.
+
+ # print a response header
+ printf "Set-Cookie: %s\n", $cookie->as_string;
=head1 DESCRIPTION
+The APR::Request::Cookie module provides base methods
+for interfacing with libapreq2's cookie API. It also provides
+a few utility functions and constants.
+
+This manpage documents the APR::Request::Cookie and
+APR::Request::Cookie::Table packages.
+
+
+
+
+=head1 OVERLOADS
+
+APR::Request::Cookie
+
+
+
+
+=head2 ""
+
+ "$cookie"
+
+The double-quote interpolation operator maps to
+C<< APR::Request::Cookie::value() >>.
+
@@ -22,50 +58,191 @@
APR::Request::Cookie
+
+
=head2 new
+ APR::Request::Cookie->new($pool,
+ name => $name,
+ value => $value,
+ %args)
+
+
+Creates a new cookie. Here C<< $pool >> is an APR::Pool object,
+and C<< $name >> is the cookie's name. The C<< $value >> is transformed
+into the cookie's raw value through the class' C<< freeze() >> method.
+The remaining arguments are optional:
+
+=over 4
+
+=item -secure
+
+=item -version
+
+=item -path
+
+=item -domain
+
+=item -port
+
+=item -expires
+
+=item -comment
+
+=item -commentURL
+
+=back
+
+For details on these arguments, please consult
+the corresponding method's documentation.
+
+
+
=head2 freeze
+ APR::Request::Cookie->freeze($value)
+
+Default serializer- returns $value unmodified.
+
+
+
=head2 thaw
+ APR::Request::Cookie->thaw($value)
+
+Reverses C<< freeze() >>; here it's a noop.
+
+
+
=head2 name
+ $cookie->name()
+
+Fetch the cookie's name.
+This attribute cannot be modified.
+
+
+
=head2 value
+ $cookie->value()
+
+Fetch the cookie's value.
+This attribute cannot be modified.
+
+
+
=head2 secure
+ $cookie->secure()
+ $cookie->secure($set)
+
+
+Get/set the cookie's secure flag.
+
+
+
=head2 version
+ $cookie->version()
+ $cookie->version($set)
+
+Get/set the cookie's version number.
+Version 0 cookies conform to the Netscape
+spec; Version 1 cookies conform to either
+RFC 2109 or RFC 2965.
+
+
+
=head2 path
+ $cookie->path()
+ $cookie->path($set)
+
+Get/set the cookie's path string.
+
+
+
=head2 domain
+ $cookie->domain()
+ $cookie->domain($set)
+
+Get/set the cookie's domain string.
+
+
+
=head2 port
+ $cookie->port()
+ $cookie->port($set)
+
+Get/set the cookie's port string.
+Only valid for Version 1 cookies.
+
+
+
=head2 comment
+ $cookie->comment()
+ $cookie->comment($set)
+
+Get/set the cookie's comment string.
+Only valid for Version 1 cookies.
+
+
+
=head2 commentURL
+ $cookie->commentURL()
+ $cookie->commentURL($set)
+
+Get/set the cookie's commentURL string.
+Only valid for Version 1 cookies.
+
+
+
=head2 is_tainted
+ $cookie->is_tainted()
+ $cookie->is_tainted($set)
+
+
+Get/set the cookie's internal tainted flag.
+
=head2 make
+ APR::Request::Cookie->make($pool, $name, $value)
+
+Fast XS cookie constructor invoked by C<< new() >>.
+The cookie's raw name & value are taken directly from the
+passed in arguments; no freezing/encoding is done on the $value.
+
+
+
=head2 as_string
+ $cookie->as_string()
+
+
+String representation of the cookie, suitable for inclusion
+in a "Set-Cookie" header.
+
+
=head1 SUBROUTINES
@@ -73,36 +250,72 @@
APR::Request::Cookie
+
+
=head2 expires
+ expires($date_string)
+
+
+
=head1 METHODS
- APR::Request::Cookie::Table
+ APR::Request::Cookie::Table - read-only version of APR::Table.
+
+Tables in this class normally arise from calls to
+C<< APR::Request::jar() >>.
+
+
=head2 cookie_class
+ $table->cookie_class()
+ $table->cookie_class($set)
+
+Get/set the class each table element is blessed into during a
+L<get> or L<FETCH> call. If defined, the class must be derived
+from APR::Request::Cookie.
+
+
+
=head2 get
+ $table->get($name)
+ $table->get()
+
+
+
=head2 FETCH
+ $table->FETCH($name)
+
-=head2 NEXTKEY
=head2 FIRSTKEY
+ $table->FIRSTKEY()
+
+
-=head2 do
+=head2 NEXTKEY
+
+ $table->NEXTKEY()
+
+
+
+
+=head2 do
+ $table->do($callback, @keys)
-=head2
=head1 SEE ALSO
Modified: httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Error/Error.pod
URL:
http://svn.apache.org/viewcvs/httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Error/Error.pod?rev=165146&r1=165145&r2=165146&view=diff
==============================================================================
--- httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Error/Error.pod (original)
+++ httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Error/Error.pod Thu Apr
28 07:31:10 2005
@@ -1,6 +1,6 @@
=head1 NAME
-APR::Request::Error
+APR::Request::Error - wrapper for libapreq2's error API.
@@ -13,6 +13,8 @@
=head1 DESCRIPTION
+This manpage documents the APR::Request::Error package.
+
@@ -25,10 +27,16 @@
=head2 strerror
+ strerror($status)
+
+Returns the apreq error string associated with a numeric C<$status> code.
+
=head1 SEE ALSO
+
+L<APR::Request>, L<APR::Error>
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=165146&r1=165145&r2=165146&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 Thu Apr
28 07:31:10 2005
@@ -1,6 +1,6 @@
=head1 NAME
-APR::Request::Param
+APR::Request::Param - wrapper for libapreq2's param API.
@@ -14,6 +14,26 @@
=head1 DESCRIPTION
+The C<< APR::Request::Param >> module provides base methods
+for interfacing with libapreq2's param API. It also provides
+a few utility functions and constants.
+
+
+
+
+=head1 OVERLOADS
+
+APR::Request::Param
+
+
+
+
+=head2 ""
+
+ "$param"
+
+The double-quote interpolation operator maps to
+C<< APR::Request::Param::value() >>.
@@ -23,51 +43,169 @@
APR::Request::Param
+
+
=head2 name
+ $param->name()
+
+Returns the param's name.
+This attribute cannot be modified.
+
+
+
=head2 value
+ $param->value()
+
+Returns the param's value.
+This attribute cannot be modified.
+
+
+
=head2 is_tainted
+ $param->is_tainted()
+ $param->is_tainted($set)
+
+
+Get/set the param's internal tainted flag.
+Note: if the param's charset is APREQ_CHARSET_UTF8 (8),
+this also activates the SvUTF8_on flag during calls
+to name() and/or value().
+
+
=head2 charset
+ $param->charset()
+ $param->charset($set)
+
+Get/set the param's internal charset. The charset
+is a number between 0 and 255; the current recognized
+values are
+
+=over 4
+
+=item 0 APREQ_CHARSET_ASCII (7-bit us-ascii)
+
+=item 1 APREQ_CHARSET_LATIN1 (8-bit iso 8859-1)
+
+=item 2 APREQ_CHARSET_CP1252 (8-bit Windows-1252)
+
+=item 8 APREQ_CHARSET_UTF8 (utf8 encoded Unicode)
+
+=back
+
+See L<is_tainted> above for info about how APREQ_CHARSET_UTF8
+relates to perl's UTF-8 flag.
+
+
+
=head2 make
+ APR::Request::Param->make($pool, $name, $value)
+
+Fast XS param constructor.
+
+
+
=head2 info
+ $param->info()
+ $param->info($set)
+
+Get/set the APR::Table headers for this param.
+
+
+
=head2 upload
+ $param->upload()
+ $param->upload($set)
+
+Get/set the APR::Brigade file-upload content for this param.
+
+
+
=head2 upload_filename
+ $param->upload_filename()
+
+Returns the client-side filename associated with this param.
+
+
+
=head2 upload_link
+ $param->upload_link($path)
+
+Links the file-upload content with the local file named C<< $path >>.
+Creates a hard-link if the spoolfile's (see L<upload_tempname>)
+temporary directory is on the same device as C<< $path >>;
+otherwise this writes a copy.
+
+
+
=head2 upload_slurp
+ $param->upload_slurp($data)
+
+Reads the entire file-upload content into C<< $data >>.
+
+
+
=head2 upload_size
+ $param->upload_size()
+
+Returns the size of the param's file-upload content.
+
+
+
=head2 upload_type
+ $param->upload_type()
+
+Returns the MIME-type of the param's file-upload content.
+
+
+
=head2 upload_tempname
+ $param->upload_tempname()
+
+Returns the name of the local spoolfile for this param.
+
+
+
=head2 upload_io
+ $param->upload_io()
+
+Returns an L<APR::Request::Brigade::IO> object, which can
+be treated as a non-seekable IO stream.
+
=head2 upload_fh
+ $param->upload_fh
+
+Returns a seekable filehandle representing the file-upload content.
+
@@ -78,21 +216,46 @@
=head2 param_class
+ $table->param_class()
+ $table->param_class($set)
+
+
+Get/set the class each table element is blessed into during a
+L<get> or L<FETCH> call. If defined, the class must be derived
+from APR::Request::Param.
+
=head2 get
+ $table->get()
+ $table->get($name)
+
+
=head2 FETCH
+ $table->FETCH($name)
+
+
+
=head2 NEXTKEY
+ $table->NEXTKEY()
+
+
+
=head2 FIRSTKEY
+ $table->FIRSTKEY()
+
+
+
=head2 do
+ $table->do($callback, @keys)
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=165146&r1=165145&r2=165146&view=diff
==============================================================================
--- httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.pod (original)
+++ httpd/apreq/trunk/glue/perl/xsbuilder/APR/Request/Request.pod Thu Apr 28
07:31:10 2005
@@ -1,6 +1,6 @@
=head1 NAME
-APR::Request
+APR::Request - wrapper for libapreq2's module/handle API.
@@ -8,15 +8,16 @@
=head1 SYNOPSIS
use APR::Request;
- my $req = APR::Request->handle($pool, ...);
-
+ my $req = $derived_class->handle( ... );
+ $param = $req->param("foo");
+ $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
+for interfacing with libapreq2's module API. It also provides
a few utility functions and constants.
@@ -74,6 +75,7 @@
=head2 disable_uploads
+Engage the disable_uploads hook for this request.
=head2 upload_hook
