Difference between revisions of "AMI Client Interface to Realtime Backend API"

From 3forge Documentation
Jump to navigation Jump to search
(Shifted java section, added sample python code)
Line 1: Line 1:
 
= Overview =
 
= Overview =
AMI provides developers a Java library to connect to the AMI Realtime Backend API via the AMI Client.
+
AMI provides developers different libraries to connect to the AMI Realtime Backend API via the AMI Client.
  
== Setup ==
+
== Java ==
=== Overview ===
+
=== Setup ===
 +
==== Overview ====
 
The AMI Client Listener is used to process messages and commands sent and received by the AMI Client.  
 
The AMI Client Listener is used to process messages and commands sent and received by the AMI Client.  
  
 
The AMI Client connects to the AMI Realtime Backend API. Below is a simple example that sends a message and a command via the AMI Client and processes the command callback.
 
The AMI Client connects to the AMI Realtime Backend API. Below is a simple example that sends a message and a command via the AMI Client and processes the command callback.
  
=== Configuration ===
+
==== Configuration ====
 
The hostname is the host where either AmiCenter or AmiRelay is running.
 
The hostname is the host where either AmiCenter or AmiRelay is running.
  
 
The port is configured via the property “ami.port” which typically is set to 3289.
 
The port is configured via the property “ami.port” which typically is set to 3289.
  
=== Java interface (see javadoc for details) ===
+
==== Java interface (see javadoc for details) ====
 
'''com.f1.ami.client.AmiClient'''
 
'''com.f1.ami.client.AmiClient'''
  
Line 20: Line 21:
 
'''com.f1.ami.client.AmiCommandDef'''
 
'''com.f1.ami.client.AmiCommandDef'''
  
=== Example - Java Code ===
+
==== Example - Java Code ====
 
<syntaxhighlight lang="java">
 
<syntaxhighlight lang="java">
 
package com.demo.runmaintest;
 
package com.demo.runmaintest;
Line 122: Line 123:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
== Sending Objects ==
+
=== Sending Objects ===
 
Once the AmiClient is connected to AMI Realtime Backend API, the client can start sending messages.
 
Once the AmiClient is connected to AMI Realtime Backend API, the client can start sending messages.
 
   
 
   
 
See Real-time Messaging API - Outbound Instruction Type - Object (O)
 
See Real-time Messaging API - Outbound Instruction Type - Object (O)
  
=== Class AmiClient ===
+
==== Class AmiClient ====
 
''startObjectMessage''  
 
''startObjectMessage''  
  
Line 176: Line 177:
 
Send pending message to AMI and block until the message is fully read by AMI, returns true if successful
 
Send pending message to AMI and block until the message is fully read by AMI, returns true if successful
  
== Commands ==
+
=== Commands ===
=== Register Command ===
+
==== Register Command ====
  
 
Commands can be created and registered to AMI via the AmiClientCommandDef class.  
 
Commands can be created and registered to AMI via the AmiClientCommandDef class.  
Line 183: Line 184:
 
''See Real-time Messaging API - Outbound Instruction Type - Object (C)''  
 
''See Real-time Messaging API - Outbound Instruction Type - Object (C)''  
 
   
 
   
==== Example - Java Code ====
+
===== Example - Java Code =====
 
<syntaxhighlight lang="java">
 
<syntaxhighlight lang="java">
 
//Creates a new command
 
//Creates a new command
Line 198: Line 199:
  
  
=== Processing Command Callbacks ===  
+
==== Processing Command Callbacks ====  
  
 
Command callbacks are processed using the AmiClientListener onCommand() method.   
 
Command callbacks are processed using the AmiClientListener onCommand() method.   
Line 204: Line 205:
 
''See Real-time Messaging API - Outbound Instruction Type - Object (R)''
 
''See Real-time Messaging API - Outbound Instruction Type - Object (R)''
  
==== Example - Java Code ====
+
===== Example - Java Code =====
 
<syntaxhighlight lang="java">
 
<syntaxhighlight lang="java">
 
public class SampleClient implements AmiClientListener {
 
public class SampleClient implements AmiClientListener {
Line 225: Line 226:
  
  
== AmiClientAsServer ==
+
=== AmiClientAsServer ===
  
 
The steps to set up the interface for the AmiClientAsServer is similar to the AmiClient interface.  
 
The steps to set up the interface for the AmiClientAsServer is similar to the AmiClient interface.  
  
=== Configuration ===
+
==== Configuration ====
 
To set it up, you will require the following configuration:
 
To set it up, you will require the following configuration:
  
Line 239: Line 240:
 
