You are here: SwitchKitฎ Development Environment - TCAP Interface Users Guide > 3 SKIM Parameter Classes > SKIM_Trans Class Methods

SKIM_Trans Class Methods

This section provides details about the methods available for the SKIM_Trans class.

SKIM_Trans()

Description

SKIM_Trans is the default constructor.

Syntax

SKIM_Trans();

Input Parameters, Input/Output Parameters, & Output Parameters

None

SetTransType()

Description

Sets SKIM transaction type.

Syntax

void SetTransType(SKIM_OCTET type);

Input Parameters, Input/Output Parameters, & Output Parameters

None

Return Values

Possible values for ITU TCAP:

SKIM_TC_UNI

SKIM_TC_BEGIN

SKIM_TC_CONTINUE

SKIM_TC_END

SKIM_TC_P_ABORT

SKIM_TC_U_ABORT

Possible values for ANSI TCAP:

SKIM_TC_UNI

SKIM_TC_BEGIN (Same as Query with Permission)

SKIM_TC_CONTINUE (Same as Conversation With Permission)

SKIM_TC_END

SKIM_TC_ABORT

SKIM_TC_QUERY_WO_PERM

SKIM_TC_CONV_WO_PERM

GetTransType()

Description

Gets SKIM transaction type.

Syntax

void GetTransType(SKIM_OCTET &type);

Input Parameters

type

Return Values

Possible values for ITU TCAP:

Possible values for ITU TCAP:

SKIM_TC_UNI, SKIM_TC_BEGIN

SKIM_TC_CONTINUE

SKIM_TC_END

SKIM_TC_P_ABORT

SKIM_TC_U_ABORT

SKIM_TC_NOTICE:

This message is received in case of network problem at SCCP layer while sending a TCAP transaction message.

Possible values for ANSI TCAP:

SKIM_TC_UNI

SKIM_TC_BEGIN (Same as Query With Permission)

SKIM_TC_CONTINUE (Same as Conversation With Permission)

SKIM_TC_END

SKIM_TC_ABORT

SKIM_TC_QUERY_WO_PERM

SKIM_TC_CONV_WO_PERM

SKIM_TC_NOTICE

GetCallReferenceId()

Description

This method returns the call reference ID. A call reference ID has one to one mapping with a TCAP dialogue ID.

Syntax

SKIM_UINT GetCallReferenceId();

Input Parameters, Input/Output Parameters, & Output Parameters

None

Return Value

Call reference ID.

SetCallReferenceId()

Description

Sets the call reference ID. The call reference ID is not set when initiating a transaction.

Syntax

void SetCallReferenceId(SKIM_UINT id);

Input Parameters

id: Call Reference ID

Input/Output Parameters, Output Parameters

None

AddOperation()

Description

Adds an operation to the given transaction object.

Syntax

void AddOperation(SKIM_Operation &op);

Input Parameters

op: SKIM_Operation object

Input/Output Parameters, Output Parameters

None

RemoveOperation()

Description

Removes an operation from a transaction object.

Syntax

void RemoveOperation(SKIM_Operation &op);

Input Parameters, Input/Output Parameters

None

Output Parameters

op: SKIM_Operation object

Return Value

SKIM_SUCCESS:

An operation removal is successful.

SKIM_ENOMSG:

No operation is available.

GetNumOfOperation()

Description

Gets the number of operations associated with a SKIM_Trans object at any given time.

Syntax

int GetNumOfOperation();

Input Parameters, Input/Output Parameters, & Output Parameters

None

Return Value

Number of operations

SetSourceAddress()

Description

Sets the SCCP source address for a given transaction object. See Also: SKIM_CallingPartyAddress API.

Syntax

void SetSourceAddress(SKIM_CallingPartyAddr &addr);

Input Parameters

addr: SCCP Calling Party Address object.

Input/Output Parameters, Output Parameters

None

GetSourceAddress()

Description

Gets the SCCP source address for a given transaction object. See Also: SKIM_CallingPartyAddress API.

Syntax

void GetSourceAddress(SKIM_CallingPartyAddr &addr);

