TCAPInitSapCfg

Builds a default TCAP user SAP configuration buffer that can be passed to TCAPSapCfg.

Prototype

S16 TCAPInitSapCfg ( U8 board, S16 spId, S16 swProt, TcapSapCfg *cfg)

Argument

Description

board

TX board number to which this request is directed. This parameter also identifies the TCAP layer instance ID.

spId

Index number of the TCAP SAP being defined.

Valid range is 0 to (TcapGenCfg.maxSaps - 1).

swProt

Protocol selector switch. Refer to the Details section for more information.

cfg

Pointer to the address of the TCAP SAP configuration parameters buffer:

typedef struct Tcap_Sap_Cfg
{
  S16      swtch;        /* Protocol selector switch       */
  U8       selectorUser; /* selector for TCAP User         */
  U8       spare1;       /* spare for alignment            */
  MemoryId memUser;      /* Memory ID - not used           */
  U8       priorUser;    /* priority - not used            */
  U8       routeUser;    /* route - not used               */
  TmrCfg   t1;           /* default invocation timer       */
  TmrCfg   t2;           /* wait for rejection timer       */
  U8       seqTimer;     /* duration to maintain SLS for
                          * sequential delivery            */
  U8       selectorSP;   /* selector for SCCP              */
  MemoryId memSP;        /* memory ID/SCCP - not used      */
  U16      procIdSP;     /* processor Id -not used         */
  U8       entSP;        /* SCCP entity ID = ENT_SCCP      */
  U8       instSP;       /* SCCP inst. ID = board num.     */
  U8       priorSP;      /* SCCP priority - not used       */
  U8       routeSP;      /* SCCP route - not used          */
  S16      spIdSP;       /* SCCP SAP ID for this TCAP SAP  */
  U8       altParamLen;  /* Alternate Parameter Length 
                          * Calculation                    */
  U8       chkpt;        /* default checkpoint strategy for
                         /* this application               */
  U8       addrOverride; /* application overrides SCCP
                         /* address                        */
  U8       allowInvkEnd; /* allow invoke component in end
                         /* message                        */
  S16      qThresh1;     /* queue size triggering congestion
                         /* level 1                        */
  S16      qThresh2;     /* queue size triggering congestion
                         /* level 2                        */
  S16      qThresh3;     /* queue size triggering congestion
                         /* level 3                        */
} TcapSapCfg;

Refer to the Details section for more information.


Return values

Return value

Description

TCAP_SUCCESS

 

TCAPM_BOARD

board is out of range.

TCAPM_NULLPTR

Null pointer was specified for cfg.

TCAPM_SWTYPE

Protocol selector switch type is invalid.


Details

swProt identifies one of the following TCAP protocol variants used on the specified SAP:

Value

Description

1

TCAP_SW_ITU88

2

TCAP_SW_ITU92

3

TCAP_SW_ANS88

4

TCAP_SW_ANS92

5

TCAP_SW_ITU97

6

TCAP_SW_ANS96


The application can change the default values within the specified range for any fields other than those denoted as internal or unused prior to calling TCAPSapCfg to send the configuration block to the TCAP layer.

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

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

Field

Range

Default value

Description

swtch

1 - 6

swProt parameter

TCAP protocol variant to be used on this SAP.

t1

1 - 65535

60

Default invocation timer, in seconds.

t2

1 - 65535

60

Time to wait for reject of non-invoke component, where applicable, in seconds.

seqTimer

1 - 255

60

Duration to request SCCP to maintain signaling link selector (SLS) when sequential delivery is required.

instSP

1 - 8

board parameter

SCCP task instance ID, always equal to the board number.

spIdSP

0 - 32766

spId parameter

SCCP SAP ID (from the SCCP configuration) to map this TCAP SAP onto. By default, set to the same value as the TCAP SAP ID.

altParamLen

0 or 1

0

Used for ANSI TCAP protocols only.

0 = Uses the normal method of deriving a component parameter length from the component length field.

1 = Uses an alternate method of obtaining the parameter length from the set or sequence tag and length.

chkpt

CHKPT_NONE

CHKPT_SEND

CHKPT_ALL

CHKPT_NONE

Checkpointing option for this SAP when deployed in a redundant configuration. Refer to Transaction checkpointing.

addrOverride

0 or 1

0

If set to 1, the application provides a called party address in a transaction response message. By default, TCAP uses a calling party address from the incoming message that initiated the transaction.

allowInvkEnd

0 or 1

0

If set to 1, the application includes an invoke component in the end transaction message.

qThresh1

1 - 32766

600

Number of inbound messages queued to the application before congestion level 1 is triggered.

qThresh2

1 - 32766

900

Number of inbound messages queued to the application before congestion level 2 is triggered.

qThresh3

1 - 32766

1200

Number of inbound messages queued to the application before congestion level 3 is triggered.