CmeMdHandler (CME Market Data Handler Library 3.19.0 API)

java.lang.Object
- biz.onixs.cme.md.handler.CmeMdHandler

public class CmeMdHandler
extends Object

Main class of CME market data handler.

Constructor Summary

Constructors
Constructor and Description

CmeMdHandler(String channelId)
Constructor.

Constructors
Constructor and Description
`CmeMdHandler(String channelId)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGroupIdFilter(String groupId)` Add the Group ID filtering value.
`void`	`addSecurityIdFilter(int securityId)` Add the Security ID filtering value.
`void`	`addSymbolFilter(String symbol)` Add the Symbol filtering value.
`void`	`clearGroupIdFilters()` Removes all the Group ID filters.
`void`	`clearSecurityIdFilters()` Removes all the Security ID filters.
`void`	`clearSymbolFilters()` Removes all the Symbol filters.
`BestBidAskTrackingOptions`	`getBestBidAskTrackingOptions()` Get options to track best bids and asks.
`BookUpdatedCallbackPolicy`	`getBookUpdatedCallbackPolicy()` Gets book updated callbacks policy.
`String`	`getChannelConfigurationFile()` Get path to the CME Market Data Feed Channel configuration XML file.
`String`	`getChannelId()` Get CME Market Data Feed Channel ID.
`biz.onixs.cme.sbe.ByteDecoder`	`getDecoder()` Get SBE decoder.
`int`	`getDirectBookDefaultDepth()` Gets direct book default depth.
`String`	`getGcpCmeProjectId()` Get the CME Google Cloud Platform project id.
`GcpContentOwner`	`getGcpContentOwner()` Get the CME content owner.
`boolean`	`getGcpDeleteSubscriptions()` Get if Handler should delete subscription after stopping the corresponding feed.
`GcpEnvironmentType`	`getGcpEnvironmentType()` Get the CME environment type.
`String`	`getGcpKeyPath()` Get the path to the key file used by Google Cloud Platform connection.
`int`	`getGcpParallelPullCount()` Get the Google Cloud Platform parallel pull count.
`String`	`getGcpProjectId()` Get the Customer Google Cloud Platform project id.
`int`	`getImpliedBookDefaultDepth()` Gets implied book default depth.
`int`	`getIncrementalCacheSize()` Get incremental packets cache size.
`static String`	`getLicenseDirectory()` Gets path to directory where license file is located.
`org.joda.time.DateTime`	`getLicenseExpirationDate()` Get license expiration date.
`static String`	`getLicenseFile()` Gets license file name or absolute path to license.
`NetworkInterface`	`getLocalNetworkInterface()` Get local network interface that is used to receive UDP multicast packets.
`NetworkInterface`	`getLocalNetworkInterfaceA()` Get local network interface that is used to receive UDP multicast packets for "A" feeds.
`NetworkInterface`	`getLocalNetworkInterfaceB()` Get local network interface that is used to receive UDP multicast packets for "B" feeds.
`static int`	`getMaximumNumberOfQueuedIncrementalRefreshMessages()` Get Maximum number of queued Market Data Incremental Refresh (X) messages.
`biz.onixs.cme.sbe.def.IMessageSchema`	`getMessageSchema()` Get SBE message schema.
`int`	`getNumberOfQueuedIncrementalRefreshMessages()`
`int`	`getOutOfOrderIncrementalQueueSize()`
`boolean`	`getProcessMarketByOrderBooks()` True if handler should process Market By Order Books and use MBO Snapshots to recover (if configured).
`boolean`	`getProcessMarketByPriceBooks()` True if handler should process Market By Price Books and use Snapshots to recover (if configured).
`ProtocolFamilyDetection`	`getProtocolFamily()` Get IP protocol family.
`ReceiveMode`	`getReceiveMode()` Get IO receive mode.
`int`	`getReceiveTimeoutInMilliseconds()` Get amount of time a Handler will wait to receive data once a read operation is initiated.
`boolean`	`getRecoverSecurityDefinitionsOnGap()` Get the flag to recover the Security Definition messages each time when the message sequence gap is detected.
`boolean`	`getReportNoDataWarning()` Get report-no-data option.
`String`	`getSecurityDefinitionsCacheRoot()` Get path where security definition cache will be stored.
`Set<String>`	`getSecurityGroupFilters()` Get security group filters.
`Set<Integer>`	`getSecurityIdFilters()` Get security ID filters.
`int`	`getSocketBufferSize()` Get UDP socket buffer size in bytes.
`HandlerState`	`getState()` Get handler state.
`Set<String>`	`getSymbolFilters()` Get symbol filters.
`boolean`	`getTcpReplay()` Get option to use the TcpReplay Channel for recovery of missed messages.
`int`	`getTcpReplayMaximumGapSize()` Get maximum gap size, which be recovered via TCP Replay service.
`String`	`getTcpReplayPassword()` Get password or passphrase to be used in the Logon (35=A) message from customer to CME Tcp Replay service.
`int`	`getTcpReplayReconnectAttempts()` Get number of attempts to receive missed messages via CME Tcp Replay service.
`int`	`getTcpReplayReconnectIntervalInMilliseconds()` Get interval between attempts to receive missed messages via CME Tcp Replay service (in milliseconds).
`int`	`getTcpReplayRequestRate()` Get the rate of TCP Replay requests.
`TcpReplayRequestRateExceededAction`	`getTcpReplayRequestRateExceededAction()` Get an action on exceed Tcp Replay Request Rate.
`int`	`getTcpReplayTimeoutIntervalInMilliseconds()` Get timeout interval for CME Tcp Replay service (in milliseconds).
`String`	`getTcpReplayUsername()` Get user ID or username to be used in the Logon (35=A) message from customer to CME Tcp Replay service.
`String`	`getTemplateFile()` Get path to the CME SBE templates file.
`UdpClientFactory`	`getUdpClientFactory()` Get factory for creating custom UDP socket client.
`boolean`	`getUseGcp()` Get the flag to use or not Google Cloud Platform instead of the standard multicast data stream.
`boolean`	`getUseIncrementalFeedA()` Get the flag to use or not incremental feed "A".
`boolean`	`getUseIncrementalFeedB()` Get the flag to use or not incremental feed "B".
`boolean`	`getUseInstrumentReplayFeedA()` Get the flag to use or not Instrument Definition (UDP) Feed "A".
`boolean`	`getUseInstrumentReplayFeedB()` Get the flag to use or not Instrument Definition (UDP) Feed "B".
`boolean`	`getUseIpSourceFiltering()` Get if datagram source addresses should be filtered.
`boolean`	`getUseSnapshotFeedA()` Get the flag to use or not Market Recovery (UDP) Feed "A".
`boolean`	`getUseSnapshotFeedB()` Get the flag to use or not Market Recovery (UDP) Feed "B".
`void`	`registerConsolidatedBookUpdatedListener(ConsolidatedBookUpdatedListener listener)` Register handler for consolidated book updates processing.
`void`	`registerErrorListener(ErrorListener errorListener)` Register handler for error event processing.
`void`	`registerImpliedBookChangedListener(ImpliedBookChangedListener listener)` Register handler for implied book changes processing.
`void`	`registerImpliedBookUpdatedListener(ImpliedBookUpdatedListener listener)` Register handler for implied book updates processing.
`void`	`registerInfoListener(InfoListener infoListener)` Register handler for information event processing.
`void`	`registerLogReplayListener(ReplayListener listener)` Register handler for log replay event processing.
`void`	`registerMarketByOrderBookChangedListener(MarketByOrderBookChangedListener listener)` Register handler for market by order book changes processing.
`void`	`registerMarketByOrderBookUpdatedListener(MarketByOrderBookUpdatedListener listener)` Register handler for market by order book updates processing.
`void`	`registerMessageProcessingListener(MessageProcessingListener listener)` Register handler for received message processing.
`void`	`registerOrderIdListener(OrderIdListener listener)` Register handler for order ids processing.
`void`	`registerPacketGapDetectedListener(PacketGapDetectedListener listener)` Register handler for detected packet gap processing.
`void`	`registerPacketProcessingListener(PacketProcessingListener listener)` Register handler for received packet processing.
`void`	`registerRegularBookChangedListener(RegularBookChangedListener listener)` Register handler for regular book changes processing.
`void`	`registerRegularBookUpdatedListener(RegularBookUpdatedListener listener)` Register handler for regular book updates processing.
`void`	`registerRequestForQuoteListener(RequestForQuoteListener listener)` Register handler for quote request processing.
`void`	`registerSecurityDefinitionListener(SecurityDefinitionListener listener)` Register handler for security definitions processing.
`void`	`registerSecurityStatusListener(SecurityStatusChangedListener listener)` Register handler for security status processing.
`void`	`registerStateChangedListener(HandlerStateChangedListener listener)` Register handler for handler state changed event processing.
`void`	`registerStatisticsListener(StatisticsListener statisticsListener)` Register handler for statistics processing.
`void`	`registerTopOfTheConsolidatedBookUpdatedListener(TopOfTheConsolidatedBookUpdatedListener listener)` Register handler for top of the consolidated book updates processing.
`void`	`registerTopOfTheImpliedBookUpdatedListener(TopOfTheImpliedBookUpdatedListener listener)` Register handler for top of the implied book updates processing.
`void`	`registerTopOfTheMarketByOrderBookUpdatedListener(TopOfTheMarketByOrderBookUpdatedListener listener)` Register handler for top of the market by order book updates processing.
`void`	`registerTopOfTheRegularBookUpdatedListener(TopOfTheRegularBookUpdatedListener listener)` Register handler for top of the regular book updates processing.
`void`	`registerTradeListener(TradeListener listener)` Register handler for trade processing.
`void`	`registerWarningListener(WarningListener warningListener)` Register handler for warning event processing.
`boolean`	`removeGroupIdFilter(String groupId)` Removes the Group ID filter value.
`boolean`	`removeSecurityIdFilter(int securityId)` Removes the Security ID filter value.
`boolean`	`removeSymbolFilter(String symbol)` Removes the Symbol filter value.
`void`	`setBookUpdatedCallbackPolicy(BookUpdatedCallbackPolicy _bookUpdatedCallbackPolicy)` Sets book updated callbacks policy.
`void`	`setChannelConfigurationFile(String value)` Set path to the CME Market Data Feed Channel configuration XML file.
`void`	`setDirectBookDefaultDepth(int directBookDefaultDepth)` Sets direct book default depth.
`void`	`setGcpCmeProjectId(String gcpProjectId)` Set the CME Google Cloud Platform project id.
`void`	`setGcpContentOwner(GcpContentOwner gcpContentOwner)` Set the CME content owner.
`void`	`setGcpDeleteSubscriptions(boolean gcpDeleteSubscriptions)` Set if Handler should delete subscription after stopping the corresponding feed.
`void`	`setGcpEnvironmentType(GcpEnvironmentType gcpEnvironmentType)` Set the CME environment type.
`void`	`setGcpKeyPath(String gcpKeyPath)` Set the path to the key file used by Google Cloud Platform connection.
`void`	`setGcpParallelPullCount(int gcpParallelPullCount)` Set the Google Cloud Platform parallel pull count.
`void`	`setGcpProjectId(String gcpProjectId)` Set the Customer Google Cloud Platform project id.
`void`	`setImpliedBookDefaultDepth(int impliedBookDefaultDepth)` Sets implied book default depth.
`void`	`setIncrementalCacheSize(int value)` Set incremental packets cache size.
`static void`	`setLicenseDirectory(String value)` Sets path to directory where license file is located.
`static void`	`setLicenseFile(String value)` Sets license file name or absolute path to license.
`void`	`setLocalNetworkInterface(NetworkInterface value)` Get local network interface that is used to receive UDP multicast packets.
`void`	`setLocalNetworkInterfaceA(NetworkInterface value)` Set local network interface that is used to receive UDP multicast packets for "A" feeds.
`void`	`setLocalNetworkInterfaceB(NetworkInterface value)` Set local network interface that is used to receive UDP multicast packets for "B" feeds.
`static void`	`setMaximumNumberOfQueuedIncrementalRefreshMessages(int value)` Get Maximum number of queued Market Data Incremental Refresh (X) messages.
`void`	`setProcessMarketByOrderBooks(boolean value)` Set if handler should process Market By Order Books and use MBO Snapshots to recover (if configured).
`void`	`setProcessMarketByPriceBooks(boolean value)` Set if handler should process Market By Price Books and use Snapshots to recover (if configured).
`void`	`setProtocolFamily(ProtocolFamilyDetection value)` Get IP protocol family.
`void`	`setReceiveMode(ReceiveMode value)` Set IO receive mode.
`void`	`setReceiveTimeoutInMilliseconds(int value)` Set amount of time a Handler will wait to receive data once a read operation is initiated.
`void`	`setRecoverSecurityDefinitionsOnGap(boolean value)` Set the flag to recover the Security Definition messages each time when the message sequence gap is detected.
`void`	`setReportNoDataWarning(boolean value)` Set report-no-data option value.
`void`	`setSecurityDefinitionsCacheRoot(String value)` Set path where security definition cache will be stored.
`void`	`setSocketBufferSize(int value)` Set UDP socket buffer size in bytes.
`void`	`setTcpReplay(boolean value)` Set option to use the TcpReplay Channel for recovery of missed messages.
`void`	`setTcpReplayMaximumGapSize(int tcpReplayMaximumGapSize)` Set maximum gap size, which be recovered via TCP Replay service.
`void`	`setTcpReplayPassword(String value)` Set password or passphrase to be used in the Logon (35=A) message from customer to CME Tcp Replay service.
`void`	`setTcpReplayReconnectAttempts(int value)` Set number of attempts to receive missed messages via CME Tcp Replay service.
`void`	`setTcpReplayReconnectIntervalInMilliseconds(int value)` Set interval between attempts to receive missed messages via CME Tcp Replay service (in milliseconds).
`void`	`setTcpReplayRequestRate(int tcpReplayRequestRate)` Set the rate of TCP Replay requests.
`void`	`setTcpReplayRequestRateExceededAction(TcpReplayRequestRateExceededAction tcpReplayRequestRateExceededAction)` Set an action on exceed Tcp Replay Request Rate.
`void`	`setTcpReplayTimeoutIntervalInMilliseconds(int value)` Set timeout interval for CME Tcp Replay service (in milliseconds).
`void`	`setTcpReplayUsername(String value)` Set user ID or username to be used in the Logon (35=A) message from customer to CME Tcp Replay service.
`void`	`setTemplateFile(String value)` Set path to the CME SBE templates file.
`void`	`setUdpClientFactory(UdpClientFactory factory)` Set factory for creating custom UDP socket client.
`void`	`setUseGcp(boolean useGcp)` Get the flag to use or not Google Cloud Platform instead of the standard multicast data stream.
`void`	`setUseIncrementalFeedA(boolean value)` Set the flag to use or not incremental feed "A" option.
`void`	`setUseIncrementalFeedB(boolean value)` Set the flag to use or not incremental feed "B" option.
`void`	`setUseInstrumentReplayFeedA(boolean value)` Set the flag to use or not Instrument Definition (UDP) Feed "A".
`void`	`setUseInstrumentReplayFeedB(boolean value)` Set the flag to use or not Instrument Definition (UDP) Feed "B".
`void`	`setUseIpSourceFiltering(boolean value)` Set if datagram source addresses should be filtered.
`void`	`setUseSnapshotFeedA(boolean value)` Set the flag to use or not Market Recovery (UDP) Feed "A".
`void`	`setUseSnapshotFeedB(boolean value)` Set the flag to use or not Market Recovery (UDP) Feed "B".
`void`	`start()` Starts the receiving and processing of market data.
`void`	`start(boolean cacheSecurityDefinitions)` Starts the receiving and processing of market data using cache security definitions option.
`void`	`start(HandlerStartupStrategy startupStrategy)` Starts the receiving and processing of market data.
`void`	`start(HandlerStartupStrategy startupStrategy, boolean cacheSecurityDefinitions)` Starts the receiving and processing of market data using the specified cache security definitions option.
`void`	`start(ReplayOptions options)` Starts the receiving and processing of market data using the specified books maintenance options.
`void`	`stop()` Stops the receiving and processing of market data.
`String`	`toString()`
`void`	`unregisterConsolidatedBookUpdatedListener()` Unregister handler for consolidated book updates processing.
`void`	`unregisterErrorListener()` Unregister handler for error event processing.
`void`	`unregisterImpliedBookChangedListener()` Unregister handler for implied book changes processing.
`void`	`unregisterImpliedBookUpdatedListener()` Unregister handler for implied book updates processing.
`void`	`unregisterInfoListener()` Unregister handler for information event processing.
`void`	`unregisterLogReplayListener()` Unregister handler for log replay event processing.
`void`	`unregisterMarketByOrderBookChangedListener()` Unregister handler for market by order book changes processing.
`void`	`unregisterMarketByOrderBookUpdatedListener()` Unregister handler for market by order book updates processing.
`void`	`unregisterMessageProcessingListener()` Unregister handler for received message processing.
`void`	`unregisterOrderIdUpdatedListener()` Unregister handler for order ids processing.
`void`	`unregisterPacketGapDetectedListener()` Unregister handler for detected message gap processing.
`void`	`unregisterPacketProcessingListener()` Unregister handler for received packet processing.
`void`	`unregisterRegularBookChangedListener()` Unregister handler for regular book changes processing.
`void`	`unregisterRegularBookUpdatedListener()` Unregister handler for regular book updates processing.
`void`	`unregisterRequestForQuoteListener()` Unregister handler for quote request processing.
`void`	`unregisterSecurityDefinitionListener()` Unregister handler for security definitions processing.
`void`	`unregisterSecurityStatusListener()` Unregister handler for security status processing.
`void`	`unregisterStateChangedListener()` Unregister handler for handler state changed event processing.
`void`	`unregisterStatisticsListener()` Unregister handler for statistics processing.
`void`	`unregisterTopOfTheConsolidatedBookUpdatedListener()` Unregister handler for top of the consolidated book updates processing.
`void`	`unregisterTopOfTheImpliedBookUpdatedListener()` Unregister handler for top of the implied book updates processing.
`void`	`unregisterTopOfTheMarketByOrderBookUpdatedListener()` Unregister handler for top of the market by order book updates processing.
`void`	`unregisterTopOfTheRegularBookUpdatedListener()` Unregister handler for top of the regular book updates processing.
`void`	`unregisterTradeListener()` Unregister handler for trade processing.
`void`	`unregisterWarningListener()` Unregister handler for warning event processing.

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

