MessageAdapter (QD Core API 3.352)

java.lang.Object
- com.devexperts.qd.qtp.MessageConsumerAdapter
- - com.devexperts.qd.qtp.MessageAdapter

All Implemented Interfaces:

MessageAdapterMBean, MessageConsumer, MessageProvider, SymbolCodec.Resolver

Direct Known Subclasses:

AgentAdapter, DistributorAdapter
```
public abstract class MessageAdapter
extends MessageConsumerAdapter
implements MessageProvider, MessageAdapterMBean
```
The MessageAdapter is a basic adapter of some entity to message API. It implements both MessageConsumer and MessageProvider interfaces with default behavior and is recommended for extension by specific adapters (instead of pure implementations of corresponding interfaces). Certain QTP connectors works only with MessageAdapter as a single representative of some entity.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MessageAdapter.AbstractFactory` An abstract message adapter factory for `QDEndpoint` or a bunch of `QDCollector` instances.
`static interface`	`MessageAdapter.CloseListener` The `CloseListener` is used to notify QTP connector that this message adapter was closed by some reason.
`static class`	`MessageAdapter.ConfigurableFactory` An abstract message adapter factory with ability to configure it with arbitrary keys and values.
`static interface`	`MessageAdapter.Factory` The `Factory` performs creation of actual message agents on demand from QTP connector.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTHENTICATION_LOGIN_REQUIRED`
`protected MessageAdapter.CloseListener`	`closeListener`
`protected boolean`	`doNotCloseOnErrors`
`static int`	`MAX_SUPPORTED_MESSAGE_TYPE`
`static int`	`MESSAGE_DESCRIBE_PROTOCOL`
`static int`	`MESSAGE_DESCRIBE_RECORDS`
`static int`	`MESSAGE_DESCRIBE_RESERVED`
`static int`	`MESSAGE_GZIP_COMPRESSION` This value is reserved and can not be used as any message type.
`static int`	`MESSAGE_HEARTBEAT`
`static int`	`MESSAGE_HISTORY_ADD_SUBSCRIPTION`
`static int`	`MESSAGE_HISTORY_DATA`
`static int`	`MESSAGE_HISTORY_REMOVE_SUBSCRIPTION`
`static int`	`MESSAGE_PART`
`static int`	`MESSAGE_RAW_DATA`
`static int`	`MESSAGE_RMI_ADVERTISE_SERVICES`
`static int`	`MESSAGE_RMI_CANCEL`
`static int`	`MESSAGE_RMI_DESCRIBE_OPERATION`
`static int`	`MESSAGE_RMI_DESCRIBE_SUBJECT`
`static int`	`MESSAGE_RMI_ERROR`
`static int`	`MESSAGE_RMI_REQUEST`
`static int`	`MESSAGE_RMI_RESPONSE`
`static int`	`MESSAGE_RMI_RESULT`
`static int`	`MESSAGE_STREAM_ADD_SUBSCRIPTION`
`static int`	`MESSAGE_STREAM_DATA`
`static int`	`MESSAGE_STREAM_REMOVE_SUBSCRIPTION`
`static int`	`MESSAGE_TEXT_FORMAT`
`static int`	`MESSAGE_TICKER_ADD_SUBSCRIPTION`
`static int`	`MESSAGE_TICKER_DATA`
`static int`	`MESSAGE_TICKER_REMOVE_SUBSCRIPTION`
`static int`	`MESSAGE_ZIP_COMPRESSION` This value is reserved and can not be used as any message type.
`protected MessageListener`	`messageListener`
`protected com.devexperts.connector.proto.EndpointId`	`remoteEndpointId`
`protected boolean`	`useDescribeProtocol`

Constructor Summary

Constructors
Modifier Constructor and Description

protected MessageAdapter(QDEndpoint endpoint, QDStats stats)

protected MessageAdapter(QDStats stats)

