uk.co.real_logic.artio.library

Class LibraryConfiguration

java.lang.Object

uk.co.real_logic.artio.CommonConfiguration

uk.co.real_logic.artio.library.LibraryConfiguration

public final class LibraryConfiguration
extends CommonConfiguration

Provides configuration for initiating an instance of Fix Library. Individual configuration options are documented on their setters. NB: DO NOT REUSE this object over multiple FixLibrary.connect() calls.

See Also:

FixLibrary

Field Summary

Fields

Modifier and Type	Field and Description
static GatewayErrorHandler	DEFAULT_GATEWAY_ERROR_HANDLER
static LibraryConnectHandler	DEFAULT_LIBRARY_CONNECT_HANDLER
static SessionExistsHandler	DEFAULT_SESSION_EXISTS_HANDLER
static SessionProxyFactory	DEFAULT_SESSION_PROXY_FACTORY

Fields inherited from class uk.co.real_logic.artio.CommonConfiguration

BACKOFF_SPINS, BACKOFF_YIELDS, DEBUG_FILE, DEBUG_FILE_PROPERTY, DEBUG_LOGGING_SEPARATOR, DEBUG_PRINT_MESSAGE_TYPES, DEBUG_PRINT_MESSAGE_TYPES_PROPERTY, DEBUG_PRINT_MESSAGES, DEBUG_PRINT_MESSAGES_PROPERTY, DEBUG_PRINT_THREAD, DEBUG_PRINT_THREAD_PROPERTY, DEBUG_TAGS, DEFAULT_DEBUG_LOGGING_SEPARATOR, DEFAULT_DIRECTORY, DEFAULT_HEARTBEAT_INTERVAL_IN_S, DEFAULT_HISTOGRAM_LOGGING_FILE, DEFAULT_HISTOGRAM_POLL_PERIOD_IN_MS, DEFAULT_INBOUND_LIBRARY_STREAM, DEFAULT_INBOUND_MAX_CLAIM_ATTEMPTS, DEFAULT_MAX_FIXP_KEEPALIVE_TIMEOUT_IN_MS, DEFAULT_MONITORING_BUFFER_LENGTH, DEFAULT_MONITORING_FILE, DEFAULT_NAME_PREFIX, DEFAULT_OUTBOUND_LIBRARY_STREAM, DEFAULT_OUTBOUND_MAX_CLAIM_ATTEMPTS, DEFAULT_PRINT_AERON_STREAM_IDENTIFIERS, DEFAULT_REASONABLE_TRANSMISSION_TIME_IN_MS, DEFAULT_REASONABLE_TRANSMISSION_TIME_IN_S, DEFAULT_REPLY_TIMEOUT_IN_MS, DEFAULT_RESEND_REQUEST_CONTROLLER, DEFAULT_SENDING_TIME_WINDOW, DEFAULT_SESSION_BUFFER_SIZE, FORCE_WRITES, FORCE_WRITES_MESSAGES_PROPERTY, HISTOGRAM_LOGGING_FILE_PROPERTY, HISTOGRAM_POLL_PERIOD_IN_MS_PROPERTY, INBOUND_MAX_CLAIM_ATTEMPTS_PROPERTY, LOGGING_SEPARATOR_PROPERTY, MONITORING_BUFFERS_LENGTH_PROPERTY, MONITORING_FILE_PROPERTY, NO_FIXP_MAX_RETRANSMISSION_RANGE, OUTBOUND_MAX_CLAIM_ATTEMPTS_PROPERTY, RUNNING_ON_WINDOWS, threadFactory, TIME_MESSAGES, TIME_MESSAGES_PROPERTY

Constructor Summary

Constructors

Constructor and Description
LibraryConfiguration()

Method Summary

