You are here: SwitchKit® Development Environment - TCAP Interface User’s Guide > 1 Introduction to SwitchKit® Development Environment TCAP Interface API > SKIM and SKTAL API

SKIM and SKTAL API

The SwitchKit SKIM and SKTAL APIs interface with the SwitchKit library. The SKIM APIs utilize services of the SKTAL layer to communication with the LLC and the CSP.

SKIM APIs

The next table describes the SKIM API classes available to applications.

Name | Description
SKIM_Api::Initialize() | Initializes a SKIM API object. This method also initializes SKTAL and registers a TCAP SSN with the CSP.
SKIM_Api::Terminate() | Terminates the SKIM API object and performs cleanup functions. This method terminates SKTAL and deregisters a TCAP SSN with the CSP. All pending dialogs associated with SKIM_Api object are cleared by sending a pre-arranged end message to the CSP.
SKIM_Api::Send | Sends TCAP transaction message along with a list of operations. A given transaction message can contain zero or more operations (TCAP Components).
SKIM_Api::SSNInService | Sends N-State request to bring the local subsystem network (SSN) in service.
SKIM_Api::SSNOutOfService | Sends N-State request to take the local SSN out of service.
SKIM_Api::SendReject | Allows the user to send TCAP Reject message for a given invoke ID and call reference ID. This method also terminates the transaction by sending TCAP End.
SKIM_Api::CancelOperation | Allows the user to cancel a previously invoked operation for a given call reference ID and invoke ID.
SKIM_Api::SendPreArrangedEnd | Sends a pre-arranged end message for a given call reference ID.
SKIM_Api::SetTransHandler | Sets a transaction handler for a given call reference ID.
SKIM_Api::ClearTransHandler | Clears a transaction handler for a given call reference ID.
SKIM_Api::EnableTracing | Enables SKIM library tracing for a given trace type.
SKIM_Api::DisableTracing | Disables SKIM library tracing for a given trace type.

SKTAL APIs

The following are some of the SKTAL API messages available to the application:

Name | Description
sktal_initializeTCAP | A one-time call for global initialization of the TCAP Abstraction layer.
sktal_terminateTCAP | A one-time call for global termination of the TCAP Abstraction layer.
sktal_registerTCAPSSNHandler | Registers the application with a given node/stack/subsystem. A generic handler will be added to the handler stack that will filter messages for the given subsystem. When a new TCAP transaction is seen, or when sk_TCAP_AllocateDialogueID is called, the NewDialogueHandler function argument will be invoked. This function is expected to register a per dialogue handler (via sktal_setTCAPSSNHandler) for the new dialogue. All incoming messages within that dialogue sequence will be passed to that handler.
sktal_unregisterTCAPSSNHandler | Removes (and terminates) the subsystem identified during registration. All ongoing transactions are terminated and the subsystem is marked out-of-service.
sktal_allocateTCAPDialogID | Allocates the TCAP dialogue ID.
sktal_setTCAPDialogHandler | Specifies a function to be invoked for incoming messages within a given transaction (identified by the Dialogue ID). The incoming event and the Dialogue ID invoke the handler; the handler should examine the event and invoke either sktal_recvTCAPDialogue or sktal_recvTCAPComponent.
sktal_clearTCAPDialogHandler | The user removes the transaction handler once the transaction has been completed (by receiving) TC-U-ABORT, TC-P-ABORT, TC-END, or TC-UNI, or sending TC-U-ABORT, TC-END, or TC-UNI). It is imperative to not take this step until the last message has been sent.
sktal_sendTCAPDialog | Sends a TCAP dialogue message.
sktal_recvTCAPDialog | Receives a TCAP dialogue info from a SKTAL_EVENT.
sktal_sendTCAPComponent | Sends a TCAP component message.
sktal_recv_TCAPComponent | Receives TCAP component information from a SKTAL_EVENT.

Diagram

The next diagram shows how SKIM and SKTAL APIs interface with the SwitchKit library.

See Transaction Capability Application Part.
The condition of a component at a given instant. The current "context" of a PPL object, such as Idle, Seizing, Answered. In PPL files, a State is represented by a circle.
In PPL, a condition that, when met, drives a state machine (PPL Component) from one state to another, by invoking an associated Primitive. In PPL files, an Event is marked by an arrow and text.