- Constructor Detail
  - CmeMdHandler
```
public CmeMdHandler(String channelId)
             throws LicenseException
```
    Constructor.
    
    Parameters:
    
    channelId - Channel ID.
    
    Throws:
    
    LicenseException - license expired, corrupted or not found.
- Method Detail
  - getDirectBookDefaultDepth
```
public int getDirectBookDefaultDepth()
```
    Gets direct book default depth. Default value is 10.
    
    Returns:
    
    direct book default depth.
  - setDirectBookDefaultDepth
```
public void setDirectBookDefaultDepth(int directBookDefaultDepth)
```
    Sets direct book default depth. Default value is 10.
    
    Parameters:
    
    directBookDefaultDepth - direct book default depth.
  - getImpliedBookDefaultDepth
```
public int getImpliedBookDefaultDepth()
```
    Gets implied book default depth. Default value is 2.
    
    Returns:
    
    implied book default depth.
  - setImpliedBookDefaultDepth
```
public void setImpliedBookDefaultDepth(int impliedBookDefaultDepth)
```
    Sets implied book default depth. Default value is 2.
    
    Parameters:
    
    impliedBookDefaultDepth - implied book default depth.
  - getBookUpdatedCallbackPolicy
```
public BookUpdatedCallbackPolicy getBookUpdatedCallbackPolicy()
```
    Gets book updated callbacks policy.
    
    Returns:
    
    Book updated callbacks policy.
  - setBookUpdatedCallbackPolicy
