com.devexperts.qd.qtp

Class OutputStreamMessageVisitor

java.lang.Object

com.devexperts.qd.qtp.AbstractMessageVisitor

com.devexperts.qd.qtp.OutputStreamMessageVisitor

All Implemented Interfaces:

MessageListener, MessageVisitor, Closeable, Flushable, AutoCloseable

public class OutputStreamMessageVisitor
extends AbstractMessageVisitor
implements MessageListener, Closeable, Flushable

Writes messages into a specified OutputStream using a specified QTP composer. It typically used to format text onto the console. This class is thread-safe. It contains its own synchronization and can be used by multiple threads.

Constructor Summary

Constructors

Constructor and Description
OutputStreamMessageVisitor(OutputStream out, AbstractQTPComposer composer, boolean autoFlush) Creates output stream message visitor writing to a specified output stream with a specified composer.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
void	messagesAvailable(MessageProvider provider) Notifies this listener that some messages are available in the specified QTP message provider.
boolean	visitData(DataProvider provider, MessageType message) This method consumes available data for data message from the given data provider.
void	visitHeartbeat(HeartbeatPayload heartbeatPayload)
boolean	visitOtherMessage(int messageType, byte[] messageBytes, int offset, int length) This method consumes other message type.
boolean	visitSubscription(SubscriptionProvider provider, MessageType message) This method consumes available subscription for subscription message from the given subscription provider.

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

visitDescribeProtocol, 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

OutputStreamMessageVisitor

public OutputStreamMessageVisitor(OutputStream out,
                                  AbstractQTPComposer composer,
                                  boolean autoFlush)

Creates output stream message visitor writing to a specified output stream with a specified composer.

Parameters:

out - the output stream.

composer - the composer.

autoFlush - if true, then flushes composed bytes to an underlying output stream after each packet.

Method Detail

visitHeartbeat

public void visitHeartbeat(HeartbeatPayload heartbeatPayload)

Specified by:

visitHeartbeat in interface MessageVisitor

Overrides:

visitHeartbeat in class AbstractMessageVisitor

visitData

public boolean visitData(DataProvider provider,
                         MessageType message)

Description copied from class: AbstractMessageVisitor

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

Specified by:

visitData in interface MessageVisitor

Specified by:

visitData in class AbstractMessageVisitor

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 message)

Description copied from class: AbstractMessageVisitor

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

Specified by:

visitSubscription in interface MessageVisitor

Specified by:

visitSubscription in class AbstractMessageVisitor

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: AbstractMessageVisitor

This method consumes other message type. This implementation always return true.

Specified by:

visitOtherMessage in interface MessageVisitor

Overrides:

visitOtherMessage in class AbstractMessageVisitor

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.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException

messagesAvailable

public void messagesAvailable(MessageProvider provider)

Description copied from interface: MessageListener

Notifies this listener that some messages are available in the specified QTP message provider.

Specified by:

messagesAvailable in interface MessageListener