.\" 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
.\" ========================================================================
.\"
.IX Title "Session 3pm"
.TH Session 3pm "2020-11-09" "perl v5.32.0" "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"
HTML::Embperl::Session \- adaptation of Apache::Session to work with HTML::Embperl
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
An adaptation of Apache::Session to work with HTML::Embperl
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.SS "Addtional Attributes for \s-1TIE\s0"
.IX Subsection "Addtional Attributes for TIE"
.IP "lazy" 4
.IX Item "lazy"
By Specifyng this attribute, you tell Apache::Session to not do any
access to the object store, until the first read or write access to
the tied hash. Otherwise the \fBtie\fR function will make sure the hash
exist or creates a new one.
.IP "create_unknown" 4
.IX Item "create_unknown"
Setting this to one causes Apache::Session to create a new session
with the given id (or a new id, depending on \f(CW\*(C`recreate_id\*(C'\fR)
when the specified session id does not exists. Otherwise it will die.
.IP "recreate_id" 4
.IX Item "recreate_id"
Setting this to one causes Apache::Session to create a new session id
when the specified session id does not exists.
.IP "object_store" 4
.IX Item "object_store"
Specify the class for the object store. (The Apache::Session:: prefix is
optional) Only for Apache::Session 1.00.
.IP "lock_manager" 4
.IX Item "lock_manager"
Specify the class for the lock manager. (The Apache::Session:: prefix is
optional) Only for Apache::Session 1.00.
.IP "Store" 4
.IX Item "Store"
Specify the class for the object store. (The Apache::Session::Store prefix is
optional) Only for Apache::Session 1.5x.
.IP "Lock" 4
.IX Item "Lock"
Specify the class for the lock manager. (The Apache::Session::Lock prefix is
optional) Only for Apache::Session 1.5x.
.IP "Generate" 4
.IX Item "Generate"
Specify the class for the id generator. (The Apache::Session::Generate prefix is
optional) Only for Apache::Session 1.5x.
.IP "Serialize" 4
.IX Item "Serialize"
Specify the class for the data serializer. (The Apache::Session::Serialize prefix is
optional) Only for Apache::Session 1.5x.
.PP
Example using attrubtes to specfiy store and object classes instead of
a derived class:
.PP
.Vb 1
\& use HTML::Embperl::Session;
\&
\& tie %session, \*(AqHTML::Embperl::Session\*(Aq, undef,
\&    { 
\&    object_store => \*(AqDBIStore\*(Aq,
\&    lock_manager => \*(AqSysVSemaphoreLocker\*(Aq,
\&    DataSource => \*(Aqdbi:Oracle:db\*(Aq 
\&    };
.Ve
.PP
\&\s-1NOTE:\s0 HTML::Embperl::Session will require the necessary additional perl modules for you.
.SS "Addtional Methods"
.IX Subsection "Addtional Methods"
.IP "setid" 4
.IX Item "setid"
Set the session id for further accesses.
.IP "getid" 4
.IX Item "getid"
Get the session id. The difference to using \f(CW$session\fR{_session_id} is,
that in lazy mode, getid will \fBnot\fR create a new session id, if it
doesn't exists.
.IP "cleanup" 4
.IX Item "cleanup"
Writes any pending data, releases all locks and deletes all data from memory.
.SH "AUTHORS"
.IX Header "AUTHORS"
Gerald Richter <richter at embperl dot org> is the current maintainer.
.PP
This class was written by Jeffrey Baker (jeffrey@kathyandjeffrey.net)
but it is taken wholesale from a patch that Gerald Richter
(richter@ecos.de) sent me against Apache::Session.