com.devexperts.qd.qtp

Class BinaryQTPComposer

java.lang.Object

com.devexperts.qd.qtp.AbstractMessageVisitor

com.devexperts.qd.qtp.AbstractQTPComposer

com.devexperts.qd.qtp.BinaryQTPComposer

All Implemented Interfaces:

DataVisitor, RecordSink, MessageVisitor, SubscriptionVisitor

Direct Known Subclasses:

ByteArrayComposer, OutputStreamComposer

public class BinaryQTPComposer
extends AbstractQTPComposer

Composes QTP messages in binary format into byte stream. The output for this composer must be configured with AbstractQTPComposer.setOutput(BufferedOutput) method immediately after construction.

See Also:

AbstractQTPComposer, BinaryQTPParser

Field Summary

Fields inherited from class com.devexperts.qd.qtp.AbstractQTPComposer

currentMessageType, msg, optSet, scheme, stats, writeEventTimeSequence, writeHeartbeat

Fields inherited from interface com.devexperts.qd.ng.RecordSink

VOID

Constructor Summary

Constructors

Constructor and Description
BinaryQTPComposer(DataScheme scheme, boolean describeRecords) Constructs binary composer.

Method Summary

Modifier and Type	Method and Description
protected void	describeRecord(DataRecord record)
protected void	finishComposingMessage(com.devexperts.io.BufferedOutput out) Performs actions necessary to finish composing a message (for example, inserts message size, inserts records descriptions if necessary).
protected BinaryRecordDesc	getRequestedRecordDesc(DataRecord record)
protected boolean	isWideDecimalSupported()
protected void	writeDescribeProtocolMessage(com.devexperts.io.BufferedOutput out, ProtocolDescriptor descriptor)
protected void	writeEmptyHeartbeatMessage(com.devexperts.io.BufferedOutput out)
protected void	writeEventTimeSequence(long eventTimeSequence)
protected void	writeField(DataField field, RecordCursor cursor)
protected void	writeHeartbeatMessage(com.devexperts.io.BufferedOutput out, HeartbeatPayload heartbeatPayload)
protected void	writeHistorySubscriptionTime(DataRecord record, long time)
protected void	writeIntField(DataIntField field, int value)
protected void	writeMessageHeader(MessageType messageType) Composes header for a message of a specific type.
protected void	writeObjField(DataObjField field, Object value)
protected void	writeOtherMessageBody(byte[] messageBytes, int offset, int length)
protected int	writeRecordHeader(DataRecord record, int cipher, String symbol, int eventFlags)
protected void	writeRecordPayload(RecordCursor cursor, int eventFlags)

Methods inherited from class com.devexperts.qd.qtp.AbstractQTPComposer

abortMessageAndRethrow, append, beginMessage, beginRecord, compose, composeDescribeProtocol, composeEmptyHeartbeat, composeHeartbeatMessage, composeTimeProgressReport, endMessage, flush, getEventTimeSequence, getMessagePayloadSize, hasCapacity, inMessage, resetSession, setOptSet, setOutput, setStats, setWriteEventTimeSequence, setWriteHeartbeat, undoWriteMessageHeaderStateChange, visitData, visitDescribeProtocol, visitHeartbeat, visitIntField, visitObjField, visitOtherMessage, visitRecord, visitRecord, visitSubscription

Methods inherited from class com.devexperts.qd.qtp.AbstractMessageVisitor

visitHistoryAddSubscription, visitHistoryData, visitHistoryRemoveSubscription, visitStreamAddSubscription, visitStreamData, visitStreamRemoveSubscription, visitTickerAddSubscription, visitTickerData, visitTickerRemoveSubscription

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryQTPComposer

public BinaryQTPComposer(DataScheme scheme,
                         boolean describeRecords)

Constructs binary composer. You must setOutput before using this composer.

Parameters:

scheme - the data scheme.

describeRecords - if true, then describe messages are composed right before records are used for the first time and this instance keeps its state and shall not be reused for different communication sessions. See AbstractQTPComposer.resetSession().

Method Detail

writeDescribeProtocolMessage

protected void writeDescribeProtocolMessage(com.devexperts.io.BufferedOutput out,
                                            ProtocolDescriptor descriptor)
                                     throws IOException

Overrides:

writeDescribeProtocolMessage in class AbstractQTPComposer

Throws:

IOException

writeEmptyHeartbeatMessage

protected void writeEmptyHeartbeatMessage(com.devexperts.io.BufferedOutput out)
                                   throws IOException

Overrides:

writeEmptyHeartbeatMessage in class AbstractQTPComposer

Throws:

IOException

writeHeartbeatMessage

protected void writeHeartbeatMessage(com.devexperts.io.BufferedOutput out,
                                     HeartbeatPayload heartbeatPayload)
                              throws IOException

Overrides:

writeHeartbeatMessage in class AbstractQTPComposer

Throws:

IOException

writeRecordHeader

protected int writeRecordHeader(DataRecord record,
                                int cipher,
                                String symbol,
                                int eventFlags)
                         throws IOException

Specified by:

writeRecordHeader in class AbstractQTPComposer

Throws:

IOException

writeRecordPayload

protected void writeRecordPayload(RecordCursor cursor,
                                  int eventFlags)
                           throws IOException

Overrides:

writeRecordPayload in class AbstractQTPComposer

Throws:

IOException

writeHistorySubscriptionTime

protected void writeHistorySubscriptionTime(DataRecord record,
                                            long time)
                                     throws IOException

Specified by:

writeHistorySubscriptionTime in class AbstractQTPComposer

Throws:

IOException

writeEventTimeSequence

protected void writeEventTimeSequence(long eventTimeSequence)
                               throws IOException

Overrides:

writeEventTimeSequence in class AbstractQTPComposer

Throws:

IOException

writeIntField

protected void writeIntField(DataIntField field,
                             int value)
                      throws IOException

Specified by:

writeIntField in class AbstractQTPComposer

Throws:

IOException

writeObjField

protected void writeObjField(DataObjField field,
                             Object value)
                      throws IOException

Specified by:

writeObjField in class AbstractQTPComposer

Throws:

IOException

writeField

protected void writeField(DataField field,
                          RecordCursor cursor)
                   throws IOException

Specified by:

writeField in class AbstractQTPComposer

Throws:

IOException

writeOtherMessageBody

protected void writeOtherMessageBody(byte[] messageBytes,
                                     int offset,
                                     int length)
                              throws IOException

Overrides:

writeOtherMessageBody in class AbstractQTPComposer

Throws:

IOException

writeMessageHeader

protected void writeMessageHeader(MessageType messageType)
                           throws IOException

Description copied from class: AbstractQTPComposer

Composes header for a message of a specific type.

Specified by:

writeMessageHeader in class AbstractQTPComposer

Parameters:

messageType - the message type.

Throws:

IOException - never. If it has been thrown then it means an internal error.

finishComposingMessage

protected void finishComposingMessage(com.devexperts.io.BufferedOutput out)
                               throws IOException

Description copied from class: AbstractQTPComposer

Performs actions necessary to finish composing a message (for example, inserts message size, inserts records descriptions if necessary). Used by BinaryQTPComposer. This implementation just copies message from AbstractQTPComposer.msg to out.

Overrides:

finishComposingMessage in class AbstractQTPComposer

Throws:

IOException

getRequestedRecordDesc

protected BinaryRecordDesc getRequestedRecordDesc(DataRecord record)

isWideDecimalSupported

protected boolean isWideDecimalSupported()

describeRecord

protected void describeRecord(DataRecord record)
                       throws IOException

Overrides:

describeRecord in class AbstractQTPComposer

Throws:

IOException