MTP3GetApiStats

Argument

Description

ctahd

Natural Access handle.

pStats

Pointer to a buffer where the statistics are returned:

typedef struct
{
  U32 qCount;      /* number of API messages currently queued    */
                   /* to MTP3 layer                              */
  U32 qPeak;       /* max number of API messages ever queued to  */
                   /* MTP3 layer                                 */
  U32 txPending;   /* current number of outstanding transmit     */
                   /* rqsts to MTP3 layer                        */
  U32 txPendPeak;  /* max number of transmit rqsts ever          */
                   /* outstanding to MTP3 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 MTP3 layer  */
  U32 rxFailed;    /* number of receive failure events from      */
                   /* MTP3 layer                                 */
  U8  apiQCongLvl; /* current outbound queue congestion level    */
                   /* [0..3]                                     */
  U8  spare1;      /* spare for alignment                        */
  U16 spare2;      /* spare for alignment                        */
} MTP3APISTATS;

bReset

If non-zero, statistics are reset after returning them to the application.

Return value

Description

MTP3_SUCCESS

CTAERR_INVALID_CTAHD

Invalid handle.