cache::object(3pm) [debian man page]

Cache::Object(3pm)					User Contributed Perl Documentation					Cache::Object(3pm)

NAME

       Cache::Object -- the data stored in a Cache.

DESCRIPTION

       Object is used by classes implementing the Cache interface as an object oriented wrapper around the data.  End users will not normally use
       Object directly, but it can be retrieved via the get_object method on the Cache::Cache interface.

SYNOPSIS

	use Cache::Object;

	my $object = new Cache::Object( );

	$object->set_key( $key );
	$object->set_data( $data );
	$object->set_expires_at( $expires_at );
	$object->set_created_at( $created_at );

METHODS

       new(  )
	   Construct a new Cache::Object.

PROPERTIES

       (get|set)_accessed_at
	   The time at which the object was last accessed.  Various cache implementations will use the accessed_at property to store information
	   for LRU algorithms.	There is no guarentee that all caches will update this field, however.

       (get|set)_created_at
	   The time at which the object was created.

       (get|set)_data
	   A scalar containing or a reference pointing to the data to be stored.

       (get|set)_expires_at
	   The time at which the object should expire from the cache.

       (get|set)_key
	   The key under which the object was stored.

       (get|set)_size
	   The size of the frozen version of this object

SEE ALSO

       Cache::Cache

AUTHOR

       Original author: DeWitt Clinton <dewitt@unto.net>

       Last author:	$Author: dclinton $

       Copyright (C) 2001-2003 DeWitt Clinton

perl v5.12.4							    2009-03-01							Cache::Object(3pm)

Cache::SizeAwareCache(3pm)				User Contributed Perl Documentation				Cache::SizeAwareCache(3pm)

NAME

       Cache::SizeAwareCache -- extends the Cache interface.

DESCRIPTION

       The SizeAwareCache interface is implemented by classes that support all of the Cache::Cache interface in addition to the limit_size and
       max_size features of a size aware cache.

       The default cache size limiting algorithm works by removing cache objects in the following order until the desired limit is reached:

	 1) objects that have expired
	 2) objects that are least recently accessed
	 3) objects that that expire next

SYNOPSIS

	 use Cache::SizeAwareCache;
	 use vars qw( @ISA );

	 @ISA = qw( Cache::SizeAwareCache );

CONSTANTS

       Please see Cache::Cache for standard constants

       $NO_MAX_SIZE
	   The cache has no size restrictions

METHODS

       Please see Cache::Cache for the standard methods

       limit_size( $new_size )
	   Attempt to resize the cache such that the total disk usage is under the $new_size parameter.  $new_size represents t size (in bytes)
	   that the cache should be limited to.  Note that this is only a one time adjustment.	To maintain the cache size, consider using the
	   max_size option, although it is considered very expensive, and can often be better achieved by peridocally calling limit_size.

OPTIONS

       Please see Cache::Cache for the standard options

       max_size
	   Sets the max_size property (size in bytes), which is described in detail below.  Defaults to $NO_MAX_SIZE.

PROPERTIES

       Please see Cache::Cache for standard properties

       (get|set)_max_size
	   If this property is set, then the cache will try not to exceed the max size value (in bytes) specified.  NOTE: This causes the size of
	   the cache to be checked on every set, and can be considered *very* expensive in some implementations.  A good alternative approach is
	   leave max_size as $NO_MAX_SIZE and to periodically limit the size of the cache by calling the limit_size( $size ) method.

SEE ALSO

       Cache::Cache

AUTHOR

       Original author: DeWitt Clinton <dewitt@unto.net>

       Last author:	$Author: dclinton $

       Copyright (C) 2001-2003 DeWitt Clinton

perl v5.12.4							    2009-03-01						Cache::SizeAwareCache(3pm)