.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "MasonX::Request::WithMultiSession 3pm"
.TH MasonX::Request::WithMultiSession 3pm "2012-12-01" "perl v5.14.2" "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"
MasonX::Request::WithMultiSession \- Multiple sub\-sessions within one "parent" session
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  PerlSetVar  MasonRequestClass  MasonX::Request::WithMultiSession
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module subclasses \f(CW\*(C`MasonX::Request::WithApacheSession\*(C'\fR in order
to allow multiple \*(L"sub-sessions\*(R" to exist within one parent session.
.PP
This can be quite useful for a web app where you want to allow the
user to open multiple windows, each with a different session, but
session ids are stored in a cookie.
.PP
Like \f(CW\*(C`MasonX::Request::WithApacheSession\*(C'\fR, sub-sessions are shared
between a request and any subrequests it creates.
.SH "METHODS"
.IX Header "METHODS"
This class has an interface quite similar to that of
\&\f(CW\*(C`MasonX::Request::WithApacheSession\*(C'\fR.
.IP "\(bu" 4
session
.Sp
The primary interface to this class is through the \f(CW\*(C`session()\*(C'\fR
method.  When this method is called without any parameters, the module
looks for an existing sub-session specified by the sub-session id
argument parameter (which can be in a query string or \s-1POST\s0).  This
value can be overridden by explicitly passing a \*(L"sub_session_id\*(R"
parameter.
.Sp
If this parameter is found, an existing sub-session is returned.  If
this parameter is not found, a new sub-session is created.
.Sp
If the \f(CW\*(C`session()\*(C'\fR method is called as \f(CW\*(C`session( clone => 1 )\*(C'\fR
then a new sub-session will be created, and its contents will be the
same as that of the current sub-session.  This is a shallow copy of
the old session hash, so objects and references are shared between
them.
.Sp
If \f(CW\*(C`session( new => 1 )\*(C'\fR is called, then a new, empty,
sub-session is created.
.Sp
You can specify the main session id to use via the \*(L"session_id\*(R"
parameter.
.IP "\(bu" 4
sub_session_id
.Sp
This method returns the currently active sub-session's id.  Use this
method to put this id into \s-1URL\s0 parameters, forms, etc. as needed.
.Sp
If given a \*(L"sub_session_id\*(R" parameter, it will set the current
sub-session id.
.IP "\(bu" 4
delete_sub_session
.Sp
By default, this simply defaults the current sub-session.  You can
pass a \*(L"sub_session_id\*(R" parameter to delete a specific session.
.SS "Parameters"
.IX Subsection "Parameters"
This module takes two parameters besides those inherited from
\&\f(CW\*(C`MasonX::Request::WithApacheSession\*(C'\fR:
.IP "\(bu" 4
multi_session_args_param / MultiSessionArgsParam
.Sp
This parameter can be used to specify which parameter contains the
sub-session id.  By default, the module will look for a parameter
called \*(L"sub_session_id\*(R".
.IP "\(bu" 4
multi_session_expire / MultiSessionExpire
.Sp
This parameter specifies the number of seconds after a sub-session is
accessed until it is purged.  If not specified, then sub-sessions are
never purged.
.Sp
Sub-sessions expiration is checked when the request object goes out of
scope.
.SH "USAGE"
.IX Header "USAGE"
You will need to manually set the sub-session id argument parameter
for each request.  The easiest way to do this is to make sure that all
URLs contain the sub-session id.  This can be done by using a \f(CW\*(C`<%filter>\*(C'\fR block in a top-level autohandler (although this won't
catch redirects), or by making sure all URLs are generated by a single
component/function.
.SH "SUPPORT"
.IX Header "SUPPORT"
Bug reports and requests for help should be sent to the mason-users
list.  See http://www.masonhq.com/resources/mailing_lists.html for
more details.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dave Rolsky, <autarch@urth.org>
.PP
Development funded by Marigold Technologies.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
HTML::Mason