Cache::FileBackend (3)

Leading comments

Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Cache::FileBackend.3pm".)

NAME

Cache::FileBackend -- a filesystem based persistence mechanism

DESCRIPTION

The FileBackend class is used to persist data to the filesystem

SYNOPSIS

  my $backend = new Cache::FileBackend( '/tmp/FileCache', 3, 000 );

  See Cache::Backend for the usage synopsis.

  $backend->store( 'namespace', 'foo', 'bar' );

  my $bar = $backend->restore( 'namespace', 'foo' );

  my $size_of_bar = $backend->get_size( 'namespace', 'foo' );

  foreach my $key ( $backend->get_keys( 'namespace' ) )
  {
    $backend->delete_key( 'namespace', $key );
  }

  foreach my $namespace ( $backend->get_namespaces( ) )
  {
    $backend->delete_namespace( $namespace );
  }

METHODS

See Cache::Backend for the documentation.

new( $root, $depth, $directory_umask )

Construct a new FileBackend that writes data to the $root directory, automatically creates subdirectories $depth levels deep, and uses the umask of $directory_umask when creating directories.

PROPERTIES

(get|set)_root

The location of the parent directory in which to store the files

(get|set)_depth

The branching factor of the subdirectories created to store the files

(get|set)_directory_umask

The umask to be used when creating directories

SEE ALSO

Cache::Backend, Cache::MemoryBackend, Cache::SharedMemoryBackend

AUTHOR

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

Last author: $Author: dclinton $

Copyright (C) 2001-2003 DeWitt Clinton