.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "Catalyst::Plugin::Session::Store::Memcached 3"
.TH Catalyst::Plugin::Session::Store::Memcached 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Catalyst::Plugin::Session::Store::Memcached \- Memcached storage backend for
session data.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Catalyst qw/ Session Session::Store::Memcached Session::State::Foo /;
.Ve
.PP
.Vb 10
\&    MyApp->config->{session} = {
\&        memcached_new_args => {
\&            # L<Cache::Memcached::Managed/new>
\&            'data' => [ "10.0.0.15:11211", "10.0.0.15:11212" ],
\&        },
\&        memcached_item_args => {
\&            # L<Cache::Memcached::Managed/set>, get, delete
\&            # ...
\&        },
\&    };
.Ve
.PP
.Vb 2
\&    # ... in an action:
\&    $c->session->{foo} = 'bar';    # will be saved
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Catalyst::Plugin::Session::Store::Memcached\*(C'\fR is a session storage plugin for
Catalyst that uses the Cache::Memcached::Managed module to connect to
memcached, a fast data caching server.
.Sh "\s-1METHODS\s0"
.IX Subsection "METHODS"
.IP "get_session_data" 4
.IX Item "get_session_data"
.PD 0
.IP "store_session_data" 4
.IX Item "store_session_data"
.IP "delete_session_data" 4
.IX Item "delete_session_data"
.IP "delete_expired_sessions" 4
.IX Item "delete_expired_sessions"
.PD
These are implementations of the required methods for a store. See
Catalyst::Plugin::Session::Store.
.IP "setup_session" 4
.IX Item "setup_session"
Sets up the session cache file.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
These parameters are placed in the hash under the \f(CW\*(C`session\*(C'\fR key in the
configuration hash.
.IP "memcached_obj" 4
.IX Item "memcached_obj"
If this key is a true value it will be used as the storage driver. It is
assumed that it adheres to the same interface as Cache::Memcached::Managed.
.IP "memcached_new_args" 4
.IX Item "memcached_new_args"
This parameter is a hash reference which will be flattenned as the argument
list to \*(L"new\*(R" in Cache::Memcached::Managed.
.Sp
Some default values will be used:
.RS 4
.IP "data" 4
.IX Item "data"
The data server to use defaults to \f(CW\*(C`localhost:11211\*(C'\fR.
.IP "namespace" 4
.IX Item "namespace"
\&\f(CW"catalyst_session"\fR
.RE
.RS 4
.RE
.IP "memcached_item_args" 4
.IX Item "memcached_item_args"
Extra arguments to be passed into \f(CW\*(C`set\*(C'\fR, \f(CW\*(C`get\*(C'\fR, and \f(CW\*(C`delete\*(C'\fR. These are
discussed in Cache::Memcached::Managed.
.Sp
Some default values will be used:
.RS 4
.IP "version" 4
.IX Item "version"
\&\f(CW\*(C`YourApp\->VERSION\*(C'\fR
.IP "key" 4
.IX Item "key"
\&\f(CW"YourApp"\fR
.RE
.RS 4
.RE
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catalyst, Catalyst::Plugin::Session, Cache::Memcached.
.SH "AUTHORS"
.IX Header "AUTHORS"
This module is derived from Catalyst::Plugin::Session::FastMmap code, and
has been heavily modified since.
.PP
Andrew Ford
.PP
Andy Grundman
.PP
Christian Hansen
.PP
Yuval Kogman, \f(CW\*(C`nothingmuch@woobling.org\*(C'\fR
.PP
Marcus Ramberg
.PP
Sebastian Riedel
.PP
head1 \s-1COPYRIGHT\s0
.PP
This program is free software, you can redistribute it and/or modify it
under the same terms as Perl itself.