Mtp3RouteStats

Obtains and potentially resets statistics for the route associated with the specified destination point code.

Prototype

MTP3_STATUS Mtp3RouteStats ( U8 board, U32 dpc, U32 opc, MTP3RouteStats *pStats, BOOL bReset)

Argument

Description

board

TX board number on which the desired MTP 3 task resides. Valid range is 1 through maxboard (currently 8).

dpc

Destination point code associated with the desired route.

opc

Originating point code associated with the desired route.  If set to zero, MTP will use the OPC specified in the general configuration.

pStats

Pointer to a buffer provided by the application where the requested statistical information is returned:

typedef struct _Mtp3RouteStats  /* MTP Level 3 route statistics */
{
  U32 dpc;          /* Destination point code of this route     */
  U32 opc;          /* Originating point code of this route     */
  U32 routeTstTx;   /* Route set test transmitted               */
  U32 routeTstRx;   /* Route set test received                  */
  U32 congTstRx;    /* Route set congestion test received       */
  U32 congTstTx;    /* Route set congestion test transmitted    */
  U32 txProhibTx;   /* Transfer prohibited transmitted          */
  U32 txProhibRx;   /* Transfer prohibited received             */
  U32 txRestrictRx; /* Transfer restricted received             */
  U32 txAllowTx;    /* Transfer allowed transmitted             */
  U32 txAllowRx;    /* Transfer allowed received                */
  U32 rteUnavCnt;   /* Route unavailable                        */
  U32 sifOctTx;     /* Number of SIF octets transmitted         */
  U32 sioOctTx;     /* Number of SIO octets transmitted         */
  U32 durRteUnav;   /* Duration of route unavailability         */
} MTP3RouteStats; 

bReset

If true (non-zero), the statistics are reset (set to zero) after returning the current values. If false (zero), no reset is performed.


Return values

Return value

Description

MTP3_SUCCESS

 

MTP3_BOARD

Invalid board number.

MTP3_HANDLE

Mtp3MgmtInit not called for the specified board.


Details

Route statistics include transmit and receive counts for messages such as route test, route congestion test, transfer prohibited, transfer restricted, and transfer allowed, as well as the number of times a route was unavailable and the total duration of route unavailability. All counts are U32 fields.

See also

Mtp3MgmtInit