biz.onixs.sbe

Class ByteDecoder

java.lang.Object

biz.onixs.sbe.ByteDecoder

public abstract class ByteDecoder
extends Object

Base API for SBE message encoding and decoding.

Constructor Summary

Constructors

Constructor and Description
ByteDecoder()

Method Summary

Modifier and Type	Method and Description
abstract Object	createEmptyComposite(String sbeCompositeTypeName, Object ref) Creates (or fills) an object for a custom composite type by SBE type name.
abstract <T> T	createEmptyCustomComposite(Class<T> cls) Creates an empty instance that implements a custom composite interface.
abstract IMessage	decode(byte[] data, int offset, int size) Decodes message bytes and returns a message object bound to the provided buffer.
abstract IMessage	decodePreCreatedMessage(byte[] data, int offset, int size) Decodes message bytes using reusable pre-created message instances.
abstract IMessage	encode(byte[] data, int offset, int size, int templateId) Initializes a message for encoding in the provided buffer.
abstract IMessage	encodePreCreatedMessage(byte[] data, int offset, int size, int templateId) Initializes a pre-created reusable message instance for encoding.
abstract boolean	isNullComposite(String sbeCompositeTypeName, Object ref) Checks whether a custom composite value is null for the specified SBE type.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteDecoder

public ByteDecoder()

Method Detail

decode

public abstract IMessage decode(byte[] data,
                                int offset,
                                int size)

Decodes message bytes and returns a message object bound to the provided buffer.

The implementation reads framing header and message header, resolves template, binds the result object to the input bytes, and returns it.

Parameters:

data - byte buffer with SBE packet data.

offset - start offset of packet in buffer.

size - number of available bytes starting from offset.

Returns:

decoded message object, or null when there is not enough data.

decodePreCreatedMessage

public abstract IMessage decodePreCreatedMessage(byte[] data,
                                                 int offset,
                                                 int size)

Decodes message bytes using reusable pre-created message instances.

This method may return a reused object on subsequent calls. Do not keep returned instance across threads unless you clone it.

Parameters:

data - byte buffer with SBE packet data.

offset - start offset of packet in buffer.

size - number of available bytes starting from offset.

Returns:

decoded message object, or null when there is not enough data.

encode

public abstract IMessage encode(byte[] data,
                                int offset,
                                int size,
                                int templateId)

Initializes a message for encoding in the provided buffer.

The implementation selects template by ID, initializes headers, and prepares repeating groups/var-data structures.

Parameters:

data - target buffer for message bytes.

offset - start offset of message in buffer.

size - number of available bytes starting from offset.

templateId - message template ID.

Returns:

initialized message object, or null when there is not enough space.

encodePreCreatedMessage

public abstract IMessage encodePreCreatedMessage(byte[] data,
                                                 int offset,
                                                 int size,
                                                 int templateId)

Initializes a pre-created reusable message instance for encoding.

This method may return a reused object on subsequent calls. Do not keep returned instance across threads unless you clone it.

Parameters:

data - target buffer for message bytes.

offset - start offset of message in buffer.

size - number of available bytes starting from offset.

templateId - message template ID.

Returns:

initialized message object, or null when there is not enough space.

createEmptyCustomComposite

public abstract <T> T createEmptyCustomComposite(Class<T> cls)

Creates an empty instance that implements a custom composite interface.

The interface class must be passed to ByteDecoderFactory.create(MessageSchema, Class[]) when decoder is created.

Type Parameters:

T - custom composite type.

Parameters:

cls - custom composite interface or class.

Returns:

new instance of custom composite implementation.

createEmptyComposite

public abstract Object createEmptyComposite(String sbeCompositeTypeName,
                                            Object ref)

Creates (or fills) an object for a custom composite type by SBE type name.

If ref == null, implementation creates a new object. If ref != null, implementation fills and returns the same object.

When ref != null, its Java type must match requested composite type.

Parameters:

sbeCompositeTypeName - composite type name as defined in SBE template.

ref - optional object instance to fill.

Returns:

new object or the same ref instance after filling.

isNullComposite

public abstract boolean isNullComposite(String sbeCompositeTypeName,
                                        Object ref)

Checks whether a custom composite value is null for the specified SBE type.

Parameters:

sbeCompositeTypeName - SBE composite type name.

ref - object to check.

Returns:

true if object contains null representation.