(Page 15 of 29 in this chapter) Version

Mtp3LinkSetStatus

Description

Obtains link set status information about the specified link set number.

Prototype

MTP3_STATUS Mtp3LinkSetStatus (U8 board,
S16 linkSetNo,
MTP3LinkSetStatus *pStatus)

board TX board number on which the desired MTP 3 task resides. Valid range is 1 to MAXBOARD (currently 8).

linkSetNo Link set number about which to obtain status information. This must have been previously defined via the Mtp3SetLinkSetCfg function.

pStatus Pointer to a buffer provided by the application where the requested status information will be returned.

Return Values

Details

A link set is a group of links that, once defined as a link set, can be controlled or queried as a group. This function obtains link set status information about the specified link set number. This information includes the link set state, the number of active and congested links, and a configuration flag. Refer to the MTP3LinkSetStatus structure for detailed information.

This structure is filled by the MTP 3 task in response to an Mtp3LinkSetStatus request:

typedef struct _Mtp3LinkSetStatus      /* MTP Level 3 - link set status */
{
  Bool  cfgFlg;                        /* Configuration flag           */
  U8    spare1;                        /* Alignment                    */
  U16   nmbActLnks;                    /* Number of active links       */
  U16   nmbCongLnks;                   /* Number of congested links    */
  Bool  cong;                          /* Link set is congested        */
  U8    state;                         /* Link set state               */
} Mtp3LinkSetStatus;
Fields that do not appear in the following table are either unused or for internal use only.
Field Name

 Possible values

 Description

nmbActLinks

 0 - minNmbActLnk

 Number of active links in this link set.

nmbCongLnks

 0 - number of links in link set

 Number of congested links in this link set.

cong

 One of:

True
False

 Link set congestion state:

Link set is congested
Link set is not congested

state

 One of:

0
1

 Link set state:

Link set is active
Link set is disabled

See Also

Mtp3MgmtInit, Mtp3SetLinkSetCfg


(Page 15 of 29 in this chapter) Version

tech_support@nmss.com
Copyright © 2000, Natural MicroSystems, Inc. All rights reserved.