Constructors
Modifier	Constructor and Description
`protected`	`MessageAdapter(QDEndpoint endpoint, QDStats stats)`
`protected`	`MessageAdapter(QDStats stats)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected boolean`	`addMask(long mask)` Adds bytes from argument mask to internal mask and notifies listeners if internal mask changed.
`protected static long`	`clearMessageMask(long mask, MessageType message)`
`void`	`close()` Closes this adapter.
`protected void`	`closeImpl()`
`com.devexperts.util.TimePeriodInfo`	`getAggregationPeriodInfo()` Returns the aggregation period info for this adapter (programmatic API).
`String`	`getAggregationPeriodInfoStr()` Returns the current effective aggregation period info as JSON.
`static DataScheme`	`getCommonScheme(QDCollector c1, QDCollector c2, QDCollector c3)` Returns common data scheme or throws IllegalArgumentException.
`com.devexperts.util.TypedMap`	`getConnectionVariables()` Returns per-connection variables for this message adapter.
`String`	`getDefaultAggregationPeriod()` Returns the default aggregation period for server-side adapters (AgentAdapter).
`QDEndpoint`	`getEndpoint()` Returns endpoint of this message adapter.
`FieldReplacersCache`	`getFieldReplacer()` Field Replacers specification.
`String`	`getMaxAggregationPeriod()` Returns the maximum aggregation period bound.
`protected static long`	`getMessageMask(MessageType message)`
`String`	`getMinAggregationPeriod()` Returns the minimum aggregation period bound.
`com.devexperts.connector.proto.EndpointId`	`getRemoteEndpointId()`
`protected String`	`getRemoteHostAddress()`
`protected ProtocolOption.Set`	`getRemoteOptSet()`
`String`	`getRequestedAggregationPeriod()` Returns the client-requested aggregation period string.
`abstract DataScheme`	`getScheme()`
`QDStats`	`getStats()`
`String`	`getStatus()`
`void`	`handleCorruptedMessage(int messageTypeId)`
`void`	`handleCorruptedStream()`
`void`	`handleUnknownMessage(int messageTypeId)`
`protected static boolean`	`hasMessageMask(long mask, MessageType message)`
`protected static QDFilter`	`intersectStripes(QDFilter stripe1, QDFilter stripe2)`
`boolean`	`isAlive()` Returns `true` when this message adapter is alive (was `started` and was not `closed` yet).
`boolean`	`isClosed()`
`boolean`	`isMarkedForImmediateRestart()` Returns `true` if this message adapter was marked for immediate restart by underlying connection when it is closed.
`boolean`	`isProtocolDescriptorCompatible(ProtocolDescriptor desc)`
`void`	`markForImmediateRestart()` Marks this message adapter for immediate restart by underlying connection when it is closed.
`long`	`nextRetrieveTime(long currentTime)` Returns next time when `retrieveMessages(MessageVisitor)` shall be called.
`protected void`	`notifyListener()`
`protected void`	`prepareAuthenticateProtocolDescriptor(ProtocolDescriptor desc)`
`void`	`prepareProtocolDescriptor(ProtocolDescriptor desc)` Prepares outgoing protocol descriptor.
`void`	`processDescribeProtocol(ProtocolDescriptor desc)` Deprecated. See `processDescribeProtocol(ProtocolDescriptor, boolean)`
`void`	`processDescribeProtocol(ProtocolDescriptor desc, boolean logDescriptor)` Process incoming protocol descriptor.
`void`	`reinitConfiguration(com.devexperts.auth.AuthSession session)` Updates the adapter configuration.
`protected void`	`reportIgnoredMessage(String reason, MessageType message)`
`protected long`	`retrieveDescribeProtocolMessage(MessageVisitor visitor, long mask)`
`protected long`	`retrieveMask()`
`boolean`	`retrieveMessages(MessageVisitor visitor)` Retrieves accumulated message into specified message visitor.
`void`	`setAggregationPeriodInfo(com.devexperts.util.TimePeriodInfo timePeriodInfo)` Updates the server-applied aggregation period info on this adapter.
`void`	`setAuthRealm(QDAuthRealm authRealm)`
`void`	`setCloseListener(MessageAdapter.CloseListener listener)`
`void`	`setConnectionVariables(com.devexperts.util.TypedMap connectionVariables)` Sets per-connection variables for this message adapter.
`void`	`setDefaultAggregationPeriod(String defaultAggregationPeriod)` Sets the default aggregation period applied when client doesn't specify one.
`void`	`setLoginHandler(QDLoginHandler loginHandler)`
`void`	`setMaxAggregationPeriod(String maxAggregationPeriod)` Sets the maximum bound for aggregation period validation.
`void`	`setMessageListener(MessageListener listener)` Note: this method SHOULD be called before calling .start() - it does not give immediate notification regarding the pending messages
`void`	`setMinAggregationPeriod(String minAggregationPeriod)` Sets the minimum bound for aggregation period validation.
`protected void`	`setRemoteOptSet(ProtocolOption.Set optSet)`
`void`	`setRequestedAggregationPeriod(String requestedAggregationPeriod)` Sets the requested aggregation period to send to the server.
`void`	`start()` Starts this adapter.
`void`	`start(MasterMessageAdapter master)` Same as start, but when slave is true it starts in slave mode.
`protected void`	`startImpl(MasterMessageAdapter master)`
`boolean`	`supportsMixedSubscription()`
`String`	`toString()` Returns description of this `MessageAdapter` for management and logging purposes.
`void`	`useDescribeProtocol()` Invocation of this method causes this `MessageAdapter` to send `DESCRIBE_PROTOCOL` message if it is capable of doing so.

