TUPGetNSapStats

Sends a request to retrieve the statistics for a given network service access point.

Prototype

S16 TUPGetNSapStats ( U8 board, S16 sapID, TUPNSapStats *stats, U8 reset)

Argument

Description

board

TX board number.

sapID

Network SAP for which to retrieve statistics.

stats

Pointer to the structure to place the retrieved statistics:

typedef struct _TupNSapStats
{
    DateTime dt;    /* date and time (Not Used)      */
    Duration dura;  /* duration (Not Used)           */
    S32 pktTx;      /* Number of transmitted packets */
    S32 pktRx;      /* Number of received packets    */
} TupNSapStats;

reset

Set this to non-zero to reset the current statistics.


Return values

Return value

Description

TUP_SUCCESS

 

TUP_BOARD

board is out of range.

TUP_DRIVER

Error occurred accessing the driver.

TUP_FAILED

Task on the TX board reported a failure.

TUP_UNBOUND

Application failed to call TUPInitMgmtAPI prior to this call.