com.datastax.oss.protocol.internal

Class Frame

java.lang.Object

com.datastax.oss.protocol.internal.Frame

public class Frame
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
boolean	beta Whether the frame was decoded from a payload that has the USE_BETA flag.
int	compressedSize The binary size of the compressed frame (including the header).
Map<String,ByteBuffer>	customPayload
Message	message
static Map<String,ByteBuffer>	NO_PAYLOAD
int	protocolVersion
int	size The binary size of the frame in bytes (including the header).
int	streamId
boolean	tracing Whether the frame was decoded from a payload that has the TRACING flag.
UUID	tracingId
List<String>	warnings

Constructor Summary

Constructors

Constructor and Description
Frame(int protocolVersion, boolean beta, int streamId, boolean tracing, UUID tracingId, int size, int compressedSize, Map<String,ByteBuffer> customPayload, List<String> warnings, Message message) This constructor is mainly intended for internal use by the frame codec.
Frame(int protocolVersion, boolean beta, int streamId, boolean tracing, UUID tracingId, Map<String,ByteBuffer> customPayload, List<String> warnings, Message message) Deprecated. maintain compatibility while Simulacron upgrades to the latest native-protocol.

Method Summary

Modifier and Type	Method and Description
static Frame	forRequest(int protocolVersion, int streamId, boolean tracing, Map<String,ByteBuffer> customPayload, Message message)
static Frame	forResponse(int protocolVersion, int streamId, UUID tracingId, Map<String,ByteBuffer> customPayload, List<String> warnings, Message message)

Methods inherited from class java.lang.Object

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

Field Detail

NO_PAYLOAD

public static final Map<String,ByteBuffer> NO_PAYLOAD

protocolVersion

public final int protocolVersion

beta

public final boolean beta

Whether the frame was decoded from a payload that has the USE_BETA flag. For encoding this is ignored, the codec will set the flag if protocolVersion == ProtocolConstants.Version.Beta, regardless of this field.

streamId

public final int streamId

tracingId

public final UUID tracingId

tracing

public final boolean tracing

Whether the frame was decoded from a payload that has the TRACING flag. For encoding this is ignored, the codec will set the flag if the tracingId != null, regardless of this field.

size

public final int size

The binary size of the frame in bytes (including the header).

This is exposed for information purposes, and only for instances returned by the frame decoder. Otherwise, it is set to -1.

compressedSize

public final int compressedSize

The binary size of the compressed frame (including the header).

This is exposed for information purposes, and only for instances returned by the frame decoder, if compression is enabled and the frame was compressed when it was received. Otherwise, it is set to -1.

customPayload

public final Map<String,ByteBuffer> customPayload

warnings

public final List<String> warnings

message

public final Message message

Constructor Detail

Frame

public Frame(int protocolVersion,
             boolean beta,
             int streamId,
             boolean tracing,
             UUID tracingId,
             int size,
             int compressedSize,
             Map<String,ByteBuffer> customPayload,
             List<String> warnings,
             Message message)

This constructor is mainly intended for internal use by the frame codec. If you want to build frames to pass for encoding, see forRequest(int, int, boolean, Map, Message) or forResponse(int, int, UUID, Map, List, Message).

Frame

@Deprecated
public Frame(int protocolVersion,
                         boolean beta,
                         int streamId,
                         boolean tracing,
                         UUID tracingId,
                         Map<String,ByteBuffer> customPayload,
                         List<String> warnings,
                         Message message)

Deprecated. maintain compatibility while Simulacron upgrades to the latest native-protocol.

Method Detail

forRequest

public static Frame forRequest(int protocolVersion,
                               int streamId,
                               boolean tracing,
                               Map<String,ByteBuffer> customPayload,
                               Message message)

forResponse

public static Frame forResponse(int protocolVersion,
                                int streamId,
                                UUID tracingId,
                                Map<String,ByteBuffer> customPayload,
                                List<String> warnings,
                                Message message)