Engine Class Reference

#include <OnixS/FIXEngine/FIX/Engine.h>

Public Member Functions
void	log (const std::string &message)
int	listenPort () const
const std::string &	logDirectory () const
Timestamp	licenseExpirationDate () const
Dictionaries	dictionaries () const
void	addSessionDictionary (const std::string &dictionaryFile)
void	addSessionDictionaryFromString (const std::string &dialectString)
void	addListenPort (int port)
void	addListenPorts (const ListenPorts &ports)
void	removeListenPort (int port)
void	removeListenPorts (const ListenPorts &ports)
void	addSslListenPort (int port)
void	addSslListenPorts (const ListenPorts &ports)
void	removeSslListenPort (int port)
void	removeSslListenPorts (const ListenPorts &ports)
void	registerListener (IEngineListener *listener)
void	unregisterListener ()
void	synchronizeHighResolutionTimeServiceWithSystemTime ()
const EngineSettings &	settings () const

Static Public Member Functions
static Engine *	init (int listenPort=0)
static Engine *	init (const std::string &configFile)
static Engine *	initFromString (const std::string &configuration)
static Engine *	init (const EngineSettings &settings)
static void	shutdown ()
static Engine *	instance ()
static bool	initialized ()

Detailed Description

Definition at line 37 of file Engine.h.

Member Function Documentation

void addListenPort

(

int

port

)

Adds the listen port(s) for incoming connections.

Exceptions

Exception

if the FIX Engine cannot start listening on the specified port(s) or the telecommunication level is disabled (the Listen Port is -1 or 0).

Note

This call is thread-safe.

void addListenPorts

(

const ListenPorts &

ports

)

void addSessionDictionary

(

const std::string &

dictionaryFile

)

Adds the session level dictionary(s) from the XML file(s) with the description of the FIX Dictionary(s).

Note

More than one file could be specified. Symbol '|' is used as the file name delimiter.

Parameters

dictionaryFile

Specifies the path(s) to the XML file(s) with the description of the FIX Dictionary(s).

Exceptions

OnixS::DomainException

if there are standart dictionary(s) in the XML file(s).

Note

This call is thread-safe.

void addSessionDictionaryFromString

(

const std::string &

dialectString

)

Adds the session level dictionary(s) from the plain text string with the description of the FIX Dictionary(s).

Parameters

dialectString

Specifies the plain text string with the description of the FIX Dictionary(s).

Exceptions

OnixS::DomainException

if there are standart dictionary(s) in the dialect string.

Note

This call is thread-safe.

void addSslListenPort

(

int

port

)

Adds the ssl listen port(s) for incoming ssl connections.

Exceptions

Exception

if the FIX Engine cannot start listening on the specified ssl port(s) or the telecommunication level is disabled (the Listen Port is -1 or 0).

Note

This call is thread-safe.

void addSslListenPorts

(

const ListenPorts &

ports

)

Dictionaries dictionaries

(

)

const

Returns the array of loaded dictionaries.

static Engine* init ( int  listenPort = 0 )

static

Initializes the FIX Engine.

Parameters

listenPort

The engine listens on this port for incoming connections. If '0' then only session-initiators can be created. If '-1' then the telecommunication level is disabled and only message parsing/assembling can be used.

Note

This call is thread-safe.

static Engine* init ( const std::string &  configFile )

static

Initializes the FIX Engine.

Parameters

configFile

Configuration file.

Note

This call is thread-safe.

static Engine* init ( const EngineSettings &  settings )

static

Initializes the FIX Engine.

Parameters

settings

Engine settings.

Note

This call is thread-safe.

static Engine* initFromString ( const std::string &  configuration )

static

Initializes the FIX Engine.

Parameters

configuration

Configuration string.

Note

This call is thread-safe.

static bool initialized ( )

static

Returns 'true' if the FIX Engine has been initialized, otherwise - 'false'.

Note

This call is thread-safe.

static Engine* instance ( )

static

Returns the Engine instance.

Exceptions

OnixS::DomainException

if the FIX Engine has not been initialized yet.

Note

This call is thread-safe.

Timestamp licenseExpirationDate

(

)

const

Returns Engine's license expiration date.

int listenPort

(

)

const

Returns the listen port.

The FIX Engine listens on this port for incoming connections.

void log

(

const std::string &

message

)

Logs the given user's message to FIX Engine's log file.

Note

This call is thread-safe.

const std::string& logDirectory

(

)

const

Returns the Engine log directory.

Inbound and outbound FIX messages, session's state data, and the FIX Engine log file are stored in this directory.

void registerListener

(

IEngineListener *

listener

)

Registers the Engine listener.

Exceptions

Exception

if the listener is already registered.

Note

This call is thread-safe.

void removeListenPort

(

int

port

)

Removes the listen port(s) for incoming connections.

Exceptions

Exception

if the telecommunication level is disabled (the Listen Port is -1 or 0).

Note

This call is thread-safe.

void removeListenPorts

(

const ListenPorts &

ports

)

void removeSslListenPort

(

int

port

)

Removes the ssl listen port(s) for incoming ssl connections.

Exceptions

Exception

if the telecommunication level is disabled (the Listen Port is -1 or 0).

Note

This call is thread-safe.

void removeSslListenPorts

(

const ListenPorts &

ports

)

const EngineSettings& settings

(

)

const

Returns the current Engine-level settings.

static void shutdown ( )

static

Shutdowns the FIX Engine and releases all resources.

Note

This call is thread-safe.

void synchronizeHighResolutionTimeServiceWithSystemTime

(

)

Performs the synchronization of the high-resolution internal time service with the system time on Windows OS.

On OS less than Windows 8 and Windows Server 2012, the internal high-resolution time service, is based on QueryPerformanceCounter API. This service is synchronized with the system time only once when an application is started, as a result, a time difference can occur in time. Therefore, for such old windows versions, it makes sense to synchronize the internal time service periodically (e.g. once per day) with the system time to avoid time drift issues.

Exceptions

Exception

if there is a session in non-disconnected state.

Note

This call is thread-safe.

The method should be called when all sessions are disconnected to avoid time resynchronization side effects.

void unregisterListener

(

)

Un-registers the Engine listener.

Note

This call is thread-safe.

---

The documentation for this class was generated from the following file:

• OnixS/FIXEngine/FIX/Engine.h