Modifier and Type	Method and Description
LibraryConfiguration	backpressureMessagesDuringReplay(boolean backpressureMessagesDuringReplay) Configures whether Session.trySend() methods such as Session.trySend(Encoder) backpressure attempts to write FIX messages whilst a replay is in progress.
LibraryConfiguration	epochNanoClock(org.agrona.concurrent.EpochNanoClock epochNanoClock) Sets the clock used for producing requestTimestamp fields on iLink3 messages.
LibraryConfiguration	fixPAcceptedSessionMaxRetransmissionRange(int fixPAcceptedSessionMaxRetransmissionRange) Sets the maximum count allowed in a FIXP retransmit request.
LibraryConfiguration	fixPConnectionAcquiredHandler(FixPConnectionAcquiredHandler fixPConnectionAcquiredHandler) When a new FIXP session connects to the gateway you register a callback handler to find out about the event.
LibraryConfiguration	fixPConnectionExistsHandler(FixPConnectionExistsHandler fixPConnectionExistsHandler)
GatewayErrorHandler	gatewayErrorHandler()
LibraryConfiguration	gatewayErrorHandler(GatewayErrorHandler gatewayErrorHandler)
java.util.List<java.lang.String>	libraryAeronChannels()
LibraryConfiguration	libraryAeronChannels(java.util.List<java.lang.String> libraryAeronChannels) Sets the list of aeron channels used to connect to the Engine
LibraryConnectHandler	libraryConnectHandler()
LibraryConfiguration	libraryConnectHandler(LibraryConnectHandler libraryConnectHandler)
int	libraryId()
org.agrona.concurrent.IdleStrategy	libraryIdleStrategy()
LibraryConfiguration	libraryIdleStrategy(org.agrona.concurrent.IdleStrategy libraryIdleStrategy) Sets the idle strategy for the FIX library instance.
LibraryConfiguration	libraryName(java.lang.String libraryName)
LibraryConfiguration	monitoringBuffersLength(java.lang.Integer monitoringBuffersLength) Sets the length of the buffer used for monitoring counters.
LibraryConfiguration	monitoringFile(java.lang.String monitoringFile) Sets the location for the monitoring file.
LibraryConfiguration	noEstablishFixPTimeoutInMs(long noEstablishFixPTimeoutInMs) Sets the timeout in milliseconds before a FIXP TCP connection is closed if no establish message is sent.
LibraryConfiguration	replyTimeoutInMs(long replyTimeoutInMs) Sets the reply timeout in milliseconds.
LibraryConfiguration	resendRequestController(ResendRequestController resendRequestController) Configures how a resend request is responded to.
LibraryScheduler	scheduler()
LibraryConfiguration	scheduler(LibraryScheduler scheduler)
SessionAcquireHandler	sessionAcquireHandler()
LibraryConfiguration	sessionAcquireHandler(SessionAcquireHandler sessionAcquireHandler) When a new FIX session connects to the gateway you register a callback handler to find out about the event.
LibraryConfiguration	sessionExistsHandler(SessionExistsHandler sessionExistsHandler)
LibraryConfiguration	sessionIdStrategy(SessionIdStrategy sessionIdStrategy) Sets the session id strategy.
SessionProxyFactory	sessionProxyFactory()
LibraryConfiguration	sessionProxyFactory(SessionProxyFactory sessionProxyFactory) Sets the factory for creating Session Proxies.

Methods inherited from class uk.co.real_logic.artio.CommonConfiguration

aeronContext, agentNamePrefix, agentNamePrefix, backoffIdleStrategy, backpressureMessagesDuringReplay, conclude, connectAttemptTimeoutInMs, customErrorConsumer, defaultHeartbeatIntervalInS, defaultHeartbeatIntervalInS, epochNanoClock, errorHandlerFactory, errorHandlerFactory, fixPAcceptedSessionMaxRetransmissionRange, histogramHandler, histogramHandler, histogramLoggingFile, histogramLoggingFile, histogramPollPeriodInMs, histogramPollPeriodInMs, inboundLibraryStream, inboundLibraryStream, inboundMaxClaimAttempts, inboundMaxClaimAttempts, maxFixPKeepaliveTimeoutInMs, maxFixPKeepaliveTimeoutInMs, messageValidationStrategy, messageValidationStrategy, monitoringAgentFactory, monitoringAgentFactory, monitoringBuffersLength, monitoringFile, monitoringThreadIdleStrategy, monitoringThreadIdleStrategy, noEstablishFixPTimeoutInMs, optimalTmpDirName, outboundLibraryStream, outboundLibraryStream, outboundMaxClaimAttempts, outboundMaxClaimAttempts, printAeronStreamIdentifiers, printAeronStreamIdentifiers, printErrorMessages, reasonableTransmissionTimeInMs, reasonableTransmissionTimeInMs, replyTimeoutInMs, resendRequestController, sendingTimeWindowInMs, sendingTimeWindowInMs, sessionBufferSize, sessionBufferSize, sessionCustomisationStrategy, sessionCustomisationStrategy, sessionEpochFractionFormat, sessionEpochFractionFormat, sessionIdStrategy, threadFactory, threadFactory, validateCompIdsOnEveryMessage, validateCompIdsOnEveryMessage, validateTimeout, validateTimeStrictly, validateTimeStrictly

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_GATEWAY_ERROR_HANDLER

