cassandra-server
Version:
A thin Javascript wrapper around Apache Cassandra to provide out of the box server support
390 lines (388 loc) • 18.5 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Sun Sep 07 15:29:30 CEST 2014 -->
<title>StreamMessage (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="StreamMessage (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/StreamMessage.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/messages/StreamInitMessage.html" title="class in org.apache.cassandra.streaming.messages"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.Serializer.html" title="interface in org.apache.cassandra.streaming.messages"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/streaming/messages/StreamMessage.html" target="_top">Frames</a></li>
<li><a href="StreamMessage.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.streaming.messages</div>
<h2 title="Class StreamMessage" class="title">Class StreamMessage</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.cassandra.streaming.messages.StreamMessage</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/streaming/messages/CompleteMessage.html" title="class in org.apache.cassandra.streaming.messages">CompleteMessage</a>, <a href="../../../../../org/apache/cassandra/streaming/messages/IncomingFileMessage.html" title="class in org.apache.cassandra.streaming.messages">IncomingFileMessage</a>, <a href="../../../../../org/apache/cassandra/streaming/messages/OutgoingFileMessage.html" title="class in org.apache.cassandra.streaming.messages">OutgoingFileMessage</a>, <a href="../../../../../org/apache/cassandra/streaming/messages/PrepareMessage.html" title="class in org.apache.cassandra.streaming.messages">PrepareMessage</a>, <a href="../../../../../org/apache/cassandra/streaming/messages/ReceivedMessage.html" title="class in org.apache.cassandra.streaming.messages">ReceivedMessage</a>, <a href="../../../../../org/apache/cassandra/streaming/messages/RetryMessage.html" title="class in org.apache.cassandra.streaming.messages">RetryMessage</a>, <a href="../../../../../org/apache/cassandra/streaming/messages/SessionFailedMessage.html" title="class in org.apache.cassandra.streaming.messages">SessionFailedMessage</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">StreamMessage</span>
extends java.lang.Object</pre>
<div class="block">StreamMessage is an abstract base class that every messages in streaming protocol inherit.
Every message carries message type(<a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.Type.html" title="enum in org.apache.cassandra.streaming.messages"><code>StreamMessage.Type</code></a>) and streaming protocol version byte.</div>
</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/streaming/messages/StreamMessage.Serializer.html" title="interface in org.apache.cassandra.streaming.messages">StreamMessage.Serializer</a><<a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.Serializer.html" title="type parameter in StreamMessage.Serializer">V</a> extends <a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.html" title="class in org.apache.cassandra.streaming.messages">StreamMessage</a>></strong></code>
<div class="block">StreamMessage serializer</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.Type.html" title="enum in org.apache.cassandra.streaming.messages">StreamMessage.Type</a></strong></code>
<div class="block">StreamMessage types</div>
</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>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.html#CURRENT_VERSION">CURRENT_VERSION</a></strong></code>
<div class="block">Streaming protocol version</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.Type.html" title="enum in org.apache.cassandra.streaming.messages">StreamMessage.Type</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.html#type">type</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/streaming/messages/StreamMessage.html#StreamMessage(org.apache.cassandra.streaming.messages.StreamMessage.Type)">StreamMessage</a></strong>(<a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.Type.html" title="enum in org.apache.cassandra.streaming.messages">StreamMessage.Type</a> type)</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/streaming/messages/StreamMessage.html" title="class in org.apache.cassandra.streaming.messages">StreamMessage</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.html#deserialize(java.nio.channels.ReadableByteChannel,%20int,%20org.apache.cassandra.streaming.StreamSession)">deserialize</a></strong>(java.nio.channels.ReadableByteChannel in,
int version,
<a href="../../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a> session)</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.html#getPriority()">getPriority</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.html#serialize(org.apache.cassandra.streaming.messages.StreamMessage,%20org.apache.cassandra.io.util.DataOutputStreamAndChannel,%20int,%20org.apache.cassandra.streaming.StreamSession)">serialize</a></strong>(<a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.html" title="class in org.apache.cassandra.streaming.messages">StreamMessage</a> message,
<a href="../../../../../org/apache/cassandra/io/util/DataOutputStreamAndChannel.html" title="class in org.apache.cassandra.io.util">DataOutputStreamAndChannel</a> out,
int version,
<a href="../../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a> session)</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, 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="CURRENT_VERSION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CURRENT_VERSION</h4>
<pre>public static final int CURRENT_VERSION</pre>
<div class="block">Streaming protocol version</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.cassandra.streaming.messages.StreamMessage.CURRENT_VERSION">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="type">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>type</h4>
<pre>public final <a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.Type.html" title="enum in org.apache.cassandra.streaming.messages">StreamMessage.Type</a> type</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StreamMessage(org.apache.cassandra.streaming.messages.StreamMessage.Type)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StreamMessage</h4>
<pre>protected StreamMessage(<a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.Type.html" title="enum in org.apache.cassandra.streaming.messages">StreamMessage.Type</a> type)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="serialize(org.apache.cassandra.streaming.messages.StreamMessage, org.apache.cassandra.io.util.DataOutputStreamAndChannel, int, org.apache.cassandra.streaming.StreamSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>serialize</h4>
<pre>public static void serialize(<a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.html" title="class in org.apache.cassandra.streaming.messages">StreamMessage</a> message,
<a href="../../../../../org/apache/cassandra/io/util/DataOutputStreamAndChannel.html" title="class in org.apache.cassandra.io.util">DataOutputStreamAndChannel</a> out,
int version,
<a href="../../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a> session)
throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="deserialize(java.nio.channels.ReadableByteChannel, int, org.apache.cassandra.streaming.StreamSession)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deserialize</h4>
<pre>public static <a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.html" title="class in org.apache.cassandra.streaming.messages">StreamMessage</a> deserialize(java.nio.channels.ReadableByteChannel in,
int version,
<a href="../../../../../org/apache/cassandra/streaming/StreamSession.html" title="class in org.apache.cassandra.streaming">StreamSession</a> session)
throws java.io.IOException</pre>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="getPriority()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPriority</h4>
<pre>public int getPriority()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>priority of this message. higher value, higher priority.</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/StreamMessage.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/messages/StreamInitMessage.html" title="class in org.apache.cassandra.streaming.messages"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cassandra/streaming/messages/StreamMessage.Serializer.html" title="interface in org.apache.cassandra.streaming.messages"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cassandra/streaming/messages/StreamMessage.html" target="_top">Frames</a></li>
<li><a href="StreamMessage.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>