Obtains linkset status information about the specified linkset number.
MTP3_STATUS Mtp3LinkSetStatus ( U8 board, S16 linkSetNo, MTP3LinkSetStatus *pStatus)
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. |
pStatus |
Pointer to a buffer provided by the application where the requested status information is returned: typedef struct _Mtp3LinkSetStatus /* MTP Level 3 - link set status */ See the Details section for field descriptions. |
Return value |
Description |
MTP3_SUCCESS |
|
MTP3_BOARD |
Invalid board number. |
MTP3_HANDLE |
Mtp3MgmtInit not called for the specified board. |
A linkset is a group of links that, once defined as a linkset, can be controlled or queried as a group. This function obtains linkset status information about the specified linkset number, including the linkset state, and the number of active and congested links.
The following table lists the Mtp3LinkSetStatus fields:
Field |
Description |
nmbActLinks |
Number of active links in this linkset. Valid values are 0 through minNmbActLnk. |
nmbCongLnks |
Number of congested links in this linkset. Valid values are 0 through number of links in linkset. |
cong |
Linkset congestion state. Valid values are: True = linkset is congested. False = linkset is not congested. |
state |
Linkset state. Valid values are: 0 = linkset is active. 1 = linkset is disabled. |