Table of Contents Index NMS Glossary Previous Page Next Page (Page 5 of 11 in this chapter) Version


TCAPGetApiStats

Description

Retrieves the current TCAP API congestion level and queue statistics.

Prototype

DWORD TCAPGetApiStats (CTAHD ctahd,
TCAPAPISTATS *pStats,
BOOL reset)

ctahd Handle from ctaOpenServices call.

pStats Address of buffer where statistics are returned to the caller.

reset If set to TRUE, all statistics (but not current congestion level) are reset to zero after stats are returned.

Return Values

Details

The structure of the TCAPAPISTATS block returned looks similar to this:

typedef struct 
{
  U32 qCount;      /* number of API messages currently queued
                    * to TCAP layer                             */
  U32 qPeak;       /* max number of API messages ever queued
                    * to TCAP layer                             */
  U32 txPending;   /* number of outstanding transmit rqsts
                    * to TCAP layer                             */
  U32 txPendPeak;  /* max transmit rqsts ever outstanding
                    * to TCAP layer                             */
  U32 txSuccess;   /* number of successful transmit
                    * requests completed                        */
  U32 txFailed;    /* number of failed transmit requests        */
  U32 txLastErr;   /* error code from last failed transmit
                    * request                                   */
  U32 rxSuccess;   /* number of events received from TCAP layer */
  U32 rxFail;      /* number of packet receive failures         */
  U8  apiQCongLvl; /* current outbound queue congestion
                    * level [0..3]                              */
  U8  tcapCongLvl; /* current TCAP layer congestion
                    * level [0..3]                              */
  U8  tcapCongSrc; /* reason for TCAP layer congestion          */
  U8  spare1;      /* spare for alignment                       */
} TCAPAPISTATS;


Table of Contents Index NMS Glossary Previous Page Next Page (Page 5 of 11 in this chapter) Version


Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2002, NMS Communications Corporation. All rights reserved.