  ami.relay.fh.csocket.props.host=localhost
 
  ami.relay.fh.csocket.props.host=localhost
  
=== Example - Java Code ===
+
==== Example - Java Code ====
  
 
<syntaxhighlight lang="java">
 
<syntaxhighlight lang="java">
Line 293: Line 294:
 
System.out.println("Loggedin");
 
System.out.println("Loggedin");
 
}
 
}
 +
 +
</syntaxhighlight>
 +
 +
== Python ==
 +
=== Setup ===
 +
The python library files are available upon request - please contact support@3forge.com to receive the latest version of the library.
 +
==== Overview ====
 +
The python library provides an interface identical to Java and can be easily configured.
 +
==== Example - Python Code ====
 +
<syntaxhighlight lang="python">
 +
from com.f1.ami.client import AmiClient
 +
from com.f1.ami.listener import AmiClientListenerInterface
 +
from com.f1.utils.options import Options
 +
 +
class TestClient(AmiClientListenerInterface):
 +
    "A script demonstrating how this client can be used to connect to AMI"
 +
    def __init__(self) -> None:
 +
        super().__init__()
 +
       
 +
        ad = AmiClient()
 +
        options = Options.ENABLE_SEND_SEQNUM + Options.ENABLE_SEND_TIMESTAMPS
 +
        ad.addListener(self)
 +
 +
        # ad.setDebugMessages()
 +
 +
        # Connecting to the AMI instance, replace with appropriate connection parameters
 +
        ad.start("127.0.0.1", 3289, "demo", options)
 +
       
 +
        # Sending a row of data to the table 'Sample'
 +
        ad.startObjectMessage("Sample")
 +
        ad.addMessageParamString("Symbol", "GBP")
 +
        ad.addMessageParamFloat("Quantity", 11.0)
 +
        ad.sendMessageAndFlush()
 +
       
 +
        # print(ad.getOutputBuffer())
 +
       
 +
        ad.close()
 +
 +
    def onMessageSent(self, client: AmiClient, message: str):
 +
        print("msg:" + message)
 +
   
 +
    def onConnect(self, client: AmiClient):
 +
        print("Connected to server!")
 +
 +
    def onDisconnect(self, client: AmiClient):
 +
        print("Disconnected from server!")
 +
 +
    def onLoggedIn(self, client: AmiClient):
 +
        print("Logged in to AMI!")
 +
 +
    def onMessageReceived(self, client: AmiClient, now, seqnum, status, message: str):
 +
        print(f"Message received from server '{message}' at {now} with sequence number {seqnum} and status {status}")
 +
   
 +
test = TestClient()
  
 
</syntaxhighlight>
 
</syntaxhighlight>

Revision as of 07:59, 23 February 2023

Overview

AMI provides developers different libraries to connect to the AMI Realtime Backend API via the AMI Client.

Java

Setup

Overview

The AMI Client Listener is used to process messages and commands sent and received by the AMI Client.

The AMI Client connects to the AMI Realtime Backend API. Below is a simple example that sends a message and a command via the AMI Client and processes the command callback.

Configuration

The hostname is the host where either AmiCenter or AmiRelay is running.

The port is configured via the property “ami.port” which typically is set to 3289.

Java interface (see javadoc for details)

com.f1.ami.client.AmiClient

com.f1.ami.client.AmiClientListener

com.f1.ami.client.AmiCommandDef

Example - Java Code

package com.demo.runmaintest;

import java.util.Map;

import com.f1.ami.client.AmiClient;
import com.f1.ami.client.AmiClientCommandDef;
import com.f1.ami.client.AmiClientListener;
import com.f1.utils.OH;
import com.f1.utils.concurrent.HasherMap;

public class SampleClient implements AmiClientListener {
	public static final byte OPTION_AUTO_PROCESS_INCOMING = 2;

	public static void main(String a[]) throws Exception {
		AmiClient client = new AmiClient();
		client.addListener(new SampleClient(client));
		client.start("localhost", 3289, "demo", OPTION_AUTO_PROCESS_INCOMING);
		while (true)
			OH.sleep(1000); // Keep process alive
	}

	private AmiClient amiClient;

