NAME

SWISH::Prog::Cache - simple in-memory cache class

SYNOPSIS

use SWISH::Prog::Cache;
my $cache = SWISH::Prog::Cache->new;
$cache->add( foo => 'bar' );
$cache->has( 'foo' ); # returns true
$cache->get( 'foo' ); # returns 'bar'
$cache->delete( 'foo' ); # removes 'foo' from cache and returns 'bar'

DESCRIPTION

SWISH::Prog::Cache is a simple in-memory caching class. It's basically just a Perl hash, but implemented as a class so that you can subclass it and use different storage (e.g. Cache::* modules).

METHODS

See SWISH::Prog::Class. Only new or overridden methods are documented here.

init

Initialize the cache. Called internally by new(). You should not need to call this yourself.

cache([ hash_ref ])

Get/set the internal in-memory cache. The default is just a hash ref. Subclasses are encouraged to implement their own storage.

has( key )

Does key exist in cache.

get( key )

Returns value for key. Returns undef if has( key ) is false.

delete( key )

Delete key from cache.

add( key => value )

Add key to cache with value value.

AUTHOR

Peter Karman, <perl@peknet.com>

BUGS

Please report any bugs or feature requests to bug-swish-prog at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SWISH-Prog. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc SWISH::Prog

You can also look for information at:

COPYRIGHT AND LICENSE

Copyright 2008-2009 by Peter Karman

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

SEE ALSO

http://swish-e.org/