```
public void setBookUpdatedCallbackPolicy(BookUpdatedCallbackPolicy _bookUpdatedCallbackPolicy)
```
    Sets book updated callbacks policy.
    
    Parameters:
    
    _bookUpdatedCallbackPolicy - Book updated callbacks policy.
  - getSecurityIdFilters
```
public Set<Integer> getSecurityIdFilters()
```
    Get security ID filters.
    
    Returns:
    
    security ID filters.
  - getSecurityGroupFilters
```
public Set<String> getSecurityGroupFilters()
```
    Get security group filters.
    
    Returns:
    
    security group filters.
  - getSymbolFilters
```
public Set<String> getSymbolFilters()
```
    Get symbol filters.
    
    Returns:
    
    symbol filters.
  - addSecurityIdFilter
```
public void addSecurityIdFilter(int securityId)
```
    Add the Security ID filtering value. The filter is inclusive. Note: this method can be called only when handler was in STOPPED, STARTED or SECURITY_DEFINITIONS_RECOVERY_STARTED state or from onSecurityDefinition callback. If this method will be called from other place this can lead to order book build errors for specified security.
    
    Parameters:
    
    securityId - SecurityID to be used for inclusive filtering.
  - removeSecurityIdFilter
```
public final boolean removeSecurityIdFilter(int securityId)
```
    Removes the Security ID filter value.
    
    Parameters:
    
    securityId - Security ID value to remove from Security ID filters.
    
    Returns:
    
    true if the element is successfully found and removed; otherwise, false.
  - clearSecurityIdFilters
```
public final void clearSecurityIdFilters()
```
    Removes all the Security ID filters.
  - addSymbolFilter
```
public final void addSymbolFilter(String symbol)
```
    Add the Symbol filtering value. The filter is inclusive. Note: this method can be called only when handler was in STOPPED, STARTED or SECURITY_DEFINITIONS_RECOVERY_STARTED state or from onSecurityDefinition callback. If this method will be called from other place this can lead to order book build errors for specified security.
    
    Parameters:
    
    symbol - Symbol to be used for inclusive filtering.
  - removeSymbolFilter
```
public final boolean removeSymbolFilter(String symbol)
```
    Removes the Symbol filter value.
    
    Parameters:
    
    symbol - Symbol value to remove from Symbol filters.
    
    Returns:
    
    true if the element is successfully found and removed; otherwise, false.
  - clearSymbolFilters
```
public final void clearSymbolFilters()
```
    Removes all the Symbol filters.
  - addGroupIdFilter
```
public final void addGroupIdFilter(String groupId)
```
    Add the Group ID filtering value. The filter is inclusive.
    
    Parameters:
    
    groupId - Group ID to be used for inclusive filtering.
  - removeGroupIdFilter
