.\" 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 "Dancer::Session::Abstract 3pm"
.TH Dancer::Session::Abstract 3pm "2012-01-27" "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"
Dancer::Session::Abstract \- abstract class for session engine
.SH "SPEC"
.IX Header "SPEC"
.IP "\fBrole\fR" 4
.IX Item "role"
A Dancer::Session object represents a session engine and should provide anything
needed to manipulate a session, whatever its storing engine is.
.IP "\fBid\fR" 4
.IX Item "id"
The session id will be written to a cookie, by default named \f(CW\*(C`dancer.session\*(C'\fR, 
it is assumed that a client must accept cookies to be able to use a 
session-aware Dancer webapp. (The cookie name can be change using the
\&\f(CW\*(C`session_name\*(C'\fR config setting.)
.IP "\fBstorage engine\fR" 4
.IX Item "storage engine"
When the session engine is enabled, a \fIbefore\fR filter takes care to initialize
the appropriate session engine (according to the setting \f(CW\*(C`session\*(C'\fR).
.Sp
Then, the filter looks for a cookie named \f(CW\*(C`dancer.session\*(C'\fR (or whatever you've
set the \f(CW\*(C`session_name\*(C'\fR setting to, if you've used it) in order to
\&\fIretrieve\fR the current session object. If not found, a new session object is
\&\fIcreated\fR and its id written to the cookie.
.Sp
Whenever a session call is made within a route handler, the singleton
representing the current session object is modified.
.Sp
After terminating the request, a \fIflush\fR is made to the session object.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This virtual class describes how to build a session engine for Dancer. This is
done in order to allow multiple session storage backends with a common interface.
.PP
Any session engine must inherit from Dancer::Session::Abstract and implement
the following abstract methods.
.SS "Configuration"
.IX Subsection "Configuration"
These settings control how a session acts.
.PP
\fIsession_name\fR
.IX Subsection "session_name"
.PP
The default session name is \*(L"dancer_session\*(R". This can be set in your config file:
.PP
.Vb 1
\&    setting session_name: "mydancer_session"
.Ve
.PP
\fIsession_secure\fR
.IX Subsection "session_secure"
.PP
The user's session id is stored in a cookie.  If true, this cookie
will be made \*(L"secure\*(R" meaning it will only be served over https.
.PP
\fIsession_expires\fR
.IX Subsection "session_expires"
.PP
When the session should expire.  The format is either the number of
seconds in the future, or the human readable offset from
\&\*(L"expires\*(R" in Dancer::Cookie.
.PP
By default, there is no expiration.
.PP
\fIsession_is_http_only\fR
.IX Subsection "session_is_http_only"
.PP
This setting defaults to 1 and instructs the session cookie to be
created with the \f(CW\*(C`HttpOnly\*(C'\fR option active, meaning that JavaScript
will not be able to access to its value.
.SS "Abstract Methods"
.IX Subsection "Abstract Methods"
.IP "\fBretrieve($id)\fR" 4
.IX Item "retrieve($id)"
Look for a session with the given id, return the session object if found, undef
if not.
.IP "\fB\f(BIcreate()\fB\fR" 4
.IX Item "create()"
Create a new session, return the session object.
.IP "\fB\f(BIflush()\fB\fR" 4
.IX Item "flush()"
Write the session object to the storage engine.
.IP "\fB\f(BIdestroy()\fB\fR" 4
.IX Item "destroy()"
Remove the current session object from the storage engine.
.IP "\fBsession_name\fR (optional)" 4
.IX Item "session_name (optional)"
Returns a string with the name of cookie used for storing the session \s-1ID\s0.
.Sp
You should probably not override this; the user can control the cookie name
using the \f(CW\*(C`session_name\*(C'\fR setting.
.SS "Inherited Methods"
.IX Subsection "Inherited Methods"
The following methods are not supposed to be overloaded, they are generic and
should be \s-1OK\s0 for each session engine.
.IP "\fBbuild_id\fR" 4
.IX Item "build_id"
Build a new uniq id.
.IP "\fBread_session_id\fR" 4
.IX Item "read_session_id"
Reads the \f(CW\*(C`dancer.session\*(C'\fR cookie.
.IP "\fBwrite_session_id\fR" 4
.IX Item "write_session_id"
Write the current session id to the \f(CW\*(C`dancer.session\*(C'\fR cookie.