Apache2::ConnectionUtil - man pages section 3: Library Interfaces and Headers

Language:

Apache2::ConnectionUtil (3)

Name

Apache2::ConnectionUtil - Perl API for Apache connection utils

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);

Description

User Contributed Perl Documentation
                         build::sparcv9::docs::api::Apache2::ConnectionUtil(3)



NAME
       Apache2::ConnectionUtil - Perl API for Apache connection utils

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);

Description
       "Apache2::ConnectionUtil" provides the Apache connection record object
       utilities API.

API
       "Apache2::ConnectionUtil" provides the following functions and/or
       methods:

   "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();

       obj: $c ( "Apache2::Connection object" )
       opt arg1: $key ( string )
           A key value

       opt arg2: $val ( SCALAR )
           Any scalar value (e.g. a reference to an array)

       ret: (3 different possible values)
           if both, $key and $val are passed the previous value for $key is
           returned if such existed, otherwise undef is returned.

           if only $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 "pnotes()"
           interface.

       since: 2.0.3

       See ("Apache2::RequestUtil::pnotes") for the details of the "pnotes"
       method usage.  The usage is identical except for a few differences.
       First is the use of $c instead of $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 "pnotes".

See Also
       Apache2::Connection.

       Apache2::RequestUtil::pnotes.

       mod_perl 2.0 documentation.

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

Authors
       The mod_perl development team and numerous contributors.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------------------------+
       |ATTRIBUTE TYPE |            ATTRIBUTE VALUE              |
       +---------------+-----------------------------------------+
       |Availability   | web/server/apache-24/module/apache-perl |
       +---------------+-----------------------------------------+
       |Stability      | Uncommitted                             |
       +---------------+-----------------------------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://www.apache.org/dist/perl/mod_perl-2.0.12.tar.gz.

       Further information about this software can be found on the open source
       community website at https://perl.apache.org/.



perl v5.32.0                      2022-01-30
                         build::sparcv9::docs::api::Apache2::ConnectionUtil(3)