.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "libapache2-mod-perl2-2.0.11::docs::api::Apache2::ConnectionUtil 3pm"
.TH libapache2-mod-perl2-2.0.11::docs::api::Apache2::ConnectionUtil 3pm "2021-05-21" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Apache2::ConnectionUtil \- Perl API for Apache connection utils
.SH "Synopsis"
.IX Header "Synopsis"
.Vb 3
\&   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);
.Ve
.SH "Description"
.IX Header "Description"
\&\f(CW\*(C`Apache2::ConnectionUtil\*(C'\fR provides the
Apache connection record object
utilities \s-1API.\s0
.SH "API"
.IX Header "API"
\&\f(CW\*(C`Apache2::ConnectionUtil\*(C'\fR provides the following functions and/or
methods:
.ie n .SS """pnotes"""
.el .SS "\f(CWpnotes\fP"
.IX Subsection "pnotes"
Share Perl variables between requests over the lifetime of the
connection.
.PP
.Vb 3
\&   $old_val  = $c\->pnotes($key => $val);
\&   $val      = $c\->pnotes($key);
\&   $hash_ref = $c\->pnotes();
.Ve
.ie n .IP "obj: $c ( ""Apache2::Connection object"" )" 4
.el .IP "obj: \f(CW$c\fR ( \f(CWApache2::Connection object\fR )" 4
.IX Item "obj: $c ( Apache2::Connection object )"
.PD 0
.ie n .IP "opt arg1: $key ( string )" 4
.el .IP "opt arg1: \f(CW$key\fR ( string )" 4
.IX Item "opt arg1: $key ( string )"
.PD
A key value
.ie n .IP "opt arg2: $val ( \s-1SCALAR\s0 )" 4
.el .IP "opt arg2: \f(CW$val\fR ( \s-1SCALAR\s0 )" 4
.IX Item "opt arg2: $val ( SCALAR )"
Any scalar value (e.g. a reference to an array)
.IP "ret: (3 different possible values)" 4
.IX Item "ret: (3 different possible values)"
if both, \f(CW$key\fR and \f(CW$val\fR are passed the previous value for \f(CW$key\fR is
returned if such existed, otherwise undef is returned.
.Sp
if only \f(CW$key\fR is passed, the current value for the given key is returned.
.Sp
if no arguments are passed, a hash reference is returned, which can then 
be directly accessed without going through the \f(CW\*(C`pnotes()\*(C'\fR interface.
.IP "since: 2.0.3" 4
.IX Item "since: 2.0.3"
.PP
See 
(\f(CW\*(C`Apache2::RequestUtil::pnotes\*(C'\fR)
for the details of the \f(CW\*(C`pnotes\*(C'\fR method usage.  The usage is identical
except for a few differences.  First is the use of \f(CW$c\fR instead of 
\&\f(CW$r\fR 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 \f(CW\*(C`pnotes\*(C'\fR.
.SH "See Also"
.IX Header "See Also"
Apache2::Connection.
.PP
Apache2::RequestUtil::pnotes.
.PP
mod_perl 2.0 documentation.
.SH "Copyright"
.IX Header "Copyright"
mod_perl 2.0 and its core modules are copyrighted under
The Apache Software License, Version 2.0.
.SH "Authors"
.IX Header "Authors"
The mod_perl development team and numerous
contributors.