public static final GatewayErrorHandler DEFAULT_GATEWAY_ERROR_HANDLER

DEFAULT_SESSION_EXISTS_HANDLER

public static final SessionExistsHandler DEFAULT_SESSION_EXISTS_HANDLER

DEFAULT_LIBRARY_CONNECT_HANDLER

public static final LibraryConnectHandler DEFAULT_LIBRARY_CONNECT_HANDLER

DEFAULT_SESSION_PROXY_FACTORY

public static final SessionProxyFactory DEFAULT_SESSION_PROXY_FACTORY

Constructor Detail

LibraryConfiguration

public LibraryConfiguration()

Method Detail

sessionAcquireHandler

public LibraryConfiguration sessionAcquireHandler(SessionAcquireHandler sessionAcquireHandler)

When a new FIX session connects to the gateway you register a callback handler to find out about the event. This method sets the handler for this library instance. Only needed if this is the accepting library instance.

Parameters:

sessionAcquireHandler - the new session handler

Returns:

this

See Also:

for the FIXP equivalent

fixPConnectionAcquiredHandler

public LibraryConfiguration fixPConnectionAcquiredHandler(FixPConnectionAcquiredHandler fixPConnectionAcquiredHandler)

When a new FIXP session connects to the gateway you register a callback handler to find out about the event. This method sets the handler for this library instance. Only needed if this is the accepting library instance.

Parameters:

fixPConnectionAcquiredHandler - the new session handler

Returns:

this

See Also:

for the FIX equivalent

libraryIdleStrategy

public LibraryConfiguration libraryIdleStrategy(org.agrona.concurrent.IdleStrategy libraryIdleStrategy)

Sets the idle strategy for the FIX library instance.

Parameters:

libraryIdleStrategy - the idle strategy for the FIX library instance.

Returns:

this

sessionExistsHandler

public LibraryConfiguration sessionExistsHandler(SessionExistsHandler sessionExistsHandler)

fixPConnectionExistsHandler

public LibraryConfiguration fixPConnectionExistsHandler(FixPConnectionExistsHandler fixPConnectionExistsHandler)

gatewayErrorHandler

public LibraryConfiguration gatewayErrorHandler(GatewayErrorHandler gatewayErrorHandler)

libraryConnectHandler

public LibraryConfiguration libraryConnectHandler(LibraryConnectHandler libraryConnectHandler)

scheduler

public LibraryConfiguration scheduler(LibraryScheduler scheduler)

sessionAcquireHandler

public SessionAcquireHandler sessionAcquireHandler()

libraryId

public int libraryId()

libraryIdleStrategy

public org.agrona.concurrent.IdleStrategy libraryIdleStrategy()

gatewayErrorHandler

public GatewayErrorHandler gatewayErrorHandler()

libraryConnectHandler

public LibraryConnectHandler libraryConnectHandler()

scheduler

public LibraryScheduler scheduler()

sessionProxyFactory

public SessionProxyFactory sessionProxyFactory()

sessionIdStrategy

public LibraryConfiguration sessionIdStrategy(SessionIdStrategy sessionIdStrategy)

Sets the session id strategy.

Overrides:

sessionIdStrategy in class CommonConfiguration

Parameters:

sessionIdStrategy - the session id strategy.

Returns:

this

See Also:

SessionIdStrategy

monitoringBuffersLength

public LibraryConfiguration monitoringBuffersLength(java.lang.Integer monitoringBuffersLength)

Sets the length of the buffer used for monitoring counters.

Overrides:

monitoringBuffersLength in class CommonConfiguration

Parameters:

monitoringBuffersLength - the length of the buffer used for monitoring counters.

Returns:

this

See Also:

CommonConfiguration.MONITORING_BUFFERS_LENGTH_PROPERTY

monitoringFile

public LibraryConfiguration monitoringFile(java.lang.String monitoringFile)

Sets the location for the monitoring file.

Overrides:

monitoringFile in class CommonConfiguration