```
public final boolean removeGroupIdFilter(String groupId)
```
    Removes the Group ID filter value.
    
    Parameters:
    
    groupId - Group ID value to remove from Group ID filters.
    
    Returns:
    
    true if the element is successfully found and removed; otherwise, false.
  - clearGroupIdFilters
```
public final void clearGroupIdFilters()
```
    Removes all the Group ID filters.
  - getState
```
public final HandlerState getState()
```
    Get handler state.
    
    Returns:
    
    handler state.
  - getReportNoDataWarning
```
public boolean getReportNoDataWarning()
```
    Get report-no-data option. Default value is false.
    
    Returns:
    
    true if report-no-data set to true; otherwise, false.
  - setReportNoDataWarning
```
public void setReportNoDataWarning(boolean value)
```
    Set report-no-data option value. Default value is false.
    
    Parameters:
    
    value - true if handler should report no-data event; otherwise, false..
  - getUseIncrementalFeedA
```
public boolean getUseIncrementalFeedA()
```
    Get the flag to use or not incremental feed "A". Default value is true.
    
    Returns:
    
    true if handler should use incremental feed "A"; otherwise, false.
  - setUseIncrementalFeedA
```
public void setUseIncrementalFeedA(boolean value)
```
    Set the flag to use or not incremental feed "A" option. Default value is true.
    
    Parameters:
    
    value - true if handler should use incremental feed "A"; otherwise, false.
  - getUseIncrementalFeedB
```
public boolean getUseIncrementalFeedB()
```
    Get the flag to use or not incremental feed "B". Default value is false.
    
    Returns:
    
    true if handler should use incremental feed "B"; otherwise, false.
  - setUseIncrementalFeedB
```
public void setUseIncrementalFeedB(boolean value)
```
    Set the flag to use or not incremental feed "B" option. Default value is false.
    
    Parameters:
    
    value - true if handler should use incremental feed "B"; otherwise, false.
  - getUseSnapshotFeedA
```
public final boolean getUseSnapshotFeedA()
```
    Get the flag to use or not Market Recovery (UDP) Feed "A". Default value is true.
    
    Returns:
    
    true if handler should use Market Recovery (UDP) Feed "A"; otherwise, false.
  - setUseSnapshotFeedA
```
public final void setUseSnapshotFeedA(boolean value)
```
    Set the flag to use or not Market Recovery (UDP) Feed "A". Default value is true.
    
    Parameters:
    
    value - true if handler should use Market Recovery (UDP) Feed "A"; otherwise, false.
  - getUseSnapshotFeedB
```
public final boolean getUseSnapshotFeedB()
```
    Get the flag to use or not Market Recovery (UDP) Feed "B". Default value is false.
    
    Returns:
    
    true if handler should use Market Recovery (UDP) Feed "B"; otherwise, false.
  - setUseSnapshotFeedB
```
public final void setUseSnapshotFeedB(boolean value)
```
    Set the flag to use or not Market Recovery (UDP) Feed "B". Default value is false.
    
    Parameters:
    
    value - true if handler should use Market Recovery (UDP) Feed "B"; otherwise, false.
  - getUseInstrumentReplayFeedA
```
public final boolean getUseInstrumentReplayFeedA()
```
    Get the flag to use or not Instrument Definition (UDP) Feed "A". Default value is true.
    
    Returns:
    
    true if handler should use Instrument Definition (UDP) Feed "A"; otherwise, false.
  - setUseInstrumentReplayFeedA
```
public final void setUseInstrumentReplayFeedA(boolean value)
```
    Set the flag to use or not Instrument Definition (UDP) Feed "A". Default value is true.
    
    Parameters:
    
    value - true if handler should use Instrument Definition (UDP) Feed "A"; otherwise, false.
  - getUseInstrumentReplayFeedB
```
public final boolean getUseInstrumentReplayFeedB()
```
    Get the flag to use or not Instrument Definition (UDP) Feed "B". Default value is false.
    
    Returns:
    
    true if handler should use Instrument Definition (UDP) Feed "B"; otherwise, false.
  - setUseInstrumentReplayFeedB
```
public final void setUseInstrumentReplayFeedB(boolean value)
```
    Set the flag to use or not Instrument Definition (UDP) Feed "B". Default value is false.
    
    Parameters:
    
    value - true if handler should use Instrument Definition (UDP) Feed "B"; otherwise, false.
  - getUdpClientFactory
```
public UdpClientFactory getUdpClientFactory()
```
    Get factory for creating custom UDP socket client.
    
    Returns:
    
    Factory for creating custom UDP socket client.
  - setUdpClientFactory
```
public void setUdpClientFactory(UdpClientFactory factory)
```
    Set factory for creating custom UDP socket client.
    
    Parameters:
    
    factory - factory for creating custom UDP socket client.
  - getSocketBufferSize
```
public int getSocketBufferSize()
```
    Get UDP socket buffer size in bytes. Default value is 4MB.
    
    Returns:
    
    socket buffer size.
  - setSocketBufferSize
```
public void setSocketBufferSize(int value)
```
    Set UDP socket buffer size in bytes. Default value is 4MB.
    
    Parameters:
    
    value - socket buffer size.
  - getUseIpSourceFiltering
```
public final boolean getUseIpSourceFiltering()
```
    Get if datagram source addresses should be filtered.
    
    Returns:
    
    true, if datagram source addresses will be filtered.
  - setUseIpSourceFiltering
```
public final void setUseIpSourceFiltering(boolean value)
```
    Set if datagram source addresses should be filtered.
    
    Parameters:
    
    value - true, if datagram source addresses will be filtered.
  - getProtocolFamily
```
public final ProtocolFamilyDetection getProtocolFamily()
```
    Get IP protocol family.
    
    Returns:
    
    IP protocol family.
  - setProtocolFamily
```
public final void setProtocolFamily(ProtocolFamilyDetection value)
```
    Get IP protocol family.
    
    Parameters:
    
    value - IP protocol family.
  - getReceiveMode
```
public ReceiveMode getReceiveMode()
```
    Get IO receive mode. Default value is ReceiveMode.SELECTOR.
    
    Returns:
    
    IO receive mode.
  - setReceiveMode
```
public void setReceiveMode(ReceiveMode value)
```
    Set IO receive mode. Default value is ReceiveMode.SELECTOR.
    
    Parameters:
    
    value - IO receive mode.
  - getIncrementalCacheSize
```
public int getIncrementalCacheSize()
```
    Get incremental packets cache size. This cache are used for packet alignment. Default value is 5.
    
    Returns:
    
    incremental packets cache size.
  - setIncrementalCacheSize
```
public void setIncrementalCacheSize(int value)
```
    Set incremental packets cache size. This cache are used for packet alignment. Default value is 5.
    
    Parameters:
    
    value - incremental packets cache size.
  - getOutOfOrderIncrementalQueueSize
```
public int getOutOfOrderIncrementalQueueSize()
```
  - getNumberOfQueuedIncrementalRefreshMessages
```
public int getNumberOfQueuedIncrementalRefreshMessages()
```
  - getBestBidAskTrackingOptions
```
public BestBidAskTrackingOptions getBestBidAskTrackingOptions()
```
    Get options to track best bids and asks.
    
    Returns:
    
    options.
  - getMaximumNumberOfQueuedIncrementalRefreshMessages
