You are here: SwitchKit TCAP Interface User’s Guide > 6 SKTAL Parameter Classes > Class TCAP_Abort : public TCAP_Dialogue
Class TCAP_Abort : public TCAP_Dialogue
Purpose
The purpose of the TCAP_Abort message class is to define the basic interface for aborting TCAP transactions. Note that this class can be user-generated for ITU TCAP, but is stack-generated only with ANSI TCAP.
The TCAP_Abort message class includes the following methods:
// Component present
virtual bool IsComponentPresent() const;
virtual void SetComponentPresent(bool);
// Abort reason
SKTAL_OCTET GetAbortReason() const;
void SetAbortReason(SKTAL_OCTET reason);
void GetAbortInfo(SKTAL_OCTET *buf, int &len);
void SetAbortInfo(SKTAL_OCTET *buf, int &len);
Syntax
See class TCAP_Dialogue
virtual bool IsComponentPresent() const;
Description
This method can be used to set the components associated with the dialogue. The SetComponentPresent method is a virtual method.
Syntax
virtual void SetComponentPresent(bool);
Input Parameters and Output Parameters
None
Input/Output Parameters
True: present the component
False: do not present the component
Return Value
None
Description
This method can be used to set the abort reason of a dialogue
Syntax
void SetAbortReason(SKTAL_OCTET reason);
Input Parameters
reason: The abort reason
Input/Output Parameters and Output Parameters
None
Return Value
None
Description
This method returns the abort reason of a dialogue
Syntax
SKTAL_OCTET GetAbortReason() const;
Input Parameters, Input/Output Parameters, & Output Parameters
None
Return Value
The abort reason as an unsigned character.
Description
This method gets the abort information for SKIM_TC_ABORT for an ANSI transaction type.
Syntax
void GetAbortInfo(SKTAL_OCTET *buf, int &len);
Input Parameters, Input/Output Parameters
None
Output Parameters
buf: Abort information
len: Information length
Description
This method sets the abort information for SKIM_TC_ABORT for an ANSI transaction type.
Syntax
void SetAbortInfo(SKTAL_OCTET *buf, int &len);
Input Parameters
buf: Abort information
len: Information length
Input/Output Parameters, & Output Parameters
None