Determines whether recovery is required for the FIX engine specified.

Namespace:  Teraspaces.QWFIX.Application
Assembly:  Teraspaces.QWFIX.Application (in Teraspaces.QWFIX.Application.dll) Version: 2.5.0.0 (2.5.0.0)

Syntax

            
 C#  Visual Basic  Visual C++  J# 
public bool IsRecoveryRequired(
	string engineName,
	string fixLogDirectory,
	out bool engineSettingsUpdated
)
Public Function IsRecoveryRequired ( _
	engineName As String, _
	fixLogDirectory As String, _
	<OutAttribute> ByRef engineSettingsUpdated As Boolean _
) As Boolean
public:
bool IsRecoveryRequired(
	String^ engineName, 
	String^ fixLogDirectory, 
	[OutAttribute] bool% engineSettingsUpdated
)
public boolean IsRecoveryRequired(
	String engineName,
	String fixLogDirectory,
	/** @attribute OutAttribute */ /** @ref */boolean engineSettingsUpdated
)

Parameters

engineName
String
Name of the FIX engine.
fixLogDirectory
String
The log directory.
engineSettingsUpdated
Boolean %
A value indicating whether the version of the FIX engine settings is updated.

Return Value

true if recovery is required; otherwise, false.

Remarks

Recovery is required if the process is unexpectedly terminated and the FIX engine scheduler of the current engine has not expired as of the time this method is called.

This method should be called before Run(String, FIXEngineRole, String, FIXStandaloneApplicationStartupMode, Boolean) is called. The main purpose of this method is to give user an option to determine FIXStandaloneApplicationStartupMode parameter in Run(String, FIXEngineRole, String, FIXStandaloneApplicationStartupMode, Boolean) method; if recovery is required. For example, if engineSettingsUpdated is true, Recover will keep using the old FIX engine settings; while Reconfig will take the latest settings and convert the message log to the latest settings before starting the FIX engine (Note: Some restriction may apply about how the settings can be modified in order to use Reconfig).

Exceptions

ExceptionCondition
Teraspaces.QWFIX..::.FIXExceptionError occurs during this operation. Check the inner exception for more details.

See Also