biz.onixs.sbe

Interface IMessage

All Superinterfaces:

Cloneable, IFieldSet

All Known Implementing Classes:

Message

public interface IMessage
extends IFieldSet, Cloneable

FIX message.

Field Summary

Fields inherited from interface biz.onixs.sbe.IFieldSet

DefaultSeparator

Method Summary

Modifier and Type	Method and Description
IMessage	clone() Creates a copy of the message instance, including part of underlying byte array with message data.
int	getBinarySize() Size of the buffer, available for the message.
byte[]	getBuffer() Byte array, which contains the message data.
int	getDynamicOffset() Offset of the variable length data.
int	getFixedBlockLength() Returns length of the fixed-size fields block appeared before first repeating group.
Object	getMessageHeader() Returns message header.
String	getMessageName() Returns name of the message by the SBE template.
int	getMsgSize() Returns message size.
int	getOffset() The message offset in the buffer.
String	getSemanticType() Returns message semantic type (FIX type).
int	getTemplateId() Returns message template id.
void	load(byte[] data, int offset, int size) Loads header fields and initialize repeating groups and VarDataField fields.

Methods inherited from interface biz.onixs.sbe.IFieldSet

contains, createEmptyStandardComposite, createNullDecimal, createNullMonthYear, createNullTimestamp, dataTags, fieldTags, getBoolean, getByte, getBytes, getChar, getCustomComposite, getDecimal, getDecimal, getGroup, getInt, getLong, getMonthYear, getMonthYear, getParent, getShort, getStatelessComposite, getString, getTimestamp, getTimestamp, getUnsignedByte, getUnsignedInt, getUnsignedLong, getUnsignedShort, getValuePtr, getVarData, getVersion, groupTags, hasFieldTag, hasGroupTag, hasTag, hasVarDataTag, init, isNullDecimal, isNullMonthYear, isNullStandardComposite, isNullTimestamp, load, reset, setBoolean, setByte, setByte, setBytes, setChar, setCustomComposite, setDecimal, setInt, setLong, setMonthYear, setShort, setShort, setString, setTimestamp, setUnsignedByte, setUnsignedByte, setUnsignedInt, setUnsignedLong, setUnsignedShort, setVarData, tagName, toFixString, toString, tryGetBoolean, tryGetByte, tryGetBytes, tryGetChar, tryGetCustomComposite, tryGetDecimal, tryGetGroup, tryGetInt, tryGetLong, tryGetMonthYear, tryGetShort, tryGetString, tryGetTimestamp, tryGetUnsignedByte, tryGetUnsignedInt, tryGetUnsignedLong, tryGetUnsignedShort, tryGetValuePtr, tryGetVarData

Method Detail

getTemplateId

int getTemplateId()

Returns message template id.

Returns:

message template id

getSemanticType

String getSemanticType()

Returns message semantic type (FIX type).

Returns:

message semantic type

getDynamicOffset

int getDynamicOffset()

Offset of the variable length data.

Returns offset of the variable length data (repeating groups and/or variable length fields).

Returns:

Offset of the variable length data.

getMsgSize

int getMsgSize()

Returns message size.

Returns size of the message with all headers: Simple Open Framing Header and the message header.

Returns:

the message size.

getBinarySize

int getBinarySize()

Size of the buffer, available for the message.

Returns size of the buffer, that is available for message data.

Returns:

size of the message buffer.

getOffset

int getOffset()

The message offset in the buffer.

Returns offset of the message beginning in the message buffer (see getBuffer()). The 'message beginning' means first byte of the Simple Open Framing Header that prepends the SBE message.

Returns:

the message offset in the buffer

getBuffer

byte[] getBuffer()

Byte array, which contains the message data.

Returns byte array that contains the message data including all headers. This buffer is attached to the message during IFieldSet.init(byte[], int, int), load(byte[], int, int), or by one of the ByteDecoder operations.

Returns:

byte array, which contains the message data

clone

IMessage clone()

Creates a copy of the message instance, including part of underlying byte array with message data.

Returns:

a copy of the message.

getFixedBlockLength

int getFixedBlockLength()

Returns length of the fixed-size fields block appeared before first repeating group.

Returns:

length of fixed-size block.

load

void load(byte[] data,
          int offset,
          int size)

Loads header fields and initialize repeating groups and VarDataField fields. Version is detected by the header content.

Parameters:

data - byte array, which contains field set data

offset - field set offset in the buffer

size - size of the buffer, available for field set

getMessageName

String getMessageName()

Returns name of the message by the SBE template. The name of the message is selected as first non-null value: - Attribute "name" of appropriate SBE template; - Semantic type of the message; - String representation of the template id prepended bit 'ID:' prefix.

Returns:

Name of the message

getMessageHeader

Object getMessageHeader()

Returns message header.

The message header class must be attached as a custom composite.

Returns:

Message header of the current message.