SccpGetGenStats

Retrieves and optionally resets the general statistics for the SCCP task.

Prototype

SCCP_STATUS SccpGetGenStats ( U8 board, SccpGenStats *pStats, U8 bReset)

Argument

Description

board

TX board number to which this request is directed.

pStats

Pointer to the address of the caller's SCCP general statistics buffer where statistics are returned.

Refer to the Details section for more information.

bReset

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


Return values

Return value

Description

SCCP_SUCCESS

 

SCCP_BOARD

board is out of range.

SCCP_DRIVER

Error occurred accessing the driver.

SCCP_NOGENCFG

SccpSetGenCfg has not been called.

SCCP_NULLPTR

Null pointer was specified for pStats.

SCCP_RESOURCES

TX board resource is exhausted. Check the txalarm log.

SCCP_TIMEOUT

Request timed out.

SCCP_UNINIT

Application failed to call SccpMgmtInit prior to this call.


Details

The SccpGenStats structure contains the following fields:

typedef struct
{
  U8         month;         /* month                        */
  U8         day;           /* day                          */
  U8         year;          /* year - since 1900            */
  U8         hour;          /* hour - 24 hour clock         */
  U8         min;           /* minute                       */
  U8         sec;           /* second                       */
  U8         tenths;        /* tenths of second             */
  U8         fill;          /* alignment                    */
} DateTime;

typedef struct
{
  DateTime dt;           /* Date and Time                   */
  Duration dura;         /* Duration (not used)             */
                         /* Routing failure                 */
  S32      rfNTASN;      /* no translation for address of
                          * such nature                     */
  S32      rfNTSA;       /* no translation for this
                          * specific address                */
  S32      rfNetFail;    /* network failure (point code
                          * unavailable)                    */
  S32      rfNetCong;    /* network congestion              */
  S32      rfSsnFail;    /* subsystem failure               */
  S32      rfSsnCong;    /* subsystem congestion            */
  S32      rfUnequip;    /* unequipped user                 */
  S32      rfHopViolate; /* Hop counter violation           */
  S32      synError;     /* Syntax Error                    */
  S32      rfUnknown;    /* reason unknown                  */
  S32      uDataTx;      /* unit data sent                  */
  S32      uDataSrvTx;   /* unit data service sent          */
  S32      uDataRx;      /* unit data received              */
  S32      uDataSrvRx;   /* unit data service received      */
  S32      xuDataTx;     /* extended unit data sent         */
  S32      xuDataSrvTx;  /* extended unit data service sent */
  S32      xuDataRx;     /* extended unit data received     */
  S32      xuDataSrvRx;  /* extended unit data service
                          * received                        */
  S32      msgHand;      /* total msgs handled              */
  S32      msgLoc;       /* total msgs intended for local
                          * subsystems                      */
  S32      gttReq;       /* msgs requiring GT  translation  */
  S32      msgTxC0;      /* total msgs sent, class 0        */
  S32      msgTxC1;      /* total msgs sent, class 1        */
  S32      msgRxC0;      /* total msgs received, class 0    */
  S32      msgRxC1;      /* total msgs received, class 1    */
  U8       spRunState;   /* current redundancy state        */
  U8       spMateState;  /* current mate state
                          * (connected/isolated             */
  U8       memCongLevel; /* task memory congestion level    */
  U8       spare1;       /* spare for alignment             */
  S32      inCongDisc;   /* inbound messages discarded due
                          * to congestion                   */
} SccpGenStats;

Counts of type S32 are the number of event occurrences since the statistics were last cleared.