TConnection (Open Traffic Sim link to IMB 0.12.00 API)

java.lang.Object
- nl.tno.imb.TConnection

```
public class TConnection
extends Object
```
The connection to the framework and starting point to use IMB. All further actions are started through a new object of this class. Main actions are:
subscribe to events to receive events
publish events to send events (called signal). if autoPublish is true you start sending events immediately
set global framework variables
send streams over the framework
set/update the current status for the connected client
optionally define the owner (specific: connected model name and id)
optionally set specific socket and connection options

Subscribe and publish return TEventEntry objects that can be used to set handlers for receiving specific events.
Default a reading thread is started to handle all socket reading. The thread calls registered event handlers for the received events.

Author:

hans.cornelissen@tno.nl

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`TConnection.TConnectionState`
`class`	`TConnection.TEventNameEntry` returned object (array) on an event name list query
`static interface`	`TConnection.TOnDisconnect` Override dispatch to implement a disconnect handler
`static interface`	`TConnection.TOnEventnames` Override dispatch to implement an event names request callback handler
`static interface`	`TConnection.TOnStatusUpdate` Override dispatch to implement a status change handler
`static interface`	`TConnection.TOnSubAndPub`
`static interface`	`TConnection.TOnVariable` Override dispatch to implement a variable change handler
`static class`	`TConnection.TVarPrefix`

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`autoPublish` when true events send on not-publuished events are automatically published
`static String`	`DEFAULT_FEDERATION` value to be used when no specific federation is used
`static String`	`DEFAULT_HUB` value to be used when no specific remote server is used
`static int`	`DEFAULT_PORT` value to be used when no specific port is used
`static int`	`EF_PUBLISHERS` request event name filter: requesting publisher counts
`static int`	`EF_SUBSCRIBERS` request event name filter: requesting subscriber counts
`static int`	`EF_TIMERS` request event name filter: requesting timer counts
`static String`	`EVENT_FILTER_POST_FIX`
`static int`	`ICE_CONNECTION_CLOSED` command result: the connection is closed
`static int`	`ICE_EVENT_NOT_PUBLISHED` command result: the event was not published
`boolean`	`imb2Compatible` when true IMB2 features are used if possible to emulate IMB3 behavior
`static byte[]`	`MAGIC_BYTES` magic bytes to identify the start of a valid IMB packet
`static byte[]`	`MAGIC_STRING_CHECK` magic bytes to identify the end of the payload on a valid IMB packet (as array of bytes)
`static int`	`MAX_PAYLOAD_SIZE` The maximum size of the payload in a low level IMB command
`TConnection.TOnDisconnect`	`onDisconnect` Handler to be called on a disconnect
`TConnection.TOnEventnames`	`onEventNames` Handler to be called on a event names request callback
`TConnection.TOnSubAndPub`	`onSubAndPub`
`static int`	`STATUS_BUSY` signal client status: busy (see updateStatus)
`static int`	`STATUS_CALCULATING` signal client status: calculating (see updateStatus)
`static int`	`STATUS_READY` signal client status: ready (see updateStatus)

Constructor Summary

