.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 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.
.\"
.\" 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
.\"
.\" 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 "Poet::Cache 3pm"
.TH Poet::Cache 3pm "2014-02-26" "perl v5.18.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"
Poet::Cache \-\- Poet caching with CHI
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&    # In a conf file...
\&    cache:
\&       defaults:
\&          driver: Memcached
\&          servers: ["10.0.0.15:11211", "10.0.0.15:11212"]
\&
\&    # In a script...
\&    use Poet::Script qw($cache);
\&
\&    # In a module...
\&    use Poet qw($cache);
\&
\&    # In a component...
\&    my $cache = $m\->cache;
\&
\&    # For an arbitrary namespace...
\&    my $cache = Poet::Cache\->new(namespace => \*(AqSome::Namespace\*(Aq)
\&
\&    # then...
\&    my $customer = $cache\->get($name);
\&    if ( !defined $customer ) {
\&        $customer = get_customer_from_db($name);
\&        $cache\->set( $name, $customer, "10 minutes" );
\&    }
\&    my $customer2 = $cache\->compute($name2, "10 minutes", sub {
\&        get_customer_from_db($name2)
\&    });
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Poet::Cache is a subclass of \s-1CHI\s0. \s-1CHI\s0 provides a unified caching \s-1API\s0 over a
variety of storage backends, such as memory, plain files, memory mapped files,
memcached, and \s-1DBI.\s0
.PP
Each package and Mason component uses its own \s-1CHI \s0namespace so
that caches remain separate.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
The Poet configuration entry 'cache', if any, will be passed to
Poet::Cache\->\fIconfig()\fR. This can go
in any Poet conf file, e.g. \f(CW\*(C`local.cfg\*(C'\fR or
\&\f(CW\*(C`global/cache.cfg\*(C'\fR.
.PP
Here's a simple configuration that caches everything to files under
\&\f(CW\*(C`data/cache\*(C'\fR. This is also the default if no configuration is present.
.PP
.Vb 4
\&   cache:
\&      defaults:
\&         driver: File
\&         root_dir: ${root}/data/cache
.Ve
.PP
Here's a more involved configuration that defines several \*(L"storage types\*(R" and
assigns each namespace a storage type.
.PP
.Vb 10
\&   cache:
\&      defaults:
\&         expires_variance: 0.2
\&      storage:
\&         file:
\&            driver: File
\&            root_dir: ${root}/data/cache
\&         memcached:
\&            driver: Memcached
\&            servers: ["10.0.0.15:11211", "10.0.0.15:11212"]
\&            compress_threshold: 4096
\&      namespace:
\&         /some/component:       { storage: file, expires_in: 5min }
\&         /some/other/component: { storage: memcached, expires_in: 1h }
\&         Some::Library:         { storage: memcached, expires_in: 10min }
.Ve
.PP
Given the configuration above, and the code
.PP
.Vb 2
\&    package Some::Library;
\&    use Poet qw($cache);
.Ve
.PP
this \f(CW$cache\fR will be created with properties
.PP
.Vb 4
\&    driver: Memcached
\&    servers: ["10.0.0.15:11211", "10.0.0.15:11212"]
\&    compress_threshold: 4096
\&    expires_in: 10min
.Ve
.SH "USAGE"
.IX Header "USAGE"
.SS "Obtaining cache handle"
.IX Subsection "Obtaining cache handle"
.IP "\(bu" 4
In a script (namespace will be 'main'):
.Sp
.Vb 1
\&    use Poet::Script qw($cache);
.Ve
.IP "\(bu" 4
In a module \f(CW\*(C`MyApp::Foo\*(C'\fR (namespace will be 'MyApp::Foo'):
.Sp
.Vb 1
\&    use Poet qw($cache);
.Ve
.IP "\(bu" 4
In a component \f(CW\*(C`/foo/bar\*(C'\fR (namespace will be '/foo/bar'):
.Sp
.Vb 1
\&    my $cache = $m\->cache;
.Ve
.IP "\(bu" 4
Manually for an arbitrary namespace:
.Sp
.Vb 1
\&    my $cache = Poet::Cache\->new(namespace => \*(AqSome::Namespace\*(Aq);
\&        
\&    # or
\&    
\&    my $cache = MyApp::Cache\->new(category => \*(AqSome::Namespace\*(Aq);
.Ve
.SS "Using cache handle"
.IX Subsection "Using cache handle"
.Vb 8
\&    my $customer = $cache\->get($name);
\&    if ( !defined $customer ) {
\&        $customer = get_customer_from_db($name);
\&        $cache\->set( $name, $customer, "10 minutes" );
\&    }
\&    my $customer2 = $cache\->compute($name2, "10 minutes", sub {
\&        get_customer_from_db($name2)
\&    });
.Ve
.PP
See \s-1CHI\s0 and Mason::Plugin::Cache for more
details.
.SH "MODIFIABLE METHODS"
.IX Header "MODIFIABLE METHODS"
These methods are not intended to be called externally, but may be useful to
override or modify with method modifiers in subclasses.
.IP "initialize_caching" 4
.IX Item "initialize_caching"
Called once when the Poet environment is initialized. By default, calls \f(CW\*(C`_\|_PACKAGE_\|_\->config\*(C'\fR with the configuration entry 'cache'.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Poet
.SH "AUTHOR"
.IX Header "AUTHOR"
Jonathan Swartz <swartz@pobox.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2012 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.