Input Parameters, Input/Output Parameters

None

Output Parameters

addr: SCCP Calling Party Address object.

SetDestAddress()

Description

Sets the SCCP destination address for a given transaction object. See also: SKIM_CalledPartyAddress API.

Syntax

void SetDestAddress(SKIM_CalledPartyAddr &addr);

Input Parameters

addr: SCCP Called Party Address object.

Input/Output Parameters, Output Parameters

None

GetDestAddress()

Description

Gets the SCCP destination address for a given transaction object. See also: SKIM_CalledPartyAddress API.

Syntax

void GetDestAddress(SKIM_CalledPartyAddr &addr);

Input Parameters, Input/Output Parameters

None

Output Parameters

addr: SCCP Called Party Address object.

GetAbortReason() (For ITU)

Description

Gets the abort reason for SKIM_TC_U_ABORT/SKIM_TC_P_ABORT (ITU).

Syntax

void GetAbortReason(SKIM_OCTET &reason);

Input Parameters

reason: Abort reason. Possible values of abort reason are defined in Appendix A.

Input/Output Parameters, Output Parameters

None

SetAbortReason (For ITU)

Description

Sets the abort reason for SKIM_TC_U_ABORT.

Note: The CSP sends SKIM_TC_P_ABORT automatically.

Syntax

void SetAbortReason(SKIM_OCTET reason);

Input Parameters,

reason: Abort reason. Possible values of abort reason are defined in Appendix A.

Input/Output Parameters and Output Parameters

None

GetAbortInfo() (For ANSI)

Description

Gets the abort information for SKIM_TC_ABORT (ANSI transaction type.)

Syntax

void GetAbortInfo(SKIM_OCTET *buf, int &len);

Input Parameters

buf : Abort information.

len: Abort information length.

Input/Output Parameters, Output Parameters

None

SetAbortInfo (For ANSI)

Description

Sets the abort information for SKIM_TC_ABORT (ANSI transaction type.)

Syntax

void SetAbortInfo(SKIM_OCTET *buf, int &len);

Input Parameters

info: Abort information.

length: Abort information length.

Input/Output Parameters and Output Parameters

None

SetQualityOfService()

Description

Sets the quality of service.

Syntax

void SetQualityOfService(const SKIM_OCTET flags,

const SKIM_OCTET priority = 0);

Input Parameters,

flags: Flags can be combination of the following types (for ITU):

0 : specifies SCCP Class 0 with no return option

SKIM_QOSI_RET_OPT: specifies SCCP Class 0 with return option

SKIM_QOSI_SEQ_CTRL: specifies SCCP) Class 1 with no return option.

SKIM_QOSI_SEQ_CTRL | SKIM_QOSI_RET_OPT: specifies SCCP Class 1 with return option set

flags: Flags can be combination of the following types (for ANSI)

8: specifies SCCP Class 0 with no return option.

SKIM_QOSI_RET_OPT | |SKIM_QOSI_PRIORITY: specifies SCCP Class 0 with return option set.

SKIM_QOSI_SEQ_CTRL | |SKIM_QOSI_PRIORITY: specifies SCCP Class 1 with no return option

SKIM_QOSI_SEQ_CTRL | SKIM_QOSI_RET_OPT | |SKIM_QOSI_PRIORITY: specifies SCCP Class 1 with return option set.

Input/Output Parameters, Output Parameters

None

GetQualityOfService()

Description

Gets the quality of service.

Syntax

void GetQualityOfService(SKIM_OCTET& flags, SKIM_OCTET& priority);

Input Parameters, Input/Output Parameters

None

Output Parameters

flags: Flags can be combination of the following types (for ITU):

0 : specifies SCCP Class 0 with no return option

SKIM_QOSI_RET_OPT: specifies SCCP Class 0 with return option

SKIM_QOSI_SEQ_CTRL: specifies SCCP) Class 1 with no return option.

SKIM_QOSI_SEQ_CTRL | SKIM_QOSI_RET_OPT: specifies SCCP Class 1 with return option set

flags: Flags can be combination of the following types (for ANSI)