Constructors
Constructor and Description
`TConnection(String aRemoteHost, int aRemotePort, String aOwnerName, int aOwnerID, String aFederation)` Create an IMB connection to the framework
`TConnection(String aRemoteHost, int aRemotePort, String aOwnerName, int aOwnerID, String aFederation, boolean aStartReadingThread)` Create an IMB connection to the framework

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the connection and cleans up socket, streams and thread
`protected void`	`finalize()`
`int`	`getClientHandle()` Returns the client handle the hub assigned to this connection
`String`	`getFederation()` Returns the current federation
`boolean`	`getLinger()` Returns the status of the linger option on the connected socket
`boolean`	`getNoDelay()` Returns the state of the NAGLE algorithm on the connected socket
`int`	`getOwnerID()` Returns the currently specified owner id
`String`	`getOwnerName()` Returns the currently specified owner name
`String`	`getRemoteHost()` Returns the IP address or DNS name of the currently connected hub
`int`	`getRemotePort()` Returns the TCP port of the currently connected hub
`int`	`getUniqueClientID()` Returns the unique client id the hub assigned to this connection
`protected void`	`handleCommandOther(int aCommand, TByteBuffer aPayload)`
`boolean`	`isConnected()` Returns the connected state of the connection
`int`	`logWriteLn(String aLogEventName, String aLine, TEventEntry.TLogLevel aLevel)` Log an entry to the framework
`protected boolean`	`open(String aHost, int aPort)`
`protected boolean`	`open(String aHost, int aPort, boolean aStartReadingThread)`
`protected String`	`prefixFederation(String aName)`
`protected String`	`prefixFederation(String aName, boolean aUseFederationPrefix)`
`TEventEntry`	`publish(String aEventName)` Publishes on the specified event
`TEventEntry`	`publish(String aEventName, boolean aUseFederationPrefix)` Publishes on the specified event
`void`	`readCommandsNonBlocking()` Manually reading commands when not using a reader thread.
`void`	`readCommandsNonThreaded(int aTimeOut)` Manually reading commands when not using a reader thread.
`void`	`removeStatus()` Removes the current status for this client
`protected void`	`requestAllVariables()` Send a request to the framework to send all variables with their contents to this client
`int`	`requestEventname(String aEventNameFilter, int aEventFilters)` Query the framework for registered event names
`void`	`setFederation(String aFederation)` Set the current federation.
`void`	`setLinger(boolean aValue)` Sets the status of the linger option on the connected socket
`void`	`setNoDelay(boolean aValue)` Sets the state of the NAGLE algorithm on the socket
`void`	`setOnStatusUpdate(TConnection.TOnStatusUpdate aValue)` Set the callback handler for status updates
`void`	`setOnVariable(TConnection.TOnVariable aValue)` Set the callback handler for framework variable changes
`void`	`setOwnerID(int aValue)` Changes the owner id
`void`	`setOwnerName(String aValue)` Changes the owner name
`protected void`	`setState(TConnection.TConnectionState aState)`
`void`	`setThrottle(int aThrottle)` Throttle down buffer events send to this client if specific flags are set on events
`void`	`setVariableValue(String aVarName, String aVarValue)` Set the value of a global framework variable
`void`	`setVariableValue(String aVarName, String aVarValue, TConnection.TVarPrefix aVarPrefix)` Set the value of a global framework variable
`void`	`setVariableValue(String aVarName, TByteBuffer aVarValue)` Set the value of a global framework variable
`void`	`setVariableValue(String aVarName, TByteBuffer aVarValue, TConnection.TVarPrefix aVarPrefix)` Set the value of a global framework variable
`int`	`signalBuffer(String aEventName, int aBufferID, byte[] aBuffer)` Send a buffer event to the framework.
`int`	`signalBuffer(String aEventName, int aBufferID, byte[] aBuffer, int aEventFlags, boolean aUseFederationPrefix)` Send a buffer event to the framework.
`int`	`signalChangeFederation(int aNewFederationID, String aNewFederation)` Signal a new federation to the framework
`int`	`signalChangeObject(String aEventName, int aAction, int aObjectID, String aAttribute)` Send a ChangeObject event to the framework This is the simple way to send events.
`int`	`signalChangeObject(String aEventName, int aAction, int aObjectID, String aAttribute, boolean aUseFederationPrefix)` Send a ChangeObject event to the framework This is the simple way to send events.
`int`	`signalEvent(String aEventName, int aEventKind, TByteBuffer aEventPayload)` Send an event to the framework.
`int`	`signalEvent(String aEventName, int aEventKind, TByteBuffer aEventPayload, boolean aUseFederationPrefix)` Send an event to the framework.
`int`	`signalFocus(double aX, double aY)` Signal a new focus point to the framework
`int`	`signalStream(String aEventName, String aStreamName, InputStream aStream)` Send a stream to the framework
`int`	`signalStream(String aEventName, String aStreamName, InputStream aStream, boolean aUseFederationPrefix)` Send a stream to the framework
`TEventEntry`	`subscribe(String aEventName)` Subscribe to the specified event
`TEventEntry`	`subscribe(String aEventName, boolean aUseFederationPrefix)` Subscribe to the specified event
`void`	`subscribeOnFederationChange(TEventEntry.TOnChangeFederation aOnChangeFederation)` Subscribe to federation change events and register the callback handler for these events
`void`	`subscribeOnFocus(TEventEntry.TOnFocus aOnFocus)` Subscribe to focus events and registers the callback handler for these events.
`String`	`toString()`
`void`	`unPublish(String aEventName)` Unpublish on the specified event.
`void`	`unPublish(String aEventName, boolean aUseFederationPrefix)` Unpublish on the specified event.
`void`	`unSubscribe(String aEventName)` Unsubscribe from the specified event
`void`	`unSubscribe(String aEventName, boolean aUseFederationPrefix)` Unsubscribe from the specified event
`void`	`updateStatus(int aProgress, int aStatus)` Update the central status for this client
`protected int`	`writeCommand(int aCommand, byte[] aPayload)` Write a single command to the framework

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - EVENT_FILTER_POST_FIX
```
public static final String EVENT_FILTER_POST_FIX
```
    See Also:
    
    Constant Field Values
  - MAGIC_BYTES
```
public static final byte[] MAGIC_BYTES
```
    magic bytes to identify the start of a valid IMB packet
  - MAGIC_STRING_CHECK
```
public static final byte[] MAGIC_STRING_CHECK
```
    magic bytes to identify the end of the payload on a valid IMB packet (as array of bytes)
  - MAX_PAYLOAD_SIZE
```
public static final int MAX_PAYLOAD_SIZE
```
    The maximum size of the payload in a low level IMB command
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HUB
```
public static final String DEFAULT_HUB
```
    value to be used when no specific remote server is used
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    value to be used when no specific port is used
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FEDERATION
```
public static final String DEFAULT_FEDERATION
```
    value to be used when no specific federation is used
    
    See Also:
    
    Constant Field Values
  - ICE_CONNECTION_CLOSED
```
public static final int ICE_CONNECTION_CLOSED
```
    command result: the connection is closed
    
    See Also:
    
    Constant Field Values
  - ICE_EVENT_NOT_PUBLISHED
```
public static final int ICE_EVENT_NOT_PUBLISHED
```
    command result: the event was not published
    
    See Also:
    
    Constant Field Values
  - autoPublish
```
public boolean autoPublish
```
    when true events send on not-publuished events are automatically published
  - imb2Compatible
```
public boolean imb2Compatible
```
    when true IMB2 features are used if possible to emulate IMB3 behavior
  - onDisconnect
```
public TConnection.TOnDisconnect onDisconnect
```
    Handler to be called on a disconnect
  - STATUS_READY
```
public static final int STATUS_READY
```
    signal client status: ready (see updateStatus)
    
    See Also:
    
    Constant Field Values
  - STATUS_CALCULATING
```
public static final int STATUS_CALCULATING
```
    signal client status: calculating (see updateStatus)
    
    See Also:
    
    Constant Field Values
  - STATUS_BUSY
```
public static final int STATUS_BUSY
```
    signal client status: busy (see updateStatus)
    
    See Also:
    
    Constant Field Values
  - onEventNames
```
public TConnection.TOnEventnames onEventNames
```
    Handler to be called on a event names request callback
  - onSubAndPub
```
public TConnection.TOnSubAndPub onSubAndPub
```
  - EF_PUBLISHERS
```
public static final int EF_PUBLISHERS
```
    request event name filter: requesting publisher counts
    
    See Also:
    
    Constant Field Values
  - EF_SUBSCRIBERS
```
public static final int EF_SUBSCRIBERS
```
    request event name filter: requesting subscriber counts
    
    See Also:
    
    Constant Field Values
  - EF_TIMERS
```
public static final int EF_TIMERS
```
    request event name filter: requesting timer counts
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TConnection
```
public TConnection(String aRemoteHost,
                   int aRemotePort,
                   String aOwnerName,
                   int aOwnerID,
                   String aFederation)
```
    Create an IMB connection to the framework
    
    Parameters:
    
    aRemoteHost - IP address or DNS name of the IMB hub to connect to
    
    aRemotePort - TCP port of the IMB hub to connect to
    
    aOwnerName - optional description of the connecting client
    
    aOwnerID - optional id of the connecting client
    
    aFederation - federation to connect with; this is default prefixed to subscribed and published event names
  - TConnection
```
public TConnection(String aRemoteHost,
                   int aRemotePort,
                   String aOwnerName,
                   int aOwnerID,
                   String aFederation,
                   boolean aStartReadingThread)
```
    Create an IMB connection to the framework
    
    Parameters:
    
    aRemoteHost - IP address or DNS name of the IMB hub to connect to
    
    aRemotePort - TCP port of the IMB hub to connect to
    
    aOwnerName - optional description of the connecting client
    
    aOwnerID - optional id of the connecting client
    
    aFederation - federation to connect with; this is default prefixed to subscribed and published event names
    
    aStartReadingThread - use an internal reader thread for processing events and commands from the connected hub
- Method Detail
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class Object
  - writeCommand
```
protected int writeCommand(int aCommand,
                           byte[] aPayload)
```
    Write a single command to the framework
    
    Parameters:
    
    aCommand -
    
    aPayload -
    
    Returns:
    
    see ICE_* constants
  - prefixFederation
```
protected String prefixFederation(String aName)
```
  - prefixFederation
```
protected String prefixFederation(String aName,
                                  boolean aUseFederationPrefix)
```
  - handleCommandOther
```
protected void handleCommandOther(int aCommand,
                                  TByteBuffer aPayload)
```
  - setState
```
protected void setState(TConnection.TConnectionState aState)
```
  - open
```
protected boolean open(String aHost,
                       int aPort)
```
  - open
```
protected boolean open(String aHost,
                       int aPort,
                       boolean aStartReadingThread)
```
  - getFederation
```
public String getFederation()
```
    Returns the current federation
  - setFederation
```
public void setFederation(String aFederation)
```
    Set the current federation. All subscribed and published events are unsubscribed/unpublished, then the federation is changed and all previously subscribed/publuished events are re-subscribed/re-published
    
    Parameters:
    
    aFederation - the new federation
  - getRemoteHost
```
public String getRemoteHost()
```
    Returns the IP address or DNS name of the currently connected hub
  - getRemotePort
```
public int getRemotePort()
```
    Returns the TCP port of the currently connected hub
  - getNoDelay
```
public boolean getNoDelay()
                   throws SocketException
```
    Returns the state of the NAGLE algorithm on the connected socket
    
    Returns:
    
    if true NAGLE is disabled (default false)
    
    Throws:
    
    SocketException
  - setNoDelay
```
public void setNoDelay(boolean aValue)
                throws SocketException
```
    Sets the state of the NAGLE algorithm on the socket
    
    Parameters:
    
    aValue - if true the NAGLE algorithm is DISABLED (default false)
    
    Throws:
    
    SocketException
  - getLinger
```
public boolean getLinger()
                  throws SocketException
```
    Returns the status of the linger option on the connected socket
    
    Returns:
    
    if true the linger option is enabled
    
    Throws:
    
    SocketException
  - setLinger
```
public void setLinger(boolean aValue)
               throws SocketException
```
    Sets the status of the linger option on the connected socket
    
    Parameters:
    
    aValue - if true the linger option is enabled with a linger time of 2 seconds
    
    Throws:
    
    SocketException
  - isConnected
```
public boolean isConnected()
```
    Returns the connected state of the connection
  - close
```
public void close()
```
    Closes the connection and cleans up socket, streams and thread
  - setThrottle
```
public void setThrottle(int aThrottle)
```
    Throttle down buffer events send to this client if specific flags are set on events
    
    Parameters:
    
    aThrottle -
  - readCommandsNonBlocking
```
public void readCommandsNonBlocking()
                             throws IOException
```
    Manually reading commands when not using a reader thread. Commands are read until connection is idle.
    
    Throws:
    
    IOException
  - readCommandsNonThreaded
```
public void readCommandsNonThreaded(int aTimeOut)
                             throws SocketException
```
    Manually reading commands when not using a reader thread. Commands are processed until the reading on the connection times out
    
    Parameters:
    
    aTimeOut -
    
    Throws:
    
    SocketException
  - getOwnerID
```
public int getOwnerID()
```
    Returns the currently specified owner id
  - setOwnerID
```
public void setOwnerID(int aValue)
```
    Changes the owner id
    
    Parameters:
    
    aValue - the new owner id
  - getOwnerName
```
public String getOwnerName()
```
    Returns the currently specified owner name
  - setOwnerName
```
public void setOwnerName(String aValue)
```
    Changes the owner name
    
    Parameters:
    
    aValue - the new owner name
  - getUniqueClientID
```
public int getUniqueClientID()
```
    Returns the unique client id the hub assigned to this connection
  - getClientHandle
```
public int getClientHandle()
```
    Returns the client handle the hub assigned to this connection
  - subscribe
```
public TEventEntry subscribe(String aEventName)
```
    Subscribe to the specified event
    
    Parameters:
    
    aEventName - the event name to subscribe to (it will be prefixed with the current federation)
    
    Returns:
    
    event entry that is to be used to assign the handler for the received events
  - subscribe
```
public TEventEntry subscribe(String aEventName,
                             boolean aUseFederationPrefix)
```
    Subscribe to the specified event
    
    Parameters:
    
    aEventName - the event name to subscribe to
    
    aUseFederationPrefix - if true the given event name will be prefixed with the current federation
    
    Returns:
    
    event entry that is to be used to assign the handler for the received events
  - publish
```
public TEventEntry publish(String aEventName)
```
    Publishes on the specified event
    
    Parameters:
    
    aEventName - the event name to publish on (it will be prefixed with the current federation)
    
    Returns:
    
    event entry that is to be used to signal events on
  - publish
```
public TEventEntry publish(String aEventName,
                           boolean aUseFederationPrefix)
```
    Publishes on the specified event
    
    Parameters:
    
    aEventName - the event name to publish on
    
    aUseFederationPrefix - if true the given event name will be prefixed with the current federation
    
    Returns:
    
    event entry that is to be used to signal events on
  - unSubscribe
```
public void unSubscribe(String aEventName)
```
    Unsubscribe from the specified event
    
    Parameters:
    
    aEventName - the event name to unsubscribe from (it will be prefixed with the current federation)
  - unSubscribe
```
public void unSubscribe(String aEventName,
                        boolean aUseFederationPrefix)
```
    Unsubscribe from the specified event
    
    Parameters:
    
    aEventName - the event name to unsubscribe from
    
    aUseFederationPrefix - if true the given event name will be prefixed with the current federation
  - unPublish
```
public void unPublish(String aEventName)
```
    Unpublish on the specified event.
    
    Parameters:
    
    aEventName - the event name to unpublish on (it will be prefixed with the current federation)
  - unPublish
```
public void unPublish(String aEventName,
                      boolean aUseFederationPrefix)
```
    Unpublish on the specified event.
    
    Parameters:
    
    aEventName - the event name to unpublish on
    
    aUseFederationPrefix - if true the given event name will be prefixed with the current federation
  - signalEvent
```
public int signalEvent(String aEventName,
                       int aEventKind,
                       TByteBuffer aEventPayload)
```
    Send an event to the framework. This is the simple way to send events. More performance can be gained by using the returned event entry from publish().
    
    Parameters:
    
    aEventName -
    
    aEventKind -
    
    aEventPayload -
    
    Returns:
    
    result of the command (see ICE_* constants)
  - signalEvent
```
public int signalEvent(String aEventName,
                       int aEventKind,
                       TByteBuffer aEventPayload,
                       boolean aUseFederationPrefix)
```
    Send an event to the framework. This is the simple way to send events. More performance can be gained by using the returned event entry from publish().
    
    Parameters:
    
    aEventName -
    
    aEventKind -
    
    aEventPayload -
    
    aUseFederationPrefix - if true the given event name will be prefixed with the current federation
    
    Returns:
    
    result of the command (see ICE_* constants)
  - signalBuffer
```
public int signalBuffer(String aEventName,
                        int aBufferID,
                        byte[] aBuffer)
```
    Send a buffer event to the framework. This is the simple way to send events. More performance can be gained by using the returned event entry from publish().
    
    Parameters:
    
    aEventName -
    
    aBufferID -
    
    aBuffer -
    
    Returns:
    
    result of the command (see ICE_* constants)
  - signalBuffer
```
public int signalBuffer(String aEventName,
                        int aBufferID,
                        byte[] aBuffer,
                        int aEventFlags,
                        boolean aUseFederationPrefix)
```
    Send a buffer event to the framework. This is the simple way to send events. More performance can be gained by using the returned event entry from publish().
    
    Parameters:
    
    aEventName -
    
    aBufferID -
    
    aBuffer -
    
    aEventFlags -
    
    aUseFederationPrefix - if true the given event name will be prefixed with the current federation
    
    Returns:
    
    result of the command (see ICE_* constants)
  - signalChangeObject
```
public int signalChangeObject(String aEventName,
                              int aAction,
                              int aObjectID,
                              String aAttribute)
```
    Send a ChangeObject event to the framework This is the simple way to send events. More performance can be gained by using the returned event entry from publish().
    
    Parameters:
    
    aEventName -
    
    aAction -
    
    aObjectID -
    
    aAttribute -
    
    Returns:
    
    result of the command (see ICE_* constants)
  - signalChangeObject
```
public int signalChangeObject(String aEventName,
                              int aAction,
                              int aObjectID,
                              String aAttribute,
                              boolean aUseFederationPrefix)
```
    Send a ChangeObject event to the framework This is the simple way to send events. More performance can be gained by using the returned event entry from publish().
    
    Parameters:
    
    aEventName -
    
    aAction -
    
    aObjectID -
    
    aAttribute -
    
    aUseFederationPrefix - if true the given event name will be prefixed with the current federation
    
    Returns:
    
    result of the command (see ICE_* constants)
  - signalStream
```
public int signalStream(String aEventName,
                        String aStreamName,
                        InputStream aStream)
```
    Send a stream to the framework
    
    Parameters:
    
    aEventName -
    
    aStreamName - name of the stream to identify the stream by the receiver
    
    aStream -
    
    Returns:
    
    result of the command (see ICE_* constants)
  - signalStream
```
public int signalStream(String aEventName,
                        String aStreamName,
                        InputStream aStream,
                        boolean aUseFederationPrefix)
```
    Send a stream to the framework
    
    Parameters:
    
    aEventName -
    
    aStreamName -
    
    aStream -
    
    aUseFederationPrefix -
    
    Returns:
    
    result of the command (see ICE_* constants)
  - setOnVariable
```
public void setOnVariable(TConnection.TOnVariable aValue)
```
    Set the callback handler for framework variable changes
    
    Parameters:
    
    aValue -
  - requestAllVariables
```
protected void requestAllVariables()
```
    Send a request to the framework to send all variables with their contents to this client
  - setVariableValue
```
public void setVariableValue(String aVarName,
                             String aVarValue)
```
    Set the value of a global framework variable
    
    Parameters:
    
    aVarName -
    
    aVarValue -
  - setVariableValue
```
public void setVariableValue(String aVarName,
                             TByteBuffer aVarValue)
```
    Set the value of a global framework variable
    
    Parameters:
    
    aVarName -
    
    aVarValue -
  - setVariableValue
```
public void setVariableValue(String aVarName,
                             String aVarValue,
                             TConnection.TVarPrefix aVarPrefix)
```
    Set the value of a global framework variable
    
    Parameters:
    
    aVarName -
    
    aVarValue -
    
    aVarPrefix -
  - setVariableValue
```
public void setVariableValue(String aVarName,
                             TByteBuffer aVarValue,
                             TConnection.TVarPrefix aVarPrefix)
```
    Set the value of a global framework variable
    
    Parameters:
    
    aVarName -
    
    aVarValue -
    
    aVarPrefix -
  - setOnStatusUpdate
```
public void setOnStatusUpdate(TConnection.TOnStatusUpdate aValue)
```
    Set the callback handler for status updates
    
    Parameters:
    
    aValue -
  - updateStatus
```
public void updateStatus(int aProgress,
                         int aStatus)
                  throws InterruptedException
```
    Update the central status for this client
    
    Parameters:
    
    aProgress - the progress, if available, from 0 to 100 or counting down to 0
    
    aStatus - the current status of the client (see STATUS_* constants)
    
    Throws:
    
    InterruptedException
  - removeStatus
```
public void removeStatus()
```
    Removes the current status for this client
  - subscribeOnFocus
```
public void subscribeOnFocus(TEventEntry.TOnFocus aOnFocus)
```
    Subscribe to focus events and registers the callback handler for these events.
    
    Parameters:
    
    aOnFocus - callback event handler
  - signalFocus
```
public int signalFocus(double aX,
                       double aY)
```
    Signal a new focus point to the framework
    
    Parameters:
    
    aX -
    
    aY -
    
    Returns:
    
    result of the command (see ICE_* constants)
  - subscribeOnFederationChange
```
public void subscribeOnFederationChange(TEventEntry.TOnChangeFederation aOnChangeFederation)
```
    Subscribe to federation change events and register the callback handler for these events
    
    Parameters:
    
    aOnChangeFederation -
  - signalChangeFederation
```
public int signalChangeFederation(int aNewFederationID,
                                  String aNewFederation)
```
    Signal a new federation to the framework
    
    Parameters:
    
    aNewFederationID -
    
    aNewFederation -
    
    Returns:
    
    result of the command (see ICE_* constants)
  - logWriteLn
```
public int logWriteLn(String aLogEventName,
                      String aLine,
                      TEventEntry.TLogLevel aLevel)
```
    Log an entry to the framework
    
    Parameters:
    
    aLogEventName -
    
    aLine -
    
    aLevel -
    
    Returns:
    
    result of the command (see ICE_* constants)
  - requestEventname
```
public int requestEventname(String aEventNameFilter,
                            int aEventFilters)
```
    Query the framework for registered event names
    
    Parameters:
    
    aEventNameFilter -
    
    aEventFilters -
    
    Returns:
    
    result of the command (see ICE_* constants)
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object

Class TConnection

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EVENT_FILTER_POST_FIX

MAGIC_BYTES

MAGIC_STRING_CHECK

MAX_PAYLOAD_SIZE

DEFAULT_HUB

DEFAULT_PORT

DEFAULT_FEDERATION

ICE_CONNECTION_CLOSED

ICE_EVENT_NOT_PUBLISHED

autoPublish

imb2Compatible

onDisconnect

STATUS_READY

STATUS_CALCULATING

STATUS_BUSY

onEventNames

onSubAndPub

EF_PUBLISHERS

EF_SUBSCRIBERS

EF_TIMERS

Constructor Detail

TConnection

TConnection

Method Detail

finalize

writeCommand

prefixFederation

prefixFederation

handleCommandOther

setState

open

open

getFederation

setFederation

getRemoteHost

getRemotePort

getNoDelay

setNoDelay

getLinger

setLinger

isConnected

close

setThrottle

readCommandsNonBlocking

readCommandsNonThreaded

getOwnerID

setOwnerID

getOwnerName

setOwnerName

getUniqueClientID

getClientHandle

subscribe

subscribe

publish

publish

unSubscribe

unSubscribe

unPublish

unPublish

signalEvent

signalEvent

signalBuffer

signalBuffer

signalChangeObject

signalChangeObject

signalStream

signalStream

setOnVariable

requestAllVariables

setVariableValue

setVariableValue

setVariableValue

setVariableValue