Initializes the general configuration structure MTP3GenCfg with default values and the provided originating point code.
MTP3_STATUS Mtp3InitGenCfg ( MTP3GenCfg *pGenCfg, U32 opc)
Argument |
Description |
pGenCfg |
Pointer to the MTP3GenCfg structure to be initialized: typedef struct _MTP3GenCfg See the Details section for field descriptions. |
opc |
Point code of the local signaling point. |
MTP3_SUCCESS
This function enables an application to initialize an MTP3GenCfg structure before calling Mtp3SetGenCfg to set the general configuration parameters. Mtp3InitGenCfg sets the opc as specified and initializes all other fields in the MTP3GenCfg structure to their defaults.
A pointer to an MTP3GenCfg structure is passed to Mtp3InitGenCfg where default values are set. After initialization, an application can override zero to all of these values and then pass the pointer to Mtp3SetGenCfg, which sets the configuration. The default values provided by Mtp3InitGenCfg are adequate for most applications.
The spCode1 and spCode2 fields in the MTP3SetGenCfg structure store the local point code. spCode1 is used by MTP 3 if the link type is CCITT or a variant of CCITT. spCode2 is used by MTP 3 if the link type is ANSI or a variant of ANSI. Both fields are set to the same value (the opc parameter) by Mtp3InitGenCfg. If a signaling point is acting as a gateway between CCITT and ANSI networks, or otherwise uses both types of point codes (14 and 24 bit), the application can override the defaults and specify different values for spCode1 and spCode2.
The following table lists the fields in the MTP3GenCfg structure that can be modified. A field name in bold indicates that subsequent calls to Mtp3SetGenCfg can update the field. Fields that do not appear in the following table are either unused or for internal use, and must not be modified.
Field |
Description |
typeSp |
Signaling point type. Valid values are: MTP3TYPE_SP = Signaling endpoint MTP3TYPE_STP = Signaling transfer point. This is the default. |
spCode1 |
Local point code for CCITT version. Must be specified with opc parameter. Valid values are 0 through 0xFFFFFF. |
spCode2 |
Local point code for ANSI or CHINA version. Must be specified with opc parameter. Valid values are 0 through 0xFFFFFF. |
rstReq |
If TRUE, restart procedures are implemented as defined by the ANSI or ITU-T specification. Valid values are TRUE (default) or FALSE. |
nmbLinks |
Maximum number of configurable data links. Valid range is 1 through 32. Default is 4. |
nmbNSap |
Maximum number of configurable network SAPs. Valid range is 1 through 64. Default is 2. |
nmbLnkSets |
Maximum number of configurable linksets. Valid range is 1 through 32. Default is 1. |
nmbRouts |
Maximum number of configurable routes. Valid range is 1 through 32767. Default is 32. |
nmbRteInst |
Maximum number of simultaneous route instances. Valid range is 1 through 32767. Default is 1024. |
nmbMasks |
Number of route masks. Valid range is 0 through 8. Default is 0. |
masks |
Route masks. The entire structure contains zeros by default. |
tmr |
General timers configuration. Refer to the MTP3GenTimerCfg structure. |
tracedata |
TRUE starts tracing of all data traffic between MTP 3 and MTP 2. Default is FALSE. |
opcRouting |
If TRUE, outbound routing is performed by both OPC and DPC. For use with multiple OPC emulation. Default is FALSE meaning outbound routing is performed by DPC only. Note that you can still use multiple OPC emulation (which is for inbound routing) and set opcRouting to FALSE. |
transparentMode |
If TRUE, all inbound traffic regardless of DPC and OPC is passed to the bound upper layer that matches the SIO value and protocol variant of the message. This behavior does not include MTP messages that MTP still handles internally. All outbound traffic is spread across all links regardless of DPC and OPC. Default is FALSE, meaning normal routing is used. |
typedef struct _MTP3GenTimerCfg
{
TimerCfg t15; /* t15 - waiting to start route set */
/* congestion test */
TimerCfg t16; /* t16 - waiting for route set congestion */
/* status update */
/* ITU restart timers */
TimerCfg t18_itu; /* ITU only - time at restarting STP to */
/* wait for TFP, TFR, TFA until enough */
/* TRA's received. Then send TFP, TFR's. */
TimerCfg t20_itu; /* ITU only - overall restart time at */
/* restarting SP/STP */
/* ANSI restart timers */
TimerCfg t22_ansi; /* ANSI only - time at restarting SP to */
/* wait for links to become available */
TimerCfg t23_ansi; /* ANSI only - time at restarting SP, */
/* after T22, to wait for all TRA's */
TimerCfg t24_ansi; /* ANSI only - time at restarting STP, */
/* after T23, waiting to send all TRA's */
TimerCfg t26_ansi; /* ANSI only - time at restarting SP */
/* waiting to repeat TRW */
TimerCfg t27_ansi; /* ANSI only - minimum duration of */
/* unavailability for full restart */
TimerCfg tRteInst; /* Route instance life timer */
TimerCfg tResync; /* Internal timer for re-syncing */
/* checkpointing */
} MTP3GenTimerCfg;
The following table lists the MTP3GenTimerCfg fields that can be modified. Unless otherwise specified, the timer names correspond to the CCITT specification. Subsequent calls to Mtp3SetGenCfg can update any field in this table. Fields that do not appear in the table are either unused or for internal use, and must not be modified. Valid values for all fields in this table range from 1 through 65535 tenths of a second.
Field |
Description |
t15 |
Waiting to start route set congestion test. Default value is 30. |
t16 |
Waiting for route set congestion status update. Default value is 20. |
t18_itu |
ITU restart timer for an STP during which links are restarted and TFA, TFR, and TFP messages are received. Default value is 300. |
t20_itu |
ITU overall restart timer. Default value is 600. |
t22_ansi |
ANSI restart timer at restarting SP waiting for links to become available. Default value is 300. |
t23_ansi |
ANSI restart timer at restarting SP waiting for TRA messages. Default value is 300. |
t26_ansi |
ANSI restart timer at restarting SP waiting to repeat TRW message. Default value is 130. |
t27_ansi |
Minimum duration of unavailability for full restart. Default value is 30. |
trteinst |
Route instance timer (internally used, not applicable to ANSI or CCITT specifications). Default value is 18000. |