.\" 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 "Jifty::Web::Session 3pm"
.TH Jifty::Web::Session 3pm "2010-12-08" "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"
Jifty::Web::Session \- A Jifty session handler
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In your \fIetc/config.yml\fR (optional):
.PP
.Vb 4
\&  framework:
\&    Web:
\&      # The default ($PORT is replaced by the port the app is running on)
\&      SessionCookieName: JIFTY_SID_$PORT
.Ve
.SS "new"
.IX Subsection "new"
Returns a new, empty session.
.SS "id"
.IX Subsection "id"
Returns the session's id if it has been loaded, or \f(CW\*(C`undef\*(C'\fR otherwise.
.SS "create"
.IX Subsection "create"
Assign a new \s-1ID\s0, and store it server-side if necessary.
.SS "load [\s-1ID\s0]"
.IX Subsection "load [ID]"
Load up the current session from the given \f(CW\*(C`ID\*(C'\fR, or the appropriate
cookie (see \*(L"cookie_name\*(R") otherwise.  If both of those fail,
creates a session in the database.
.SS "load_by_kv key => value"
.IX Subsection "load_by_kv key => value"
Load up the current session from the given (key, value) pair. If no matching
session could be found, it will create a new session with the key, value set.
Be sure that what you're loading by is unique. If you're loading a session
based on, say, a timestamp, then you're asking for trouble.
.SS "unload"
.IX Subsection "unload"
Flush the session, and leaves the session object blank.
.SS "loaded"
.IX Subsection "loaded"
Returns true if the session has already been loaded.
.SS "get \s-1KEY\s0 [\s-1TYPE\s0]"
.IX Subsection "get KEY [TYPE]"
Returns the value for \f(CW\*(C`KEY\*(C'\fR for the current user's session.  \f(CW\*(C`TYPE\*(C'\fR,
which defaults to \*(L"key\*(R", allows accessing of other namespaces in the
session, including \*(L"metadata\*(R" and \*(L"continuation\*(R".
.SS "set \s-1KEY\s0 => \s-1VALUE\s0, [\s-1TYPE\s0]"
.IX Subsection "set KEY => VALUE, [TYPE]"
Sets the value \f(CW\*(C`VALUE\*(C'\fR for \f(CW\*(C`KEY\*(C'\fR for the session.  \f(CW\*(C`TYPE\*(C'\fR, which
defaults to \*(L"key\*(R", allows values to be set in other namespaces,
including \*(L"metadata\*(R" and \*(L"continuation\*(R". \f(CW\*(C`VALUE\*(C'\fR can be an arbitrary
perl data structure \*(-- \f(CW\*(C`Jifty::Web::Session\*(C'\fR will serialize it for
you.
.SS "remove \s-1KEY\s0, [\s-1TYPE\s0]"
.IX Subsection "remove KEY, [TYPE]"
Remove key \f(CW\*(C`KEY\*(C'\fR from the cache.  \f(CW\*(C`TYPE\*(C'\fR defaults to \*(L"key\*(R".
.SS "remove_all"
.IX Subsection "remove_all"
Removes the session from the database entirely.
.SS "set_continuation \s-1ID\s0 \s-1CONT\s0"
.IX Subsection "set_continuation ID CONT"
Stores a continuation in the session.
.SS "get_continuation \s-1ID\s0"
.IX Subsection "get_continuation ID"
Pulls a continuation from the current session. Expects a continuation
\&\f(CW\*(C`ID\*(C'\fR.
.SS "remove_continuation \s-1ID\s0"
.IX Subsection "remove_continuation ID"
Removes a continuation with id \f(CW\*(C`ID\*(C'\fR from the store.
.SS "continuations"
.IX Subsection "continuations"
Return a hash of all the continuations in this session, keyed by the
continuations' \f(CW\*(C`id\*(C'\fR.
.SS "set_cookie"
.IX Subsection "set_cookie"
Sets the session cookie.
.SS "cookie_name"
.IX Subsection "cookie_name"
Returns the current session's cookie_name \*(-- it is the same for all
users, but varies according to the port the server is running on.
.SS "expires [\s-1VALUE\s0]"
.IX Subsection "expires [VALUE]"
Get or set the session's expiration date, in a format expected by
Cache::Cache.