Methods inherited from class com.devexperts.qd.qtp.MessageConsumerAdapter
getSymbol, processData, processHeartbeat, processHistoryAddSubscription, processHistoryData, processHistoryRemoveSubscription, processOtherMessage, processOtherMessage, processRecordSource, processStreamAddSubscription, processStreamData, processStreamRemoveSubscription, processSubscription, processTickerAddSubscription, processTickerData, processTickerRemoveSubscription, processTimeProgressReport

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - AUTHENTICATION_LOGIN_REQUIRED
```
public static final String AUTHENTICATION_LOGIN_REQUIRED
```
    See Also:
    
    Constant Field Values
  - useDescribeProtocol
```
protected boolean useDescribeProtocol
```
  - doNotCloseOnErrors
```
protected boolean doNotCloseOnErrors
```
  - closeListener
```
protected volatile MessageAdapter.CloseListener closeListener
```
  - messageListener
```
protected volatile MessageListener messageListener
```
  - remoteEndpointId
```
protected com.devexperts.connector.proto.EndpointId remoteEndpointId
```
  - MESSAGE_HEARTBEAT
```
public static final int MESSAGE_HEARTBEAT
```
    See Also:
    
    Constant Field Values
  - MESSAGE_DESCRIBE_PROTOCOL
```
public static final int MESSAGE_DESCRIBE_PROTOCOL
```
    See Also:
    
    Constant Field Values
  - MESSAGE_DESCRIBE_RECORDS
```
public static final int MESSAGE_DESCRIBE_RECORDS
```
    See Also:
    
    Constant Field Values
  - MESSAGE_DESCRIBE_RESERVED
```
public static final int MESSAGE_DESCRIBE_RESERVED
```
    See Also:
    
    Constant Field Values
  - MESSAGE_PART
```
public static final int MESSAGE_PART
```
    See Also:
    
    Constant Field Values
  - MESSAGE_RAW_DATA
