com.esri.arcgis.trackinganalyst
Interface ITxConnectionMessages

All Superinterfaces:

Serializable

All Known Implementing Classes:

GeneralTrackingConnector, InternetConnection, ServerConnection

public interface ITxConnectionMessages
extends Serializable

Provides access to the methods and properties for a connector object to retrieve messages from a live data source.

Description

This interface is new at ArcGIS 9.3.

Product Availability

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

Method Summary

int	getEventReadyHandle() The handle to the event that is signaled when a message is ready to be received.
int	getMessageCount() The count of messages ready to retrieve.
IMessage	nextMessage() Retrieves a message from the server connection.

Method Detail

getMessageCount

int getMessageCount()
                    throws IOException,
                           AutomationException

The count of messages ready to retrieve.

Product Availability

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

Returns:

The plNumberOfMessages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEventReadyHandle

int getEventReadyHandle()
                        throws IOException,
                               AutomationException

The handle to the event that is signaled when a message is ready to be received.

Product Availability

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

Returns:

The phReadyEvent (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

nextMessage

IMessage nextMessage()
                     throws IOException,
                            AutomationException

Retrieves a message from the server connection.

Product Availability

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

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.