Gantry::Plugins::Cache::Memcached - A Plugin interface to a caching subsystem
It is sometimes desirable to cache data between page acceses. This module gives access to the Cache::Memcached module to store that data.
<Perl> # ... use MyApp qw{ -Engine=CGI -TemplateEngine=TT Cache::Memcached }; </Perl>
This plugin mixes in methods to store data within a cache. This data is then available for later retrival. Data is stored within the cache by key/value pairs. There are no restrictions on what information can be stored. This cache is designed for short term data storage. Cached data items will be timed out and purged at regular intervals. The caching system also has the concept of namespace. Namespaces are being used to make key's unique. So you may store multiple unique data items within the cache.
The following items can be set by configuration:
cache_rehash wither to attempt a failover to another server cache_expires the expiration of items within the cache cache_servers which cache servers to use cache_compress_threshold the threshold to start compression
The following reasonable defaults are being used for those items:
cache_rehash no cache_expires 3600 seconds cache_servers 127.0.0.1:11212 cache_compress_threshold 1000 bytes
Since this cache is being managed by Cache::Memcached, any changes to those defaults should be consistent with that modules usage.
This method will initialize the cache. It should be called only once within the application.
$self->cache_init();
For internal use.
Dual use accessor for init flag. If cache_init has run this attribute is 1, otherwise it's 0.
This method will get/set the current namespace for cache operations.
$self->cache_namespace($namespace);
This method returns the handle for the underlining cache. You can use this handle to manipulate the cache directly. Doing so will be highly specific to the underling cache handler.
$handle = $self->cache_handle();
Equivalent to
$self->cache_handle();
This method is for other cache plugins which support a purge method.
This method returns the data associated with the current namespace/key combination.
$self->cache_namespace($namespace); $data = $self->cache_get($key);
This method stores the data associated with the current namespace/key combination.
$self->cache_namespace($namespace); $self->cache_set($key, $data);
This method is currently not available with memcached.
This method will clear the entire cache.
$self->cache_clear();
This method removes the data associated with the current namespace/key combination.
$self->cache_namespace($namespace); $self->cache_del($key);
Retrieves the current expiration time for data items with thecache. The expiration time can be changed for this module. It is adviseable to not do so. Expiration time formats are highly specific to the underlining cache handler.
$expiration = $self->cache_expires();
Gantry
Kevin L. Esteb <kesteb@wsipc.org>, Tim Keefer <tim@timkeefer.com>
Copyright (C) 2007 Kevin L. Esteb
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.
To install Gantry::Plugins::Cache, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Gantry::Plugins::Cache
CPAN shell
perl -MCPAN -e shell install Gantry::Plugins::Cache
For more information on module installation, please visit the detailed CPAN module installation guide.