```
public static final int MESSAGE_RAW_DATA
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TICKER_DATA
```
public static final int MESSAGE_TICKER_DATA
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TICKER_ADD_SUBSCRIPTION
```
public static final int MESSAGE_TICKER_ADD_SUBSCRIPTION
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TICKER_REMOVE_SUBSCRIPTION
```
public static final int MESSAGE_TICKER_REMOVE_SUBSCRIPTION
```
    See Also:
    
    Constant Field Values
  - MESSAGE_STREAM_DATA
```
public static final int MESSAGE_STREAM_DATA
```
    See Also:
    
    Constant Field Values
  - MESSAGE_STREAM_ADD_SUBSCRIPTION
```
public static final int MESSAGE_STREAM_ADD_SUBSCRIPTION
```
    See Also:
    
    Constant Field Values
  - MESSAGE_STREAM_REMOVE_SUBSCRIPTION
```
public static final int MESSAGE_STREAM_REMOVE_SUBSCRIPTION
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HISTORY_DATA
```
public static final int MESSAGE_HISTORY_DATA
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HISTORY_ADD_SUBSCRIPTION
```
public static final int MESSAGE_HISTORY_ADD_SUBSCRIPTION
```
    See Also:
    
    Constant Field Values
  - MESSAGE_HISTORY_REMOVE_SUBSCRIPTION
```
public static final int MESSAGE_HISTORY_REMOVE_SUBSCRIPTION
```
    See Also:
    
    Constant Field Values
  - MESSAGE_RMI_ADVERTISE_SERVICES
```
public static final int MESSAGE_RMI_ADVERTISE_SERVICES
```
    See Also:
    
    Constant Field Values
  - MESSAGE_RMI_DESCRIBE_SUBJECT
```
public static final int MESSAGE_RMI_DESCRIBE_SUBJECT
```
    See Also:
    
    Constant Field Values
  - MESSAGE_RMI_DESCRIBE_OPERATION
```
public static final int MESSAGE_RMI_DESCRIBE_OPERATION
```
    See Also:
    
    Constant Field Values
  - MESSAGE_RMI_REQUEST
```
public static final int MESSAGE_RMI_REQUEST
```
    See Also:
    
    Constant Field Values
  - MESSAGE_RMI_CANCEL
```
public static final int MESSAGE_RMI_CANCEL
```
    See Also:
    
    Constant Field Values
  - MESSAGE_RMI_RESULT
```
public static final int MESSAGE_RMI_RESULT
```
    See Also:
    
    Constant Field Values
  - MESSAGE_RMI_ERROR
```
public static final int MESSAGE_RMI_ERROR
```
    See Also:
    
    Constant Field Values
  - MESSAGE_RMI_RESPONSE
```
public static final int MESSAGE_RMI_RESPONSE
```
    See Also:
    
    Constant Field Values
  - MAX_SUPPORTED_MESSAGE_TYPE
```
public static final int MAX_SUPPORTED_MESSAGE_TYPE
```
    See Also:
    
    Constant Field Values
  - MESSAGE_TEXT_FORMAT
```
public static final int MESSAGE_TEXT_FORMAT
```
    See Also:
    
    Constant Field Values
  - MESSAGE_ZIP_COMPRESSION
```
public static final int MESSAGE_ZIP_COMPRESSION
```
    This value is reserved and can not be used as any message type. It is the second byte of zip file compression.
    
    See Also:
    
    Constant Field Values
  - MESSAGE_GZIP_COMPRESSION
```
public static final int MESSAGE_GZIP_COMPRESSION
```
    This value is reserved and can not be used as any message type. It is the second byte of gzip file compression.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MessageAdapter
```
protected MessageAdapter(QDEndpoint endpoint,
                         QDStats stats)
```
  - MessageAdapter
```
protected MessageAdapter(QDStats stats)
```
- Method Detail
  - getCommonScheme
```
public static DataScheme getCommonScheme(QDCollector c1,
                                         QDCollector c2,
                                         QDCollector c3)
