.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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 "CHI::Driver::Memcached 3pm"
.TH CHI::Driver::Memcached 3pm "2019-11-19" "perl v5.30.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"
CHI::Driver::Memcached \-\- Distributed cache via memcached (memory cache daemon)
.SH "VERSION"
.IX Header "VERSION"
version 0.16
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use CHI;
\&
\&    my $cache = CHI\->new(
\&        driver => \*(AqMemcached\*(Aq,   # or \*(AqMemcached::Fast\*(Aq, or \*(AqMemcached::libmemcached\*(Aq
\&        namespace => \*(Aqproducts\*(Aq,
\&        servers => [ "10.0.0.15:11211", "10.0.0.15:11212", "/var/sock/memcached",
\&        "10.0.0.17:11211", [ "10.0.0.17:11211", 3 ] ],
\&        debug => 0,
\&        compress_threshold => 10_000,
\&    );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A \s-1CHI\s0 driver that uses Cache::Memcached to store data in the specified
memcached server(s).
.PP
CHI::Driver::Memcached::Fast and CHI::Driver::Memcached::libmemcached are
also available as part of this distribution. They work with other Memcached
clients and support a similar feature set. Documentation for all three modules
is presented below.
.SH "CONSTRUCTOR OPTIONS"
.IX Header "CONSTRUCTOR OPTIONS"
Namespace, appended with \*(L":\*(R", is passed along to the Cached::Memcached::*
constructor, along with any constructor options not recognized by
\&\s-1CHI\s0 \- for example \fIservers\fR, \fIcompress_threshold\fR and
\&\fIdebug\fR.
.PP
If you need more control over the options passed to Cache::Memcached::*, you
may specify a hash directly in \f(CW\*(C`memd_params\*(C'\fR.
.SH "METHODS"
.IX Header "METHODS"
Besides the standard \s-1CHI\s0 methods:
.IP "memd" 4
.IX Item "memd"
Returns a handle to the underlying Cache::Memcached::* object. You can use this
to call memcached-specific methods that are not supported by the general \s-1API,\s0
e.g.
.Sp
.Vb 2
\&    $self\->memd\->incr("key");
\&    my $stats = $self\->memd\->stats();
.Ve
.SH "UNSUPPORTED METHODS"
.IX Header "UNSUPPORTED METHODS"
These standard \s-1CHI\s0 methods cannot currently be supported by memcached, chiefly
because there is no way to get a list of stored keys.
.IP "dump_as_hash" 4
.IX Item "dump_as_hash"
.PD 0
.IP "clear" 4
.IX Item "clear"
.IP "get_keys" 4
.IX Item "get_keys"
.IP "get_namespaces" 4
.IX Item "get_namespaces"
.IP "is_empty" 4
.IX Item "is_empty"
.IP "purge" 4
.IX Item "purge"
.PD
.SH "SUPPORT AND DOCUMENTATION"
.IX Header "SUPPORT AND DOCUMENTATION"
Questions and feedback are welcome, and should be directed to the perl-cache
mailing list:
.PP
.Vb 1
\&    http://groups.google.com/group/perl\-cache\-discuss
.Ve
.PP
Bugs and feature requests will be tracked at \s-1RT:\s0
.PP
.Vb 1
\&    http://rt.cpan.org/NoAuth/Bugs.html?Dist=CHI\-Driver\-Memcached
.Ve
.PP
The latest source code can be browsed and fetched at:
.PP
.Vb 2
\&    http://github.com/jonswar/perl\-chi\-driver\-memcached/tree/master
\&    git clone git://github.com/jonswar/perl\-chi\-driver\-memcached.git
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Jonathan Swartz
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1CHI\s0, Cache::Memcached,
CHI::Driver::Memcached::Fast, CHI::Driver::Memcached::libmemcached
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright (C) 2007 Jonathan Swartz.
.PP
CHI::Driver::Memcached is provided \*(L"as is\*(R" and without any express or implied
warranties, including, without limitation, the implied warranties of
merchantibility and fitness for a particular purpose.
.PP
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011 by Jonathan Swartz.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.