Retrieves and optionally resets the statistics for a specified TCAP service access point (SAP).
S16 TCAPSapStats ( U8 board, S16 sapID, TcapSapStats *stats, U8 reset)
|
Argument |
Description |
|
board |
TX board number to which this request is directed. |
|
sapId |
Index number of the target TCAP SAP. |
|
stats |
Pointer to the address of a caller's TCAP SAP statistics buffer where statistics are to be returned. Refer to the Details section for more information. |
|
reset |
If non-zero, statistics are reset to zero after retrieving. |
|
Return value |
Description |
|
TCAP_SUCCESS |
|
|
TCAPM_BADSAP |
sapId is either out of range or the call was made prior to calling TCAPGenCfg. |
|
TCAPM_BOARD |
board is out of range. |
|
TCAPM_DRIVER |
Error occurred accessing the driver. |
|
TCAP_FAILED |
Task on the TX board reported a failure. |
|
TCAPM_NULLPTR |
Null pointer was specified for stats. |
|
TCAPM_TIMEOUT |
Request timed out. |
|
TCAPM_UNINIT |
Application failed to call TCAPInitMgmtAPI prior to this call. |
The TcapSapStats structure is shown here. Counts of type S32 represent the number of event occurrences since last cleared. Counts of type TcapEvCnt include both a count of events plus a time stamp of the first occurrence of the event, displayed in hundredths of seconds since the last boot.
typedef struct Tcap_Ev_Cnt
{
S32 cnt; /* event count */
U32 first; /* when it first happened */
} TcapEvCnt;
typedef struct Tcap_Sap_Stats
{
S16 swtch; /* protocol variant switch */
S16 fill; /* fill for alignment */
S32 openTrans; /* number of open transactions */
S32 frmTx; /* frames transmitted */
S32 invTx; /* invoke components transmitted */
S32 resTx; /* result components transmitted */
S32 rejTx; /* reject components transmitted */
S32 errTx; /* error components transmitted */
S32 uniTx; /* unidirectional msgs xmitted */
S32 beginTx; /* begin messages transmitted */
S32 contTx; /* continue messages transmitted */
S32 endTx; /* end messages transmitted */
S32 abortTx; /* abort messages transmitted */
S32 qryPrmTx; /* query with permission xmitted */
S32 qryNoPrmTx; /* query w/out permission xmitted */
S32 conPrmTx; /* conversation with permission
* xmitted */
S32 conNoPrmTx; /* conversation without permission
* transmitted */
S32 respTx; /* response transmitted */
S32 frmRx; /* frames received */
S32 invRx; /* invoke components received */
S32 resRx; /* result components received */
S32 rejRx; /* reject components received */
S32 errRx; /* error components received */
S32 uniRx; /* unidirectional msgs received */
S32 beginRx; /* begin messages received */
S32 contRx; /* continue messages received */
S32 endRx; /* end messages received */
S32 abortRx; /* abort messages received */
S32 qryPrmRx; /* query with permission rec'd */
S32 qryNoPrmRx; /* query without permission rec'd */
S32 conPrmRx; /* conversation with permission
* rec'd */
S32 conNoPrmRx; /* conversation w/out permission
* rec'd */
S32 respRx; /* response received */
S32 drop; /* frames dropped */
TcapEvCnt urPkg; /* unrecognized package type */
TcapEvCnt inTrn; /* incorrect transaction portion */
TcapEvCnt bdTrn; /* badly structured transaction
* portion */
TcapEvCnt urTrn; /* unrecognized transaction ID */
TcapEvCnt prTrn; /* permission to release problem */
TcapEvCnt ruTrn; /* resource unavailable */
TcapEvCnt urCmp; /* general - unrecognized comp. */
TcapEvCnt inCmp; /* general-incorrect component
* portion */
TcapEvCnt bdCmp; /* general - badly structured
* component portion */
TcapEvCnt dupId; /* invoke - duplicate Invoke Id */
TcapEvCnt urOp; /* invoke - unrecognized op code */
TcapEvCnt inPrm; /* invoke - incorrect parameters */
TcapEvCnt iurId; /* invoke - unrecognized correlation
* ID */
TcapEvCnt rurId; /* ret. result - unrecognized correl.
* ID */
TcapEvCnt uxRes; /* ret. result - unexpected ret.
* result */
TcapEvCnt eurId; /* ret. error - unrecognized correl.
* ID */
TcapEvCnt uxRer; /* ret. error - unexpected return
* error */
TcapEvCnt urErr; /* ret. error - unrecognized error
* code */
TcapEvCnt uxErr; /* ret. error - unexpected error */
TcapEvCnt enPrm; /* ret. error - incorrect parameter */
S32 outCongAbort; /* outbound transactions refused -
/* congestion */
S32 outCongDisc; /* outbound msgs discarded -
/* congestion */
S32 inbCongAbort; /* inbound transactions refused -
/* congestion */
S32 inbCongDisc; /* inbound msgs discarded -
/* congestion */
U8 currInbCongLvl; /* current inbound congestion level */
U8 currOutbCongLvl; /* current outbound congestion level */
} TcapSapStats;