UNPKG

cassandra-server

Version:

A thin Javascript wrapper around Apache Cassandra to provide out of the box server support

359 lines (358 loc) 14.4 kB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:31 CEST 2014 --> <title>RefCountedMemory (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="RefCountedMemory (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/RefCountedMemory.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><a href="../../../../org/apache/cassandra/cache/KeyCacheKey.html" title="class in org.apache.cassandra.cache"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cache/RowCacheKey.html" title="class 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/RefCountedMemory.html" target="_top">Frames</a></li> <li><a href="RefCountedMemory.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:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li><a href="#fields_inherited_from_class_org.apache.cassandra.io.util.Memory">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 RefCountedMemory" class="title">Class RefCountedMemory</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../../../org/apache/cassandra/io/util/Memory.html" title="class in org.apache.cassandra.io.util">org.apache.cassandra.io.util.Memory</a></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.cache.RefCountedMemory</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.lang.AutoCloseable</dd> </dl> <hr> <br> <pre>public class <span class="strong">RefCountedMemory</span> extends <a href="../../../../org/apache/cassandra/io/util/Memory.html" title="class in org.apache.cassandra.io.util">Memory</a> implements java.lang.AutoCloseable</pre> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field_summary"> <!-- --> </a> <h3>Field Summary</h3> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.io.util.Memory"> <!-- --> </a> <h3>Fields inherited from class&nbsp;org.apache.cassandra.io.util.<a href="../../../../org/apache/cassandra/io/util/Memory.html" title="class in org.apache.cassandra.io.util">Memory</a></h3> <code><a href="../../../../org/apache/cassandra/io/util/Memory.html#peer">peer</a></code></li> </ul> </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">&nbsp;</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/RefCountedMemory.html#RefCountedMemory(long)">RefCountedMemory</a></strong>(long&nbsp;size)</code>&nbsp;</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">&nbsp;</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>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/RefCountedMemory.html#close()">close</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="../../../../org/apache/cassandra/cache/RefCountedMemory.html" title="class in org.apache.cassandra.cache">RefCountedMemory</a></code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/RefCountedMemory.html#copy(long)">copy</a></strong>(long&nbsp;newSize)</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/RefCountedMemory.html#free()">free</a></strong>()</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/RefCountedMemory.html#reference()">reference</a></strong>()</code>&nbsp;</td> </tr> <tr class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><strong><a href="../../../../org/apache/cassandra/cache/RefCountedMemory.html#unreference()">unreference</a></strong>()</code> <div class="block">decrement reference count.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.io.util.Memory"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.io.util.<a href="../../../../org/apache/cassandra/io/util/Memory.html" title="class in org.apache.cassandra.io.util">Memory</a></h3> <code><a href="../../../../org/apache/cassandra/io/util/Memory.html#allocate(long)">allocate</a>, <a href="../../../../org/apache/cassandra/io/util/Memory.html#asByteBuffers()">asByteBuffers</a>, <a href="../../../../org/apache/cassandra/io/util/Memory.html#equals(java.lang.Object)">equals</a>, <a href="../../../../org/apache/cassandra/io/util/Memory.html#getByte(long)">getByte</a>, <a href="../../../../org/apache/cassandra/io/util/Memory.html#getBytes(long,%20byte[],%20int,%20int)">getBytes</a>, <a href="../../../../org/apache/cassandra/io/util/Memory.html#getInt(long)">getInt</a>, <a href="../../../../org/apache/cassandra/io/util/Memory.html#getLong(long)">getLong</a>, <a href="../../../../org/apache/cassandra/io/util/Memory.html#put(long,%20org.apache.cassandra.io.util.Memory,%20long,%20long)">put</a>, <a href="../../../../org/apache/cassandra/io/util/Memory.html#setByte(long,%20byte)">setByte</a>, <a href="../../../../org/apache/cassandra/io/util/Memory.html#setBytes(long,%20byte[],%20int,%20int)">setBytes</a>, <a href="../../../../org/apache/cassandra/io/util/Memory.html#setBytes(long,%20java.nio.ByteBuffer)">setBytes</a>, <a href="../../../../org/apache/cassandra/io/util/Memory.html#setInt(long,%20int)">setInt</a>, <a href="../../../../org/apache/cassandra/io/util/Memory.html#setLong(long,%20long)">setLong</a>, <a href="../../../../org/apache/cassandra/io/util/Memory.html#setMemory(long,%20long,%20byte)">setMemory</a>, <a href="../../../../org/apache/cassandra/io/util/Memory.html#size()">size</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&nbsp;java.lang.Object</h3> <code>clone, 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"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="RefCountedMemory(long)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>RefCountedMemory</h4> <pre>public&nbsp;RefCountedMemory(long&nbsp;size)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="reference()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>reference</h4> <pre>public&nbsp;boolean&nbsp;reference()</pre> <dl><dt><span class="strong">Returns:</span></dt><dd>true if we succeed in referencing before the reference count reaches zero. (A FreeableMemory object is created with a reference count of one.)</dd></dl> </li> </ul> <a name="unreference()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>unreference</h4> <pre>public&nbsp;void&nbsp;unreference()</pre> <div class="block">decrement reference count. if count reaches zero, the object is freed.</div> </li> </ul> <a name="copy(long)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>copy</h4> <pre>public&nbsp;<a href="../../../../org/apache/cassandra/cache/RefCountedMemory.html" title="class in org.apache.cassandra.cache">RefCountedMemory</a>&nbsp;copy(long&nbsp;newSize)</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/io/util/Memory.html#copy(long)">copy</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/cassandra/io/util/Memory.html" title="class in org.apache.cassandra.io.util">Memory</a></code></dd> </dl> </li> </ul> <a name="free()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>free</h4> <pre>public&nbsp;void&nbsp;free()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../org/apache/cassandra/io/util/Memory.html#free()">free</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/cassandra/io/util/Memory.html" title="class in org.apache.cassandra.io.util">Memory</a></code></dd> </dl> </li> </ul> <a name="close()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>close</h4> <pre>public&nbsp;void&nbsp;close()</pre> <dl> <dt><strong>Specified by:</strong></dt> <dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd> </dl> </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/RefCountedMemory.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><a href="../../../../org/apache/cassandra/cache/KeyCacheKey.html" title="class in org.apache.cassandra.cache"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../org/apache/cassandra/cache/RowCacheKey.html" title="class 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/RefCountedMemory.html" target="_top">Frames</a></li> <li><a href="RefCountedMemory.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:&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li> <li><a href="#fields_inherited_from_class_org.apache.cassandra.io.util.Memory">Field</a>&nbsp;|&nbsp;</li> <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail:&nbsp;</li> <li>Field&nbsp;|&nbsp;</li> <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</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 &copy; 2014 The Apache Software Foundation</small></p> </body> </html>