(Page 17 of 29 in this chapter) Version

Mtp3LinkStatus

Description

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.

Prototype

MTP3_STATUS Mtp3LinkStatus (U8 board,
S16 linkNo,
MTP3LinkStatus *pStatus )
board TX board number on which the desired MTP 3 task resides. Valid range is 1 to MAXBOARD (currently 8).
linkNo Link number to obtain status information about. The link number must have been previously defined via the Mtp3SetLinkCfg function.
pStatus Pointer to a buffer provided by the application where the requested status information will be returned.

Return Values

MTP3_SUCCESS
MTP3_BOARDInvalid board number specified.
MTP3_HANDLEMtp3MgmtInit was never called for the specified board.

Details

Refer to the MTP3LinkStatus structure for detailed information.
This structure is filled by the MTP 3 task in response to an Mtp3LinkStatus request. typedef struct _Mtp3LinkStatus /* MTP Level 3 - signaling link status */ { U8 state; /* Link state */ U8 flcSt; /* Flow control state */ S16 tQSize; /* Transmit queue size */ S16 rTQSize; /* Retransmit queue size */ Bool blkd; /* Link is blocked */ Bool locBlkd; /* Link is blocked locally */ Bool inhbt; /* Link is inhibited */ Bool locInhbt; /* Local inhibit indication */ Bool rmtInhbt; /* Remote inhibit indication */ Bool uninhbt; /* Uninhibit signaling indication */ Bool cong; /* Link is congested */ Bool emerg; /* Emergency indication */ } MTP3LinkStatus; Field Name Possible values Description linkState One of: MTP3_LNK_INACTIVE MTP3_LNK_CONN MTP3_LNK_INACTIVE MTP3_LNK_FAILED MTP3_LNK_WAITCON State of the data link Link is inactive Link is connecting Link is active. Data flow possible. Link has failed. Link is waiting for a remote connect flcSt True False Flow control state: Flow control for link is on Flow control for link is off tQSize 0 - 0xFFFF Transmit queue size rTQSize 0 - 0xFFFF Retransmit queue size blkd True False Blocking state: Link is blocked Link is not blocked locBlkd True False Local blocking state: Link is locally blocked Link is not locally blocked inhbt True False Inhibited state: Link is inhibited Link is not inhibited locInhbt True False Local inhibited state: Link is locally inhibited Link is not locally inhibited rmtInhbt True False Remote inhibited state: Link is remotely inhibited Link is not remotely inhibited uninhbt True False Uninhibit signaling indication: Uninhibit signal received Uninhibit signal not received cong True False Congestion state: Link is congested Link is not congested emerg True False Emergency indication: Emergency indication present Emergency indication not present

See Also

Mtp3MgmtInit, Mtp3SetLinkSetCfg

(Page 17 of 29 in this chapter) Version

tech_support@nmss.com

Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.