FixEngine class

class V12.FIXAntenna.FixEngine

FIX Engine interface.

__init__([prop_file : str = ""]) → FixEngine

Initializes the Engine.

Parameters

prop_file (str) – The FIX Engine configuration parameter`s file name. If it is equal to “” or omitted, then “./engine.properties” is used.

Returns

An instance of this class.

Return type

FixEngine

Note

Must be called before any other method of this library.

create_session(session_id: SessionId, parser_name: str) → Session

Creates a new FIX Session. It is the user’s responsibility to call the Session.finalize() method.

Parameters

  • session_id (SessionId) – The session identifier.

  • parser_name (str) – Name of the parser( ‘id’ attribute in the FIX Dictionary file ). A FIX Parser should be created for this.

Returns

The created session.

Return type

Session

Note

Two sessions with the same values of senderCompID and targetCompID cannot be created.

Warning

Do not delete the Application while the session is not terminated.

create_session(session_id: SessionId, parser_name: str, app_protocol: FIXVersion) → Session

Creates a new FIX Session. It is the user’s responsibility to call the Session.finalize() method.

Parameters

  • session_id (SessionId) – The session identifier.

  • parser_name (str) – Name of the parser( ‘id’ attribute in the FIX Dictionary file ). A FIX Parser should be created for this.

  • app_protocol (FIXVersion) – Default application FIX protocol version. Required if underlyingProtocolType equals FIXT11_TCP or parserID points to FIXT 1.1 protocol.

Returns

The created session.

Return type

Session

Note

Two sessions with the same values of senderCompID and targetCompID cannot be created.

Warning

Do not delete the Application while the session is not terminated.

create_session(session_id: SessionId, parser_name: str, app_protocol: FIXVersion, params: SessionParameters) → Session

Creates a new FIX Session. It is the user’s responsibility to call the Session.finalize() method.

Parameters

  • session_id (SessionId) – The session identifier.

  • parser_name (str) – Name of the parser( ‘id’ attribute in the FIX Dictionary file ). A FIX Parser should be created for this.

  • app_protocol (FIXVersion) – Default application FIX protocol version. Required if underlyingProtocolType equals FIXT11_TCP or parserID points to FIXT 1.1 protocol.

  • params (SessionParameters) – Session parameters.

Returns

The created session.

Return type

Session

Note

Two sessions with the same values of senderCompID and targetCompID cannot be created.

Warning

Do not delete the Application while the session is not terminated.

create_session(session_id: SessionId, parser_name: str, params: SessionParameters) → Session

Creates a new FIX Session. It is the user’s responsibility to call the Session.finalize() method.

Parameters

  • session_id (SessionId) – The session identifier.

  • parser_name (str) – Name of the parser( ‘id’ attribute in the FIX Dictionary file ). A FIX Parser should be created for this.

  • params (SessionParameters) – Session parameters.

Returns

The created session.

Return type

Session

Note

Two sessions with the same values of senderCompID and targetCompID cannot be created.

Warning

Do not delete the Application while the session is not terminated.

get_configured_sessions_ids() → List[SessionId]

Returns a list of SessionId for SessionParameters found in engine.properties.

Returns

A list of SessionId for SessionParameters found in engine.properties.

Return type

List[SessionId]

get_listen_port() → int

Returns engine listen port number.

Returns

Engine listen port number.

Return type

int

Note

if the value is 0 then the communication level must be disabled.