```
    Returns common data scheme or throws IllegalArgumentException. Accepts null parameters.
    
    Parameters:
    
    c1 - QDCollector
    
    c2 - QDCollector
    
    c3 - QDCollector
    
    Returns:
    
    common data scheme.
    
    Throws:
    
    IllegalArgumentException - if collectors have different schemes or all are null.
  - getScheme
```
public abstract DataScheme getScheme()
```
  - getEndpoint
```
public QDEndpoint getEndpoint()
```
    Returns endpoint of this message adapter.
  - getFieldReplacer
```
public FieldReplacersCache getFieldReplacer()
```
    Field Replacers specification.
  - getAggregationPeriodInfo
```
public com.devexperts.util.TimePeriodInfo getAggregationPeriodInfo()
```
    Returns the aggregation period info for this adapter (programmatic API). For AgentAdapter: computed from actual channel shaper values. For DistributorAdapter: received from server.
    
    Returns:
    
    aggregation period info, or TimePeriodInfo.UNKNOWN if not available
  - setAggregationPeriodInfo
```
@Internal
public void setAggregationPeriodInfo(com.devexperts.util.TimePeriodInfo timePeriodInfo)
```
    Updates the server-applied aggregation period info on this adapter. Default no-op; DistributorAdapter overrides with the real assignment, and wrapper adapters (e.g. RMIMessageAdapter) override to forward to their attached adapter.
  - getAggregationPeriodInfoStr
```
public String getAggregationPeriodInfoStr()
```
    Description copied from interface: MessageAdapterMBean
    
    Returns the current effective aggregation period info as JSON. Format: {"min":1.5,"max":2.0} (seconds with decimals).
    
    Specified by:
    
    getAggregationPeriodInfoStr in interface MessageAdapterMBean
  - getRequestedAggregationPeriod
```
public String getRequestedAggregationPeriod()
```
    Description copied from interface: MessageAdapterMBean
    
    Returns the client-requested aggregation period string. Returns null if not set. Applicable for client-side adapters (DistributorAdapter).
    
    Specified by:
    
    getRequestedAggregationPeriod in interface MessageAdapterMBean
  - setRequestedAggregationPeriod
```
public void setRequestedAggregationPeriod(String requestedAggregationPeriod)
```
    Description copied from interface: MessageAdapterMBean
    
    Sets the requested aggregation period to send to the server.
    
    Specified by:
    
    setRequestedAggregationPeriod in interface MessageAdapterMBean
    
    Parameters:
    
    requestedAggregationPeriod - aggregation period string (e.g. "1s"), or "undefined"/empty to reset
  - getDefaultAggregationPeriod
```
public String getDefaultAggregationPeriod()
```
    Description copied from interface: MessageAdapterMBean
    
    Returns the default aggregation period for server-side adapters (AgentAdapter).
    
    Specified by:
    
    getDefaultAggregationPeriod in interface MessageAdapterMBean
  - setDefaultAggregationPeriod
```
public void setDefaultAggregationPeriod(String defaultAggregationPeriod)
```
    Description copied from interface: MessageAdapterMBean
    
    Sets the default aggregation period applied when client doesn't specify one.
    
    Specified by:
    
    setDefaultAggregationPeriod in interface MessageAdapterMBean
  - getMinAggregationPeriod
```
public String getMinAggregationPeriod()
```
    Description copied from interface: MessageAdapterMBean
    
    Returns the minimum aggregation period bound.
    
    Specified by:
    
    getMinAggregationPeriod in interface MessageAdapterMBean
  - setMinAggregationPeriod
```
public void setMinAggregationPeriod(String minAggregationPeriod)
```
    Description copied from interface: MessageAdapterMBean
    
    Sets the minimum bound for aggregation period validation.
    
    Specified by:
    
    setMinAggregationPeriod in interface MessageAdapterMBean
  - getMaxAggregationPeriod
```
public String getMaxAggregationPeriod()
```
    Description copied from interface: MessageAdapterMBean
    
    Returns the maximum aggregation period bound.
    
    Specified by:
    
    getMaxAggregationPeriod in interface MessageAdapterMBean
  - setMaxAggregationPeriod
```
public void setMaxAggregationPeriod(String maxAggregationPeriod)
```
    Description copied from interface: MessageAdapterMBean
    
    Sets the maximum bound for aggregation period validation.
    
    Specified by:
    
    setMaxAggregationPeriod in interface MessageAdapterMBean
  - toString
```
public String toString()
```
    Returns description of this MessageAdapter for management and logging purposes.
    
    Overrides:
    
    toString in class Object
  - notifyListener
```
protected void notifyListener()
```
  - setCloseListener
```
public void setCloseListener(MessageAdapter.CloseListener listener)
```
  - nextRetrieveTime
```
public long nextRetrieveTime(long currentTime)
```
    Returns next time when retrieveMessages(MessageVisitor) shall be called. This method is overridden when a message has to be generated at a certain time in the future. For immediate message delivery use addMask(long), which immediately calls notifyListener() as needed.
    This implementation returns Long.MAX_VALUE.
    
    Parameters:
    
    currentTime - the current value of System.currentTimeMillis()
    
    Returns:
    
    next time when retrieveMessages(MessageVisitor) shall be called even if the mask of messages for immediate delivery is empty.
  - supportsMixedSubscription
```
public boolean supportsMixedSubscription()
```
  - setAuthRealm
```
public void setAuthRealm(QDAuthRealm authRealm)
```
  - setLoginHandler
```
public void setLoginHandler(QDLoginHandler loginHandler)
```
  - getConnectionVariables
```
@Nullable
public com.devexperts.util.TypedMap getConnectionVariables()
```
    Returns per-connection variables for this message adapter.
  - setConnectionVariables
```
public void setConnectionVariables(@Nonnull
                                   com.devexperts.util.TypedMap connectionVariables)
