SccpInitGenCfg

Initializes an SCCP general configuration buffer to default values that can be passed to SccpSetGenCfg.

Prototype

SCCP_STATUS SccpInitGenCfg ( SccpGenCfg *pCfg)

Argument

Description

pCfg

Pointer to the SCCP general configuration structure to initialize. Refer to the Details section for information.


Return values

Return value

Description

SCCP_SUCCESS

 

SCCP_NULLPTR

Null pointer was specified for pCfg.


Details

Prior to calling SccpSetGenCfg to send the configuration to the SCCP layer, the application can change the default values within the specified range for any fields other than those denoted as internal or unused.

The SCCPGenCfg structure contains the following fields:

typedef struct
{
  U8       enable;         /* 0 = disabled, 1 = enabled               */
  U8       spare1;         /* alignment                               */
  U16      value;          /* timeout in tenths of seconds            */
}

typedef struct
{
  U8       maxSaps;      /* Max Number of SCCP User Saps               */
  U8       maxNSaps;     /* Max Number of Network Saps(MTP3)           */
  U16      maxScli;      /* Max Number of Sequence 
                          * Connectionless Instances                   */
  U16      maxAddrs;     /* Max Number of Addresses                    */
  U16      maxRtes;      /* Max Number of Routes                       */
  U8       DefRouting;   /* Flag for Default Routing                   */
  U8       ConnDrop;     /* Flag prevents Connection Drop on 
                          * link loss                                  */
  U16      maxAdjDpc;    /* Max Number of Adjacent Point Codes         */
  U16      maxMsgDrn;    /* Max message to drain  (max: 65535)         */
  U16      maxXUDTs;     /* Max external. unit data control 
                          * blocks (ITU92)                             */
  U16      maxXUDTref;   /* Obsolete, not used                         */
  U8       status;       /* Local Status -- SCCP_ONLINE | SCCP_OFFLINE */
  U8       pcDispFmt     /* point code display format                  */
  S16      sogThresh;    /* Threshold for granting state change        */
  S16      scliTimeRes;  /* Time Resolution                            */
  S16      rteTimeRes;   /* Time Resolution                            */
  S16      sapTimeRes;   /* Time Resolution                            */
  S16      nsapTimeRes;  /* Time resolution                            */
  S16      xrefTimeRes;  /* Time Resolution                            */
  S16      asmbTimeRes;  /* Time Resolution                            */
  U16      spare2;       /* alignment                                  */
  TimerCfg scliTimer;    /* default SCLI timer                         */
  TimerCfg sstTimer;     /* default SST timer                          */
  TimerCfg nsapTimer;    /* default network sap timer                  */
  TimerCfg srtTimer;     /* Default Timer for SRT                      */
  TimerCfg ignoreTimer;  /* default ignore SST timer                   */
  TimerCfg coordTimer;   /* default Cord State Change SST timer        */
  TimerCfg xrefFrzTimer; /* default timer for freezing external
                          * unit data reference (ITU-92)               */
  TimerCfg defAsmbTmr;   /* default timer for external unit
                          * data assembly (CCITT92)                    */
  PDesc    stkmgr;       /* Stack Manager - not used                   */
  U16      maxConn;      /* max number of connections                  */
  S16      connThresh;   /* Connection Threshold                       */
  S16      queueThresh;  /* Queue Threshold                            */
  S16      conTimeRes;   /* connection Timer resolution                */
  S16      frzTimeRes;   /* freeze Timer resolution                    */
  U16      spare3;       /* alignment                                  */
  TimerCfg freezeTimer;  /* default lcl reference freeze timer         */
  TimerCfg connTimer;    /* default connection timer                   */
  TimerCfg txInactTimer; /* time to allow connection to exist
                          * with no transmit packets                   */
  TimerCfg rxInactTimer; /* time to allow connection to exist
                          * with no receive packets                    */
  TimerCfg relTimer;     /* default release timer                      */
  TimerCfg repRelTimer;  /* default repeat release timer (ITU-92 only) */
  TimerCfg intvalTimer;  /* default report abnormal release timer      */
  TimerCfg guardTimer;   /* default restart timer                      */
  TimerCfg resetTimer;   /* default reset timer                        */
  TimerCfg aicTimer;     /* default app. inactivity control timer      */
  TimerCfg aicRespTimer; /* default app. inactivity response timer     */
  TimerCfg conRespTimer; /* default connect. indication response timer */
  U8       alarmLevel;   /* alarm level                                */
  U8       traceFlags;   /* trace flags                                */
  U8       spare4;       /* alignment                                  */
  U8       spare5;       /* alignment                                  */
  U32      memThresh1;   /* memory congestion threshold 1              */
  U32      memThresh2;   /* memory congestion threshold 2              */
  U32      memThresh3;   /* memory congestion threshold 3              */
} SccpGenCfg;

 

Default values for the SccpGenCfg structure that can be overridden by the calling application are listed in the following table.

Note: SccpGenCfg structure members not listed in the following table are either unused or for internal use only. These fields are set to correct values by SccpInitGenCfg and must not be overridden by the application.

All values listed in the following table can be modified on the first call to SccpSetGenCfg. On subsequent calls to SccpSetGenCfg, only parameters listed in bold can be modified. Those fields not in bold are ignored on subsequent calls.

