Lucent Technologies DEFINITY Enterprise Communications Server Release 6 CallVisor PC ASAI Instructions Manual

Introduction to ASAI
Issue  3  May 1998
3-3
Terms and Concepts
ASAI is an interface between an adjunct and the ECS; however, a number of 
terms can be used instead of or in addition to “adjunct” and “ECS.” In this book, 
the following terms are used with the meanings shown below:
The term “application” is used only in the phrase “application program” or 
“application programmer.”
To the ECS, “application” means an adjunct entity that requests and receives 
ASAI services or capabilities. Although more...

Introduction to ASAI
3-4Issue  3  May 1998 
ASAI capabilities can be further broken down into capability “primitives” that 
perform a single task (requesting a service, responding to a request, confirming a 
request or indicating that a request has been fulfilled). A primitive is an atomic 
message passed by the library. For example, the Heartbeat capability consists of 
two primitives: C_HB_REQ and C_HB_CONF. For more details on Capability 
primitives see ‘‘ASAI Capability Manual pages’’ on page 9-21 in...

Introduction to ASAI
Issue  3  May 1998
3-5
The ASAI Library Functions
The functions provided by the ASAI library are:
asai_open()
asai_close()
asai_set_env()
asai_get_env()
asai_send()
asai_rcv()
asai_errval()
These functions afford access to the services defined by the full set of ASAI 
capabilities. The basic purpose of the functions is twofold: to manage the 
communication path over which ASAI capabilities are requested and 
acknowledged and to manage the exchange of information over an established...

Introduction to ASAI
3-6Issue  3  May 1998 
Table 3-1 gives a brief description of the ASAI library functions that manage the 
communication path:
Table 3-1. ASAI Library Functions for Managing the Communication Path 
Function Description
asai_openOpens a communication path to the capability provider, 
using either a blocking or nonblocking mode of operation. 
The communication path is identified by a file descriptor.
asai_closeTerminates the communication path from the application 
process to the...

Introduction to ASAI
Issue  3  May 1998
3-7
The other ASAI library functions are described briefly in Tables 3-2 and 3-3 below.
In general, ASAI library functions return 0 when successful and -1 on failure. 
Exceptions are noted in the manual pages in Chapter 8, ‘‘ASAI Capability 
Primitives’’ and Chapter 9, ‘‘Programming Manual Pages.’’
Table 3-2. ASAI Library Functions for Exchanging Information
Function Description
asai_sendInitiates, continues or terminates an association by 
transmitting request or...

Introduction to ASAI
3-8Issue  3  May 1998 
Application Service Elements
The ASAI Application Service Elements (ASEs) support ASAI functions. ASEs, 
also referred to as ‘‘capability groups,” are the high-level building blocks from 
which specific applications are constructed. Each ASE defines a series of 
relationship interactions between a client and a server: third party call control, 
event notification, value query and so on.
Each capability provides a specific type of interaction between the client...

Introduction to ASAI
Issue  3  May 1998
3-9
Third Party Call Control
(continued)C_3PRC
C_3PRC_CONF
C_3PREDIR
C_3PREDIR_ACK
C_3PSD
C_3PSD_CONF
C_3PSDS
C_3PSDS_CONF
C_3PSH
C_3PSH_CONF
C_3PSL_DISC
C_3PSL_DISC_ACK
C_3PSL_RECONN
C_3PSL_RECONN_ACK
C_3PSSC_CONF
C_3PSSC_REQ
C_3PTC_REQ
C_3PTC_CONFRelinquish Control
Confirm Relinquish Control
Redirect Call
Confirm redirect Call
Selective Drop
Confirm Selective Drop
Send DTMF Signals
Confirm Send DTMF 
Signals
Selective Hold
Confirm Selective Hold
Listen...

Introduction to ASAI
3-10Issue  3  May 1998 
In addition, the ASAI library provides two types of C_ABORT capabilities, as shown 
in Table 3-5. The two ASAI abort services are referred to as user aborts and 
provider aborts.
A user abort is a program-initiated abort and a provider abort is a library-initiated 
abort. The C_ABORT capability is applicable to all ASEs. The application can 
send and receive an abort at any time. An abort is always terminating.
Value QueryC_VQ_CONF
C_VQ_REQ
C_VQ_RESPConfirm...

Introduction to ASAI
Issue  3  May 1998
3-11
ASAI Capabilities
The library functions asai_send() and asai_rcv() are used to exchange 
capabilities. Each ASAI capability is specific, performing a single task. These 
tasks are classified as initiating, continuing or terminating. The capabilities are 
also classified as acknowledged or unacknowledged.
Table 3-6 lists each capability primitive and shows how it is classified. Note that a 
number of the confirmation primitives are classified both as...

Introduction to ASAI
3-12Issue  3  May 1998 
C_3PREDIR_ACKxx
C_3PSDx
C_3PSD_CONFx
C_3PSDSx
C_3PSDS_CONFx
C_3PSHx
C_3PSH_CONFx
C_3PSL_DISCx
C_3PSL_DISC_ACKx
C_3PSL_RECONNx
C_3PSL_RECONN_ACKx
C_3PSSC_CONFx
C-PSSC_REQx
C_3PTC_CONFxx
C_3PTC_REQx
C_ABORTx
C_EN_CANx
C_EN_CAN_CONFxx
C_EN_CONFxx
C_EN_ENDx
C_EN_REPx
C_EN_REQx
C_EN_SCNx
C_EN_SCN_CONFx
C_HB_CONFx
C_HB_REQx
C_RF_CONFx
C_RF_REQx
Table 3-6. Classification of ASAI Capabilities  — Continued
Acknowledged Unacknowledged
Init. Cont. Term. Init. Cont. Term.