TUPGetCircStats

Sends a request to retrieve the statistics for a given circuit.

Prototype

S16 TUPGetCircStats ( U8 board, CirIdx circID, TUPCircStats *stats, U8 reset)

Argument

Description

board

TX board number.

circID

Circuit index for which to retrieve statistics.

stats

Pointer to structure to place retrieved statistics. Refer to the Details section for more information.

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.


Details

The TupCircStats structure appears as follows:

typedef struct _TupCircStats
{
    DateTime dt;      /* date and time (Not Used)             */
    Duration dura;    /* duration (Not Used)                  */
    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 adrCmpltTx;   /* Address complete transmitted         */
    S32 answerTx;     /* Answer transmitted                   */
    S32 contiTx;      /* Continuity transmitted               */
    S32 conChkReqTx;  /* Continuity Check Request transmitted */
    S32 fotTx;        /* Forward transmitted                  */
    S32 clfTx;        /* Release transmitted                  */
    S32 cclTx;        /* Caller clear transmitted             */
    S32 rlgTx;        /* Release Complete transmitted         */
    S32 cbkTx;        /* clear back transmitted               */
    S32 ranTx;        /* Reanswer transmitted                 */
    S32 oprTx;        /* operator transmitted                 */
    S32 mpmTx;        /* meter pulse transmitted              */
    S32 accTx;        /* auto cong level transmitted          */
    S32 ubmTx;        /* UBM txed, including SLB and STB      */
    S32 initAdrTx;    /* Initial Address transmitted          */
    S32 infoTx;       /* Info transmitted                     */
    S32 infoReqTx;    /* Info Request transmitted             */
    S32 subsAdrTx;    /* Subsequent Address transmitted       */
    S32 malTx;        /* Malicious Call Print transmitted     */
    S32 chargeTx;     /* Charge 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 adrCmpltRx;   /* Address complete received            */
    S32 answerRx;     /* Answer received                      */
    S32 contiRx;      /* Continuity received                  */
    S32 conChkReqRx;  /* Continuity Check Request received    */
    S32 fotRx;        /* Forward received                     */
    S32 clfRx;        /* Release received                     */
    S32 cclRx;        /* Caller clear received                */
    S32 rlgRx;        /* Release Complete received            */
    S32 cbkRx;        /* clear back received                  */
    S32 ranRx;        /* Reanswer received                    */
    S32 oprRx;        /* operator received                    */
    S32 mpmRx;        /* meter pulse received                 */
    S32 accRx;        /* auto cong level received             */
    S32 ubmRx;        /* UBM received, including SLB/STB      */
    S32 initAdrRx;    /* Initial Address received             */
    S32 infoReqRx;    /* Info Request received                */
    S32 infoRx;       /* Info received                        */
    S32 subsAdrRx;    /* Subsequent Address received          */
    S32 malRx;        /* Malicious Call Print received        */
    S32 chargeRx;     /* Charge received                      */
} TupCircStats;