.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" 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 "Memoize::Memcached 3pm" .TH Memoize::Memcached 3pm "2011-05-13" "perl v5.12.3" "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" Memoize::Memcached \- use a memcached cache to memoize functions .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 4 \& use Memoize::Memcached \& memcached => { \& servers => [ \*(Aq127.0.0.1:11211\*(Aq ], \& }; \& \& memoize_memcached(\*(Aqfoo\*(Aq); \& \& # Function \*(Aqfoo\*(Aq is now memoized using the memcached server \& # running on 127.0.0.1:11211 as the cache. .Ve .SH "WARNING" .IX Header "WARNING" The way \f(CW\*(C`flush_cache\*(C'\fR works with memcached can be dangerous. Please read the documentation below on \f(CW\*(C`flush_cache\*(C'\fR. .SH "EXPORT" .IX Header "EXPORT" This module exports \f(CW\*(C`memoize_memcached\*(C'\fR, \f(CW\*(C`flush_cache\*(C'\fR, and \&\f(CW\*(C`unmemoize\*(C'\fR. The \f(CW\*(C`unmemoize\*(C'\fR function is just the one from Memoize, and is made available for convenience. .SH "FUNCTIONS" .IX Header "FUNCTIONS" .SS "memoize_memcached" .IX Subsection "memoize_memcached" This is the memcached equivalent of \f(CW\*(C`memoize\*(C'\fR. It works very similarly, except for some difference in options. .PP If the \f(CW\*(C`LIST_CACHE\*(C'\fR or \f(CW\*(C`SCALAR_CACHE\*(C'\fR options are passed in, \&\f(CW\*(C`memoize_memcached\*(C'\fR will complain and then pass the request along to \&\f(CW\*(C`memoize\*(C'\fR. The result will be a memoized function, but using whatever cache you specified and \s-1NOT\s0 using memcached at all. .PP This function also accepts a \f(CW\*(C`memcached\*(C'\fR option, which expects a hashref. This is de-referenced and passed directly into an internal function which sets up the memcached configuration for that function. This contents of this hashref are mostly options passed to \&\f(CW\*(C`Cache::Memcached\*(C'\fR, with a few exceptions. .PP The actual key used to look up memoize data in memcached is formed from the function name, the normalized arguments, and some additional prefixes which can be set via the \f(CW\*(C`memcached\*(C'\fR option. These prefixes are \f(CW\*(C`key_prefix\*(C'\fR, \f(CW\*(C`list_key_prefix\*(C'\fR, and \f(CW\*(C`scalar_key_prefix\*(C'\fR. .PP The \f(CW\*(C`key_prefix\*(C'\fR defaults to \*(L"memoize\-\*(R" if it's not passed in, or an undefined value is passed in. .PP The \f(CW\*(C`list_key_prefix\*(C'\fR and \f(CW\*(C`scalar_key_prefix\*(C'\fR options default to \&\*(L"list\-\*(R" and \*(L"scalar\-\*(R" respectively, by the same criteria. .PP So, the default way the key is generated is: .PP .Vb 1 \& "memoize\-\-list\-" .Ve .PP or .PP .Vb 1 \& "memoize\-\-scalar\-" .Ve .PP The function and normalized args portion of this key are set internally, but the \*(L"memoize\-\*(R" prefix and the context portion can be configured with memcached options as follows: .PP .Vb 1 \& "\-function\-\-args" .Ve .PP Examples: .PP .Vb 1 \& memoize_memcached(\*(Aqfoo\*(Aq); \& \& # keys generated will look like this: \& # list context: memoize\-foo\-list\- \& # scalar context: memoize\-foo\-scalar\- \& \& memoize_memcached(\*(Aqfoo\*(Aq, \& memcached => { \& servers => [ ... ], \& key_prefix => \*(Aq_M\-\*(Aq, \& list_key_prefix => \*(AqL\-\*(Aq, \& scalar_key_prefix => \*(AqS\-\*(Aq, \& }, \& ; \& \& # keys generated will look like this: \& # list context: _M\-foo\-L\- \& # scalar context: _M\-foo\-S\- .Ve .SS "flush_cache" .IX Subsection "flush_cache" The behavior documented in \f(CW\*(C`Memoize\*(C'\fR is sort of implemented. A call to \f(CW\*(C`flush_cache(\*(Aqmemoized_function\*(Aq)\*(C'\fR will indeed clear the cache of all cached return values for that function, \s-1BUT\s0 it will also clear the entire memcached cache, including all other memoized functions using the same memcached cache, and even data unrelated to \&\f(CW\*(C`Memoize::Memcached\*(C'\fR in the same cache. It will flush the entire cache. .PP There are 2 new ways to call this function: .PP .Vb 1 \& flush_cache(); .Ve .PP and .PP .Vb 1 \& flush_cache(memoized_function => qw( an argument signature )); .Ve .PP The call without arguments will flush the entire memcached cache, just like the 1 argument version. This includes unrelated data. Be careful. .PP The call with 2 or more arguments will flush only the cached return values (array and scalar contexts) for a call to the function named by the first argument with an argument signature matching the second argument to the end. Unlike the other 2 ways to call this function, when called this way only the specified part of the cache is flushed. .PP I would recommended that only the 2 or more argument version of \&\f(CW\*(C`flush_cache\*(C'\fR be called unless you are very sure of what you are doing. .SH "GOTCHAS" .IX Header "GOTCHAS" The biggest gotcha is that you probably never want to call \&\f(CW\*(C`flush_cache(\*(Aqmemoized_function\*(Aq)\*(C'\fR. Because of the way \f(CW\*(C`CLEAR\*(C'\fR is implemented against memcached, this call will flush the entire memcached cache. Everything. Even stuff having nothing to do with \&\f(CW\*(C`Memoize::Memcached\*(C'\fR. You are warned. .SH "TO-DO" .IX Header "TO-DO" A more intuitive interface for handling different memcached server configurations would probably be useful. .SH "AUTHOR" .IX Header "AUTHOR" David Trischuk, \f(CW\*(C`\*(C'\fR .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests to \f(CW\*(C`bug\-memoize\-memcached at rt.cpan.org\*(C'\fR, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Memoize\-Memcached . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .SH "SUPPORT" .IX Header "SUPPORT" You can find documentation for this module with the perldoc command. .PP .Vb 1 \& perldoc Memoize::Memcached .Ve .PP You can also look for information at: .IP "\(bu" 4 \&\s-1RT:\s0 \s-1CPAN\s0's request tracker .Sp http://rt.cpan.org/NoAuth/Bugs.html?Dist=Memoize\-Memcached .IP "\(bu" 4 AnnoCPAN: Annotated \s-1CPAN\s0 documentation .Sp http://annocpan.org/dist/Memoize\-Memcached .IP "\(bu" 4 \&\s-1CPAN\s0 Ratings .Sp http://cpanratings.perl.org/d/Memoize\-Memcached .IP "\(bu" 4 Search \s-1CPAN\s0 .Sp http://search.cpan.org/dist/Memoize\-Memcached .SH "ACKNOWLEDGMENTS" .IX Header "ACKNOWLEDGMENTS" The tied hash portion of this module is heavily based on \&\f(CW\*(C`Cache::Memcached::Tie\*(C'\fR by Andrew Kostenko. .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2008 David Trischuk, all rights reserved. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.