TCAPGetApiStats

Retrieves congestion level activity statistics from the TCAP service. For more information, refer to TCAP service congestion.

Prototype

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

Argument

Description

ctahd

Handle from ctaOpenServices.

pStats

Pointer to the address of the buffer where statistics are returned to the caller.

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;

reset

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


Return values

Return value

Description

TCAP_SUCCESS

 

CTAERR_BAD_ARGUMENT

Natural Access handle is invalid, or the statistics buffer is set to NULL.

CTAERR_INVALID_HANDLE

Natural Access handle is invalid.