8: specifies SCCP Class 0 with no return option.

SKIM_QOSI_RET_OPT | |SKIM_QOSI_PRIORITY: specifies SCCP Class 0 with return option set.

SKIM_QOSI_SEQ_CTRL | |SKIM_QOSI_PRIORITY: specifies SCCP Class 1 with no return option

SKIM_QOSI_SEQ_CTRL | SKIM_QOSI_RET_OPT | |SKIM_QOSI_PRIORITY: specifies SCCP Class 1 with return option set.

priority: message priority.

SetPreArrangedEnd()

Description

Sets the pre-arranged end for the SKIM_TC_END transaction type. By default the end type is set to basic.

Syntax

void SetPreArrangedEnd();

Input Parameters, Input/Output Parameters & Output Parameters

None

GetReportCause()

Description

Gets the reported cause for SKIM_TC_NOTICE transaction type.

Syntax

SKIM_OCTET GetReportCause() const;

#if defined(CCITT) || defined(PRC)

Input Parameters, Input/Output Parameters & Output Parameters

None

Return Value:

Report cause value.

SCCP_RET_NO_TRANS_ADDR_NAT

SCCP_RET_NO_TRANS_THIS_ADDR

SCCP_RET_SUBSYS_CONG

SCCP_RET_SUBSYS_FAIL

SCCP_RET_UNEQUIPPED_USER

SCCP_RET_NETWORK_FAIL

SCCP_RET_NETWORK_CONG

SCCP_RET_UNQUAL

SCCP_RET_ERR_IN_TRANSPORT

SCCP_RET_ERR_IN_LOCAL_PROCESS

SCCP_RET_ERR_DEST_CANNOT_PERF_REASSEMBLY

SCCP_RET_ERR_SCCP_FAILURE (ITU Only)

SCCP_RET_ERR_HOP_COUNT_VIOLATION (ANSI only)

SCCP_RET_ERR_INV_ISNI_ROUT_REQ (ANSI only)

SCCP_RET_ERR_UNAUTH_MSG (ANSI only)

SCCP_RET_ERR_MSG_INCOMPATIBILITY (ANSI only)

SCCP_RET_ERR_CANNOT_PERFORM_ISNI_ROUTING (ANSI only)

SCCP_RET_ERR_REDUNDANT_ISNI_ROUTING_INFO (ANSI only)

SCCP_RET_ERR_UNABLE_TO_IDENTIFY_ISNI_INFO (ANSI only)

GetApplicationContext() (ITU only)

Description

Allows the user to get the application context for a transaction.

Syntax

void GetApplicationContext(SKIM_OCTET* buf, int& len) const;

Input Parameters, Input/Output Parameters

None

Output Parameters:

buf: Buffer to copy application context information.

len: Number of bytes copied in application context information.

SetApplicationContext() (ITU only)

Description

Allows the user to set the application context for a transaction.

Syntax

void SetApplicationContext(const SKIM_OCTET* buf, const int len);

Input Parameters

buf: Buffer to copy application context information.

len: Number of bytes copied in application context information.

Input/Output and Output Parameters:

None

SetUserInfo() (ITU only)

Description

Allows the user to set the user information for a transaction.

Syntax

void SetUserInfo(const SKIM_OCTET* buf, const int len);

Input Parameters

buf: Buffer containing user information.

len: Number of bytes in user information.

Input/Output and Output Parameters:

None

GetUserInfo() (ITU only)

Description

Allows the user to get the user information for a transaction.

Syntax

void GetUserInfo(SKIM_OCTET* buf, int& len) const;

Input Parameters, Input/Output Parameters

None

Output Parameters:

buf: Buffer containing user information.

len: Number of bytes in user information.

A sequence of eight bits.
International Telecommunications Union (UN)
See Transaction Capability Application Part.
American National Standards Institute. ANSI administers and coordinates the U.S. voluntary standardization and conformity assessment system for the
telecommunications industry. More details on these standards may be
viewed at www.ansi.org.
Comit้ Consultatif Internationale de Telephonique et Telegraphique (now ITU)