tfInterfaceGetStats

Jump to: navigation, search

Table of Contents >> Programmer's Reference


#include <trsocket.h>


int tfInterfaceGetStats (
ttUserInterface interfaceHandle,
int statName,
void * statValuePtr,
int statLen,
int flag
);


Function Description

This new API allows the user to retrieve the value of options set on the interface. Currently, only one option is supported:


Parameters

  • interfaceHandle
    Handle of the interface to retrieve the specified statistic from.
  • statName
    Statistic to retrieve. Valid statistics are specified below.
  • statValuePtr
    Pointer to appropriate data type in which to store the statistic’s value. See list of statistics below for the appropriate data type.
  • statLen
    sizeof() data type pointed to by statValuePtr.
  • flag
    Set to TM_INTF_STAT_FLAG_CLEAR to reset the stat to 0. Set to TM_INTF_STAT_FLAG_KEEP to keep the stat unchanged.


Returns

  • TM_INTF_STAT_FORW_INC_PKT
    Number of packets forwarded from the given interface to another interface. The data type for this option is ttUser32Bit.
  • TM_INTF_STAT_FORW_INC_BYTE
    Number of bytes forwarded from the given interface to another interface. The data type for this option is ttIntfStatBignum.
  • TM_INTF_STAT_FORW_OUT_PKT
    Number of packets forwarded to the given interface. The data type for this option is ttUser32Bit.
  • TM_INTF_STAT_FORW_OUT_BYTE
    Number of bytes forwarded to the given interface. The data type for this option is ttIntfStatBignum.


Table of Contents >> Programmer's Reference