Mtp3LinkSetStats

Obtains (and potentially resets) linkset statistical information about the specified linkset number.

Prototype

MTP3_STATUS Mtp3LinkSetStats ( U8 board, S16 linkSetNo, MTP3LinkSetStats *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).

linkSetNo

Linkset number about which to obtain status information. Must have been previously defined with Mtp3SetLinkSetCfg.

pStats

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

typedef struct _Mtp3LinkSetStats /* MTP Level 3 link set
                                    statistics                 */
{
  U32  strtLnkSetFail;   /* Start of linkset failure           */
  U32  stopLnkSetFail;   /* Stop of linkset failure            */
  U32  durLnkSetUnav;    /* Duration of linkset unavailability */
} MTP3LinkSetStats;

bReset

Optionally resets statistics.


Return values

Return value

Description

MTP3_SUCCESS

 

MTP3_BOARD

Invalid board number.

MTP3_HANDLE

Mtp3MgmtInit not called for the specified board.


Details

Linkset statistics include the number of times a linkset has failed and recovered and the total duration of linkset unavailability.

If the bReset value is a non-zero integer, the statistics are reset after returning the current values. A value of zero disables the reset function.

See also

Mtp3MgmtInit, Mtp3SetLinkSetCfg