com.marketfactory.mfapi.enterprise.api

Interface SessionBuilder

public interface SessionBuilder

Start here to create a SessionBuilder, populate the required information and build a Session.

Method Summary

Modifier and Type	Method and Description
Session	build() Builds the Session.
static SessionBuilder	createSessionBuilder()
SessionBuilder	withBackPressureNotificationHandler(BackPressureNotificationHandler backPressureNotificationHandler) Optional.
SessionBuilder	withCallbackHandler(CallbackHandler callbackHandler) Required.
SessionBuilder	withCredentials(java.lang.String username, java.lang.String password) Required.
SessionBuilder	withHeartbeatInterval(int heartbeatIntervalSeconds) Optional.
SessionBuilder	withHost(java.lang.String host, int port) Required.
SessionBuilder	withNextExpectedMessageSequenceNumberStore(NextExpectedMessageSequenceNumberStore incomingMsgSeqNumStore) Required.
SessionBuilder	withNextOutgoingMessageSequenceNumberStore(NextOutgoingMessageSequenceNumberStore outgoingMsgSeqNumStore) Required.
SessionBuilder	withResetSeqNum(boolean resetSeqNum) Optional.
SessionBuilder	withTcpReceiveBufferSizeHint(int tcpBufferReceiveSizeHint) Optional.
SessionBuilder	withTcpSendBufferSizeHint(int tcpSendBufferSizeHint) Optional.
SessionBuilder	withVenue(java.lang.String venueName, com.marketfactory.protocol.sbe4.SessionType sessionType) Required.

Method Detail

createSessionBuilder

static SessionBuilder createSessionBuilder()

withHost

SessionBuilder withHost(java.lang.String host,
                        int port)

Required. Set the host and port to connect to.

Parameters:

host - host

port - port

Returns:

SessionBuilder

withCredentials

SessionBuilder withCredentials(java.lang.String username,
                               java.lang.String password)

Required. Set the username and password to use for the session.

Parameters:

username - username to use to initiateLogon

password - password to use to initiateLogon

Returns:

SessionBuilder

withVenue

SessionBuilder withVenue(java.lang.String venueName,
                         com.marketfactory.protocol.sbe4.SessionType sessionType)

Required. Set the session venue and type.

Parameters:

venueName - venue to connect o

sessionType - service type to connect to

Returns:

SessionBuilder

withNextOutgoingMessageSequenceNumberStore

SessionBuilder withNextOutgoingMessageSequenceNumberStore(NextOutgoingMessageSequenceNumberStore outgoingMsgSeqNumStore)

Required. NextOutgoingMessageSequenceNumberStore to use for this session.

Parameters:

outgoingMsgSeqNumStore - to use for this session

Returns:

SessionBuilder

withNextExpectedMessageSequenceNumberStore

SessionBuilder withNextExpectedMessageSequenceNumberStore(NextExpectedMessageSequenceNumberStore incomingMsgSeqNumStore)

Required. NextExpectedMessageSequenceNumberStore to use for this session.

Parameters:

incomingMsgSeqNumStore - to use for this session

Returns:

SessionBuilder

withCallbackHandler

SessionBuilder withCallbackHandler(CallbackHandler callbackHandler)

Required. Handler for the messages and session events.

Parameters:

callbackHandler - handler

Returns:

SessionBuilder

withBackPressureNotificationHandler

SessionBuilder withBackPressureNotificationHandler(BackPressureNotificationHandler backPressureNotificationHandler)

Optional. Sets a back pressure notification handler. If not set, notifications will not be sent.

Parameters:

backPressureNotificationHandler - handler to notify on session back pressure events

Returns:

SessionBuilder

withHeartbeatInterval

SessionBuilder withHeartbeatInterval(int heartbeatIntervalSeconds)

Optional. Sets the heartbeat interval. Restricts the value to LogonEncoder.heartBtIntMinValue() ()} and LogonEncoder.heartBtIntMaxValue() If not set, defaults to SessionBuilderFactory.DEFAULT_HEARTBEAT_INTERVAL_SECONDS

Parameters:

heartbeatIntervalSeconds - seconds to set heartbeat interval to

Returns:

SessionBuilder

withResetSeqNum

SessionBuilder withResetSeqNum(boolean resetSeqNum)

Optional. Defaults false.
May be used freely in UAT. In Production, may only be set to True when SessionType=Pricing/Replay. Indicates both sides of a FIX session should reset sequence numbers, all messages queued for resend will be lost.

Parameters:

resetSeqNum - true to reset sequence numbers, false to leave client and server sequence numbers

Returns:

SessionBuilder

withTcpSendBufferSizeHint

SessionBuilder withTcpSendBufferSizeHint(int tcpSendBufferSizeHint)

Optional. Set the size of the TCP send buffer. This is a hint - in that the OS will attempt to size it to your requested value but might not be exact. StandardSocketOptions.SO_SNDBUF

Parameters:

tcpSendBufferSizeHint - bytes to set the TCP send buffer to

Returns:

SessionBuilder

withTcpReceiveBufferSizeHint

SessionBuilder withTcpReceiveBufferSizeHint(int tcpBufferReceiveSizeHint)

Optional. Set the size of the TCP receive buffer. This is a hint - in that the OS will attempt to size it to your requested value but might not be exact. StandardSocketOptions.SO_RCVBUF

Parameters:

tcpBufferReceiveSizeHint - bytes to set the TCP receive buffer to

Returns:

SessionBuilder

build

Session build()

Builds the Session. Might fail if values are missing.

Returns:

the built Session, ready to use.