Inter-Process Communication (IPC) Handler

<FIXEdge>
  <DllHandlers>
    <Handler Name="IPC1"
      Description="IPC Handler"
      DllName="./libIPCHandler-MD-x64.so"
      ListenAddress="/tmp/unixsock"
      ClientTag="ClientTagValue"      
      TimeoutUsec="100000"
      ClientConnectionWaitTimeoutMsec="100"
      AuxData="StaticIpc1AuxData"
      AuxDataContextKeyName="ResultAuxDataKeyName"
    />
  </DllHandlers>
  <BusinessLayer>
    <Rule Description="Sending to IPC client">
      <Source Name="NORTH-FE"/>
      <Action>
        <HandlerAction Name="IPC1" AuxData="DynamicIpc1AuxData" TimeoutUsec="15000" AuxDataContextKeyName="AuxDataKvKey"/>
      </Action>
    </Rule>
  </BusinessLayer>
</FIXEdge>

// Calling the IPC1 with the current FIX message, passing "HandlerAuxData" to the Client, binding the auxiliary data, sent by the client to the "IPC1_clientAuxData" key of the session KV storage.

handler("IPC1", [ 
	["TimeoutUsec", "150000"], 
	["AuxData", "HandlerAuxData"], 
	["AuxDataContextKeyName", "AuxDataKvKey"] 
]);

FIXEdge-SDK/ipc_client
FIXEdge-SDK/ipc_client/protocol.md                          # The actual protocol specification.
FIXEdge-SDK/ipc_client/Node.js                             # Node.js is similar for Windows and Linux.
FIXEdge-SDK/ipc_client/Node.js/fixedge_ipc_server.mjs      # Simple server abstraction.
FIXEdge-SDK/ipc_client/Node.js/ipc_client_example.mjs     # Simple client that uses the above abstraction.
FIXEdge-SDK/ipc_client/Python
FIXEdge-SDK/ipc_client/Python/Linux
FIXEdge-SDK/ipc_client/Python/Linux/fixedge_ipc_server.py  # Simple server abstraction.
FIXEdge-SDK/ipc_client/Python/Linux/ipc_client_example.py # Simple client that uses the above abstraction.
FIXEdge-SDK/ipc_client/Python/Windows/requirements.txt    # Dependencies to be installed.
FIXEdge-SDK/ipc_client/Python/Windows
FIXEdge-SDK/ipc_client/Python/Windows/fixedge_ipc_server.py  # Simple server abstraction.
FIXEdge-SDK/ipc_client/Python/Windows/ipc_client_example.py # Simple client that uses the above abstraction.

{
  'message': 'a string containing the JSON FIX message',
  'clientTag': 'a string containing the clientTag setup on server',
  'auxData': 'a string auxiliary data passed with the message'
}

import { FixEdgeIpcServerV1 } from './fixedge_ipc_server.mjs';
 
const fe = new FixEdgeIpcServerV1;
 
fe.on('error', (message)=>{
    console.log('FixEdge server communication error: ', message);
});
 
fe.on('end', ()=>{
    console.log('FixEdge server closed connection.');
});
 
fe.on('clientTag', (clientTag)=>{
    console.log('FixEdge server set up the client tag: ' + clientTag);
});
 
fe.onMessage = (fixMessageRequest)=>{
    console.log('FixEdge server message: ' + JSON.stringify(fixMessageRequest));
    fe.replySuccess(/*not returning any modified message*/ '', /*no template string*/ '',  /*no auxiliary data*/ '');
};
 
if(process.platform !== 'win32')
    fe.connect('/tmp/fixedge_unixdomainsocket_name');
else
    fe.connect('\\\\.\\pipe\\fixedge_namedpipe_name');

python3 -m pip install -r requirements.txt

{
  'message': 'a string containing the JSON FIX message',
  'clientTag': 'a string containing the clientTag setup on server',
  'auxData': 'a string auxiliary data passed with the message'
}

import sys
import json
from fixedge_ipc_server import fixedge_ipc_server_v1
 
if sys.version_info[0] < 3:
    raise Exception("Python 3 is required for this code to run.")
 
server = fixedge_ipc_server_v1()
 
client_tag = ""
try:
    client_tag = server.connect('/tmp/fixedge_unixdomainsocket_name')
except Exception as error:
    print("Unable to connect due to:", error)
    exit(1)
 