	public SampleClient(AmiClient client) {
		this.amiClient = client;
	}
    @Override
	public void onMessageReceived(AmiClient source, long now, int seqnum, int status, CharSequence message) {
		System.out.println("Message received: " + message);
	}
    @Override
	public void onMessageSent(AmiClient source, CharSequence message) {
		System.out.println("Message sent: " + message);
	}
    @Override
	public void onConnect(AmiClient source) {
		System.out.println("Connected");
	}
    @Override
	public void onDisconnect(AmiClient source) {
		System.out.println("Disconnected");
	}
    @Override
	public void onLoggedIn(AmiClient amiClient) {
		// We’ve successfully connected an logged in, let’s register stuff.
		System.out.println("Logged in");
		// Send message
		this.amiClient.startObjectMessage("SampleOrders", "1");
		// Send as String
		// addMessageParamString(String key, String value)
		this.amiClient.addMessageParamString("Order", "Order");
		// Send as int
		// addMessageParamInt(String key, int value)
		this.amiClient.addMessageParamInt("Quantity", 1000);
		// Send as double
		// addMessageParamDouble(String key, double value)
		this.amiClient.addMessageParamDouble("Price", 2703.1995);
		// Send as long
		// addMessageParamLong(String key, long value)
		this.amiClient.addMessageParamLong("Price", (long) 2703.1995);
		// Send as float
		// addMessageParamFloat(String key, float value)
		this.amiClient.addMessageParamFloat("Volume", (float) 0.45466549498);
		// Send as boolean
		// addMessageParamBoolean(String key, boolean value)
		this.amiClient.addMessageParamBoolean("GTC", false);
		// Send as json object
		// addMessageParamJson(String key, Object value)
		Map map = new HasherMap<String, String>();
		this.amiClient.addMessageParamJson("Table", map);
		// Send as binary
		// addMessageParamBinary(String key, byte[] value)
		byte[] binary = "hello world".getBytes();
		this.amiClient.addMessageParamBinary("Val", binary);
		// Send as num
		// addMessageParamBinary(String key, CharSequence value)
		this.amiClient.addMessageParamEnum("Num", "ENUM");
		// Send as object
		// addMessageParamObject(String key, Object value)
		Object obj = new Object();
		this.amiClient.addMessageParamObject("Data", obj);
		this.amiClient.sendMessageAndFlush();

		// Register a  command
		AmiClientCommandDef def = new AmiClientCommandDef("sample_cmd_def");
		def.setConditions(AmiClientCommandDef.CONDITION_USER_CLICK);
		this.amiClient.sendCommandDefinition(def);
		this.amiClient.flush();
		System.out.println("Sent command");
	}
        @Override
	public void onCommand(AmiClient source, String requestId, String cmd, String userName, String type, String id, Map<String, Object> params) {
		// Do business logic triggered by callback
		System.out.println("On command");
		source.startResponseMessage(requestId, 1, "Okay").addMessageParamLong("sample_user_callback", 45).sendMessageAndFlush();
	}
}

Sending Objects

Once the AmiClient is connected to AMI Realtime Backend API, the client can start sending messages.

See Real-time Messaging API - Outbound Instruction Type - Object (O)

Class AmiClient

startObjectMessage

AmiClient startObjectMessage(String type, CharSequence id)

Starts an object (O) message. Param id is optional.


startObjectMessage

AmiClient startObjectMessage(String type, CharSequence id, long expiresOn)

Starts an object (O) message. Param id is optional. If the param expiresOn is: set to 0 the object does not expire, a positive value the object expires at an epoc absolute time, a negative value the object expires in an offset time(milliseconds) into the future.


addMessageParamObject

void addMessageParamObject(String key, Object value)


addMessageParams

AmiClient addMessageParams(Map<String, Object> params)

See com.f1.ami.client.AmiClient (javadoc for other addMessageParam[types])


sendMessage

boolean sendMessage()

Finalize and send the current message, returns true if successful


flush

void flush()

Send pending message buffer to AMI, can be called at anytime


sendMessageAndFlush

boolean sendMessageAndFlush()

Send pending message to AMI and block until the message is fully read by AMI, returns true if successful

Commands

Register Command

Commands can be created and registered to AMI via the AmiClientCommandDef class.

See Real-time Messaging API - Outbound Instruction Type - Object (C)

Example - Java Code
//Creates a new command
AmiClientCommandDef commandDef = new AmiClientCommandDef("COMMAND_ID");
//Sets the name of the command on the frontend
commandDef.setName("Command Name");
//Specifies when to show the command
commandDef.setFilterClause("panel.title==\"PanelName\"");
//Specifies an additional param from the source table to be passed to the onCommand params
commandDef.setFields("id");
//Sends a command (C) declaration via the AMI Client
client.sendCommandDefinition(commandDef);


Processing Command Callbacks

Command callbacks are processed using the AmiClientListener onCommand() method.

