Obtains data link status information about the specified link number, including the link state, flow control state, queue sizes, and blocked, inhibited, and congestion status.
MTP3_STATUS Mtp3LinkStatus ( U8 board, S16 linkNo, MTP3LinkStatus *pStatus)
Argument |
Description |
board |
TX board number on which the desired MTP 3 task resides. Valid range is 1 through maxboard (currently 8). |
linkNo |
Link number for which to obtain status information. Must have been previously defined with Mtp3SetLinkCfg. |
pStatus |
Pointer to a buffer provided by the application where the requested status information is returned: typedef struct _MTP3LinkStatus /* MTP Level 3 - signalling link 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. |
The following table describes the MTP3LinkStatus fields:
Field |
Description |
linkState |
State of the data link: MTP3_LNK_INACTIVE = Link is inactive. MTP3_LNK_CONN = Link is connecting. MTP3_LNK_ACTIVE = Link is active. Data flow possible. MTP3_LNK_FAILED = Link failed. MTP3_LNK_WAITCON = Link is waiting for a remote connect. |
flcSt |
Flow control state: True = Flow control for link is on. False = Flow control for link is off. |
blkd |
Blocking state: True = Link is blocked. False = Link is not blocked. |
locBlkd |
Local blocking state: True = Link is locally blocked. False = Link is not locally blocked. |
rmtBlkd |
Remote blocking state: True = Link is remotely blocked. False = Link is not remotely blocked. |
inhbt |
Inhibited state: True = Link is inhibited. False = Link is not inhibited. |
locInhbt |
Local inhibited state: True = Link is locally inhibited. False = Link is not locally inhibited. |
rmtInhbt |
Remote inhibited state: True = Link is remotely inhibited. False = Link is not remotely inhibited. |
uninhbt |
Uninhibit signaling indication: True = Uninhibit signal received. False = Uninhibit signal not received. |
cong |
Congestion state: True = Link is congested. False = Link is not congested. |
emerg |
Emergency indication: True = Emergency indication present. False = Emergency indication not present. |