Mtp3InitRouteCfg

Initializes the provided route configuration structure MTP3RouteCfg with default values, the specified route number, the DPC, and the switch type.

Prototype

MTP3_STATUS Mtp3InitRouteCfg ( MTP3RouteCfg *pRouteCfg, S16 routeNo, U32 dpc, U8 swType)

Argument

Description

pRouteCfg

Pointer to the MTP3RouteCfg structure to be initialized:

typedef struct _MTP3RoutCfg
                        /* MTP Level 3 routing configuration */
{
  U32  dpc;             /* Destination point code            */
  U32  opc;             /* Originating point code            */
  U8   spType;          /* Signaling point type              */
  U8   swtchType;       /* Switch type                       */
  U16  cmbLnkSetId;     /* Combined link set ID              */
  Bool loadShar;        /* Load sharing indication between   */
                        /*  linksets                         */
  U8   dir;             /* Direction                         */
  Bool rteToAdjSp;      /* Flag indicating this route to     */
                        /*  adjacent SP                      */
  Bool rteToCluster;    /* Flag indicating this route to     */
                        /*  a cluster                        */
  U8   ssf;             /* Sub service field                 */
  U8   spare1;          /* Alignment                         */
  U16  spare2;          /* Alignment                         */
  MTP3RteTimerCfg tmr;  /* Route timer configuration         */
} MTP3RouteCfg;

See the Details section for field descriptions.

routeNo

Number to assign to this route. Valid range is 0 through the maximum number of routes defined in the call to Mtp3SetGenCfg.

dpc

Destination point code associated with this route.

swType

Switch type of the target signaling point. Must be one of the following types:

MTP3LNK_ANSI

MTP3LNK_CCITT

MTP3LNK_JNTT

MTP3LNK_JTTC


Return values

MTP3_SUCCESS

Details

This function enables an application to initialize an MTP3RouteCfg structure before calling Mtp3SetRouteCfg to set the route configuration parameters. Mtp3InitRouteCfg sets the linkset number, dpc, and switch type as specified, and initializes all other fields in the MTP3RouteCfg structure to their defaults.

A pointer to an MTP3RouteCfg structure is passed to Mtp3InitRouteCfg where default values are set. After initialization, an application can override zero to all of these values and then pass the pointer to Mtp3SetRouteCfg, which sets the configuration. The default values provided by Mtp3InitRouteCfg are adequate for most applications.

The following table lists the MTP3RouteCfg fields that can be modified. A field name in bold indicates that subsequent calls to Mtp3SetRouteCfg with the same dpc or cmbLnkSetId can update the field. Fields that do not appear in the table are either unused or for internal use, and must not be modified.

Field

Description

dpc

Destination point code. Must be specified with the dpc parameter. Valid values are 0 through 0xFFFFFF.

opc

Originating point code. This field defaults to zero and indicates to the MTP task that it must use the general OPC instead. It can be overridden for multiple OPC emulation.

spType

Signaling point type of the destination of this route. Valid values are:

MTP3TYPE_SP

MTP3TYPE_STP (default)

swType

Switch type of the destination of this route. Must be specified with the swType parameter. Valid values are:

MTP3LNK_ANSI

MTP3LNK_CCITT

MTP3LNK_JNTT

MTP3LNK_JTTC

cmbLnkSetId

Route ID. Must be specified with the routeNo parameter. Valid values are 1 through 256.

dir

Route direction. Valid values are:

MTP3_RTE_UP (inbound)

MTP3_RTE_DN (outbound)

MTP3RteTimerCfg

Route timer configuration. Refer to the MTP3RteTimerCfg structure.

rteToAdjSp

Flag indicating whether or not this route is to an adjacent signaling point. Valid values are True or False.

rteToCluster

Flag indicating whether this route is to a cluster (True) or a single signaling point (False). This value affects only STP nodes.

ssf

Subservice field. Used to determine what to put in the ssf field of MTP 3 originated management messages. Default based on swType:

MTP3SSF_NAT = LNK_ANSI or LNK_ANSI88.

MTP3SSF_INTL = LNK_CCITT, LNK_JNTT, or LNK_JTTC.


MTP3RteTimerCfg structure

typedef struct _MTP3RteTimerCfg
{
  TimerCfg t8;       /* t8 - transfer prohibited inhibition    */
                     /* timer                                  */
  TimerCfg t10;      /* t10 - waiting to repeat route set test */
   /* ITU restart timers */
  TimerCfg t19_itu;  /* ITU only - time after sending a TRA to */
                     /* ignore rcvd TRA's                      */
  TimerCfg t21_itu;  /* ITU only - overall restart time at     */
                     /* adjacent SP/STP                        */
   /* ANSI restart timers */
  TimerCfg t25_ansi; /* ANSI only - time at adjacent SP        */
                     /* waiting for TRA                        */
  TimerCfg t28_ansi; /* ANSI only - time at adjacent SP        */
                     /* waiting for TRW                        */
  TimerCfg t29_ansi; /* ANSI only - timer started when TRA     */
                     /* sent in response to unexpected TRW     */
                     /* or TRA                                 */
  TimerCfg t30_ansi; /* ANSI only - timer to limit sending     */
                     /* of TFP's and TFR's in response to      */
                     /* unexpected TRW or TRA                  */
} MTP3RteTimerCfg;

The following table lists the MTP3RteTimerCfg fields that can be modified. Unless otherwise specified, the timer names correspond to the CCITT specification. Subsequent calls to Mtp3SetRouteCfg with the same dpc or cmbLnkSetId can update any field in this table. Valid values for all fields in this table range from 1 through 65535 tenths of a second.

Field

Default

Description

t8

1

Transfer prohibited inhibition timer.

t10

45

Timer waiting to repeat route set test message.

t19_itu

680

ITU restart timer to avoid ping-pong of TFP, TFR, or TRA messages.

t21_itu

640

Overall ITU restart timer at adjacent SP.

t25_ansi

320

ANSI restart timer at adjacent SP waiting for a TRA message.

t28_ansi

300

ANSI restart timer at adjacent SP waiting for a TRW message.

t29_ansi

630

ANSI restart timer started when a TRA is sent in response to an unexpected TRA or TRW.

t30_ansi

320

ANSI restart timer to limit sending of TFPs and TFRs in response to unexpected TRA or TRW.


See also

Mtp3MgmtInit, Mtp3SetGenCfg, Mtp3SetRouteCfg