Mtp3RouteStatus

Obtains routing status information about the route associated with the specified destination point code.

Prototype

MTP3_STATUS Mtp3RouteStatus ( U8 board, U32 dpc, U32 opc, MTP3RouteStatus *pStatus)

Argument

Description

board

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

dpc

Destination point code associated with the desired route.

opc

Originating point code associated with the desired route.  If set to zero, MTP will use the OPC specified in the general configuration.

pStatus

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

typedef struct _Mtp3RouteStatus      /* MTP Level 3 - route status    */
{
  U32   dpc;                         /* Destination point code        */
  U32   opc;                         /* Originating point code        */
  U16   nmbActvLnkSets;              /* Number of active link sets    */
  U16   nmbCongLnkSets;              /* Number of congested link sets */
  U8    state;                       /* Route state                   */
  Bool  cong;                        /* Route set is congested        */
  Bool  rstFlg;                      /* SP restarting flag            */
} MTP3RouteStatus;

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 Mtp3RouteStatus fields:

Field

Description

dpc

Destination point code associated with this route. Valid values are 0 through 0xFFFFFF.

opc

Originating point code associated with this route.  Valid values are 0 through 0xFFFFFF.

nmbActvLnkSets

Number of active link sets. Valid values are 0 through 32.

nmbCongLnkSets

Number of congested link sets. Valid values are 0 through 32.

state

Route state:

0 = Route unavailable.

1 = Route available.

cong

Route congestion state:

True = Route congested.

False = Route not congested.

rstFlg

Adjacent signaling point restarting flag:

True = Adjacent signaling point is restarting.

False = Adjacent signaling point is not restarting.


See also

Mtp3MgmtInit