```
    Sets per-connection variables for this message adapter. This method may be invoked only once during a life-time of MessageAdapter.
  - getRemoteHostAddress
```
protected String getRemoteHostAddress()
```
  - getRemoteEndpointId
```
public com.devexperts.connector.proto.EndpointId getRemoteEndpointId()
```
  - useDescribeProtocol
```
public void useDescribeProtocol()
```
    Invocation of this method causes this MessageAdapter to send DESCRIBE_PROTOCOL message if it is capable of doing so. It should be invoked once before calling start(). The code that calls this method shall also consult nextRetrieveTime(long).
  - retrieveDescribeProtocolMessage
```
protected long retrieveDescribeProtocolMessage(MessageVisitor visitor,
                                               long mask)
```
  - reinitConfiguration
```
public void reinitConfiguration(com.devexperts.auth.AuthSession session)
```
    Updates the adapter configuration.
    
    Parameters:
    
    session - the unique session.
  - prepareProtocolDescriptor
```
public void prepareProtocolDescriptor(ProtocolDescriptor desc)
```
    Prepares outgoing protocol descriptor. Implementers should call super.prepareProtocolDescriptor(desc).
    
    Parameters:
    
    desc - outgoing protocol descriptor
  - prepareAuthenticateProtocolDescriptor
```
protected void prepareAuthenticateProtocolDescriptor(ProtocolDescriptor desc)
```
  - processDescribeProtocol
```
public void processDescribeProtocol(ProtocolDescriptor desc,
                                    boolean logDescriptor)
```
    Process incoming protocol descriptor. Implementers should call super.processDescribeProtocol(desc).
    
    Specified by:
    
    processDescribeProtocol in interface MessageConsumer
    
    Overrides:
    
    processDescribeProtocol in class MessageConsumerAdapter
    
    Parameters:
    
    desc - incoming protocol descriptor
    
    logDescriptor - when protocol description shall be logged.
  - processDescribeProtocol
```
public final void processDescribeProtocol(ProtocolDescriptor desc)
```
    Deprecated. See processDescribeProtocol(ProtocolDescriptor, boolean)
    
    Deprecated. Left to force compilation failure for overriding classes.
  - isProtocolDescriptorCompatible
```
public boolean isProtocolDescriptorCompatible(ProtocolDescriptor desc)
```
  - getRemoteOptSet
```
protected ProtocolOption.Set getRemoteOptSet()
```
  - setRemoteOptSet
```
protected void setRemoteOptSet(ProtocolOption.Set optSet)
```
  - getStats
```
public QDStats getStats()
```
  - handleCorruptedStream
```
public void handleCorruptedStream()
```
    Specified by:
    
    handleCorruptedStream in interface MessageConsumer
    
    Overrides:
    
    handleCorruptedStream in class MessageConsumerAdapter
  - handleCorruptedMessage
```
public void handleCorruptedMessage(int messageTypeId)
```
    Specified by:
    
    handleCorruptedMessage in interface MessageConsumer
    
    Overrides:
    
    handleCorruptedMessage in class MessageConsumerAdapter
  - handleUnknownMessage
```
public void handleUnknownMessage(int messageTypeId)
```
    Specified by:
    
    handleUnknownMessage in interface MessageConsumer
    
    Overrides:
    
    handleUnknownMessage in class MessageConsumerAdapter
  - retrieveMessages
```
public boolean retrieveMessages(MessageVisitor visitor)
```
    Description copied from interface: MessageProvider
    
    Retrieves accumulated message into specified message visitor. Returns true if some messages still remains in the provider or false if all accumulated messages were retrieved.
    
    Specified by:
    
    retrieveMessages in interface MessageProvider
  - setMessageListener
```
public void setMessageListener(MessageListener listener)
```
    Note: this method SHOULD be called before calling .start() - it does not give immediate notification regarding the pending messages
    
    Specified by:
    
    setMessageListener in interface MessageProvider
  - isAlive
```
public final boolean isAlive()
```
    Returns true when this message adapter is alive (was started and was not closed yet).
    
    Specified by:
    
    isAlive in interface MessageAdapterMBean
  - isClosed
```
public final boolean isClosed()
```
  - getStatus
```
public final String getStatus()
```
  - start
```
public final void start()
```
    Starts this adapter. Each adapter can be started only once. Closed adapter can not be started again.
  - start
```
public final void start(MasterMessageAdapter master)
```
    Same as start, but when slave is true it starts in slave mode. In slave mode there is a master message adapter that prepares and sends protocol descriptor using prepareProtocolDescriptor method of this adapter.
  - close
```
public final void close()
```
    Closes this adapter. Once closed, adapter can not be started again and is useless.
    
    Specified by:
    
    close in interface MessageAdapterMBean
  - markForImmediateRestart
```
public void markForImmediateRestart()
```
    Marks this message adapter for immediate restart by underlying connection when it is closed.
  - isMarkedForImmediateRestart
```
public boolean isMarkedForImmediateRestart()
```
    Returns true if this message adapter was marked for immediate restart by underlying connection when it is closed.
  - startImpl
```
protected void startImpl(MasterMessageAdapter master)
```
  - closeImpl
```
protected void closeImpl()
```
  - reportIgnoredMessage
```
protected void reportIgnoredMessage(String reason,
                                    MessageType message)