See Real-time Messaging API - Outbound Instruction Type - Object (R)

Example - Java Code
public class SampleClient implements AmiClientListener {
	//...
	@Override
	public void onCommand(AmiClient source, String requestId, String cmd, String userName, String type, String id, Map<String, Object> params) {
		String origRequestId = requestId;
		int status = 1;
		String message = "Okay";
		//Starts a response (R) message
		source.startResponseMessage(origRequestId, status, message);
		//Get additional params defined by AmiClientCommandDef.setFields
		long id = (long)params.get("id");
		source.addMessageParamLong("id", id);
		source.sendMessageAndFlush();
	}
}


AmiClientAsServer

The steps to set up the interface for the AmiClientAsServer is similar to the AmiClient interface.

Configuration

To set it up, you will require the following configuration:

ami.relay.fh.active=$${ami.relay.fh.active},csocket
ami.relay.fh.csocket.start=true
ami.relay.fh.csocket.class=com.f1.ami.relay.fh.AmiClientSocketFH
ami.relay.fh.csocket.props.amiId=client_socket
ami.relay.fh.csocket.props.port=1234
ami.relay.fh.csocket.props.host=localhost

Example - Java Code

package com.f1.ami.client;

import java.io.IOException;
import java.net.Socket;
import java.util.Map;

public class AmiClientAsServerTest implements AmiClientAsServerFactory, AmiClientListener {
	public static void main(String a[]) throws IOException {
		new AmiClientAsServer(1234, null, null, new AmiClientAsServerTest());
	}

	@Override
	public void onClient(Socket socket, AmiClient client) throws IOException {
		client.start(socket, "demo", AmiClient.ENABLE_AUTO_PROCESS_INCOMING);
		client.startObjectMessage("ClientAsServer", null);
		client.addMessageParamString("key", "Hello!");
		client.addMessageParamLong("now", System.currentTimeMillis());
		client.addMessageParamDouble("now", System.currentTimeMillis());
		client.sendMessageAndFlush();
		client.addListener(this);
	}

	@Override
	public void onMessageReceived(AmiClient rawClient, long now, int seqnum, int status, CharSequence message) {
		System.out.println("On Message Received: " + message);
	}

	@Override
	public void onMessageSent(AmiClient rawClient, CharSequence message) {
		// TODO Auto-generated method stub
	}

	@Override
	public void onConnect(AmiClient rawClient) {
		System.out.println("Connected");
	}

	@Override
	public void onDisconnect(AmiClient rawClient) {
		System.out.println("Disconnected");
	}

	@Override
	public void onCommand(AmiClient rawClient, String requestId, String cmd, String userName, String objectType, String objectId, Map<String, Object> params) {
		// TODO Auto-generated method stub
	}

	@Override
	public void onLoggedIn(AmiClient rawClient) {
		System.out.println("Loggedin");
	}

Python

Setup

The python library files are available upon request - please contact support@3forge.com to receive the latest version of the library.

Overview

The python library provides an interface identical to Java and can be easily configured.

Example - Python Code

from com.f1.ami.client import AmiClient
from com.f1.ami.listener import AmiClientListenerInterface
from com.f1.utils.options import Options

class TestClient(AmiClientListenerInterface):
    "A script demonstrating how this client can be used to connect to AMI"
    def __init__(self) -> None:
        super().__init__()
        
        ad = AmiClient()
        options = Options.ENABLE_SEND_SEQNUM + Options.ENABLE_SEND_TIMESTAMPS
        ad.addListener(self)

        # ad.setDebugMessages()

        # Connecting to the AMI instance, replace with appropriate connection parameters
        ad.start("127.0.0.1", 3289, "demo", options)
        
        # Sending a row of data to the table 'Sample'
        ad.startObjectMessage("Sample")
        ad.addMessageParamString("Symbol", "GBP")
        ad.addMessageParamFloat("Quantity", 11.0)
        ad.sendMessageAndFlush()
        
        # print(ad.getOutputBuffer())
        
        ad.close()

    def onMessageSent(self, client: AmiClient, message: str):
        print("msg:" + message)
    
    def onConnect(self, client: AmiClient):
        print("Connected to server!")

    def onDisconnect(self, client: AmiClient):
        print("Disconnected from server!")

    def onLoggedIn(self, client: AmiClient):
        print("Logged in to AMI!")

    def onMessageReceived(self, client: AmiClient, now, seqnum, status, message: str):
        print(f"Message received from server '{message}' at {now} with sequence number {seqnum} and status {status}")
    
test = TestClient()