Statistics related functions

Functions

VOID TcStatisticsDestroy (TC_STATISTICS statistics)
 It releases a statistics handle returned by TcPortQueryStatistics or TcInstanceQueryStatistics.
TC_STATUS TcStatisticsUpdate (TC_STATISTICS statistics)
 It updates the port or instance statistics referred to by a given handle.
TC_STATUS TcStatisticsQueryValue (TC_STATISTICS statistics, ULONG counterId, PULONGLONG pValue)
 It queries a statitics object for a specific counter of an instance or a port.

Function Documentation

VOID TcStatisticsDestroy ( TC_STATISTICS  statistics  ) 

It releases a statistics handle returned by TcPortQueryStatistics or TcInstanceQueryStatistics.

Parameters:
statistics Handle to the statistics handle to be destroyed.

Thread safety: this function is thread safe if called on different statistics handles (TC_STATISTICS). Calling this function on the same statistics handle from concurrent threads must be synchronized.

TC_STATUS TcStatisticsUpdate ( TC_STATISTICS  statistics  ) 

It updates the port or instance statistics referred to by a given handle.

Parameters:
statistics Handle to the statistics to be updated.
Returns:
One of the Error codes values.

Thread safety: this function is thread safe if called on different statistics handles (TC_STATISTICS). Calling this function on the same statistics handle from concurrent threads must be synchronized.

TC_STATUS TcStatisticsQueryValue ( TC_STATISTICS  statistics,
ULONG  counterId,
PULONGLONG  pValue 
)

It queries a statitics object for a specific counter of an instance or a port.

Parameters:
statistics Handle to the statistics object to query.
counterId Identifier of the counter to be queried for in the statistics object. Possible values are listed in the section Statistical counters.
pValue Pointer to a caller allocated 64bit integer value. On success, it will return the queried counter.
Returns:

Thread safety: this function is thread safe if called on different statistics handles (TC_STATISTICS). Calling this function on the same statistics handle from concurrent threads must be synchronized.


TurboCap API documentation. Copyright (c) 2007-2008 CACE Technologies. All rights reserved.