(Page 13 of 29 in this chapter) Version


Mtp3InitRouteCfg

Description

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

Prototype

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

pRouteCfg Pointer to the MTP3RouteCfg structure to be initialized.

routeNo Number to assign to this route. Valid range is 1 to 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 either MTP3LNK_ANSI or MTP3LNK_CCITT.

Return Values

Details

This function is provided as a quick way for an application to initialize an MTP3RouteCfg structure before calling Mtp3SetRouteCfg (see next section) to set the route configuration parameters. This function sets the link set number, dpc, and switch type as specified and initializes all other fields in the MTP3RouteCfg structure to their defaults.

Refer to the following MTP3RouteCfg structure for more information about its fields and their default values.

The following structures are used for individual route configuration in the MTP 3 task. Typically a pointer to an MTP3RouteCfg structure is passed to Mtp3InitRouteCfg where default values are set. These defaults are specified in the following table. If there is no default, either the field is unused or its value is passed as a parameter to Mtp3InitRouteCfg. After initialization, an application may override zero to all of these values and then pass the pointer to the Mtp3SetRouteCfg function, which actually sets the configuration.

Most of the default values provided by Mtp3InitRouteCfg will be adequate for most applications.

typedef struct _Mtp3RoutCfg     /* MTP Level 3 routing configuration  */
{
  U32             dpc;          /* Destination point code             */
  U8              spType;       /* Signaling point type               */
  U8              swtchType;    /* Switch type                        */
  U16             cmbLnkSetId;  /* Route ID                           */
  Bool            loadShar;     /* Load sharing indication between link 
                                 * sets                               */
  U8              dir;          /* Direction.  Up (inbound) or Down
                                 * (outbound).                        */
  MTP3RteTimerCfg tmr;          /* Route timer configuration          */
  Bool            rteToAdjSp;   /* Indicates if this is a route to an
                                 * adjacent SP                        */
  Bool            rteToCluster; /* Indicates if this is a route to a 
                                 * cluster                            */
  U8               ssf;         /* Sub service field                  */
} MTP3RoutCfg;

Fields that do not appear in the following table are either unused or for internal use only. Those fields should not be modified by the user. Field names in bold indicate that the field can be updated on subsequent calls to Mtp3SetRouteCfg with the same dpc or cmbLnkSetId.

Field Name

Default

Valid Values

Description

dpc

None

0 - 0xFFFFFF

Destination point code. Must be specified via the dpc parameter

spType

STP

One of:


MTP3TYPE_SP
or
MTP3TYPE_STP

Signaling point type of the destination of this route.

signaling end point (no transfer functions)
or
signaling transfer point.

swType

None

One of:


MTP3LNK_ANSI
MTP3LNK_CCITT

Switch type of the destination of this route. Either:

ANSI switch type, or
CCITT switch type.

Must be specified via the swType parameter.

cmbLnkSetId

None

1 - 16

Route ID. Must be specified via the routeNo parameter.

dir

DN

One of:

MTP3_RTE_UP
MTP3_RTE_DN

Route direction. Either:

up (inbound), or
down (outbound)

MTP3RteTimerCfg

See below

See below

Route timer configuration. See structure below.

rteToAdjSp

True

True/False

Flag indicating whether this route is to an adjacent signaling point or not.

rteToCluster

False

True/False

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

ssf

Based on swType

One of:

MTP3SSF_NAT
MTP3SSF_INTL

Subservice field. Default based on
swType.

swType = ANSI
swType = CCITT

This is used to determine what to put in the ssf field of MTP 3 originated management messages.

typedef struct _Mtp3RteTimerCfg
{
  TimerCfg  t8;   /* Transfer prohibited inhibition timer         */
  TimerCfg  t10;  /* Waiting to repeat route set test             */
  TimerCfg  t21;  /* Waiting to restart traffic routed through
                   * adjacent SP                                  */
  TimerCfg  t25;  /* Waiting for traffic restart allowed
                   * message for ANSI                             */
} MTP3RteTimerCfg;

Fields that do not appear in the following table are either unused or for internal use only. Those fields should not be modified by the user. Field names in bold indicate that the field can be updated on subsequent calls to Mtp3SetRouteCfg with the same dpc or routeId (routeNo). Unless otherwise specified, the timer names correspond to the CCITT specification. Differences from the ANSI and/or CCITT specification are noted in parentheses in the description.
Field Name

Default
(in tenth/secs)

Range

Description

t8

1

1 - 65535

Transfer prohibited inhibition timer

t10

45

1 - 65535

Waiting to repeat route set test message

t21

5

1 - 65535

Waiting to restart traffic routed through adjacent signaling point (ANSI timer T28)

t25

30

1 - 65535

Waiting for traffic restart allowed message for ANSI (CCITT timer N/A)

See Also

Mtp3MgmtInit, Mtp3SetGenCfg, Mtp3SetRouteCfg



(Page 13 of 29 in this chapter) Version


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