1Cache::FileCache(3)   User Contributed Perl Documentation  Cache::FileCache(3)
2
3
4

NAME

6       Cache::FileCache -- implements the Cache interface.
7

DESCRIPTION

9       The FileCache class implements the Cache interface.  This cache stores
10       data in the filesystem so that it can be shared between processes.
11

SYNOPSIS

13         use Cache::FileCache;
14
15         my $cache = new Cache::FileCache( { 'namespace' => 'MyNamespace',
16                                             'default_expires_in' => 600 } );
17
18         See Cache::Cache for the usage synopsis.
19

METHODS

21       See Cache::Cache for the API documentation.
22
23       Clear( [$cache_root] )
24           See Cache::Cache, with the optional $cache_root parameter.
25
26       Purge( [$cache_root] )
27           See Cache::Cache, with the optional $cache_root parameter.
28
29       Size( [$cache_root] )
30           See Cache::Cache, with the optional $cache_root parameter.
31

OPTIONS

33       See Cache::Cache for standard options.  Additionally, options are set
34       by passing in a reference to a hash containing any of the following
35       keys:
36
37       cache_root
38           The location in the filesystem that will hold the root of the
39           cache.  Defaults to the 'FileCache' under the OS default temp
40           directory ( often '/tmp' on UNIXes ) unless explicitly set.
41
42       cache_depth
43           The number of subdirectories deep to cache object item.  This
44           should be large enough that no cache directory has more than a few
45           hundred objects.  Defaults to 3 unless explicitly set.
46
47       directory_umask
48           The directories in the cache on the filesystem should be globally
49           writable to allow for multiple users.  While this is a potential
50           security concern, the actual cache entries are written with the
51           user's umask, thus reducing the risk of cache poisoning.  If you
52           desire it to only be user writable, set the 'directory_umask'
53           option to '077' or similar.  Defaults to '000' unless explicitly
54           set.
55

PROPERTIES

57       See Cache::Cache for default properties.
58
59       (get|set)_cache_root
60           See the definition above for the option cache_root
61
62       (get|set)_cache_depth
63           See the definition above for the option cache_depth
64
65       (get|set)_directory_umask
66           See the definition above for the option directory_umask
67

SEE ALSO

69       Cache::Cache
70

AUTHOR

72       Original author: DeWitt Clinton <dewitt@unto.net>
73
74       Last author:     $Author: dclinton $
75
76       Copyright (C) 2001-2003 DeWitt Clinton
77
78
79
80perl v5.32.1                      2021-01-26               Cache::FileCache(3)
Impressum