SccpGetUSapStats

Retrieves and optionally resets the user service access point statistics for a particular user service access point of the SCCP task.

Prototype

SCCP_STATUS SccpGetUSapStats ( U8 board, SccpUSapStats *pStats, U16 sapId, U8 bReset)

Argument

Description

board

TX board number.

pStats

Pointer to the address of the caller's SCCP user service access point statistics buffer where statistics are returned:

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)          */
  S32        ssOOSReqGr;  /* Subsystem out-of-service
                           * request granted              */
  S32        ssOOSReqDn;  /* Subsystem out-of-service
                           * request denied               */
  S32        msgTxBSS;    /* msgs sent to backup 
                           * subsystem                    */
  S32        inCongDisc;  /* inbound messages discarded
                           * due to congestion            */
  S32        inCongRtnd;  /* inbound messages returned
                           * due to congestion            */
  S32        outCongDisc; /* outbound messages discarded
                           * due to congestion            */
  S32        outCongRtnd; /* outbound messages returned
                           * due to congestion            */
} SccpUSapStats;

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

sapId

User service access point ID.

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_EXCEEDMAXCFG

User service access point ID is out of the configured range.

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.