Mtp2LinkStats
Obtains and potentially resets statistical information about the specified
link number.
Prototype
MTP2_STATUS Mtp2LinkStats (U8
board, S16
linkNo, MTP2LinkStats
*pStats, BOOL
bReset)
Argument |
Description |
board |
TX board number on which the desired MTP 2 task resides. |
linkNo |
Link number for which to obtain statistical information. Must have been
previously defined through Mtp2SetLinkCfg. |
pStats |
Pointer to a buffer provided by the application where the requested
statistical information is returned:
typedef struct _Mtp2LinkStats /* MTP Level 2 link statistics */
{
U32 inService; /* start of in-service */
U32 lclBusy; /* duration of local-busy */
U32 slFailAll; /* all reasons for a signaling link
* failure */
U32 slFailAb; /* Abnormal FIBR/BSNR link failure */
U32 slFailAck; /* delay of acknowledgment link
* failure */
U32 slFailErr; /* excessive error rate link failure */
U32 slFailCong; /* excessive congestion link failure */
U32 slFailAlign; /* alignment link failure */
U32 slNSUErr; /* number of signal units in error */
U32 slNegAck; /* number of negative acknowledgments */
U32 nSifSioTx; /* number of SIF/SIO packets
* transmitted */
U32 nRetrans; /* number of octets transmitted */
U32 mTx; /* information frames transmitted */
U32 lTx; /* receive ready frames transmitted */
U32 fTx; /* receive not ready frames
* transmitted */
U32 nSifSioRx; /* number of SIF/SIO packets received */
U32 mRx; /* information frames received */
U32 lRx; /* receive ready frames received */
U32 fRx; /* receive not ready frames received */
U16 txCnt; /* Number of messages on the transmit */
/* queue */
U16 hiTxCnt; /* Hiqh water number of messages on */
/* the transmit queue */
U16 rtbCnt; /* Number of messages on the */
/* retransmit queue */
U16 hiRtbCnt; /* Hiqh water number of messages on */
/* the retransmit queue */
U16 ltxCnt; /* Number of messages on the lower */
/* transmit queue */
U16 hiLtxCnt; /* Hiqh water number of messages on */
/* the lower transmit queue */
U16 sapCnt; /* Number of messages on the inbound */
/* sap queue */
U16 hiSapCnt; /* Hiqh water number of messages on */
/* the inbound sap queue */
} MTP2LinkStats; |
bReset |
If true (non-zero), statistics are reset (set to zero) after returning
the current values. If false (zero), no reset is performed. |
Return values
Return value |
Description |
MTP2_SUCCESS |
|
MTP2_BOARD |
Invalid board number. |
MTP2_HANDLE |
Mtp2MgmtInit
not called for specified board. |
Details
Statistics include counts for:
Various message types and their acknowledgments,
both transmitted and received.
Various failure counts.
Queue levels and high water marks.
See also
Mtp2MgmtInit, Mtp2SetLinkCfg