Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > c575b3572b1a595b8b6ae0529951ea8a > files > 3

perl-CHI-0.44-3.fc14.noarch.rpm

<html><head><title>CHI::CacheObject</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" >
<link rel="stylesheet" type="text/css" title="pod_stylesheet" href="http://search.cpan.org/s/style.css">

</head>
<body class='pod'>
<!--
  generated by Pod::Simple::HTML v3.15,
  using Pod::Simple::PullParser v3.15,
  under Perl v5.012002 at Wed Mar  2 00:52:11 2011 GMT.

 If you want to change this HTML document, you probably shouldn't do that
   by changing it directly.  Instead, see about changing the calling options
   to Pod::Simple::HTML, and/or subclassing Pod::Simple::HTML,
   then reconverting this document from the Pod source.
   When in doubt, email the author of Pod::Simple::HTML for advice.
   See 'perldoc Pod::Simple::HTML' for more info.

-->

<!-- start doc -->
<a name='___top' class='dummyTopAnchor' ></a>

<div class='indexgroup'>
<ul   class='indexList indexList1'>
  <li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
  <li class='indexItem indexItem1'><a href='#SYNOPSIS'>SYNOPSIS</a>
  <li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a>
  <li class='indexItem indexItem1'><a href='#METHODS'>METHODS</a>
</ul>
</div>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>

<p>CHI::CacheObject - Contains information about cache entries</p>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="SYNOPSIS"
>SYNOPSIS</a></h1>

<pre>    my $object = $cache-&#62;get_object($key);
    
    my $key        = $object-&#62;key();
    my $value      = $object-&#62;value();
    my $expires_at = $object-&#62;expires_at();
    my $created_at = $object-&#62;created_at();

    if ($object-&#62;is_expired()) { ... }</pre>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="DESCRIPTION"
>DESCRIPTION</a></h1>

<p>The <a href="http://search.cpan.org/perldoc?get_object" class="podlinkpod"
>CHI</a> method returns this object if the key exists. The object will be returned even if the entry has expired, as long as it has not been removed.</p>

<p>There is currently no public API for creating one of these objects directly.</p>

<h1><a class='u' href='#___top' title='click to go to top of document'
name="METHODS"
>METHODS</a></h1>

<p>All methods are read-only. The get_* methods are provided for backward compatibility with Cache::Cache&#39;s Cache::Object.</p>

<dl>
<dt><a name="key"
>key</a></dt>

<dd>
<p>The key.</p>

<dt><a name="value"
>value</a></dt>

<dd>
<p>The value.</p>

<dt><a name="expires_at"
>expires_at</a></dt>

<dd>
<dt><a name="get_expires_at"
>get_expires_at</a></dt>

<dd>
<p>Epoch time at which item expires.</p>

<dt><a name="created_at"
>created_at</a></dt>

<dd>
<dt><a name="get_created_at"
>get_created_at</a></dt>

<dd>
<p>Epoch time at which item was last written to.</p>

<dt><a name="is_expired"
>is_expired</a></dt>

<dd>
<p>Returns boolean indicating whether item has expired. This may be probabilistically determined if an <a href="#expires_variance" class="podlinkpod"
>&#34;expires_variance&#34;</a> was used.</p>
</dd>
</dl>

<!-- end doc -->

</body></html>