IONCallableClient Class

The IONCallableClient class provides mechanisms to handle communication with the server, execution of IDL commands, retrieval of IDL command log output, and getting and setting IDL variables on the ION Server.

In order to provide support for mouse operations (the IDL CURSOR procedure) the main thread that handles the Java event loop must not block during IDL command execution. If the main event thread blocked and the IDL server requested a mouse location, the client and the server would be in a deadlock condition. To prevent a deadlock condition, this class provides the sendIDLCommand() method which sends the command to the server for execution and returns, not waiting for the command to complete. The class is informed of the commands completion status through the IONCommandDoneListener interface.

Class Declaration

Methods

IONCallableClient() — Constructs an object of the IONCallableClient class.

addIONCommandDoneListener() — Adds a "command done" listener to the client object.

addIONDisconnectListener() — Adds a "disconnect" listener to the client object.

addIONOutputListener() — Adds an "output" listener to the client object.

connect() — Connects to the server.

disconnect() — Shuts down the ION Server and disconnects.

executeIDLCommand() — Executes an IDL command on the ION Server. Control is not retuned until the command has been executed.

getClientVersion() — Returns the current version of ION.

getConnectionType() — Returns the type of connection in use.

getIDLVariable() — Gets the value of an IDL variable on the ION Server.

removeIONCommandDoneListener() — Removes a "command done" listener from the client object.

removeIONDisconnectListener() — Removes a "disconnect" listener from the client object.

removeIONOutputListener() — Removes a listener from the client object.

sendIDLCommand() — Posts an IDL command to the ION Server. Control is returned as soon as the command is sent.

setConnectionMethod() — Sets the type of connection for the client.

setConnectionTimeout() — Sets the timeout for socket connections.

setIDLVariable() — Sets the value of an IDL variable on the ION Server.