cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
551 lines (550 loc) • 19.6 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:33 CEST 2014 -->
<title>Memory (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="Memory (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/Memory.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/io/util/MappedFileDataInput.html" title="class in org.apache.cassandra.io.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/io/util/MemoryInputStream.html" title="class in org.apache.cassandra.io.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/io/util/Memory.html" target="_top">Frames</a></li>
<li><a href="Memory.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>Nested | </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.io.util</div>
<h2 title="Class Memory" class="title">Class Memory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.io.util.Memory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/cassandra/cache/RefCountedMemory.html" title="class in org.apache.cassandra.cache">RefCountedMemory</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Memory</span>
extends java.lang.Object</pre>
<div class="block">An off-heap region of memory that must be manually free'd when no longer needed.</div>
</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>
<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 long</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#peer">peer</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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#Memory(long)">Memory</a></strong>(long bytes)</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>static <a href="../../../../../org/apache/cassandra/io/util/Memory.html" title="class in org.apache.cassandra.io.util">Memory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#allocate(long)">allocate</a></strong>(long bytes)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.nio.ByteBuffer[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#asByteBuffers()">asByteBuffers</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/io/util/Memory.html" title="class in org.apache.cassandra.io.util">Memory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#copy(long)">copy</a></strong>(long newSize)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object o)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#free()">free</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#getByte(long)">getByte</a></strong>(long offset)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#getBytes(long,%20byte[],%20int,%20int)">getBytes</a></strong>(long memoryOffset,
byte[] buffer,
int bufferOffset,
int count)</code>
<div class="block">Transfers count bytes from Memory starting at memoryOffset to buffer starting at bufferOffset</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#getInt(long)">getInt</a></strong>(long offset)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#getLong(long)">getLong</a></strong>(long offset)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#put(long,%20org.apache.cassandra.io.util.Memory,%20long,%20long)">put</a></strong>(long trgOffset,
<a href="../../../../../org/apache/cassandra/io/util/Memory.html" title="class in org.apache.cassandra.io.util">Memory</a> memory,
long srcOffset,
long size)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#setByte(long,%20byte)">setByte</a></strong>(long offset,
byte b)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#setBytes(long,%20byte[],%20int,%20int)">setBytes</a></strong>(long memoryOffset,
byte[] buffer,
int bufferOffset,
int count)</code>
<div class="block">Transfers count bytes from buffer to Memory</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#setBytes(long,%20java.nio.ByteBuffer)">setBytes</a></strong>(long memoryOffset,
java.nio.ByteBuffer buffer)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#setInt(long,%20int)">setInt</a></strong>(long offset,
int l)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#setLong(long,%20long)">setLong</a></strong>(long offset,
long l)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#setMemory(long,%20long,%20byte)">setMemory</a></strong>(long offset,
long bytes,
byte b)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/io/util/Memory.html#size()">size</a></strong>()</code> </td>
</tr>
</table>
<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, 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="peer">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>peer</h4>
<pre>protected long peer</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Memory(long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Memory</h4>
<pre>protected Memory(long bytes)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="allocate(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allocate</h4>
<pre>public static <a href="../../../../../org/apache/cassandra/io/util/Memory.html" title="class in org.apache.cassandra.io.util">Memory</a> allocate(long bytes)</pre>
</li>
</ul>
<a name="setByte(long, byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setByte</h4>
<pre>public void setByte(long offset,
byte b)</pre>
</li>
</ul>
<a name="setMemory(long, long, byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMemory</h4>
<pre>public void setMemory(long offset,
long bytes,
byte b)</pre>
</li>
</ul>
<a name="setLong(long, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLong</h4>
<pre>public void setLong(long offset,
long l)</pre>
</li>
</ul>
<a name="setInt(long, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInt</h4>
<pre>public void setInt(long offset,
int l)</pre>
</li>
</ul>
<a name="setBytes(long, java.nio.ByteBuffer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBytes</h4>
<pre>public void setBytes(long memoryOffset,
java.nio.ByteBuffer buffer)</pre>
</li>
</ul>
<a name="setBytes(long, byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBytes</h4>
<pre>public void setBytes(long memoryOffset,
byte[] buffer,
int bufferOffset,
int count)</pre>
<div class="block">Transfers count bytes from buffer to Memory</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>memoryOffset</code> - start offset in the memory</dd><dd><code>buffer</code> - the data buffer</dd><dd><code>bufferOffset</code> - start offset of the buffer</dd><dd><code>count</code> - number of bytes to transfer</dd></dl>
</li>
</ul>
<a name="getByte(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByte</h4>
<pre>public byte getByte(long offset)</pre>
</li>
</ul>
<a name="getLong(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLong</h4>
<pre>public long getLong(long offset)</pre>
</li>
</ul>
<a name="getInt(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInt</h4>
<pre>public int getInt(long offset)</pre>
</li>
</ul>
<a name="getBytes(long, byte[], int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBytes</h4>
<pre>public void getBytes(long memoryOffset,
byte[] buffer,
int bufferOffset,
int count)</pre>
<div class="block">Transfers count bytes from Memory starting at memoryOffset to buffer starting at bufferOffset</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>memoryOffset</code> - start offset in the memory</dd><dd><code>buffer</code> - the data buffer</dd><dd><code>bufferOffset</code> - start offset of the buffer</dd><dd><code>count</code> - number of bytes to transfer</dd></dl>
</li>
</ul>
<a name="put(long, org.apache.cassandra.io.util.Memory, long, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public void put(long trgOffset,
<a href="../../../../../org/apache/cassandra/io/util/Memory.html" title="class in org.apache.cassandra.io.util">Memory</a> memory,
long srcOffset,
long size)</pre>
</li>
</ul>
<a name="copy(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre>public <a href="../../../../../org/apache/cassandra/io/util/Memory.html" title="class in org.apache.cassandra.io.util">Memory</a> copy(long newSize)</pre>
</li>
</ul>
<a name="free()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>free</h4>
<pre>public void free()</pre>
</li>
</ul>
<a name="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public long size()</pre>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public boolean equals(java.lang.Object o)</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code> in class <code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="asByteBuffers()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>asByteBuffers</h4>
<pre>public java.nio.ByteBuffer[] asByteBuffers()</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/Memory.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/io/util/MappedFileDataInput.html" title="class in org.apache.cassandra.io.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/io/util/MemoryInputStream.html" title="class in org.apache.cassandra.io.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/io/util/Memory.html" target="_top">Frames</a></li>
<li><a href="Memory.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>Nested | </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>