isupCircuitStats
Sends a request to retrieve the statistics for a given circuit and blocks
the calling application while waiting for a response.
Prototype
short isupCircuitStats ( U8
board, U32
circId, IsupCircStats
*stats)
Argument |
Description |
board |
TX board number. |
circId |
Circuit for which to retrieve statistics. |
stats |
Pointer to the following IsupCircStats
structure, where the requested statistics information is returned:
typedef struct _IsupCircStats
{
DateTime dt; /* Date and time */
Duration dura; /* Duration */
S32 blockTx; /* Circuit Blocking Transmitted */
S32 blockAckTx; /* Circuit Blocking Ack Transmitted */
S32 unblockTx; /* Circuit Unblocking Transmitted */
S32 unblockAckTx; /* Circuit Unblocking Ack Transmitted */
S32 cirResTx; /* Circuit Reset Transmitted */
S32 cirGrBlockTx; /* Circuit Group Blocking Transmitted */
S32 cirGrBlockAckTx; /* Circuit Group Blocking Ack Transmitted */
S32 cirGrUnBlockTx; /* Circuit Group Unblocking Transmitted */
S32 cirGrUnBlockAckTx; /* Circuit Group Unblocking Ack Transmitted */
S32 cirGrQTx; /* Circuit Group Query Transmitted */
S32 cirGrQAckTx; /* Circuit Group Query Acknowledge Transmitted*/
S32 cirGrResTx; /* Circuit Group Reset Transmitted */
S32 cirGrResAckTx; /* Circuit Group Reset Ack Transmitted */
S32 usrPrtTstTx; /* User Part Test Transmitted */
S32 usrPrtAvTx; /* User Part Available Transmitted */
S32 cirValTstTx; /* Circuit Validation Test Transmitted */
S32 cirValRspTx; /* Circuit Validation Response Transmitted */
S32 blockRx; /* Circuit Blocking Received */
S32 blockAckRx; /* Circuit Blocking Ack Received */
S32 unblockRx; /* Circuit Unblocking Received */
S32 unblockAckRx; /* Circuit Unblocking Ack Received */
S32 cirResRx; /* Circuit Reset Received */
S32 cirGrBlockRx; /* Circuit Group Blocking Received */
S32 cirGrBlockAckRx; /* Circuit Group Blocking Ack Received */
S32 cirGrUnBlockRx; /* Circuit Group Unblocking Received */
S32 cirGrUnBlockAckRx; /* Circuit Group Unblocking Ack Received */
S32 cirGrQRx; /* Circuit Group Query Received */
S32 cirGrQAckRx; /* Circuit Group Query Acknowledge Transmitted*/
S32 cirGrResRx; /* Circuit Group Reset Received */
S32 cirGrResAckRx; /* Circuit Group Reset Ack Received */
S32 usrPrtTstRx; /* User Part Test Received */
S32 usrPrtAvRx; /* User Part Available Received */
S32 cirValTstRx; /* Circuit Validation Test received */
S32 cirValRspRx; /* Circuit Validation Response received */
} IsupCircStats ; |
Return values
Return value |
Description |
ISUP_SUCCESS |
|
ISUP_BOARD |
board is
out of range. |
ISUP_DRIVER |
Error occurred accessing the driver. |
ISUP_FAILED |
Task on the TX board returned a failure. |
ISUP_UNBOUND |
Application failed to call isupInitMgmtAPI
prior to this call. |
Details
isupCircuitStats
automatically resets the statistics counters. To control the resetting
of the statistics counters, use isupCircuitStatsEx
instead of isupCircuitStats.
For information, see isupCircuitStatsEx.
Example
S16 status;
U8 boardNum = 1;
U32 circId = 1;
IsupCircStats sts;
if ((status = isupCircuitStats(boardNum, circId, &sts)) != ISUP_MGMT_SUCCESS)
{
printf( "Board %d Circuit %d Statistics Request failed: status = %d\n",
boardNum, circId, status );
}
else
printf( “Successfully retrieved circuit statistics for circuit %d on board %d\n",
circId, boardNum );
/* The sts structure contains the circuit statistics */
}