You are here: SwitchKit® Development Environment - TCAP Interface User’s Guide > 3 SKIM Parameter Classes > SKIM_Notify Class Methods
This section provides details about the methods available for the SKIM_Notify class.
Description
Gets the notification type.
1. When the user receives a notification, the user should use appropriate get methods based on notification object. The default value returned by all GetXX methods is 0. Zero means that the parameter is not set for the notification.
2. For the SKIM_NOTIFY_NACK_IND, GetCauseType() provides a transaction type / operation type for the NACK that is received.
3. The GetCallReferenceId() method is relevant for SKIM_NOTIFY_OP_TIMEOUT notifications. This method returns the call reference ID of the transaction for which a SKIM_NOTIFY_OP_TIMEOUT is received.
4. The SKIM_NOTIFY_OP_TIMEOUT corresponds to TC-L-CANCEL when an outgoing Invoke operation timeout occurs in the TCAP stack.
5. For the SKIM_NOTIFY_SCCP_MGMT_IND notification, GetCause() provides the type of SCCP N-State indication received. GetSSN() and GetPC() methods provide the affected PC and SSN.
6. For the SKIM_NOTIFY_MTP3_MGMT_IND notification, GetCause() provides the type of SCCP N-PCState indication received. GetPC() method provides the affected point code.
Syntax
int GetType();
Input Parameters, Input/Output Parameters, & Output Parameters
None
Return Value:
Notification type. Possible values are:
|
Value |
Description |
|
SKIM_NOTIFY_SCCP_MGMT_IND |
SCCP management indication. |
|
SKIM_NOTIFY_MTP3_MGMT_IND |
N-PC State management indication. |
|
SKIM_NOTIFY_OP_TIMEOUT |
Operation timeout. For ITU only. |
|
SKIM_NOTIFY_INTERNAL_ERROR |
SKIM internal error. |
|
SKIM_NOTIFY_NACK_IND |
PPL NACK Indication form EXS. |
Description
Gets the call reference ID for a given notification.
Syntax
SKIM_UINT GetCallReferenceId;
Input Parameters, Input/Output Parameters, & Output Parameters
None
Return Value
id: Call reference ID
Description
Returns the notification cause corresponding to a given notification type. For the SKIM_NOTIFY_NACK_IND notification type, GetCause () returns a PPL event NACK cause value (ack status) received from the CSP.
The SKIM_NOTIFY_INTERNAL_ERROR notification is received for the following causes:
SKIM_TRANS_RECORD_ERROR -Transaction record error
SKIM_INVALID_COMP_ERROR - Invalid component received
SKIM_COMP_RECV_ERROR - Receive error/failed
SKIM_DUP_INVID_ERROR - Duplicate invoke ID
SKIM_UNK_INVID_ERROR - Unknown invoke ID
SKIM_INV_MSG_TYPE_ERROR - Invalid message type
SKIM_RES_LIMT_ERROR - Resource limitation.
Syntax
int GetCause();
Input Parameters, Input/Output Parameters, & Output Parameters
None
Return Value
Notification cause value.
Description
Returns cause type values associated with the SKIM_NOTIFY_NACK_IND notification. For the SKIM_NOTIFY_NACK_IND notification, the cause type value indicates the transaction type or operation type for which the NACK is received from the CSP.
Syntax
SKIM_OCTET GetCauseType();
Input Parameters, Input/Output Parameters, & Output Parameters
None
Return Value
Cause Type.
Description
Gets affected subsystem number associated with SKIM_NOTIFY_SCCP_MGMT_IND notification
Syntax
SKIM_OCTET GetSSN();
Input Parameters, Input/Output Parameters, & Output Parameters
None
Return Value
Subsystem number.
Description
Gets affected point code associated with SKIM_NOTIFY_SCCP_MGMT_IND and SKIM_NOTIFY_MTP3_MGMT_IND notification.
Syntax
SKIM_UINT GetPC();
Input Parameters, Input/Output Parameters & Output Parameters
None
Return Value
Point code value.
Description
Returns the invoke ID of an operation. Invoke IDs are common to all operation types.
Syntax
SKIM_OCTET GetInvokeId();
Input Parameters, Input/Output Parameters & Output Parameters
None
Return Value
The invoke ID as an unsigned char.