---

APPLICATION PROGRAMMING INTERFACE

This section introduces the basic mechanisms to invoke the documented APIs. More...

Modules
INVOCATION MECHANISMS
	This section describes the invocation mechanisms, for the APIs mentioned in this document.
APIs CLASSIFICATION
	This section enlists the classification of SCTP APIS.
SERVICE USER APIS - FUNCTIONAL INTERFACE
	This section enlists the Service User (SU) API's required with Functional Interface.
SYSTEM MANAGEMENT APIS - FUNCTIONAL INTERFACE
	This section enlists information about System Management (SM) APIs.
SERVICE USER APIS - MESSAGE BASED INTERFACE
	This section details the Service User(SU) APIs for Messaged Based Interface.
SYSTEM MANAGEMENT APIS - MESSAGE-BASED INTERFACE
	This section describes and lists System Management APIs for Message-Based Interface.
TRANSPORT LAYER APIS
	This section lists and describes Transport Layer APIs.

---

Detailed Description

This section introduces the basic mechanisms to invoke the documented APIs.

The APIs provide the application developer with a method to access the functionality of the stack and use its services. The Application passes appropriate parameters to the AP, through the structures defined for each API. The following chapters explain API Usage in detail, and the parameters required for invocation of each API.

APIs are categorized as:

• APIs with SU The SU, needs to register itself with the stack, before invoking any of the primitives. APIs are provided to register/deregister SUs. The stack allocates a unique application ID in response to a registration request.

  APIs are provided for the following primitives (as listed in RFC 2960): INITIALIZE, ASSOCIATE, SHUTDOWN, ABORT, SEND, SETPRIMARY, RECEIVE, STATUS, CHANGEHEARTBEAT, REQUESTHEARTBEAT, GETSRTTREPORT, SETFAILURETHRESHOLD, and SETPROTOCOLPARAMETERS, RECEIVE_UNSENT, RECEIVE_UNACKED, FLUSH BUFFERS. The APIs for these are discussed in Service User APIs - Functional Interface Section.

• APIs with System Management System Management APIs are provided for the system management entity to configure, retrieve and update information regarding statistics and error messages. APIs are also provided for the initialization of the stack. The APIs for these modules are discussed the System Management APIs Section.

• APIs with Timer Module The APIs with timer module are needed to port the stack on a new platform. The APIs for these modules are discussed in the Transport Layer APIs section.

• APIs with Underlined Transport Mechanism These are needed to port the stack on a new transport mechanism. The APIs for these modules are discussed in Service User APIs - Messag Based Interface Section.

---