perl-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Fred Moyer <f...@taperfriendlymusic.org>
Subject Re: Connection pnotes
Date Tue, 25 Apr 2006 04:06:56 GMT
Philippe M. Chiasson wrote:
> Geoffrey Young wrote:
>>>>it will probably be easier for me to muck with the tests once they are
>>>>committed.  to that end, let's get the functionality to where it needs to
be
>>>>then I'll work on recreating and removing the warnings.
>>>
>>>If the patch looks good to you, I'll check it in and we should be good.
>>
>>yeah, go ahead.
> 
> 
> We now have connection pnotes as of r386784.
> 
> Documentation patch is still necessary.

Here's a suggested patch.  I've created a separate pod file for 
Apache2::ConnectionUtil.  I've referenced Apache2::RequestUtil::pnotes, 
shown usage, and identified differences between the two.  Style and 
wording matched to Apache2::RequestUtil pnotes method for the usage.


Index: src/docs/2.0/api/config.cfg
===================================================================
--- src/docs/2.0/api/config.cfg (revision 396758)
+++ src/docs/2.0/api/config.cfg (working copy)
@@ -21,6 +21,7 @@
          Apache2/CmdParms.pod
          Apache2/Command.pod
          Apache2/Connection.pod
+        Apache2/ConnectionUtil.pod
          Apache2/Const.pod
          Apache2/Directive.pod
          Apache2/Filter.pod

src/docs/2.0/api/Apache2/ConnectionUtil.pod
=======================================================================
+++ src/docs/2.0/api/Apache2/ConnectionUtil.pod (new copy)
=head1 NAME

Apache2::ConnectionUtil - Perl API for Apache connection utils




=head1 Synopsis

   use Apache2::Connection     ();
   use Apache2::ConnectionUtil ();
   use Apache2::RequestRec     ();

   # grab the connection object;
   my $c = $r->connection;

   # share perl objects like $r->pnotes
   $old_val = $c->pnotes($key => $value);






=head1 Description

C<Apache2::ConnectionUtil> provides the
L<Apache connection record object|docs::2.0::api::Apache2::Connection>
utilities API.





=head1 API

C<Apache2::ConnectionUtil> provides the following functions and/or
methods:








=head2 C<pnotes>

Share Perl variables between requests over the lifetime of the
connection.

   $old_val  = $c->pnotes($key => $val);
   $val      = $c->pnotes($key);
   $hash_ref = $c->pnotes();



=over 4

=item obj: C<$c>
( C<L<Apache2::Connection object|docs::2.0::api::Apache2::Connection>> )

=item opt arg1: C<$key> ( string )

A key value

=item opt arg2: C<$val> ( SCALAR )

Any scalar value (e.g. a reference to an array)

=item ret: (3 different possible values)

if both, C<$key> and C<$val> are passed the previous value for C<$key> is
returned if such existed, otherwise undef is returned.

if only C<$key> is passed, the current value for the given key is returned.

if no arguments are passed, a hash reference is returned, which can then 
be directly accessed without going through the C<pnotes()> interface.

=item since: 2.0.3

=back

See 
(C<L<Apache2::RequestUtil|docs::2.0::api::Apache2::RequestUtil/C_pnotes_>>)
for the details of the C<pnotes> method usage.  The usage is identical
except for a few differences.  First is the use of C<$c> instead of 
C<$r> as
the invocant.  The second is that the the data persists for the lifetime of
the connection instead of the lifetime of the request.  If the connection is
lost, so is the data stored in C<pnotes>.



=head1 See Also

L<Apache2::Connection|docs::2.0::api::Apache2::Connection>.

L<Apache2::RequestUtil|docs::2.0::api::Apache2::RequestUtil/C_pnotes_>.

L<mod_perl 2.0 documentation|docs::2.0::index>.


=head1 Copyright

mod_perl 2.0 and its core modules are copyrighted under
The Apache Software License, Version 2.0.




=head1 Authors

L<The mod_perl development team and numerous
contributors|about::contributors::people>.

=cut


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@perl.apache.org
For additional commands, e-mail: dev-help@perl.apache.org


Mime
View raw message