```
public static int getMaximumNumberOfQueuedIncrementalRefreshMessages()
```
    Get Maximum number of queued Market Data Incremental Refresh (X) messages.
    When the message gap is detected all subsequent Refresh(X) messages are queued until the Handler re-synchronizes with the market using Snapshot(W) messages. After that the queued Refresh(X) messages are re-played. This setting could be used to limit the memory usage when there is no Market Data - Snapshot/Full Refresh (W) messages. Default value is 10000;
    
    Returns:
    
    maximum number of queued Market Data Incremental Refresh (X) messages.
  - setMaximumNumberOfQueuedIncrementalRefreshMessages
```
public static void setMaximumNumberOfQueuedIncrementalRefreshMessages(int value)
```
    Get Maximum number of queued Market Data Incremental Refresh (X) messages.
    When the message gap is detected all subsequent Refresh(X) messages are queued until the Handler re-synchronizes with the market using Snapshot(W) messages. After that the queued Refresh(X) messages are re-played. This setting could be used to limit the memory usage when there is no Market Data - Snapshot/Full Refresh (W) messages.
    Default value is 10000;
    
    Parameters:
    
    value - maximum number of queued Market Data Incremental Refresh (X) messages.
  - registerInfoListener
```
public void registerInfoListener(InfoListener infoListener)
```
    Register handler for information event processing.
    
    Parameters:
    
    infoListener - handler.
  - unregisterInfoListener
```
public void unregisterInfoListener()
```
    Unregister handler for information event processing.
  - registerErrorListener
```
public void registerErrorListener(ErrorListener errorListener)
```
    Register handler for error event processing.
    
    Parameters:
    
    errorListener - handler.
  - unregisterErrorListener
```
public void unregisterErrorListener()
```
    Unregister handler for error event processing.
  - registerWarningListener
```
public void registerWarningListener(WarningListener warningListener)
```
    Register handler for warning event processing.
    
    Parameters:
    
    warningListener - handler.
  - unregisterWarningListener
```
public void unregisterWarningListener()
```
    Unregister handler for warning event processing.
  - registerSecurityDefinitionListener
```
public void registerSecurityDefinitionListener(SecurityDefinitionListener listener)
```
    Register handler for security definitions processing.
    
    Parameters:
    
    listener - handler.
  - unregisterSecurityDefinitionListener
```
public void unregisterSecurityDefinitionListener()
```
    Unregister handler for security definitions processing.
  - registerStateChangedListener
```
public void registerStateChangedListener(HandlerStateChangedListener listener)
```
    Register handler for handler state changed event processing.
    
    Parameters:
    
    listener - handler.
  - unregisterStateChangedListener
```
public void unregisterStateChangedListener()
```
    Unregister handler for handler state changed event processing.
  - registerLogReplayListener
```
public void registerLogReplayListener(ReplayListener listener)
```
    Register handler for log replay event processing.
    
    Parameters:
    
    listener - handler.
  - unregisterLogReplayListener
```
public void unregisterLogReplayListener()
```
    Unregister handler for log replay event processing.
  - registerStatisticsListener
```
public void registerStatisticsListener(StatisticsListener statisticsListener)
```
    Register handler for statistics processing.
    
    Parameters:
    
    statisticsListener - handler.
  - unregisterStatisticsListener
```
public void unregisterStatisticsListener()
```
    Unregister handler for statistics processing.
  - registerRegularBookChangedListener
```
public void registerRegularBookChangedListener(RegularBookChangedListener listener)
```
    Register handler for regular book changes processing.
    
    Parameters:
    
    listener - handler.
  - unregisterRegularBookChangedListener
```
public void unregisterRegularBookChangedListener()
```
    Unregister handler for regular book changes processing.
  - registerRegularBookUpdatedListener
```
public void registerRegularBookUpdatedListener(RegularBookUpdatedListener listener)
```
    Register handler for regular book updates processing.
    
    Parameters:
    
    listener - handler.
  - unregisterRegularBookUpdatedListener
```
public void unregisterRegularBookUpdatedListener()
```
    Unregister handler for regular book updates processing.
  - registerImpliedBookChangedListener
```
public void registerImpliedBookChangedListener(ImpliedBookChangedListener listener)
```
    Register handler for implied book changes processing.
    
    Parameters:
    
    listener - handler.
  - unregisterImpliedBookChangedListener
```
public void unregisterImpliedBookChangedListener()
```
    Unregister handler for implied book changes processing.
  - registerImpliedBookUpdatedListener
```
public void registerImpliedBookUpdatedListener(ImpliedBookUpdatedListener listener)
```
    Register handler for implied book updates processing.
    
    Parameters:
    
    listener - handler.
  - unregisterImpliedBookUpdatedListener
```
public void unregisterImpliedBookUpdatedListener()
```
    Unregister handler for implied book updates processing.
  - registerMarketByOrderBookChangedListener
```
public void registerMarketByOrderBookChangedListener(MarketByOrderBookChangedListener listener)
```
    Register handler for market by order book changes processing.
    
    Parameters:
    
    listener - handler.
  - unregisterMarketByOrderBookChangedListener
```
public void unregisterMarketByOrderBookChangedListener()
```
    Unregister handler for market by order book changes processing.
  - registerMarketByOrderBookUpdatedListener
```
public void registerMarketByOrderBookUpdatedListener(MarketByOrderBookUpdatedListener listener)
```
    Register handler for market by order book updates processing.
    
    Parameters:
    
    listener - handler.
  - unregisterMarketByOrderBookUpdatedListener
```
public void unregisterMarketByOrderBookUpdatedListener()
```
    Unregister handler for market by order book updates processing.
  - registerTopOfTheRegularBookUpdatedListener
```
public void registerTopOfTheRegularBookUpdatedListener(TopOfTheRegularBookUpdatedListener listener)
```
    Register handler for top of the regular book updates processing.
    
    Parameters:
    
    listener - handler.
  - unregisterTopOfTheRegularBookUpdatedListener
```
public void unregisterTopOfTheRegularBookUpdatedListener()
```
    Unregister handler for top of the regular book updates processing.
  - registerTopOfTheImpliedBookUpdatedListener
```
public void registerTopOfTheImpliedBookUpdatedListener(TopOfTheImpliedBookUpdatedListener listener)
```
    Register handler for top of the implied book updates processing.
    
    Parameters:
    
    listener - handler.
  - unregisterTopOfTheImpliedBookUpdatedListener
```
public void unregisterTopOfTheImpliedBookUpdatedListener()
```
    Unregister handler for top of the implied book updates processing.
  - registerTopOfTheConsolidatedBookUpdatedListener
```
public void registerTopOfTheConsolidatedBookUpdatedListener(TopOfTheConsolidatedBookUpdatedListener listener)
```
    Register handler for top of the consolidated book updates processing.
    
    Parameters:
    
    listener - handler.
  - unregisterTopOfTheConsolidatedBookUpdatedListener
```
public void unregisterTopOfTheConsolidatedBookUpdatedListener()
```
    Unregister handler for top of the consolidated book updates processing.
  - registerTopOfTheMarketByOrderBookUpdatedListener
```
public void registerTopOfTheMarketByOrderBookUpdatedListener(TopOfTheMarketByOrderBookUpdatedListener listener)
```
    Register handler for top of the market by order book updates processing.
    
    Parameters:
    
    listener - handler.
  - unregisterTopOfTheMarketByOrderBookUpdatedListener
```
public void unregisterTopOfTheMarketByOrderBookUpdatedListener()
```
    Unregister handler for top of the market by order book updates processing.
  - registerConsolidatedBookUpdatedListener
```
public void registerConsolidatedBookUpdatedListener(ConsolidatedBookUpdatedListener listener)
```
    Register handler for consolidated book updates processing.
    
    Parameters:
    
    listener - handler.
  - unregisterConsolidatedBookUpdatedListener
