Class Engine
FIX Engine.
Inherited Members
Namespace: OnixS.Fix
Assembly: OnixS.Fix.Engine.dll
Syntax
public class Engine : IEventSink
Properties
DictionaryManager
Returns the DictionaryManager.
Declaration
public DictionaryManager DictionaryManager { get; }
Property Value
Type | Description |
---|---|
DictionaryManager | Dictionary Manager |
Instance
The instance of the engine.
Declaration
public static Engine Instance { get; }
Property Value
Type | Description |
---|---|
Engine | The instance of the engine. |
IsInitialized
Gets the FIX Engine initialization status.
Declaration
public static bool IsInitialized { get; }
Property Value
Type | Description |
---|---|
Boolean | Engine initialized status |
LicenseExpirationDate
Declaration
public DateTime LicenseExpirationDate { get; }
Property Value
Type | Description |
---|---|
DateTime |
Settings
Returns Engine settings.
Declaration
public EngineSettings Settings { get; }
Property Value
Type | Description |
---|---|
EngineSettings | the Engine settings |
Methods
AddListenPort(Int32)
Adds the listen port for incoming connections.
Declaration
public void AddListenPort(int port)
Parameters
Type | Name | Description |
---|---|---|
Int32 | port | New listen port for incoming connections. |
AddListenPorts(IList<Int32>)
Adds the listen port(s) for incoming connections.
Declaration
public void AddListenPorts(IList<int> ports)
Parameters
Type | Name | Description |
---|---|---|
IList<Int32> | ports | New listen ports for incoming connections. |
Init()
Initializes the engine. Must be called before any other method of the library.
Declaration
public static Engine Init()
Returns
Type | Description |
---|---|
Engine | instance of the Engine. |
Init(EngineSettings)
Initializes the engine. Must be called before any other method of the library.
Declaration
public static Engine Init(EngineSettings settings)
Parameters
Type | Name | Description |
---|---|---|
EngineSettings | settings | Engine configuration settings |
Returns
Type | Description |
---|---|
Engine | instance of the Engine. |
Init(Int32)
Initializes the Fix Engine.
Note: Must be called before any other method of the library.
Declaration
public static Engine Init(int listenPort)
Parameters
Type | Name | Description |
---|---|---|
Int32 | listenPort | The engine listens on this port for incoming connections. |
Returns
Type | Description |
---|---|
Engine | Engine instance |
Log(String)
Declaration
public void Log(string info)
Parameters
Type | Name | Description |
---|---|---|
String | info |
LogTimestamp()
Returns the current UTC timestamp in the session storage's log format. For example: YYYYMMDD-HH:MM:SS:nanoseconds (e.g. 19750118-15:07:08.123456789).
Declaration
public static string LogTimestamp()
Returns
Type | Description |
---|---|
String |
OnError(EngineErrorEventArgs)
Declaration
protected virtual void OnError(EngineErrorEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
EngineErrorEventArgs | e |
OnIncomingTelecommunicationLink(IncomingTelecommunicationLinkEventArgs)
Declaration
protected virtual void OnIncomingTelecommunicationLink(IncomingTelecommunicationLinkEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
IncomingTelecommunicationLinkEventArgs | e |
OnUnknownIncomingConnection(UnknownIncomingConnectionEventArgs)
Declaration
protected virtual void OnUnknownIncomingConnection(UnknownIncomingConnectionEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
UnknownIncomingConnectionEventArgs | e |
OnWarning(EngineWarningEventArgs)
Declaration
protected virtual void OnWarning(EngineWarningEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
EngineWarningEventArgs | e |
RemoveListenPort(Int32)
Removes the listen port for incoming connections.
Declaration
public void RemoveListenPort(int port)
Parameters
Type | Name | Description |
---|---|---|
Int32 | port | Listen port to remove. |
RemoveListenPorts(IList<Int32>)
Removes the listen port(s) for incoming connections.
Declaration
public void RemoveListenPorts(IList<int> ports)
Parameters
Type | Name | Description |
---|---|---|
IList<Int32> | ports | Listen ports to remove. |
Shutdown()
Shut downs the engine.
Declaration
public void Shutdown()
Events
Error
Error condition is detected.
Declaration
public event EventHandler<EngineErrorEventArgs> Error
Event Type
Type | Description |
---|---|
EventHandler<EngineErrorEventArgs> |
IncomingTelecommunicationLink
Incoming telecommunication link is detected.
Declaration
public event EventHandler<IncomingTelecommunicationLinkEventArgs> IncomingTelecommunicationLink
Event Type
Type | Description |
---|---|
EventHandler<IncomingTelecommunicationLinkEventArgs> |
UnknownIncomingConnection
Unknown incoming FIX Connection is detected.
Declaration
public event EventHandler<UnknownIncomingConnectionEventArgs> UnknownIncomingConnection
Event Type
Type | Description |
---|---|
EventHandler<UnknownIncomingConnectionEventArgs> |
Warning
Warning condition is detected.
Declaration
public event EventHandler<EngineWarningEventArgs> Warning
Event Type
Type | Description |
---|---|
EventHandler<EngineWarningEventArgs> |