cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
422 lines (421 loc) • 20.9 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:31 CEST 2014 -->
<title>AutoSavingCache (apache-cassandra API)</title>
<meta name="date" content="2014-09-07">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AutoSavingCache (apache-cassandra API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AutoSavingCache.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../org/apache/cassandra/cache/AutoSavingCache.CacheSerializer.html" title="interface in org.apache.cassandra.cache"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/cache/AutoSavingCache.html" target="_top">Frames</a></li>
<li><a href="AutoSavingCache.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.cassandra.cache</div>
<h2 title="Class AutoSavingCache" class="title">Class AutoSavingCache<K extends <a href="../../../../org/apache/cassandra/cache/CacheKey.html" title="interface in org.apache.cassandra.cache">CacheKey</a>,V></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html" title="class in org.apache.cassandra.cache">org.apache.cassandra.cache.InstrumentingCache</a><K,V></li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.cache.AutoSavingCache<K,V></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">AutoSavingCache<K extends <a href="../../../../org/apache/cassandra/cache/CacheKey.html" title="interface in org.apache.cassandra.cache">CacheKey</a>,V></span>
extends <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html" title="class in org.apache.cassandra.cache">InstrumentingCache</a><K,V></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/AutoSavingCache.CacheSerializer.html" title="interface in org.apache.cassandra.cache">AutoSavingCache.CacheSerializer</a><<a href="../../../../org/apache/cassandra/cache/AutoSavingCache.CacheSerializer.html" title="type parameter in AutoSavingCache.CacheSerializer">K</a> extends <a href="../../../../org/apache/cassandra/cache/CacheKey.html" title="interface in org.apache.cassandra.cache">CacheKey</a>,<a href="../../../../org/apache/cassandra/cache/AutoSavingCache.CacheSerializer.html" title="type parameter in AutoSavingCache.CacheSerializer">V</a>></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>class </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/AutoSavingCache.Writer.html" title="class in org.apache.cassandra.cache">AutoSavingCache.Writer</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/cassandra/service/CacheService.CacheType.html" title="enum in org.apache.cassandra.service">CacheService.CacheType</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html#cacheType">cacheType</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Set<<a href="../../../../org/apache/cassandra/service/CacheService.CacheType.html" title="enum in org.apache.cassandra.service">CacheService.CacheType</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html#flushInProgress">flushInProgress</a></strong></code>
<div class="block">True if a cache flush is currently executing: only one may execute at a time.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.concurrent.ScheduledFuture<?></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html#saveTask">saveTask</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html#AutoSavingCache(org.apache.cassandra.cache.ICache,%20org.apache.cassandra.service.CacheService.CacheType,%20org.apache.cassandra.cache.AutoSavingCache.CacheSerializer)">AutoSavingCache</a></strong>(<a href="../../../../org/apache/cassandra/cache/ICache.html" title="interface in org.apache.cassandra.cache">ICache</a><<a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html" title="type parameter in AutoSavingCache">K</a>,<a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html" title="type parameter in AutoSavingCache">V</a>> cache,
<a href="../../../../org/apache/cassandra/service/CacheService.CacheType.html" title="enum in org.apache.cassandra.service">CacheService.CacheType</a> cacheType,
<a href="../../../../org/apache/cassandra/cache/AutoSavingCache.CacheSerializer.html" title="interface in org.apache.cassandra.cache">AutoSavingCache.CacheSerializer</a><<a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html" title="type parameter in AutoSavingCache">K</a>,<a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html" title="type parameter in AutoSavingCache">V</a>> cacheloader)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.io.File</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html#getCachePath(java.lang.String,%20java.lang.String,%20java.util.UUID,%20java.lang.String)">getCachePath</a></strong>(java.lang.String ksName,
java.lang.String cfName,
java.util.UUID cfId,
java.lang.String version)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/cassandra/cache/AutoSavingCache.Writer.html" title="class in org.apache.cassandra.cache">AutoSavingCache.Writer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html#getWriter(int)">getWriter</a></strong>(int keysToSave)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html#loadSaved(org.apache.cassandra.db.ColumnFamilyStore)">loadSaved</a></strong>(<a href="../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html#scheduleSaving(int,%20int)">scheduleSaving</a></strong>(int savePeriodInSeconds,
int keysToSave)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.concurrent.Future<?></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html#submitWrite(int)">submitWrite</a></strong>(int keysToSave)</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.cache.InstrumentingCache">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.cassandra.cache.<a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html" title="class in org.apache.cassandra.cache">InstrumentingCache</a></h3>
<code><a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#clear()">clear</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#containsKey(K)">containsKey</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#get(K)">get</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#getCapacity()">getCapacity</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#getInternal(K)">getInternal</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#getKeySet()">getKeySet</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#getMetrics()">getMetrics</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#hotKeySet(int)">hotKeySet</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#isCapacitySetManually()">isCapacitySetManually</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#put(K,%20V)">put</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#putIfAbsent(K,%20V)">putIfAbsent</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#remove(K)">remove</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#replace(K,%20V,%20V)">replace</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#setCapacity(long)">setCapacity</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#size()">size</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#updateCapacity(long)">updateCapacity</a>, <a href="../../../../org/apache/cassandra/cache/InstrumentingCache.html#weightedSize()">weightedSize</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="flushInProgress">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flushInProgress</h4>
<pre>public static final java.util.Set<<a href="../../../../org/apache/cassandra/service/CacheService.CacheType.html" title="enum in org.apache.cassandra.service">CacheService.CacheType</a>> flushInProgress</pre>
<div class="block">True if a cache flush is currently executing: only one may execute at a time.</div>
</li>
</ul>
<a name="saveTask">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>saveTask</h4>
<pre>protected volatile java.util.concurrent.ScheduledFuture<?> saveTask</pre>
</li>
</ul>
<a name="cacheType">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>cacheType</h4>
<pre>protected final <a href="../../../../org/apache/cassandra/service/CacheService.CacheType.html" title="enum in org.apache.cassandra.service">CacheService.CacheType</a> cacheType</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AutoSavingCache(org.apache.cassandra.cache.ICache, org.apache.cassandra.service.CacheService.CacheType, org.apache.cassandra.cache.AutoSavingCache.CacheSerializer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AutoSavingCache</h4>
<pre>public AutoSavingCache(<a href="../../../../org/apache/cassandra/cache/ICache.html" title="interface in org.apache.cassandra.cache">ICache</a><<a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html" title="type parameter in AutoSavingCache">K</a>,<a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html" title="type parameter in AutoSavingCache">V</a>> cache,
<a href="../../../../org/apache/cassandra/service/CacheService.CacheType.html" title="enum in org.apache.cassandra.service">CacheService.CacheType</a> cacheType,
<a href="../../../../org/apache/cassandra/cache/AutoSavingCache.CacheSerializer.html" title="interface in org.apache.cassandra.cache">AutoSavingCache.CacheSerializer</a><<a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html" title="type parameter in AutoSavingCache">K</a>,<a href="../../../../org/apache/cassandra/cache/AutoSavingCache.html" title="type parameter in AutoSavingCache">V</a>> cacheloader)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCachePath(java.lang.String, java.lang.String, java.util.UUID, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCachePath</h4>
<pre>public java.io.File getCachePath(java.lang.String ksName,
java.lang.String cfName,
java.util.UUID cfId,
java.lang.String version)</pre>
</li>
</ul>
<a name="getWriter(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriter</h4>
<pre>public <a href="../../../../org/apache/cassandra/cache/AutoSavingCache.Writer.html" title="class in org.apache.cassandra.cache">AutoSavingCache.Writer</a> getWriter(int keysToSave)</pre>
</li>
</ul>
<a name="scheduleSaving(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scheduleSaving</h4>
<pre>public void scheduleSaving(int savePeriodInSeconds,
int keysToSave)</pre>
</li>
</ul>
<a name="loadSaved(org.apache.cassandra.db.ColumnFamilyStore)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadSaved</h4>
<pre>public int loadSaved(<a href="../../../../org/apache/cassandra/db/ColumnFamilyStore.html" title="class in org.apache.cassandra.db">ColumnFamilyStore</a> cfs)</pre>
</li>
</ul>
<a name="submitWrite(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>submitWrite</h4>
<pre>public java.util.concurrent.Future<?> submitWrite(int keysToSave)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AutoSavingCache.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../org/apache/cassandra/cache/AutoSavingCache.CacheSerializer.html" title="interface in org.apache.cassandra.cache"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/cassandra/cache/AutoSavingCache.html" target="_top">Frames</a></li>
<li><a href="AutoSavingCache.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2014 The Apache Software Foundation</small></p>
</body>
</html>