```
public void unregisterConsolidatedBookUpdatedListener()
```
    Unregister handler for consolidated book updates processing.
  - registerOrderIdListener
```
public void registerOrderIdListener(OrderIdListener listener)
```
    Register handler for order ids processing.
    
    Parameters:
    
    listener - handler.
  - unregisterOrderIdUpdatedListener
```
public void unregisterOrderIdUpdatedListener()
```
    Unregister handler for order ids processing.
  - registerRequestForQuoteListener
```
public void registerRequestForQuoteListener(RequestForQuoteListener listener)
```
    Register handler for quote request processing.
    
    Parameters:
    
    listener - handler.
  - unregisterRequestForQuoteListener
```
public void unregisterRequestForQuoteListener()
```
    Unregister handler for quote request processing.
  - registerSecurityStatusListener
```
public void registerSecurityStatusListener(SecurityStatusChangedListener listener)
```
    Register handler for security status processing.
    
    Parameters:
    
    listener - handler.
  - unregisterSecurityStatusListener
```
public void unregisterSecurityStatusListener()
```
    Unregister handler for security status processing.
  - registerTradeListener
```
public void registerTradeListener(TradeListener listener)
```
    Register handler for trade processing.
    
    Parameters:
    
    listener - handler.
  - unregisterTradeListener
```
public void unregisterTradeListener()
```
    Unregister handler for trade processing.
  - registerPacketGapDetectedListener
```
public void registerPacketGapDetectedListener(PacketGapDetectedListener listener)
```
    Register handler for detected packet gap processing.
    
    Parameters:
    
    listener - handler.
  - unregisterPacketGapDetectedListener
```
public void unregisterPacketGapDetectedListener()
```
    Unregister handler for detected message gap processing.
  - registerMessageProcessingListener
```
public void registerMessageProcessingListener(MessageProcessingListener listener)
```
    Register handler for received message processing.
    
    Parameters:
    
    listener - handler.
  - unregisterMessageProcessingListener
```
public void unregisterMessageProcessingListener()
```
    Unregister handler for received message processing.
  - registerPacketProcessingListener
```
public void registerPacketProcessingListener(PacketProcessingListener listener)
```
    Register handler for received packet processing.
    
    Parameters:
    
    listener - handler.
  - unregisterPacketProcessingListener
```
public void unregisterPacketProcessingListener()
```
    Unregister handler for received packet processing.
  - getSecurityDefinitionsCacheRoot
```
public String getSecurityDefinitionsCacheRoot()
```
    Get path where security definition cache will be stored. Default value is current directory.
    
    Returns:
    
    path where security definition cache will be stored.
  - setSecurityDefinitionsCacheRoot
```
public void setSecurityDefinitionsCacheRoot(String value)
```
    Set path where security definition cache will be stored. Default value is current directory.
    
    Parameters:
    
    value - path where security definition cache will be stored.
  - getLocalNetworkInterface
```
public final NetworkInterface getLocalNetworkInterface()
```
    Get local network interface that is used to receive UDP multicast packets. If set to null then all available local network interfaces are used.
    
    Returns:
    
    local network interface that is used to receive UDP multicast packets.
  - setLocalNetworkInterface
```
public final void setLocalNetworkInterface(NetworkInterface value)
```
    Get local network interface that is used to receive UDP multicast packets. If set to null then all available local network interfaces are used.
    
    Parameters:
    
    value - local network interface that is used to receive UDP multicast packets.
  - getLocalNetworkInterfaceA
```
public final NetworkInterface getLocalNetworkInterfaceA()
```
    Get local network interface that is used to receive UDP multicast packets for "A" feeds. If set to null then the LocalNetworkInterface value is used.
    
    Returns:
    
    local network interface that is used to receive UDP multicast packets for "A" feeds.
  - setLocalNetworkInterfaceA
```
public final void setLocalNetworkInterfaceA(NetworkInterface value)
```
    Set local network interface that is used to receive UDP multicast packets for "A" feeds. If set to null then the LocalNetworkInterface value is used.
    
    Parameters:
    
    value - local network interface that is used to receive UDP multicast packets for "A" feeds.
  - getLocalNetworkInterfaceB
```
public final NetworkInterface getLocalNetworkInterfaceB()
```
    Get local network interface that is used to receive UDP multicast packets for "B" feeds. If set to null then the LocalNetworkInterface value is used.
    
    Returns:
    
    local network interface that is used to receive UDP multicast packets for "B" feeds.
  - setLocalNetworkInterfaceB
```
public final void setLocalNetworkInterfaceB(NetworkInterface value)
```
    Set local network interface that is used to receive UDP multicast packets for "B" feeds. If set to null then the LocalNetworkInterface value is used.
    
    Parameters:
    
    value - local network interface that is used to receive UDP multicast packets for "B" feeds.
  - getReceiveTimeoutInMilliseconds
```
public final int getReceiveTimeoutInMilliseconds()
```
    Get amount of time a Handler will wait to receive data once a read operation is initiated. Default value is 36000.
    
    Returns:
    
    amount of time a Handler will wait to receive data once a read operation is initiated.
  - setReceiveTimeoutInMilliseconds
```
public final void setReceiveTimeoutInMilliseconds(int value)
```
    Set amount of time a Handler will wait to receive data once a read operation is initiated. Default value is 36000.
    
    Parameters:
    
    value - amount of time a Handler will wait to receive data once a read operation is initiated.
  - getUseGcp
```
public boolean getUseGcp()
```
    Get the flag to use or not Google Cloud Platform instead of the standard multicast data stream. Default value is false.
    
    Returns:
    
    true if handler should use Google Cloud Platform instead of the standard multicast data stream; otherwise, false.
  - setUseGcp
```
public void setUseGcp(boolean useGcp)
```
    Get the flag to use or not Google Cloud Platform instead of the standard multicast data stream. Default value is false.
    
    Parameters:
    
    useGcp - true if handler should use Google Cloud Platform instead of the standard multicast data stream; otherwise, false.
  - getGcpKeyPath
```
public String getGcpKeyPath()
```
    Get the path to the key file used by Google Cloud Platform connection.
    
    Returns:
    
    path to the key file used by Google Cloud Platform connection.
  - setGcpKeyPath
```
public void setGcpKeyPath(String gcpKeyPath)
```
    Set the path to the key file used by Google Cloud Platform connection.
    
    Parameters:
    
    gcpKeyPath - path to the key file used by Google Cloud Platform connection.
  - getGcpProjectId
```
public String getGcpProjectId()
```
    Get the Customer Google Cloud Platform project id.
    
    Returns:
    
    Customer Google Cloud Platform project id.
  - setGcpProjectId
```
public void setGcpProjectId(String gcpProjectId)
```
    Set the Customer Google Cloud Platform project id.
    
    Parameters:
    
    gcpProjectId - Customer Google Cloud Platform project id.
  - getGcpCmeProjectId
```
public String getGcpCmeProjectId()
```
    Get the CME Google Cloud Platform project id.
    
    Returns:
    
    CME Google Cloud Platform project id.
  - setGcpCmeProjectId
```
public void setGcpCmeProjectId(String gcpProjectId)
```
    Set the CME Google Cloud Platform project id.
    
    Parameters:
    
    gcpProjectId - CME Google Cloud Platform project id.
  - getGcpEnvironmentType
```
public GcpEnvironmentType getGcpEnvironmentType()
```
    Get the CME environment type.
    
    Returns:
    
    CME environment type.
  - setGcpEnvironmentType
```
public void setGcpEnvironmentType(GcpEnvironmentType gcpEnvironmentType)
```
    Set the CME environment type.
    
    Parameters:
    
    gcpEnvironmentType - CME environment type.
  - getGcpContentOwner
