You are here: SwitchKit® Development Environment - TCAP Interface User’s Guide > 6 SKTAL Parameter Classes > ClassTCAP_Notice : public TCAP_Dialogue

ClassTCAP_Notice : public TCAP_Dialogue

Purpose

The purpose of the TCAP_Notice message class is to define the basic interface by which TCAP can deliver quality-of-service messages to the user. At the present time, this is implemented only for ITU TCAP, and is never generated by the user.

Summary of Methods

The TCAP_Notice message class includes the following methods:

// Component present

virtual bool IsComponentPresent() const

virtual void SetComponentPresent(bool)

// Report cause

void SetReportCause(SKTAL_OCTET reason);

SKTAL_OCTET GetReportCause() const;

// Quality of service

virtual void SetQualityOfService(const SKTAL_OCTET flags,

const SKTAL_OCTET priority = 0)

virtual void GetQualityOfService(SKTAL_OCTET& flags,

SKTAL_OCTET& priority) const;

// Application context

virtual void SetApplicationContext(const SKTAL_OCTET* buf, const int len);

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

virtual void SetApplicationContext(const SKTAL_ByteArray& buf);

virtual void GetApplicationContext(SKTAL_ByteArray& buf) const;

// User info

virtual void SetUserInfo(const SKTAL_OCTET* buf, const int len);

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

virtual void SetUserInfo(const SKTAL_ByteArray& buf);

virtual void GetUserInfo(SKTAL_ByteArray& buf) const;

IsComponentPresent()

See class TCAP_Dialogue

Syntax

virtual bool IsComponentPresent() const;

SetComponentPresent()

See class TCAP_Abort

Syntax

virtual void SetComponentPresent(bool);

SetReportCause()

Description

This method can be used to set the report cause of a dialogue

Syntax

void SetReportCause(SKTAL_OCTET reason);

Input Parameters

reason: the report cause reason

Input/Output Parameters and Output Parameters

None

Return Value

None

GetReportCause()

Description

This method returns the report cause of a dialogue

Syntax

SKTAL_OCTET GetReportCause() const;

Input Parameters, Input/Output Parameters, & Output Parameters

None

Return Value

The report cause as an unsigned character. The following are the report cause values:

• 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)

SetQualityOfService()

See class TCAP_Dialogue

Syntax

virtual void SetQualityOfService(const SKTAL_OCTET flags,

const SKTAL_OCTET priority = 0);

GetQualityOfService()

See class TCAP_Dialogue

Syntax

virtual void GetQualityOfService(SKTAL_OCTET& flags,

SKTAL_OCTET& priority) const;

SetApplicationContext()

See class TCAP_Dialogue

Syntax

virtual void SetApplicationContext(const SKTAL_OCTET* buf, const int len);

virtual void SetApplicationContext(const SKTAL_ByteArray& buf);

GetApplicationContext()

See class TCAP_Dialogue

Syntax

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

virtual void GetApplicationContext(SKTAL_ByteArray& buf) const;

SetUserInfo()

See class TCAP_Dialogue

Syntax

virtual void SetUserInfo(const SKTAL_OCTET* buf, const int len);

virtual void SetUserInfo(const SKTAL_ByteArray& buf);

GetUserInfo()

See class TCAP_Dialogue

Syntax

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

virtual void GetUserInfo(SKTAL_ByteArray& buf) const;

See Transaction Capability Application Part.
International Telecommunications Union (UN)
A sequence of eight bits.
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.