(Page 1 of 19 in this chapter)

Chapter 4

API Reference

4.1 Files

4.2 Connection IDs

: SCCPBindReq 49
: SCCPConnectRqst 51
: SCCPConnectResp 52
: SCCPCoordRqst 53
: SCCPCoordResp 54
: SCCPDAckRqst 55
: SCCPDataRqst 56
: SCCPEDataRqst 58
: SCCPInitAPI 59
: SCCPReleaseRqst 60
: SCCPResetRqst 61
: SCCPResetResp 62
: SCCPRetrieveMessage 63
: SCCPStateRqst 77
: SCCPSyncObj 78
: SCCPTermAPI 79
: SCCPUDataRqst 80
: SCCPUnbindReq 81

This section provides a detailed description of the primitives (requests and responses) that comprise the SCCP API and the messages (indications and confirmations) received via the SCCPRetrieveMessage primitive. It also describes the parameters supported for each request/message. Note that not all parameters are applicable to both ANSI and ITU-T (CCITT) networks.

4.1 Files

The following files are provided with the SCCP API distribution disk. File Description ss7type.h Basic data types employed by the SCCP API. sccpapi.h Messages and constants described in section 3. Function prototypes and constants described in the following subsections. libsccp.a Static library to link with user application (UnixWare and Solaris). sccpapi.lib Import library to link with user application (Windows NT). sccpapi.dll Dynamic link library automatically linked to application (Windows NT only).
Additionally, a sample application (sccpdemo) has been supplied to demonstrate calls to the SCCP API. This sample application consists of three source files:

File

Description

init.c

Some initialization code.

tx_core.c

File descriptor and poll() management code.

connect.c

SCCP connection management code.
A makefile is supplied for building the sample application.

File	Description
`ss7type.h`	Basic data types employed by the SCCP API.
`sccpapi.h`	Messages and constants described in section 3. Function prototypes and constants described in the following subsections.
`libsccp.a`	Static library to link with user application (UnixWare and Solaris).
`sccpapi.lib`	Import library to link with user application (Windows NT).
`sccpapi.dll`	Dynamic link library automatically linked to application (Windows NT only).

File	Description
`init.c`	Some initialization code.
`tx_core.c`	File descriptor and poll() management code.
`connect.c`	SCCP connection management code.

4.2 Connection IDs

For connection-oriented services, the application and the SCCP task use connection IDs to reference the SAP (subsystem) and connection that a particular message applies to. This is true for both requests and responses from the application to the SCCP layer as well as indications and confirmations from the SCCP task to the application. The structure of a connection ID is as follows: typedef struct connectID { S16 suId; /* service user ID */ S16 spId; /* service provider ID */ S16 suConnId; /* user's connection ref number */ S16 spConnId; /* SCCP's connection ref number */ } ConnectID;
suId The application's reference number for the SAP being used; this will be the same as the suId passed by the application in the BIND request; the application which implements multiple SAPs may use this field on incoming messages to identify the SAP it belongs to.
spId The SCCP SAP number that the message belongs to; the application must set this field on all messages from the application to the SCCP layer.
SuConnId An arbitrary number that the application may use to identify the connection. The application sets this value on the first message associated with a connection - connect request for outgoing connections or connect response for incoming connections - and the SCCP layer will return this value on all subsequent messages belonging to this connection.
SpConnId SCCP's number that identifies the connection. The application must save this value from the first message received associated with a connection - connect confirm for outgoing connections or connect indication for incoming connections - and pass it on all subsequent messages belonging to this connection.

For connectionless primitives, just the suId and spId concepts are used to allow the application and the SCCP layer, respectively, to identify the SAP associated with a connectionless request.

(Page 1 of 19 in this chapter)

tech_support@nmss.com