Sends a request to retrieve the statistics for a given, pre-defined circuit group.
S16 TUPGetGrpStats ( U8 board, U16 groupID, TUPGrpStats *stats, U8 reset)
Argument |
Description |
board |
TX board number. |
groupID |
Group number from which to retrieve statistics. |
stats |
Pointer to structure in which to place retrieved statistics. Refer to the Details section for more information. |
reset |
Set this to non-zero to reset the current statistics. |
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. |
The TUPGrpStats structure appears as follows:
typedef struct _TupGrpStats
{
DateTime dt; /* date and time (Not Used) */
Duration dura; /* duration (Not Used) */
S32 cirHwGrBlockRx; /* HW Circuit Group Blocking Received */
S32 cirHwGrBlockAckRx;
/* HW Circuit Group Blocking Ack Rx */
S32 cirHwGrUnBlockRx;
/* HW Circuit Grp Unblocking Received */
S32 cirHwGrUnBlockAckRx;
/* HW Circuit Group Unblocking Ack Rx */
S32 cirSwGrBlockRx; /* SW Circuit Group Blocking Received */
S32 cirSwGrBlockAckRx;
/* SW Circuit Group Blocking Ack Rx */
S32 cirSwGrUnBlockRx;
/* SW Circuit Grp Unblocking Received */
S32 cirSwGrUnBlockAckRx;
/* SW Circuit Group Unblocking Ack Rx */
S32 cirMGrBlockRx; /* Maint Circuit Group Blocking Rx */
S32 cirMGrBlockAckRx; /* Maint Circuit Grp Blocking Ack Rx */
S32 cirMGrUnBlockRx; /* Maint Circuit Grp Unblocking Rx */
S32 cirMGrUnBlockAckRx;
/* Maint Circuit Grp Unblocking Ack Rx */
S32 cirGrResRx; /* Circuit Group Reset Received */
S32 cirGrResAckRx; /* Circuit Group Reset Ack Received */
S32 cirHwGrBlockTx; /* HW Circuit Group Blocking Tx */
S32 cirHwGrBlockAckTx;
/* HW Circuit Group Blocking Ack Tx */
S32 cirHwGrUnBlockTx; /* HW Circuit Grp Unblocking Tx */
S32 cirHwGrUnBlockAckTx;
/* HW Circuit Group Unblocking Ack Tx */
S32 cirSwGrBlockTx; /* SW Circuit Group Blocking Tx */
S32 cirSwGrBlockAckTx;
/* SW Circuit Group Blocking Ack Tx */
S32 cirSwGrUnBlockTx; /* SW Circuit Grp Unblocking Tx */
S32 cirSwGrUnBlockAckTx;
/* SW Circuit Group Unblocking Ack Tx */
S32 cirMGrBlockTx; /* Maint Circuit Group Blocking Tx */
S32 cirMGrBlockAckTx; /* Maint Circuit Grp Blocking Ack Tx */
S32 cirMGrUnBlockTx; /* Maint Circuit Grp Unblocking Tx */
S32 cirMGrUnBlockAckTx;
/* Maint Circuit Grp Unblocking Ack Tx */
S32 cirGrResTx; /* Circuit Group Reset Tx */
S32 cirGrResAckTx; /* Circuit Group Reset Ack Tx */
} TupGrpStats;