Field

Range

Default value

Description

maxSaps

1 - 255

2

Maximum number of SCCP user SAPs (subsystem number and protocol variant) that can be defined.

maxNSaps

1 - 255

1

Maximum number of MTP 3 network SAPs that SCCP uses.

maxScli

0 - 65535

20

Maximum number of simultaneous sequenced connectionless data transfers.

maxAddrs

0 - 65535

7

Maximum number of global title translation entries.

maxRtes

1 - 65535

4

Maximum number of route definition entries.

DefRouting

0 or 1

0

Set to 1 to enable the default routing feature.

ConnDrop

0 or 1

0

Set to 1 to retain connections over a link loss.

maxAdjDpc

0 - 65535

4

Maximum number of route definitions that can be defined as adjacent (SCCP_ADJACENT). If a route is specified as adjacent, it is notified of some point code changes in this or other nodes. It is also notified of some subsystem status changes in this or other nodes.

maxMsgDrn

0 - 65535

5

Maximum number of messages queued to MTP 3 to send in one time interval when exiting flow control.

maxXUDTs

0 - 65535

0

Maximum number of control blocks to allocate for reassembling segmented extended unit data messages.

status

SCCP_OFFLINE

SCCP_ONLINE

SCCP_ONLINE

Initial status of SCCP layer.

pcDispFmt

DEFAULT[DFLT]

INTERNATIONAL[INTL]
JNTT

DEFAULT

For DEFAULT, point codes are interpreted as 24 bit 8.8.8 values.

For INTERNATIONAL, point codes are interpreted as 14 bit 3.8.3 values.

For JNTT, point codes are interpreted as 16 bit 7.4.5 values.

sogThresh

0 - 9

1

Minimum percentage of board memory that must be available before granting a subsystem out-of-service request (SOR) from a backup signaling point.

scliTimer

0 - 65535

2 seconds

Maximum time that a sequenced connectionless transmission can take before control block is deallocated.

sstTimer

0 - 65535

30 seconds

Time to wait between subsystem test (SST) messages.

nsapTimer

0 - 65535

1 seconds

Time to wait between draining blocks of queued messages to the MTP 3 layer after exiting flow control.

srtTimer

0 - 65535

30 seconds

Time to wait between subsystem routing test (SRT) messages.

ignoreTimer

0 - 65535

30 seconds

Time period after local subsystem goes out of service to ignore subsystem test messages.

coordTimer

0 - 65535

30 seconds

Time to wait for response to coordinated state change request.

xrefFrzTimer

0 - 65535

1 second

Time to freeze an XUDT local reference before reusing it.

defAsmbTmr

0 - 65535

20 seconds

Maximum time for reassembling all segments of an XUDT message.

maxConn

0 - 65535

512

Maximum number of simultaneous connections.

connThresh

0 - 9

3

Maximum percentage of board memory that must be available before accepting a new connection in either direction (expressed in units of 10%).

queueThresh

0 - 32766

3

Maximum number of data messages that can be queued for a connection waiting for a connection window to open.

freezeTimer

0 - 65535

1 second

Time to freeze a connection local reference before reusing it.

connTimer

0 - 65535

180 seconds

Time to wait for a response to a connection request.

txInactTimer

0 - 65535

600 seconds

Time to wait with no outgoing packets on a connection before sending an inactivity test (IT) message.

rxInactTimer

0 - 65535

900 seconds

Time to wait with no incoming packets on a connection before clearing the connection. The amount of time should be greater than txInactTimer.

relTimer

0 - 65535

4 seconds

Time to wait for a response to a release request.

repRelTimer

0 - 65535

4 seconds

Time to wait for a response to a second release request.

intvalTimer

0 - 65535

8 seconds

Time to wait before reporting abnormal release timer.

guardTimer

0 - 65535

1 second

Time to wait after a MTP 3 restart before allowing traffic.

resetTimer

0 - 65535

6 seconds

Time to wait for a response to a reset request.

aicTimer

0 - 65535

480 seconds

Time with no application activity for an active connection before NMS SCCP generates a connection inactivity indication event. Used only if application inactivity control is enabled for that user SAP.

aicRespTimer

0 - 65535

10 seconds

Time that the application has to respond to a connection inactivity indication event. Used only if application inactivity control is enabled for that user SAP.

conRespTimer

0 - 65535

10 seconds

Time that the application has to respond to an incoming connection indication with either a connection response or a release request before the SCCP layer refuses the connection. If the value is zero, no timing for the application response is performed.

alarmLevel

SCCP_ALARMLVL_DISABLE

SCCP_ALARMLVL_DEFAULT

SCCP_ALARMLVL_DEBUG

SCCP_ALARMLVL_DETAIL

SCCP_ALARMLVL_DEFAULT

Level of alarms generated by the SCCP layer. Refer to SccpAlarmControl for a definition of alarm levels.

traceFlags

0 - 255

0

Data tracing. Refer to SccpTraceControl for a definition of trace flags.

memThresh1

0 - 99

10

Percentage of board memory available at which memory congestion level 1 starts.

memThresh2

0 - 99

8

Percentage of board memory available at which memory congestion level 2 starts.

memThresh3

0 - 99

5

Percentage of board memory available at which memory congestion level 3 starts.