com.marketfactory.mfclient.api

Interface MFSession

All Known Subinterfaces:

MFMarketDataSession, MFStpBookingSession, MFTradeDateRolloverSession, MFTradingSession

All Known Implementing Classes:

MFMarketDataSessionToCoreMarketDataSessionAdapter, MFStpBookingSessionToCoreStpBookingSessionAdapter, MFTradeDateRolloverSessionToCoreTradeDateRolloverSessionAdapter, MFTradingSessionToCoreTradingSessionAdapter

public interface MFSession

Common methods for all MFSession types

Method Summary

Modifier and Type	Method and Description
int	getPort() The port used for this session.
long	getSendingTime() Retrieves the MF server sending time (nanoseconds since epoch) of the current message frame.
java.lang.String	getUsername() The username used for this session.
boolean	isLoggedOn()
void	logon() Sends a logon message with the supplied username and password.
void	logout() Initiates logout.
void	logoutResponse() The response to a logout from the server.

Method Detail

getUsername

java.lang.String getUsername()

The username used for this session.

Returns:

username associated with this session.

getPort

int getPort()

The port used for this session. Useful to see if the port was calculated.

Returns:

the port associated with this session.

logon

void logon()
    throws MFException

Sends a logon message with the supplied username and password. Should only be called in the event loop by the handler.

Throws:

MFException - If there is an error when attempting to send this message.

logout

void logout()
     throws MFException

Initiates logout. This should be called so a clean and dirty (one where the socket closes w/o a logout) can be easily differentiated. Can be called from any thread

Throws:

MFException - If there is an error when attempting to send this message.

isLoggedOn

boolean isLoggedOn()

logoutResponse

void logoutResponse()
             throws MFException

The response to a logout from the server. This should be called if a logout is received so that the client can indicate a clean logout. Can be called from any thread

Throws:

MFException - If there is an error when attempting to send this message.

getSendingTime

long getSendingTime()

Retrieves the MF server sending time (nanoseconds since epoch) of the current message frame. If the message frame has multiple messages the returned timestamp might be the same for several callbacks messages.
If called before data is received, will return 0.
Note: No synchronization. Should not be called outside the callback thread.

Returns:

timestamp current message was sent from the MF servers (in nanos)