Mtp3NSapStatus

Obtains network service access point status information from the MTP 3 task, including the NSAP state (bound or unbound) and the flow control state (on or off).

Prototype

MTP3_STATUS Mtp3NSapStatus ( U8 board, S16 nsapNo, MTP3NSapStatus *pStatus)

Argument

Description

board

TX board number on which the desired MTP 3 task resides. This value must be from 1 through maxboard (currently 8).

nsapNo

NSAP number for which to obtain status information. Must have been previously defined with Mtp3SetNSapCfg.

pStatus

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

typedef struct _Mtp3NSapStatus
                       /* MTP Level 3 - SAP status             */
{
  U8  sapState;        /* SAP state                            */
  U8  flcSt;           /* Flow control state                   */
  U8  spare1;          /* Alignment                            */
  U8  spare2;          /* Alignment                            */
  U32 congDiscard;     /* Messages discarded due to congestion */
} MTP3NSapStatus;

See the Details section for field descriptions.


Return values

Return value

Description

MTP3_SUCCESS

 

MTP3_BOARD

Invalid board number.

MTP3_HANDLE

Mtp3MgmtInit not called for the specified board.


Details

The following table describes the Mtp3NSapStatus fields:

Field

Description

sapState

State of the service access point. Valid values:

SN_UNBND = No application has bound to this SAP.

SN_BND = An application has bound to this SAP.

flcSt

Flow control state. Valid values:

TRUE = Flow control is on.

FALSE = Flow control is off.

congDiscard

Count of inbound messages discarded due to congestion. For more information, see Controlling congestion.


See also

Mtp3MgmtInit, Mtp3SetNSapCfg