com.datastax.oss.protocol.internal

Class FrameCodec<B>

java.lang.Object

com.datastax.oss.protocol.internal.FrameCodec<B>

public class FrameCodec<B>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FrameCodec.CodecGroup Intermediary class to pass request/response codecs to the frame codec.

Field Summary

Fields

Modifier and Type	Field and Description
static int	V3_ENCODED_HEADER_SIZE The header size for protocol v3 and above.

Constructor Summary

Constructors

Constructor and Description
FrameCodec(PrimitiveCodec<B> primitiveCodec, Compressor<B> compressor, FrameCodec.CodecGroup... codecGroups)

Method Summary

Modifier and Type	Method and Description
Frame	decode(B source) Decodes the next frame from the given buffer.
int	decodeBodySize(B source) Decodes the size of the body of the next frame contained in the given buffer.
static <B> FrameCodec<B>	defaultClient(PrimitiveCodec<B> primitiveCodec, Compressor<B> compressor) Builds a new instance with the default codecs for a client (encoding requests, decoding responses).
static <B> FrameCodec<B>	defaultServer(PrimitiveCodec<B> primitiveCodec, Compressor<B> compressor) Builds a new instance with the default codecs for a server (decoding requests, encoding responses).
B	encode(Frame frame) Allocates a new buffer and encodes the given frame into it.
int	encodedBodySize(Frame frame) How many bytes are needed to encode the given frame's body (message + tracing id, custom payload and/or warnings if relevant).
int	encodedHeaderSize(Frame frame) How many bytes are needed to encode the given frame's header.
void	encodeInto(Frame frame, int bodySize, B dest) Encodes the given frame into an existing buffer.

Methods inherited from class java.lang.Object

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

Field Detail

V3_ENCODED_HEADER_SIZE

public static final int V3_ENCODED_HEADER_SIZE

The header size for protocol v3 and above. Currently, it is the same for all supported protocol versions.

If you have a reference to an instance of this class, encodedHeaderSize(Frame) is a more future-proof way to get this information.

See Also:

Constant Field Values

Constructor Detail

FrameCodec

public FrameCodec(PrimitiveCodec<B> primitiveCodec,
                  Compressor<B> compressor,
                  FrameCodec.CodecGroup... codecGroups)

Method Detail

defaultClient

public static <B> FrameCodec<B> defaultClient(PrimitiveCodec<B> primitiveCodec,
                                              Compressor<B> compressor)

Builds a new instance with the default codecs for a client (encoding requests, decoding responses).

defaultServer

public static <B> FrameCodec<B> defaultServer(PrimitiveCodec<B> primitiveCodec,
                                              Compressor<B> compressor)

Builds a new instance with the default codecs for a server (decoding requests, encoding responses).

encode

public B encode(Frame frame)

Allocates a new buffer and encodes the given frame into it.

encodeInto

public void encodeInto(Frame frame,
                       int bodySize,
                       B dest)

Encodes the given frame into an existing buffer.

Note that this method never compresses the frame body; it is intended for protocol v5+, where multiple frames are concatenated into a single buffer and compressed together, instead of individually.

The caller is responsible for ensuring that the buffer has enough space remaining, that is: encodedHeaderSize(Frame) + encodedBodySize(Frame) bytes.

Parameters:

bodySize - the body size to use in the header, if available. This is just an optimization because the caller may already know it if it has performed the size check above. If not, pass a negative value, and it will be recomputed.

encodedHeaderSize

public int encodedHeaderSize(Frame frame)

How many bytes are needed to encode the given frame's header.

encodedBodySize

public int encodedBodySize(Frame frame)

How many bytes are needed to encode the given frame's body (message + tracing id, custom payload and/or warnings if relevant).

decodeBodySize

public int decodeBodySize(B source)

Decodes the size of the body of the next frame contained in the given buffer.

The buffer must contain at least the frame's header. This method performs a relative read, it will not consume any data from the buffer.

decode

public Frame decode(B source)

Decodes the next frame from the given buffer.

The buffer must contain at least one complete frame. It may be followed by additional data (which will not be consumed).