UNPKG

cassandra-server

Version:

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

341 lines (340 loc) 15.6 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:30 CEST 2014 --> <title>CompressedStreamReader (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="CompressedStreamReader (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/CompressedStreamReader.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/streaming/compress/CompressedInputStream.html" title="class in org.apache.cassandra.streaming.compress"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/streaming/compress/CompressedStreamWriter.html" title="class in org.apache.cassandra.streaming.compress"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/streaming/compress/CompressedStreamReader.html" target="_top">Frames</a></li> <li><a href="CompressedStreamReader.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="#field_summary">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><a href="#field_detail">Field</a>&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.streaming.compress</div> <h2 title="Class CompressedStreamReader" class="title">Class CompressedStreamReader</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../../../../org/apache/cassandra/streaming/StreamReader.html" title="class in org.apache.cassandra.streaming">org.apache.cassandra.streaming.StreamReader</a></li> <li> <ul class="inheritance"> <li>org.apache.cassandra.streaming.compress.CompressedStreamReader</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="strong">CompressedStreamReader</span> extends <a href="../../../../../org/apache/cassandra/streaming/StreamReader.html" title="class in org.apache.cassandra.streaming">StreamReader</a></pre> <div class="block">StreamReader that reads from streamed compressed SSTable</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">&nbsp;</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/streaming/compress/CompressionInfo.html" title="class in org.apache.cassandra.streaming.compress">CompressionInfo</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/streaming/compress/CompressedStreamReader.html#compressionInfo">compressionInfo</a></strong></code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="fields_inherited_from_class_org.apache.cassandra.streaming.StreamReader"> <!-- --> </a> <h3>Fields inherited from class&nbsp;org.apache.cassandra.streaming.<a href="../../../../../org/apache/cassandra/streaming/StreamReader.html" title="class in org.apache.cassandra.streaming">StreamReader</a></h3> <code><a href="../../../../../org/apache/cassandra/streaming/StreamReader.html#cfId">cfId</a>, <a href="../../../../../org/apache/cassandra/streaming/StreamReader.html#desc">desc</a>, <a href="../../../../../org/apache/cassandra/streaming/StreamReader.html#estimatedKeys">estimatedKeys</a>, <a href="../../../../../org/apache/cassandra/streaming/StreamReader.html#inputVersion">inputVersion</a>, <a href="../../../../../org/apache/cassandra/streaming/StreamReader.html#repairedAt">repairedAt</a>, <a href="../../../../../org/apache/cassandra/streaming/StreamReader.html#sections">sections</a>, <a href="../../../../../org/apache/cassandra/streaming/StreamReader.html#session">session</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/streaming/compress/CompressedStreamReader.html#CompressedStreamReader(org.apache.cassandra.streaming.messages.FileMessageHeader,%20org.apache.cassandra.streaming.StreamSession)">CompressedStreamReader</a></strong>(<a href="../../../../../org/apache/cassandra/streaming/messages/FileMessageHeader.html" title="class in org.apache.cassandra.streaming.messages">FileMessageHeader</a>&nbsp;header, <a href="../../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a>&nbsp;session)</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><a href="../../../../../org/apache/cassandra/io/sstable/SSTableWriter.html" title="class in org.apache.cassandra.io.sstable">SSTableWriter</a></code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/streaming/compress/CompressedStreamReader.html#read(java.nio.channels.ReadableByteChannel)">read</a></strong>(java.nio.channels.ReadableByteChannel&nbsp;channel)</code>&nbsp;</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected long</code></td> <td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/streaming/compress/CompressedStreamReader.html#totalSize()">totalSize</a></strong>()</code>&nbsp;</td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_org.apache.cassandra.streaming.StreamReader"> <!-- --> </a> <h3>Methods inherited from class&nbsp;org.apache.cassandra.streaming.<a href="../../../../../org/apache/cassandra/streaming/StreamReader.html" title="class in org.apache.cassandra.streaming">StreamReader</a></h3> <code><a href="../../../../../org/apache/cassandra/streaming/StreamReader.html#createWriter(org.apache.cassandra.db.ColumnFamilyStore,%20long,%20long)">createWriter</a>, <a href="../../../../../org/apache/cassandra/streaming/StreamReader.html#drain(java.io.InputStream,%20long)">drain</a>, <a href="../../../../../org/apache/cassandra/streaming/StreamReader.html#writeRow(org.apache.cassandra.io.sstable.SSTableWriter,%20java.io.DataInput,%20org.apache.cassandra.db.ColumnFamilyStore)">writeRow</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, 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="compressionInfo"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>compressionInfo</h4> <pre>protected final&nbsp;<a href="../../../../../org/apache/cassandra/streaming/compress/CompressionInfo.html" title="class in org.apache.cassandra.streaming.compress">CompressionInfo</a> compressionInfo</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="CompressedStreamReader(org.apache.cassandra.streaming.messages.FileMessageHeader, org.apache.cassandra.streaming.StreamSession)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>CompressedStreamReader</h4> <pre>public&nbsp;CompressedStreamReader(<a href="../../../../../org/apache/cassandra/streaming/messages/FileMessageHeader.html" title="class in org.apache.cassandra.streaming.messages">FileMessageHeader</a>&nbsp;header, <a href="../../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a>&nbsp;session)</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="read(java.nio.channels.ReadableByteChannel)"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>read</h4> <pre>public&nbsp;<a href="../../../../../org/apache/cassandra/io/sstable/SSTableWriter.html" title="class in org.apache.cassandra.io.sstable">SSTableWriter</a>&nbsp;read(java.nio.channels.ReadableByteChannel&nbsp;channel) throws java.io.IOException</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/streaming/StreamReader.html#read(java.nio.channels.ReadableByteChannel)">read</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cassandra/streaming/StreamReader.html" title="class in org.apache.cassandra.streaming">StreamReader</a></code></dd> <dt><span class="strong">Parameters:</span></dt><dd><code>channel</code> - where this reads data from</dd> <dt><span class="strong">Returns:</span></dt><dd>SSTable transferred</dd> <dt><span class="strong">Throws:</span></dt> <dd><code>java.io.IOException</code> - if reading the remote sstable fails. Will throw an RTE if local write fails.</dd></dl> </li> </ul> <a name="totalSize()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>totalSize</h4> <pre>protected&nbsp;long&nbsp;totalSize()</pre> <dl> <dt><strong>Overrides:</strong></dt> <dd><code><a href="../../../../../org/apache/cassandra/streaming/StreamReader.html#totalSize()">totalSize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/cassandra/streaming/StreamReader.html" title="class in org.apache.cassandra.streaming">StreamReader</a></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/CompressedStreamReader.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/streaming/compress/CompressedInputStream.html" title="class in org.apache.cassandra.streaming.compress"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../org/apache/cassandra/streaming/compress/CompressedStreamWriter.html" title="class in org.apache.cassandra.streaming.compress"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/cassandra/streaming/compress/CompressedStreamReader.html" target="_top">Frames</a></li> <li><a href="CompressedStreamReader.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="#field_summary">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><a href="#field_detail">Field</a>&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>