Parameters:

monitoringFile - the location for the monitoring file.

Returns:

this

See Also:

CommonConfiguration.MONITORING_FILE_PROPERTY

libraryAeronChannels

public LibraryConfiguration libraryAeronChannels(java.util.List<java.lang.String> libraryAeronChannels)

Sets the list of aeron channels used to connect to the Engine

Parameters:

libraryAeronChannels - the list of aeron channels used to connect to the Engine

Returns:

this

sessionProxyFactory

public LibraryConfiguration sessionProxyFactory(SessionProxyFactory sessionProxyFactory)

Sets the factory for creating Session Proxies.

Parameters:

sessionProxyFactory - the factory for creating Session Proxies.

Returns:

this

See Also:

SessionProxy

replyTimeoutInMs

public LibraryConfiguration replyTimeoutInMs(long replyTimeoutInMs)

Sets the reply timeout in milliseconds.

This is the timeout for control protocol messages between the FIX Gateway and FIX Library instances.

Overrides:

replyTimeoutInMs in class CommonConfiguration

Parameters:

replyTimeoutInMs - the reply timeout in milliseconds.

Returns:

this

noEstablishFixPTimeoutInMs

public LibraryConfiguration noEstablishFixPTimeoutInMs(long noEstablishFixPTimeoutInMs)

Sets the timeout in milliseconds before a FIXP TCP connection is closed if no establish message is sent. This is analogous to EngineConfiguration.noLogonDisconnectTimeoutInMs(int) for FIX.

Overrides:

noEstablishFixPTimeoutInMs in class CommonConfiguration

Parameters:

noEstablishFixPTimeoutInMs - the time before a FIXP connection is closed if no establish message is sent.

Returns:

this

fixPAcceptedSessionMaxRetransmissionRange

public LibraryConfiguration fixPAcceptedSessionMaxRetransmissionRange(int fixPAcceptedSessionMaxRetransmissionRange)

Sets the maximum count allowed in a FIXP retransmit request. This is only used for accepted FIXP sessions, such as Binary Entrypoint.

Overrides:

fixPAcceptedSessionMaxRetransmissionRange in class CommonConfiguration

Parameters:

fixPAcceptedSessionMaxRetransmissionRange - the maximum count allowed in a FIXP retransmit request.

Returns:

this

epochNanoClock

public LibraryConfiguration epochNanoClock(org.agrona.concurrent.EpochNanoClock epochNanoClock)

Sets the clock used for producing requestTimestamp fields on iLink3 messages.

Overrides:

epochNanoClock in class CommonConfiguration

Parameters:

epochNanoClock - the clock used for producing requestTimestamp fields on iLink3 messages.

Returns:

this

backpressureMessagesDuringReplay

public LibraryConfiguration backpressureMessagesDuringReplay(boolean backpressureMessagesDuringReplay)

Configures whether Session.trySend() methods such as Session.trySend(Encoder) backpressure attempts to write FIX messages whilst a replay is in progress. Defaults to true. Artio can disconnect slow consumer FIX sessions in certain situations. This is a particularly high risk event if an Artio user attempts to write messages to a FIX session, whilst simultaneously a replay is going on. Artio's replay mechanism takes account of the backpressure rates in order to avoid triggering a slow-consumer disconnect whilst a replay is in progress. Setting this option to true (the default) ensures that a slow-consumer disconnect won't happen during a replay. An alternative perspective of back-pressure in an Artio system is that if a slow consumer cannot read messages sent in response to a resend request whilst FIX messages are being written into the queue then it should trigger a slow consumer disconnect as expected. Setting this configuration option to false results in this behaviour.

Overrides:

backpressureMessagesDuringReplay in class CommonConfiguration

Parameters:

backpressureMessagesDuringReplay - true if you want to apply back-pressure to libraries during replay.

Returns:

this

resendRequestController

public LibraryConfiguration resendRequestController(ResendRequestController resendRequestController)

Configures how a resend request is responded to. We default to responding to any valid resend request. See Javadoc on ResendRequestController for details of how to implement it.

Overrides:

resendRequestController in class CommonConfiguration

Parameters:

resendRequestController - the controller to use.

Returns:

this

libraryAeronChannels

public java.util.List<java.lang.String> libraryAeronChannels()

libraryName

public LibraryConfiguration libraryName(java.lang.String libraryName)