File Coverage

blib/lib/Catalyst/Plugin/Cache/FastMmap.pm

Criterion	Covered	Total	%
statement	15	26	57.6
branch	0	6	0.0
condition			n/a
subroutine	5	6	83.3
pod	1	1	100.0
total	21	39	53.8

package Catalyst::Plugin::Cache::FastMmap;

use strict;
use warnings;
use MRO::Compat;
use base 'Class::Data::Inheritable';

use Cache::FastMmap;

our $VERSION= '0.9';

__PACKAGE__->mk_classdata('cache');

sub setup {
    my $self = shift;

    my %params = ();

    if ( $self->config->{cache} ) {
        %params = %{ $self->config->{cache} };
    }

    if ( $params{storage} ) {
        $params{share_file} = delete $params{storage};
    }

    if ( $params{expires} ) {
        $params{expire_time} = delete $params{expires};
    }

    $self->cache( Cache::FastMmap->new(%params) );

    return $self->next::method(@_);
}

1;


__END__

=head1 NAME

Catalyst::Plugin::Cache::FastMmap - DEPRECATED FastMmap cache

=head1 SYNOPSIS

    use Catalyst qw[Cache::FastMmap];

    MyApp->config(
        cache => {
            storage => '/tmp/cache',
            xpires => 3600,
        },
    );

    my $data;

    unless ( $data = $c->cache->get('data') ) {
        $data = MyApp::Model::Data->retrieve('data');
        $c->cache->set( 'data', $data );
    }

    $c->response->body($data);


=head1 DESCRIPTION

This package is part of the Catalyst Cache family. It allows
integration of L<Cache::FastMmap> and L<Catalyst>

This module extends the Catalyst application class with a C<mmap> cache.

This module is not recommended for production use, as L<Cache::FastMmap> can
segfault and/or unexpectedly throw away your data.

=head1 METHODS

=over

=item setup

Sets up the cache

=item cache

Returns an instance of C<Cache::FastMmap>

=back

=head1 SEE ALSO

L<Cache::FastMmap>, L<Catalyst>.

=head1 AUTHOR

Christian Hansen, C<[e-mail]>

Sebastian Riedel, C<[e-mail]>

=head1 LICENSE

This library is free software . You can redistribute it and/or modify it under
the same terms as perl itself.

=head1 COPYRIGHT

Copyright (c) 2005-2011, the above mentioned AUTHORs.

=cut