.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Arch::SharedCache 3pm"
.TH Arch::SharedCache 3pm "2022-06-08" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Arch::SharedCache \- a synchronized data structure (map) for IPC
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Arch::SharedCache;
\&
\&    my $cache = Arch::SharedCache\->new(
\&        dir => \*(Aq/tmp/dir\-listings\*(Aq,
\&        max_size   => 100,
\&        expiration => 600,  # 10 minutes
\&    );
\&
\&    sub ls_long { scalar \`ls \-l $_[0]\` }
\&
\&    my $user_dir = \*(Aq/usr/share\*(Aq;
\&    $cache\->store($user_dir => ls_long($user_dir));
\&    $cache\->fetch_store(sub { ls_long($_[0]) }, qw(/tmp /bin /usr/share));
\&    printf "Cached listing of $user_dir:\en%s", $cache\->fetch($user_dir);
\&    $cache\->delete($user_dir);
\&
\&    # examine /tmp/dir\-listings/ after running this script
\&    # see also synopsys of Arch::SharedIndex
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Arch::SharedCache provides an Arch::SharedIndex implementation using a
single file per value.
.SH "METHODS"
.IX Header "METHODS"
The following methods are available:
.PP
\&\fBnew\fR.
.PP
Other methods are documented in Arch::SharedIndex.
.IP "\fBnew\fR \fIoptions\fR" 4
.IX Item "new options"
Create a new Arch::SharedCache object.  \fIoptions\fR is a hash of options.
.RS 4
.IP "\fBdir\fR" 4
.IX Item "dir"
The cache directory used to store data.  Will be created if it doesn't exist.
.IP "\fBindex_file\fR" 4
.IX Item "index_file"
Name of the index file for the cache.  Defaults to \f(CW\*(C`\f(CBdir\f(CW/.index\*(C'\fR.
.RE
.RS 4
.RE
.SH "BUGS"
.IX Header "BUGS"
Awaiting for your reports.
.SH "AUTHORS"
.IX Header "AUTHORS"
Mikhael Goikhman (migo@homemail.com\*(--Perl\-GPL/arch\-perl\*(--devel).
.PP
Enno Cramer (uebergeek@web.de\-\-2003/arch\-perl\*(--devel).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
For more information, see Arch::SharedIndex.