com.esri.arcgis.trackinganalyst
Interface IGatewayStatistics

All Superinterfaces:

Serializable

All Known Implementing Classes:

InternetConnection

public interface IGatewayStatistics
extends Serializable

Manages requests of gateway statistics.

Product Availability

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

Method Summary

IPropSet	getGatewayConnectionStatistics() Retrieves the connection portion of the gateway statistics.
IPropSet	getGatewayProcessStatistics() Retrieves the process portion of the gateway statistics.
IStringArray	getGatewayServiceNames() Retrieves a list of service names from the gateway statistics.
IPropSet	getGatewayServiceStatistics(String serviceName) Retrieves the services portion of the gateway statistics.
int	getGatewayStatisticsRate() The time in milliseconds between requests made to get the latest gateway statistics.
void	setGatewayStatisticsRate(int requestRate) The time in milliseconds between requests made to get the latest gateway statistics.
void	startGatewayStatistics() Start making periodic requests for statistics from the gateway.
void	stopGatewayStatistics() Stop making periodic requests for statistics from the gateway.

Method Detail

startGatewayStatistics

void startGatewayStatistics()
                            throws IOException,
                                   AutomationException

Start making periodic requests for statistics from the gateway.

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.

stopGatewayStatistics

void stopGatewayStatistics()
                           throws IOException,
                                  AutomationException

Stop making periodic requests for statistics from the gateway.

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.

setGatewayStatisticsRate

void setGatewayStatisticsRate(int requestRate)
                              throws IOException,
                                     AutomationException

The time in milliseconds between requests made to get the latest gateway statistics.

Product Availability

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

Parameters:

requestRate - The requestRate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGatewayStatisticsRate

int getGatewayStatisticsRate()
                             throws IOException,
                                    AutomationException

The time in milliseconds between requests made to get the latest gateway statistics.

Product Availability

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

Returns:

The requestRate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGatewayConnectionStatistics

IPropSet getGatewayConnectionStatistics()
                                        throws IOException,
                                               AutomationException

Retrieves the connection portion of the gateway statistics.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGatewayProcessStatistics

IPropSet getGatewayProcessStatistics()
                                     throws IOException,
                                            AutomationException

Retrieves the process portion of the gateway statistics.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGatewayServiceNames

IStringArray getGatewayServiceNames()
                                    throws IOException,
                                           AutomationException

Retrieves a list of service names from the gateway statistics.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGatewayServiceStatistics

IPropSet getGatewayServiceStatistics(String serviceName)
                                     throws IOException,
                                            AutomationException

Retrieves the services portion of the gateway statistics.

Product Availability

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

Parameters:

serviceName - The serviceName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.