```
public GcpContentOwner getGcpContentOwner()
```
    Get the CME content owner.
    
    Returns:
    
    CME content owner.
  - setGcpContentOwner
```
public void setGcpContentOwner(GcpContentOwner gcpContentOwner)
```
    Set the CME content owner.
    
    Parameters:
    
    gcpContentOwner - CME content owner.
  - getGcpParallelPullCount
```
public int getGcpParallelPullCount()
```
    Get the Google Cloud Platform parallel pull count. Default value: 1 Recommendation: from CME perf tests, it is found that in order to keep up with consuming 10000 messages/second, we need to set this configuration to 4 on a four-core virtual machine (defaults to 1). Please tune it empirically.
    
    Returns:
    
    Google Cloud Platform parallel pull count.
  - setGcpParallelPullCount
```
public void setGcpParallelPullCount(int gcpParallelPullCount)
```
    Set the Google Cloud Platform parallel pull count. Default value: 1 Recommendation: from CME perf tests, it is found that in order to keep up with consuming 10000 messages/second, we need to set this configuration to 4 on a four-core virtual machine (defaults to 1). Please tune it empirically.
    
    Parameters:
    
    gcpParallelPullCount - Google Cloud Platform parallel pull count.
  - getGcpDeleteSubscriptions
```
public boolean getGcpDeleteSubscriptions()
```
    Get if Handler should delete subscription after stopping the corresponding feed. Default value: true
    
    Returns:
    
    true, if Handler should delete subscription after stopping the corresponding feed.
  - setGcpDeleteSubscriptions
```
public void setGcpDeleteSubscriptions(boolean gcpDeleteSubscriptions)
```
    Set if Handler should delete subscription after stopping the corresponding feed. Default value: true
    
    Parameters:
    
    gcpDeleteSubscriptions - true, if Handler should delete subscription after stopping the corresponding feed.
  - getRecoverSecurityDefinitionsOnGap
```
public final boolean getRecoverSecurityDefinitionsOnGap()
```
    Get the flag to recover the Security Definition messages each time when the message sequence gap is detected. Default value is false.
    
    Returns:
    
    true if handler should recover security definitions if message gap detected; otherwise, false.
  - setRecoverSecurityDefinitionsOnGap
```
public final void setRecoverSecurityDefinitionsOnGap(boolean value)
```
    Set the flag to recover the Security Definition messages each time when the message sequence gap is detected. Default value is false.
    
    Parameters:
    
    value - true if handler should recover security definitions if message gap detected; otherwise, false.
  - getChannelId
```
public final String getChannelId()
```
    Get CME Market Data Feed Channel ID.
    
    Returns:
    
    CME Market Data Feed Channel ID.
  - getLicenseExpirationDate
```
public final org.joda.time.DateTime getLicenseExpirationDate()
```
    Get license expiration date.
    
    Returns:
    
    License expiration date
  - getChannelConfigurationFile
```
public final String getChannelConfigurationFile()
```
    Get path to the CME Market Data Feed Channel configuration XML file.
    
    Returns:
    
    path to the CME Market Data Feed Channel configuration XML file.
  - setChannelConfigurationFile
```
public final void setChannelConfigurationFile(String value)
```
    Set path to the CME Market Data Feed Channel configuration XML file.
    
    Parameters:
    
    value - path to the CME Market Data Feed Channel configuration XML file.
  - getTcpReplay
```
public final boolean getTcpReplay()
```
    Get option to use the TcpReplay Channel for recovery of missed messages. This method recovers all missed messages. Default value is false.
    
    Returns:
    
    option to use the TcpReplay Channel for recovery of missed messages.
  - setTcpReplay
```
public final void setTcpReplay(boolean value)
```
    Set option to use the TcpReplay Channel for recovery of missed messages. This method recovers all missed messages. Default value is false.
    
    Parameters:
    
    value - option to use the TcpReplay Channel for recovery of missed messages.
  - getTcpReplayUsername
```
public final String getTcpReplayUsername()
```
    Get user ID or username to be used in the Logon (35=A) message from customer to CME Tcp Replay service.
    
    Returns:
    
    username.
  - setTcpReplayUsername
```
public final void setTcpReplayUsername(String value)
```
    Set user ID or username to be used in the Logon (35=A) message from customer to CME Tcp Replay service.
    
    Parameters:
    
    value - username.
  - getTcpReplayPassword
```
public final String getTcpReplayPassword()
```
    Get password or passphrase to be used in the Logon (35=A) message from customer to CME Tcp Replay service.
    
    Returns:
    
    password.
  - setTcpReplayPassword
```
public final void setTcpReplayPassword(String value)
```
    Set password or passphrase to be used in the Logon (35=A) message from customer to CME Tcp Replay service.
    
    Parameters:
    
    value - password.
  - getTcpReplayReconnectAttempts
```
public final int getTcpReplayReconnectAttempts()
```
    Get number of attempts to receive missed messages via CME Tcp Replay service. Default value is 10.
    
    Returns:
    
    number of attempts to receive missed messages via CME Tcp Replay service.
  - setTcpReplayReconnectAttempts
```
public final void setTcpReplayReconnectAttempts(int value)
```
    Set number of attempts to receive missed messages via CME Tcp Replay service. Default value is 10.
    
    Parameters:
    
    value - number of attempts to receive missed messages via CME Tcp Replay service.
  - getTcpReplayReconnectIntervalInMilliseconds
```
public final int getTcpReplayReconnectIntervalInMilliseconds()
```
    Get interval between attempts to receive missed messages via CME Tcp Replay service (in milliseconds). Default value is 100.
    
    Returns:
    
    interval between attempts to receive missed messages via CME Tcp Replay service (in milliseconds).
  - setTcpReplayReconnectIntervalInMilliseconds
```
public final void setTcpReplayReconnectIntervalInMilliseconds(int value)
```
    Set interval between attempts to receive missed messages via CME Tcp Replay service (in milliseconds). Default value is 100.
    
    Parameters:
    
    value - interval between attempts to receive missed messages via CME Tcp Replay service (in milliseconds).
  - getTcpReplayTimeoutIntervalInMilliseconds
```
public final int getTcpReplayTimeoutIntervalInMilliseconds()
```
    Get timeout interval for CME Tcp Replay service (in milliseconds). Default value is 2000.
    
    Returns:
    
    timeout interval for CME Tcp Replay service (in milliseconds).
  - setTcpReplayTimeoutIntervalInMilliseconds
```
public final void setTcpReplayTimeoutIntervalInMilliseconds(int value)
```
    Set timeout interval for CME Tcp Replay service (in milliseconds). Default value is 2000.
    
    Parameters:
    
    value - timeout interval for CME Tcp Replay service (in milliseconds).
  - getTcpReplayMaximumGapSize
```
public int getTcpReplayMaximumGapSize()
```
    Get maximum gap size, which be recovered via TCP Replay service. Larger gaps will recovered via snapshots. Default value - 30000 packets.
    
    Returns:
    
    maximum gap size for TCP Replay service.
  - setTcpReplayMaximumGapSize
```
public void setTcpReplayMaximumGapSize(int tcpReplayMaximumGapSize)
```
    Set maximum gap size, which be recovered via TCP Replay service. Larger gaps will recovered via snapshots. Default value - 30000 packets.
    
    Parameters:
    
    tcpReplayMaximumGapSize - maximum gap size for TCP Replay service.
  - getTcpReplayRequestRate
```
public int getTcpReplayRequestRate()
```
    Get the rate of TCP Replay requests. Default value - 15 requests per second (limited by CME). If greater, TCP replay account can be blocked.
    
    Returns:
    
    the rate of TCP Replay requests.
  - setTcpReplayRequestRate
