The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Cache::Funky - How is simple, convenient cache module?

SYNOPSIS

    package MyCache;

    use strict;
    use warnings;
    use base qw( Cache::Funky );
    
    __PACKAGE__->setup( 'Storage::Memcached' =>  { servers => [ '127.0.0.1:12345' ] });
    __PACKAGE__->register( 'foo', sub { `date` } ); # * date: Tue May  1 21:53:36 JST 2007
    __PACKAGE__->register( 'boo', sub { shift . '_' . `date` } ); # * date: $id + _Tue May 1 21:53:36 JST 2007

    1;


    ------

    #! perl
    use strict;
    use warnings;
    use MyCache;

    print MyCache->foo;    # * Tue May  1 21:53:36 JST 2007
    
    sleep 10;
    print MyCache->foo;    # * Tue May  1 21:53:36 JST 2007
    
    MyCache->delete('foo');
    print MyCache->foo;    # * Tue May  1 21:53:36+? JST 2007 is NOW!

    print MyCache->boo('id1');    # * id1_Tue May  1 21:53:36 JST 2007
    print MyCache->boo('id2');    # * id2_Tue May  1 21:53:36 JST 2007
    
    sleep 10;
    print MyCache->boo('id1');    # * id1_Tue May  1 21:53:36 JST 2007
    
    # only remove id1
    MyCache->delete('boo', 'id1');
    print MyCache->boo('id1');    # * id1_Tue May  1 21:53:36+? JST 2007
    print MyCache->boo('id2');    # * id2_Tue May  1 21:53:36 JST 2007

    MyCache->deletes([qw/foo boo/]);

DESCRIPTION

This module manage where to get orignal data and set it in cache. And when you want to update the cache data , only you need to to is delete the cache you wanted update.

METHOD

setup( 'Storage::*' => $args )

Set the storage Module name which you use and the information that the storage class needs. You can find Storage module at Cache::Funky::Storage::* .

Please refer to POD of a storage class which information is necessary.

register( $attribute, $CODE_ref )

Please set an acquisition method of a attribute and data to register with your class.

delete( $attribute [,$id])

Give the registerd method name then the cache will be deleted. so next time you call the method, the cache will be updated.

also allow you to have second argument which delete only specific cache which has $id as key.

 MyCache->foo( 'key1' );
 MyCache->foo( 'key2' );

 # only remove key1
 MyCache->delete( 'foo' , 'key1' );

deletes( $attributes_ref );

you can set array ref as parameter to delete multiple cache data.

SEE ALSO

Cache::Funky::Storage

AUTHOR

Masahiro Funakoshi <masap@cpan.org>

Tomohiro Teranishi <tomohiro.teranishi@gmail.com>

LICENCE AND COPYRIGHT

Copyright (c) 2007, Masahiro Funakoshi <masap@cpan.org>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.