```
  - retrieveMask
```
protected final long retrieveMask()
```
  - addMask
```
protected final boolean addMask(long mask)
```
    Adds bytes from argument mask to internal mask and notifies listeners if internal mask changed.
    
    Parameters:
    
    mask - changed bytes mask.
    
    Returns:
    
    true, if internal mask changed and adapter is alive.
  - getMessageMask
```
protected static long getMessageMask(MessageType message)
```
  - hasMessageMask
```
protected static boolean hasMessageMask(long mask,
                                        MessageType message)
```
  - clearMessageMask
```
protected static long clearMessageMask(long mask,
                                       MessageType message)
```
  - intersectStripes
```
protected static QDFilter intersectStripes(QDFilter stripe1,
                                           QDFilter stripe2)
```

Class MessageAdapter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

AUTHENTICATION_LOGIN_REQUIRED

useDescribeProtocol

doNotCloseOnErrors

closeListener

messageListener

remoteEndpointId

MESSAGE_HEARTBEAT

MESSAGE_DESCRIBE_PROTOCOL

MESSAGE_DESCRIBE_RECORDS

MESSAGE_DESCRIBE_RESERVED

MESSAGE_PART

MESSAGE_RAW_DATA

MESSAGE_TICKER_DATA

MESSAGE_TICKER_ADD_SUBSCRIPTION

MESSAGE_TICKER_REMOVE_SUBSCRIPTION

MESSAGE_STREAM_DATA

MESSAGE_STREAM_ADD_SUBSCRIPTION

MESSAGE_STREAM_REMOVE_SUBSCRIPTION

MESSAGE_HISTORY_DATA

MESSAGE_HISTORY_ADD_SUBSCRIPTION

MESSAGE_HISTORY_REMOVE_SUBSCRIPTION

MESSAGE_RMI_ADVERTISE_SERVICES

MESSAGE_RMI_DESCRIBE_SUBJECT

MESSAGE_RMI_DESCRIBE_OPERATION

MESSAGE_RMI_REQUEST

MESSAGE_RMI_CANCEL

MESSAGE_RMI_RESULT

MESSAGE_RMI_ERROR

MESSAGE_RMI_RESPONSE

MAX_SUPPORTED_MESSAGE_TYPE

MESSAGE_TEXT_FORMAT

MESSAGE_ZIP_COMPRESSION

MESSAGE_GZIP_COMPRESSION

Constructor Detail

MessageAdapter

MessageAdapter

Method Detail

getCommonScheme

getScheme

getEndpoint

getFieldReplacer

getAggregationPeriodInfo

setAggregationPeriodInfo

getAggregationPeriodInfoStr

getRequestedAggregationPeriod

setRequestedAggregationPeriod

getDefaultAggregationPeriod

setDefaultAggregationPeriod

getMinAggregationPeriod

setMinAggregationPeriod

getMaxAggregationPeriod

setMaxAggregationPeriod

toString

notifyListener

setCloseListener

nextRetrieveTime

supportsMixedSubscription

setAuthRealm

setLoginHandler

getConnectionVariables

setConnectionVariables

getRemoteHostAddress

getRemoteEndpointId

useDescribeProtocol

retrieveDescribeProtocolMessage

reinitConfiguration

prepareProtocolDescriptor

prepareAuthenticateProtocolDescriptor

processDescribeProtocol

processDescribeProtocol

isProtocolDescriptorCompatible

getRemoteOptSet