```
public void setTcpReplayRequestRate(int tcpReplayRequestRate)
```
    Set the rate of TCP Replay requests. Default value - 15 requests per second (limited by CME). If greater, TCP replay account can be blocked.
    
    Parameters:
    
    tcpReplayRequestRate - the rate of TCP Replay requests.
  - getTcpReplayRequestRateExceededAction
```
public TcpReplayRequestRateExceededAction getTcpReplayRequestRateExceededAction()
```
    Get an action on exceed Tcp Replay Request Rate. Default value - true.
    
    Returns:
    
    an action on exceeded Tcp Replay Request Rate.
  - setTcpReplayRequestRateExceededAction
```
public void setTcpReplayRequestRateExceededAction(TcpReplayRequestRateExceededAction tcpReplayRequestRateExceededAction)
```
    Set an action on exceed Tcp Replay Request Rate. Default value - true.
    
    Parameters:
    
    tcpReplayRequestRateExceededAction - an action on exceeded Tcp Replay Request Rate.
  - getProcessMarketByPriceBooks
```
public boolean getProcessMarketByPriceBooks()
```
    True if handler should process Market By Price Books and use Snapshots to recover (if configured). Default value is true.
    
    Returns:
    
    true if handler should process Market By Price Books and use Snapshots to recover.
  - setProcessMarketByPriceBooks
```
public void setProcessMarketByPriceBooks(boolean value)
```
    Set if handler should process Market By Price Books and use Snapshots to recover (if configured). Default value is true.
    
    Parameters:
    
    value - true, if handler should process Market By Price Books and use Snapshots to recover.
  - getProcessMarketByOrderBooks
```
public boolean getProcessMarketByOrderBooks()
```
    True if handler should process Market By Order Books and use MBO Snapshots to recover (if configured). Default value is false.
    
    Returns:
    
    true if handler should process Market By Order Books and use MBO Snapshots to recover.
  - setProcessMarketByOrderBooks
```
public void setProcessMarketByOrderBooks(boolean value)
```
    Set if handler should process Market By Order Books and use MBO Snapshots to recover (if configured). Default value is false.
    
    Parameters:
    
    value - true, if handler should process Market By Order Books and use MBO Snapshots to recover.
  - getTemplateFile
```
public final String getTemplateFile()
```
    Get path to the CME SBE templates file.
    
    Returns:
    
    path to the CME SBE templates file.
  - setTemplateFile
```
public final void setTemplateFile(String value)
```
    Set path to the CME SBE templates file.
    
    Parameters:
    
    value - path to the CME SBE templates file.
  - getLicenseFile
```
public static String getLicenseFile()
```
    Gets license file name or absolute path to license.
    
    Returns:
    
    License file name or absolute path to license.
  - setLicenseFile
```
public static void setLicenseFile(String value)
```
    Sets license file name or absolute path to license.
    
    Parameters:
    
    value - License file name or absolute path to license.
  - getLicenseDirectory
```
public static String getLicenseDirectory()
```
    Gets path to directory where license file is located.
    
    Returns:
    
    Path to directory where license file is located.
  - setLicenseDirectory
```
public static void setLicenseDirectory(String value)
```
    Sets path to directory where license file is located.
    
    Parameters:
    
    value - Path to directory where license file is located.
  - getDecoder
```
public final biz.onixs.cme.sbe.ByteDecoder getDecoder()
```
    Get SBE decoder.
    
    Returns:
    
    SBE decoder.
  - getMessageSchema
```
public final biz.onixs.cme.sbe.def.IMessageSchema getMessageSchema()
```
    Get SBE message schema.
    
    Returns:
    
    SBE message schema.
  - start
```
public final void start(ReplayOptions options)
```
    Starts the receiving and processing of market data using the specified books maintenance options. Security definitions was not cached.
    
    Parameters:
    
    options - replay options
  - start
```
public final void start()
                 throws IOException
```
    Starts the receiving and processing of market data. Security definitions was not cached.
    
    Throws:
    
    IOException
  - start
```
public final void start(HandlerStartupStrategy startupStrategy)
                 throws IOException
```
    Starts the receiving and processing of market data. Security definitions was not cached.
    
    Parameters:
    
    startupStrategy - Market joining strategy.
    
    Throws:
    
    IOException
  - start
```
public final void start(boolean cacheSecurityDefinitions)
                 throws IOException
```
    Starts the receiving and processing of market data using cache security definitions option.
    
    Parameters:
    
    cacheSecurityDefinitions - true if handler should cache received security definitions; otherwise, false.
    
    Throws:
    
    IOException
  - start
```
public final void start(HandlerStartupStrategy startupStrategy,
                        boolean cacheSecurityDefinitions)
                 throws IOException
```
    Starts the receiving and processing of market data using the specified cache security definitions option.
    
    Parameters:
    
    startupStrategy - Market joining strategy.
    
    cacheSecurityDefinitions - true if handler should cache received security definitions; otherwise, false.
    
    Throws:
    
    IOException
  - stop
```
public final void stop()
                throws InterruptedException
```
    Stops the receiving and processing of market data.
    
    Throws:
    
    InterruptedException - if method will be interrupted.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CmeMdHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CmeMdHandler

Method Detail

getDirectBookDefaultDepth

setDirectBookDefaultDepth

getImpliedBookDefaultDepth

setImpliedBookDefaultDepth

getBookUpdatedCallbackPolicy

setBookUpdatedCallbackPolicy

getSecurityIdFilters

getSecurityGroupFilters

getSymbolFilters

addSecurityIdFilter

removeSecurityIdFilter

clearSecurityIdFilters

addSymbolFilter

removeSymbolFilter

clearSymbolFilters

addGroupIdFilter

removeGroupIdFilter

clearGroupIdFilters

getState

getReportNoDataWarning

setReportNoDataWarning

getUseIncrementalFeedA

setUseIncrementalFeedA

getUseIncrementalFeedB

setUseIncrementalFeedB

getUseSnapshotFeedA

setUseSnapshotFeedA

getUseSnapshotFeedB

setUseSnapshotFeedB

getUseInstrumentReplayFeedA

setUseInstrumentReplayFeedA

getUseInstrumentReplayFeedB

setUseInstrumentReplayFeedB

getUdpClientFactory

setUdpClientFactory

getSocketBufferSize

setSocketBufferSize

getUseIpSourceFiltering

setUseIpSourceFiltering

getProtocolFamily

setProtocolFamily

getReceiveMode

setReceiveMode

getIncrementalCacheSize

setIncrementalCacheSize

getOutOfOrderIncrementalQueueSize

getNumberOfQueuedIncrementalRefreshMessages

getBestBidAskTrackingOptions

getMaximumNumberOfQueuedIncrementalRefreshMessages

setMaximumNumberOfQueuedIncrementalRefreshMessages

registerInfoListener

unregisterInfoListener

registerErrorListener

unregisterErrorListener

registerWarningListener

unregisterWarningListener

registerSecurityDefinitionListener

unregisterSecurityDefinitionListener

registerStateChangedListener

unregisterStateChangedListener

registerLogReplayListener

unregisterLogReplayListener

registerStatisticsListener

unregisterStatisticsListener

registerRegularBookChangedListener

unregisterRegularBookChangedListener

registerRegularBookUpdatedListener

unregisterRegularBookUpdatedListener

registerImpliedBookChangedListener

unregisterImpliedBookChangedListener

registerImpliedBookUpdatedListener

unregisterImpliedBookUpdatedListener

registerMarketByOrderBookChangedListener