SCCPGetStats

Retrieves congestion level activity statistics from the SCCP service.

Prototype

DWORD SCCPGetStats ( CTAHD ctahd, SccpStats *stats, U8 bReset)

Argument

Description

ctahd

Natural Access handle returned by ctaCreateContext.

stats

Pointer to a user-supplied SccpStats structure:

typedef struct  _SCCP_STAT
{
    U32   succTx;        /* number of successful transmits     */
    U32   succRx;        /* number of successful receives      */
    U32   failTx;        /* number of transmit failures        */
    U32   failTxErr;     /* last transmit failure error        */
    U32   failRx;        /* number of receive failures         */
    U32   failRxErr;     /* last receive failure error         */
    U32   outStTx;       /* Number of messages outstanding to
                          * the board                          */
    U32   maxOutStTx;    /* Maximum number of messages
                          * outstanding to the board           */
    U32   quTx;          /* Number of messages queued by the
                          * SCCP service                       */
    U32   maxQuTx;       /* Maximum number of messages queued
                          * by the SCCP service                */
    U8    currCongState; /* Current outbound congestion state  */
    U8    svcCongState;  /* Service congestion state(0-3)      */
    U8    taskCongState; /* last reported SCCP task
                          * congestion state(0-3)              */
} SccpStats;

 

bReset

If non-zero, statistics are set to zero after retrieval.


Return values

Return value

Description

SCCP_SUCCESS

 

SCCPERR_DRIVER

Statistics could not be retrieved from the Natural Access service.

SCCPERR_RESOURCES

Number of available buffers is exhausted.

CTAERR_BAD_ARGUMENT

One or more arguments are invalid.

CTAERR_INVALID_CTAHD

Natural Access handle is invalid.


Details

This function returns SCCP service statistics for the Natural Access handle provided.

Refer to Handling congestion events for more information.