com.marketfactory.mfclient.api

Interface MFClient

public interface MFClient

Central class for managing sessions with MarketFactory.

Create sessions using this class. They will be automatically registered with this MFClient.

Port calculation:

• If the MFClient was created with a baseport (using MFFactory.createMFClient(int)) then you can provide AUTO_CALCULATE_PORT_VALUE as the port parameter when creating a session (either trading or market data) and the port will be calculated automatically.
  You may still set the port parameter when creating a session and the session will use the provided value instead of calculating.
• If the MFClient was created without a baseport (using MFFactory.createMFClient() then you must provide a port to the trading session (if any). If you do, then subsequent market data sessions can use the AUTO_CALCULATE_PORT_VALUE as the port parameter and the port will be calculated using the trading session's port.
  If you do not create a trading session first, or there will not be a trading session, then you must provide a valid port when creating market data sessions.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO_CALCULATE_PORT_VALUE

Method Summary

Modifier and Type	Method and Description
boolean	isMarketDataSessionRegistered(long venueID) Returns whether or not there is a registered market data session for a venueID.
boolean	isRunning() If this MFClient instance is running.
boolean	isStopped() Returns true if this MFClient is stopped either due to an exception or the stop method being invoked.
MFMarketDataSession	newTcpMarketDataPriceDepthBookSession(MFPriceDepthBookHandler handler, java.lang.String venueName, long venueID, java.lang.String username, java.lang.String password, java.lang.String hostname, int port, boolean autoRelogon) Creates and registers a MFMarketDataSession for connecting to a particular venue gateway over TCP.
MFMarketDataSession	newTcpMarketDataSession(MFMarketDataHandler handler, java.lang.String venueName, long venueID, java.lang.String username, java.lang.String password, java.lang.String hostname, int port, boolean autoRelogon) Creates and registers a MFMarketDataSession for connecting to a particular venue gateway over TCP.
MFStpBookingSession	newTcpStpBookingSession(MFStpBookingHandler handler, java.lang.String username, java.lang.String password, java.lang.String hostname, int port, boolean autoRelogon) Creates and registers a MFStpBookingSession for connecting to a particular venue gateway over TCP.
MFTradeDateRolloverSession	newTcpTradeDateRolloverSession(MFTradeDateRolloverHandler handler, java.lang.String username, java.lang.String password, java.lang.String hostname, int port, boolean autoRelogon)
MFTradingSession	newTcpTradingSession(MFTradingHandler handler, java.lang.String username, java.lang.String password, java.lang.String hostname, int port, boolean autoRelogon) Creates and registers a session for connecting to the trading gateway over TCP.
void	run() Runs the event loop.
void	stop() Stops the event loop and closes open sockets.

Field Detail

AUTO_CALCULATE_PORT_VALUE

static final int AUTO_CALCULATE_PORT_VALUE

See Also:

Constant Field Values

Method Detail

run

void run()
  throws MFException

Runs the event loop. This will trigger the onStart method on any registered handlers. If this loop ends due to an exception or by the user calling stop(), the MFClient is dead and cannot be reused.

Note: Only one thread should call this method. If another thread calls this method an MFException will be thrown.
Note: run() cannot be called after this MFClient is stop()ed. An exception will be thrown.

Throws:

MFException

isRunning

boolean isRunning()

If this MFClient instance is running. run() should not be called if it is.

Returns:

true if the MFClient is running (i.e. run() has been called and is still executing

stop

void stop()
   throws MFException

Stops the event loop and closes open sockets. This is not a 'nice' shutdown. Subscriptions will not be unsubscribed for and no Logout message will be sent to the server. Signals onStop in all registered handlers.

This can be called from an external thread or internally from a handler.

Throws:

MFException - if there was an problem shutting down

isStopped

boolean isStopped()

Returns true if this MFClient is stopped either due to an exception or the stop method being invoked. The client cannot be reused if it has been stopped.

Returns:

true if stopped, false otherwise (i.e. not started or is running)

newTcpTradingSession

MFTradingSession newTcpTradingSession(MFTradingHandler handler,
                                      java.lang.String username,
                                      java.lang.String password,
                                      java.lang.String hostname,
                                      int port,
                                      boolean autoRelogon)
                               throws MFException

Creates and registers a session for connecting to the trading gateway over TCP.

You can only register a single trading session on an MFClient

See the port rules in the class documentation

Parameters:

autoRelogon - automatically relogons when a disconnection occurs.

Throws:

MFException

newTcpMarketDataSession

MFMarketDataSession newTcpMarketDataSession(MFMarketDataHandler handler,
                                            java.lang.String venueName,
                                            long venueID,
                                            java.lang.String username,
                                            java.lang.String password,
                                            java.lang.String hostname,
                                            int port,
                                            boolean autoRelogon)
                                     throws MFException

Creates and registers a MFMarketDataSession for connecting to a particular venue gateway over TCP.

See the port rules in the class documentation

Parameters:

autoRelogon - automatically relogons when a disconnection occurs.

Throws:

MFException

newTcpMarketDataPriceDepthBookSession

MFMarketDataSession newTcpMarketDataPriceDepthBookSession(MFPriceDepthBookHandler handler,
                                                          java.lang.String venueName,
                                                          long venueID,
                                                          java.lang.String username,
                                                          java.lang.String password,
                                                          java.lang.String hostname,
                                                          int port,
                                                          boolean autoRelogon)
                                                   throws MFException

Creates and registers a MFMarketDataSession for connecting to a particular venue gateway over TCP.

Provides market data updates as a PriceDepthBook through the provided MFPriceDepthBookHandler

See the port rules in the class documentation

Parameters:

autoRelogon - automatically relogons when a disconnection occurs.

Throws:

MFException

newTcpTradeDateRolloverSession

MFTradeDateRolloverSession newTcpTradeDateRolloverSession(MFTradeDateRolloverHandler handler,
                                                          java.lang.String username,
                                                          java.lang.String password,
                                                          java.lang.String hostname,
                                                          int port,
                                                          boolean autoRelogon)
                                                   throws MFException

Throws:

MFException

newTcpStpBookingSession

MFStpBookingSession newTcpStpBookingSession(MFStpBookingHandler handler,
                                            java.lang.String username,
                                            java.lang.String password,
                                            java.lang.String hostname,
                                            int port,
                                            boolean autoRelogon)
                                     throws MFException

Creates and registers a MFStpBookingSession for connecting to a particular venue gateway over TCP. See the port rules in the class documentation

Parameters:

autoRelogon - automatically relogons when a disconnection occurs.

Throws:

MFException

isMarketDataSessionRegistered

boolean isMarketDataSessionRegistered(long venueID)

Returns whether or not there is a registered market data session for a venueID.

Parameters:

venueID - id of the venue to check