Package org.apache.cassandra.streaming.messages

Class StreamMessage

java.lang.Object

org.apache.cassandra.streaming.messages.StreamMessage

Direct Known Subclasses:

CompleteMessage, IncomingStreamMessage, KeepAliveMessage, OutgoingStreamMessage, PrepareAckMessage, PrepareSynAckMessage, PrepareSynMessage, ReceivedMessage, SessionFailedMessage, StreamInitMessage

public abstract class StreamMessage
extends java.lang.Object

StreamMessage is an abstract base class that every messages in streaming protocol inherit. Every message carries message type(StreamMessage.Type) and streaming protocol version byte.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StreamMessage.Serializer<V extends StreamMessage>	StreamMessage serializer
static class	StreamMessage.Type	StreamMessage types

Field Summary

Fields

Modifier and Type	Field	Description
StreamMessage.Type	type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StreamMessage(StreamMessage.Type type)

Method Summary

Modifier and Type	Method	Description
static StreamMessage	deserialize(DataInputPlus in, int version)
StreamSession	getOrCreateAndAttachInboundSession(StreamingChannel channel, int messagingVersion)	Get or create a StreamSession based on this stream message data: not all stream messages support this, so the default implementation just throws an exception.
int	getPriority()
static void	serialize(StreamMessage message, StreamingDataOutputPlus out, int version, StreamSession session)
static long	serializedSize(StreamMessage message, int version)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

type

public final StreamMessage.Type type

Constructor Detail

StreamMessage

protected StreamMessage(StreamMessage.Type type)

Method Detail

serialize

public static void serialize(StreamMessage message,
                             StreamingDataOutputPlus out,
                             int version,
                             StreamSession session)
                      throws java.io.IOException

Throws:

java.io.IOException

serializedSize

public static long serializedSize(StreamMessage message,
                                  int version)
                           throws java.io.IOException

Throws:

java.io.IOException

deserialize

public static StreamMessage deserialize(DataInputPlus in,
                                        int version)
                                 throws java.io.IOException

Throws:

java.io.IOException

getPriority

public int getPriority()

Returns:

priority of this message. higher value, higher priority.

getOrCreateAndAttachInboundSession

public StreamSession getOrCreateAndAttachInboundSession(StreamingChannel channel,
                                                        int messagingVersion)

Get or create a StreamSession based on this stream message data: not all stream messages support this, so the default implementation just throws an exception.