com.devexperts.qd.qtp

Class OutputStreamComposer

java.lang.Object

com.devexperts.qd.qtp.AbstractMessageVisitor

com.devexperts.qd.qtp.AbstractQTPComposer

com.devexperts.qd.qtp.BinaryQTPComposer

com.devexperts.qd.qtp.OutputStreamComposer

All Implemented Interfaces:

DataVisitor, RecordSink, MessageVisitor, SubscriptionVisitor

public class OutputStreamComposer
extends BinaryQTPComposer

This composer stores filtered data and subscription to a specified OutputStream in binary QTP format. It serves as a convenience object that combines output buffer and composer together. It can be used as MessageVisitor, DataVisitor, SubscriptionVisitor or RecordSink to store snapshots of data to a file, which can be later read with InputStreamParser. For more advanced file writing capabilities (to write event tapes) see com.devexperts.qd.qtp.file package.

See Also:

InputStreamParser

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
OutputStreamComposer(DataScheme scheme) Creates composer for specified data scheme.

Method Summary

Modifier and Type	Method and Description
void	append(RecordCursor cursor) Adds a record to this sink from the specified RecordCursor.
void	composeCollector(QDCollector collector) Composes specified collector.
void	composeEndpoint(QDEndpoint endpoint) Composes all collectors defined in specified endpoint.
void	flush() Finishes current message if any and sends all composed bytes to output stream.
void	flushMessage() Finishes current message.
int	getRecordCounter() Returns number of composed records since initialization.
boolean	hasCapacity() Returns true when this message's capacity had not exceeded threshold yet.
void	init(OutputStream output, SubscriptionFilter filter) Initializes composer with a specified output stream and subscription filter parameters.
void	setMessageType(MessageType messageType) Sets message type for subsequent data or subscription.
void	setOutput(com.devexperts.io.BufferedOutput output) Changes output for the composed messages.
boolean	visitData(DataProvider provider, MessageType type) This method consumes available data for data message from the given data provider.
void	visitIntField(DataIntField field, int value) Visits next Int-field within current record.
void	visitObjField(DataObjField field, Object value) Visits next Obj-field within current record.
boolean	visitOtherMessage(int messageType, byte[] messageBytes, int offset, int length) This method consumes other message type.
void	visitRecord(DataRecord record, int cipher, String symbol) Visits next record.
void	visitRecord(DataRecord record, int cipher, String symbol, long time) Visits next record.
boolean	visitSubscription(SubscriptionProvider provider, MessageType type) This method consumes available subscription for subscription message from the given subscription provider.

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

describeRecord, finishComposingMessage, getRequestedRecordDesc, isWideDecimalSupported, writeDescribeProtocolMessage, writeEmptyHeartbeatMessage, writeEventTimeSequence, writeField, writeHeartbeatMessage, writeHistorySubscriptionTime, writeIntField, writeMessageHeader, writeObjField, writeOtherMessageBody, writeRecordHeader, writeRecordPayload

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

abortMessageAndRethrow, beginMessage, beginRecord, compose, composeDescribeProtocol, composeEmptyHeartbeat, composeHeartbeatMessage, composeTimeProgressReport, endMessage, getEventTimeSequence, getMessagePayloadSize, inMessage, resetSession, setOptSet, setStats, setWriteEventTimeSequence, setWriteHeartbeat, undoWriteMessageHeaderStateChange, visitDescribeProtocol, visitHeartbeat

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

OutputStreamComposer

public OutputStreamComposer(DataScheme scheme)

Creates composer for specified data scheme. You must init this composer before using it.

Method Detail

setOutput

public void setOutput(com.devexperts.io.BufferedOutput output)

Changes output for the composed messages. This implementation throws UnsupportedOperationException.

Overrides:

setOutput in class AbstractQTPComposer

Parameters:

output - output for the composed messages.

init

public void init(OutputStream output,
                 SubscriptionFilter filter)

Initializes composer with a specified output stream and subscription filter parameters. It resets session state from previous composing session. Both parameters could be null to deinitialize composer and release object references.

composeEndpoint

public void composeEndpoint(QDEndpoint endpoint)

