Obtains and potentially resets statistics for the route associated with the specified destination point code.
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 */ |
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 value |
Description |
MTP3_SUCCESS |
|
MTP3_BOARD |
Invalid board number. |
MTP3_HANDLE |
Mtp3MgmtInit not called for the specified board. |
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.