print('FixEdge server set up the client tag: ', client_tag)
 
while True:
     fmr = {};
     try:
        fmr = server.recv_fix_message_request()
    except Exception as error:
        print("Unable to communicate due to:", error)
        exit(1)
 
    print(fmr)
    server.reply_success('', '', '')

<Handler
    Name="IPC1"
    Description="IPC Handler"
    DllName="IPCHandler-MD-x64.dll"
    ListenAddress="\\.\pipe\fixedge_namedpipe_name"
/>

import sys
import json
from fixedge_ipc_server import fixedge_ipc_server_v1

if sys.version_info[0] < 3:
    raise Exception("Python 3 is required for this code to run.")

server = fixedge_ipc_server_v1()

client_tag = ""
try:
	client_tag = server.connect('/tmp/fixedge_unixdomainsocket_name')
except Exception as error:
	print("Unable to connect due to:", error)
    exit(1)

print('FixEdge server set up the client tag: ', client_tag)

while True:
     fmr = {};
     try:
		fmr = server.recv_fix_message_request()
	except Exception as error:
        print("Unable to communicate due to:", error)
        exit(1)

    message = json.loads(fmr['message'])

	message['Body']['ListID'] = 'NewListID'

    server.reply_success(json.dumps(message), '', '')

import { FixEdgeIpcServerV1 } from './fixedge_ipc_server.mjs';

const fe = new FixEdgeIpcServerV1;

fe.on('error', (message) => {
    console.log('FixEdge server communication error: ', message); 
});

fe.on('end', () => {
    console.log('FixEdge server closed connection.'); 
});

fe.on('clientTag', (clientTag) => {
    console.log('FixEdge server set up the client tag: ' + clientTag); 
});

fe.onMessage = (fixMessageRequest) => {
    var msg = JSON.parse(fixMessageRequest.message);
    msg.Body.ListID = 'NewListID'; 
    fe.replySuccess(JSON.stringify(msg), '', '');
};

if (process.platform !== 'win32') 
    fe.connect('/tmp/fixedge_unixdomainsocket_name');
else
    fe.connect('\\\\.\\pipe\\fixedge_namedpipe_name'); 

# Usual FE server abstraction initialization is skipped
 
while True:
     fmr = {};
     try:
        fmr = server.recv_fix_message_request()
    except Exception as error:
        print('Unable to communicate due to:', error)
        exit(1)
 
    message = json.loads(fmr['message'])
    message['Header']['BeginString'] = 'FIX.4.3'
    server.reply_success(json.dumps(message), 'FIX43', '')

// Usual FE server abstraction initialization is skipped
 
fe.onMessage = (fixMessageRequest)=>{
    var msg = JSON.parse(fixMessageRequest.message);
    msg.Header.BeginString = 'FIX.4.3';
    fe.replySuccess(JSON.stringify(msg), 'FIX43',  '');
};

<Action> 
    <Script Language="JavaScript" FileName="aux-data.js"/> 
</Action>

// Calling the IPC1 with the current FIX message, passing "Hello, Client!" to 
// the Client, binding the auxiliary data sent by the client to the 
// "IPC1_clientAuxData" key of the session KV storage. 
var ctxKvKey = "IPC1_clientAuxData";

handler("IPC1", [
    ["AuxData", "Hello, Client!"], 
    ["AuxDataContextKeyName", ctxKvKey]
]);

print(getCtxKV(ctxKvKey));

# Usual FE server abstraction initialization is skipped
while True:
    fmr = {}
    try:
        fmr = server.recv_fix_message_request()
    except Exception as error:
        print('Unable to communicate due to:', error)
        exit(1)

    print('Received from server:', fmr['auxData'])
    server.reply_success('', '', '', 'Hello, Server!')

// Usual FE server abstraction initialization is skipped
fe.onMessage = (fixMessageRequest) => {
    console.log(fixMessageRequest.auxData);
    fe.replySuccess(JSON.stringify(msg), '', 'Hello, Server!');
}; 

...
2024-10-18 14:28:09,759 UTC   DEBUG   [BL_Action]  138398241130048  Setting BL context key value store [IPC1._client_] = Hello, Server!
...
2024-10-18 14:28:09,760 UTC   INFO    [aux-data.js]  138398241130048  JavaScript 'aux-data.js' output: Hello, Server!
...