.\" 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 "Cache::SizeAwareCache 3pm"
.TH Cache::SizeAwareCache 3pm "2022-06-30" "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"
Cache::SizeAwareCache \-\- extends the Cache interface.
.SH "DESCRIPTION"
.IX Header "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.
.PP
The default cache size limiting algorithm works by removing cache
objects in the following order until the desired limit is reached:
.PP
.Vb 3
\&  1) objects that have expired
\&  2) objects that are least recently accessed
\&  3) objects that expire next
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use Cache::SizeAwareCache;
\&  use vars qw( @ISA );
\&
\&  @ISA = qw( Cache::SizeAwareCache );
.Ve
.SH "CONSTANTS"
.IX Header "CONSTANTS"
Please see Cache::Cache for standard constants
.IP "\fI\f(CI$NO_MAX_SIZE\fI\fR" 4
.IX Item "$NO_MAX_SIZE"
The cache has no size restrictions
.SH "METHODS"
.IX Header "METHODS"
Please see Cache::Cache for the standard methods
.IP "\fBlimit_size( \f(CB$new_size\fB )\fR" 4
.IX Item "limit_size( $new_size )"
Attempt to resize the cache such that the total disk usage is under
the \fI\f(CI$new_size\fI\fR parameter.  \fI\f(CI$new_size\fI\fR 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
\&\fImax_size\fR option, although it is considered very expensive, and can
often be better achieved by periodically calling \fIlimit_size\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
Please see Cache::Cache for the standard options
.IP "\fImax_size\fR" 4
.IX Item "max_size"
Sets the max_size property (size in bytes), which is described in
detail below.  Defaults to \fI\f(CI$NO_MAX_SIZE\fI\fR.
.SH "PROPERTIES"
.IX Header "PROPERTIES"
Please see Cache::Cache for standard properties
.IP "\fB(get|set)_max_size\fR" 4
.IX Item "(get|set)_max_size"
If this property is set, then the cache will try not to exceed the max
size value (in bytes) specified.  \s-1NOTE:\s0 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 \f(CW$NO_MAX_SIZE\fR and to periodically limit the size of
the cache by calling the limit_size( \f(CW$size\fR ) method.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Cache::Cache
.SH "AUTHOR"
.IX Header "AUTHOR"
Original author: DeWitt Clinton <dewitt@unto.net>
.PP
Last author:     \f(CW$Author:\fR dclinton $
.PP
Copyright (C) 2001\-2003 DeWitt Clinton