You are viewing the version of this documentation from Perl 5.8.2. View the latest version

CONTENTS

NAME

FileCache - keep more files open than the system permits

SYNOPSIS

use FileCache;
# or
use FileCache maxopen => 16;

cacheout $mode, $path;
# or
cacheout $path;
print $path @data;

$fh = cacheout $mode, $path;
# or
$fh = cacheout $path;
print $fh @data;

DESCRIPTION

The cacheout function will make sure that there's a filehandle open for reading or writing available as the pathname you give it. It automatically closes and re-opens files if you exceed your system's maximum number of file descriptors, or the suggested maximum maxopen.

cacheout EXPR

The 1-argument form of cacheout will open a file for writing ('>') on it's first use, and appending ('>>') thereafter.

Returns EXPR on success for convenience. You may neglect the return value and manipulate EXPR as the filehandle directly if you prefer.

cacheout MODE, EXPR

The 2-argument form of cacheout will use the supplied mode for the initial and subsequent openings. Most valid modes for 3-argument open are supported namely; '>', '+>', '<', '<+', '>>', '|-' and '-|'

Returns EXPR on success for convenience. You may neglect the return value and manipulate EXPR as the filehandle directly if you prefer.

CAVEATS

While it is permissible to close a FileCache managed file, do not do so if you are calling FileCache::cacheout from a package other than which it was imported, or with another module which overrides close. If you must, use FileCache::cacheout_close.

BUGS

sys/param.h lies with its NOFILE define on some systems, so you may have to set maxopen yourself.

NOTES

FileCache installs signal handlers for CHLD (a.k.a. CLD) and PIPE in the calling package to handle deceased children from 2-arg cacheout with '|-' or '-|' expediently. The children would otherwise be reaped eventually, unless you terminated before repeatedly calling cacheout.

1 POD Error

The following errors were encountered while parsing the POD:

Around line 52:

You forgot a '=back' before '=head1'