|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MessageVisitor
The MessageVisitor
defines protocol of serial access to messages
using Visitor pattern. It allows message provider with complicated storage
effectively give away messages to external consumer.
All visiting methods must return false
if they have retrieved
all intended data and true
otherwise. The later usually happens
because the visitor has no more capacity to retrieve data.
Because visited data is being sent in a serial order, it is a good idea to consult data priorities before deciding the order of data visiting.
Implementations of this interface shall extend AbstractMessageVisitor
.
Method Detail |
---|
void visitDescribeProtocol(ProtocolDescriptor descriptor)
boolean visitData(DataProvider provider, MessageType message)
false
if it had retrieved all available data and no data left,
true
if more data remains to be consumedboolean visitSubscription(SubscriptionProvider provider, MessageType message)
false
if it had retrieved all available subscription and nothing left,
true
if more subscription remains to be consumed@Deprecated boolean visitTickerData(DataProvider provider)
visitData(DataProvider provider, MessageType MessageType.TICKER_DATA)
instead
MessageType.TICKER_DATA
message from
the given data provider.
false
if it had retrieved all available data and no data left,
true
if more data remains to be consumed@Deprecated boolean visitTickerAddSubscription(SubscriptionProvider provider)
visitSubscription(SubscriptionProvider provider, MessageType MessageType.TICKER_ADD_SUBSCRIPTION)
instead
MessageType.TICKER_ADD_SUBSCRIPTION
message from
the given subscription provider.
false
if it had retrieved all available subscription and nothing left,
true
if more subscription remains to be consumed@Deprecated boolean visitTickerRemoveSubscription(SubscriptionProvider provider)
visitSubscription(SubscriptionProvider provider, MessageType MessageType.TICKER_REMOVE_SUBSCRIPTION)
instead
MessageType.TICKER_REMOVE_SUBSCRIPTION
message from
the given subscription provider.
false
if it had retrieved all available subscription and nothing left,
true
if more subscription remains to be consumed@Deprecated boolean visitStreamData(DataProvider provider)
visitData(DataProvider provider, MessageType MessageType.STREAM_DATA)
instead
MessageType.STREAM_DATA
message from
the given data provider.
false
if it had retrieved all available data and no data left,
true
if more data remains to be consumed@Deprecated boolean visitStreamAddSubscription(SubscriptionProvider provider)
visitSubscription(SubscriptionProvider provider, MessageType MessageType.STREAM_ADD_SUBSCRIPTION)
instead
MessageType.STREAM_ADD_SUBSCRIPTION
message from
the given subscription provider.
false
if it had retrieved all available subscription and nothing left,
true
if more subscription remains to be consumed@Deprecated boolean visitStreamRemoveSubscription(SubscriptionProvider provider)
visitSubscription(SubscriptionProvider provider, MessageType MessageType.STREAM_REMOVE_SUBSCRIPTION)
instead
MessageType.STREAM_REMOVE_SUBSCRIPTION
message from
the given subscription provider.
false
if it had retrieved all available subscription and nothing left,
true
if more subscription remains to be consumed@Deprecated boolean visitHistoryData(DataProvider provider)
visitData(DataProvider provider, MessageType MessageType.HISTORY_DATA)
instead
MessageType.HISTORY_DATA
message from
the given data provider.
false
if it had retrieved all available data and no data left,
true
if more data remains to be consumed@Deprecated boolean visitHistoryAddSubscription(SubscriptionProvider provider)
visitSubscription(SubscriptionProvider provider, MessageType MessageType.HISTORY_ADD_SUBSCRIPTION)
instead
MessageType.HISTORY_ADD_SUBSCRIPTION
message from
the given subscription provider.
false
if it had retrieved all available subscription and nothing left,
true
if more subscription remains to be consumed@Deprecated boolean visitHistoryRemoveSubscription(SubscriptionProvider provider)
visitSubscription(SubscriptionProvider provider, MessageType MessageType.HISTORY_REMOVE_SUBSCRIPTION)
instead
MessageType.HISTORY_REMOVE_SUBSCRIPTION
message from
the given subscription provider.
false
if it had retrieved all available subscription and nothing left,
true
if more subscription remains to be consumedboolean visitOtherMessage(int messageType, byte[] messageBytes, int offset, int length)
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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |