com.esri.arcgis.trackinganalyst
Interface IClientConnection

All Superinterfaces:

Serializable

All Known Implementing Classes:

PlugIn

public interface IClientConnection
extends Serializable

Provides access to methods and properties implemented by datalinks and consumed by the Tracking Server.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Method Summary

void	disconnect() Disconnects client connection.
int	getClientQueueCount() Number of connections in client queue.
Object	getDataFilters() Defines data filters in client connection.
String	getID() Defines data's ID value in client connection.
String	getName() Defines dataset name in client connection.
int	getServerQueueCount() Number of connections in server queue.
int	getStatus() Indicates status of the client connection.
Object	getTimeEstablished() Indicates time connection was established.
int	getTotalClientMessageCount() Total number of client messages.
int	getTotalServerMessageCount() Total number of server messages.
IMessage	popClientMessage(int nTimeOut) Obtain next message from the client queue.
void	postClientMessage(IMessage piMessage) Post a client message to server queue.
void	setName(String pVal) Defines dataset name in client connection.

Method Detail

getDataFilters

Object getDataFilters()
                      throws IOException,
                             AutomationException

Defines data filters in client connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

String getID()
             throws IOException,
                    AutomationException

Defines data's ID value in client connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

Defines dataset name in client connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String pVal)
             throws IOException,
                    AutomationException

Defines dataset name in client connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerQueueCount

int getServerQueueCount()
                        throws IOException,
                               AutomationException

Number of connections in server queue.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClientQueueCount

int getClientQueueCount()
                        throws IOException,
                               AutomationException

Number of connections in client queue.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeEstablished

Object getTimeEstablished()
                          throws IOException,
                                 AutomationException

Indicates time connection was established.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalServerMessageCount

int getTotalServerMessageCount()
                               throws IOException,
                                      AutomationException

Total number of server messages.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTotalClientMessageCount

int getTotalClientMessageCount()
                               throws IOException,
                                      AutomationException

Total number of client messages.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatus

int getStatus()
              throws IOException,
                     AutomationException

Indicates status of the client connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Returns:

A com.esri.arcgis.trackinganalyst.enumConnectionStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnect

void disconnect()
                throws IOException,
                       AutomationException

Disconnects client connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

postClientMessage

void postClientMessage(IMessage piMessage)
                       throws IOException,
                              AutomationException

Post a client message to server queue.

Description

The postMessage method posts a message to the Tracking Server's queue. This method is only valid if the Status is CONNECTED.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

piMessage - A reference to a com.esri.arcgis.trackinganalyst.IMessage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

popClientMessage

IMessage popClientMessage(int nTimeOut)
                          throws IOException,
                                 AutomationException

Obtain next message from the client queue.

Description

The popMessage method returns a message from the Client's message queue if a message is available. Returns S_OK on success; S_FALSE if the timeout occurs; otherwise E_FAIL or E_UNEXPECTED. This method is only valid if the Status is CONNECTED.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:

nTimeOut - The nTimeOut (in)

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IMessage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.