Composes all collectors defined in specified endpoint.

composeCollector

public void composeCollector(QDCollector collector)

Composes specified collector.

setMessageType

public void setMessageType(MessageType messageType)

Sets message type for subsequent data or subscription.

getRecordCounter

public int getRecordCounter()

Returns number of composed records since initialization.

flush

public void flush()

Finishes current message if any and sends all composed bytes to output stream.

Specified by:

flush in interface RecordSink

Overrides:

flush in class AbstractQTPComposer

flushMessage

public void flushMessage()

Finishes current message.

visitData

public boolean visitData(DataProvider provider,
                         MessageType type)

Description copied from class: AbstractQTPComposer

This method consumes available data for data message from the given data provider.

Specified by:

visitData in interface MessageVisitor

Overrides:

visitData in class AbstractQTPComposer

Returns:

false if it had retrieved all available data and no data left, true if more data remains to be consumed.

visitSubscription

public boolean visitSubscription(SubscriptionProvider provider,
                                 MessageType type)

Description copied from class: AbstractQTPComposer

This method consumes available subscription for subscription message from the given subscription provider.

Specified by:

visitSubscription in interface MessageVisitor

Overrides:

visitSubscription in class AbstractQTPComposer

Returns:

false if it had retrieved all available subscription and nothing left, true if more subscription remains to be consumed.

visitOtherMessage

public boolean visitOtherMessage(int messageType,
                                 byte[] messageBytes,
                                 int offset,
                                 int length)

Description copied from class: AbstractQTPComposer

This method consumes other message type.

Specified by:

visitOtherMessage in interface MessageVisitor

Overrides:

visitOtherMessage in class AbstractQTPComposer

Parameters:

messageType - integer number representing a type of the message.

messageBytes - array containing message data.

offset - position of the first byte of message data in messageBytes array.

length - number of bytes starting from offset in messageBytes related to this message.

Returns:

true if the whole message was not processed because the visitor is full and false if the message was successfully processed.

hasCapacity

public boolean hasCapacity()

Description copied from class: AbstractQTPComposer

Returns true when this message's capacity had not exceeded threshold yet. This implementation always returns true when invoked not in message, e.g. the overall number of bytes composed is not checked by this implementation (only the message size for data and subscription messages is limited). Each call to AbstractQTPComposer.beginMessage(MessageType) resets capacity threshold for a new message.

Specified by:

hasCapacity in interface DataVisitor

Specified by:

hasCapacity in interface RecordSink

Specified by:

hasCapacity in interface SubscriptionVisitor

Overrides:

hasCapacity in class AbstractQTPComposer

append

public void append(RecordCursor cursor)

Description copied from interface: RecordSink

Adds a record to this sink from the specified RecordCursor.

Specified by:

append in interface RecordSink

Overrides:

append in class AbstractQTPComposer

visitRecord

public void visitRecord(DataRecord record,
                        int cipher,
                        String symbol,
                        long time)

Description copied from interface: SubscriptionVisitor

Visits next record.

Specified by:

visitRecord in interface RecordSink

Specified by:

visitRecord in interface SubscriptionVisitor

Overrides:

visitRecord in class AbstractQTPComposer

visitRecord

public void visitRecord(DataRecord record,
                        int cipher,
                        String symbol)

Description copied from interface: DataVisitor

Visits next record.

Specified by:

visitRecord in interface DataVisitor

Specified by:

visitRecord in interface RecordSink

Overrides:

visitRecord in class AbstractQTPComposer

visitIntField

public void visitIntField(DataIntField field,
                          int value)

Description copied from interface: DataVisitor

Visits next Int-field within current record.

Specified by:

visitIntField in interface DataVisitor

Specified by:

visitIntField in interface RecordSink

Overrides:

visitIntField in class AbstractQTPComposer

visitObjField

public void visitObjField(DataObjField field,
                          Object value)

Description copied from interface: DataVisitor

Visits next Obj-field within current record.

Specified by:

visitObjField in interface DataVisitor

Specified by:

visitObjField in interface RecordSink

Overrides:

visitObjField in class AbstractQTPComposer