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

ASAI Capability Primitives
Issue  3  May 1998
8-15
NOTE:
Whenever the server returns cause_value with an unrecognized value, 
the value is mapped to C_PROTERR. If the server does not return a value, 
then cause_value is mapped to C_NUSE_LONG.
Future releases of the ASAI library may include new cause_values. The 
application can be programmed for upward compatibility by providing for 
unexpected cause_values in the code.
Pool
The pool parameter, used with a number of capabilities, identifies a buffer area...

ASAI Capability Primitives
8-16Issue  3  May 1998  

Issue  3  May 19989-1
9
Programming Manual Pages
ASAI Library Manual Pages
Access to ASAI services is provided through a collection of functions known as 
the ASAI library. A single library can:
nAccess multiple ports (IPCI boards) or LAN Gateway links
nCommunicate with one or more switches
nManage communications for multiple ASAI links and ports 
These capabilities are provided by specifying a different node_id argument to 
the asai_set_env function for each newly opened file descriptor on which the...

Programming Manual Pages
9-2Issue  3  May 1998 
A major release is defined by a technological level or major change in operation 
from a previous release. A minor release is an enhancement or refinement to an 
existing major release. A delta release is a small enhancement or bug fix, 
differently tuned, or specific to a hardware platform.
Applications Development 
Environment for CV/LAN
The CV/LAN provides an executable for the server, asaiserv. asaiserv 
automatically runs after installation or system...

Programming Manual Pages
Issue  3  May 1998
9-3
Here m: is the drive and path leading to include\fcntl.h. For example, 
m: can refer to:
c:\Program Files\DevStudio\Vc
You MUST properly set m: with the subst command at the DOS prompt to 
avoid getting errors during compilation. For example:
subst m: c:\Program Files\DevStudio\Vc
The following paths to the ASAI and Unix header files under Windows NT must be 
included in your development environment:
\include\unix
\asai\include
By default  is set as:...

Programming Manual Pages
9-4Issue  3  May 1998 
Synopsis
This section illustrates the declaration of the function, including necessary header 
files.
Description
This section describes the function, including its parameters.
Return Value
This section gives the return values of the function on success and failure.
Errors
This section lists error values and describes the errors that are set in 
asai_errno. asai_errno is defined as follows:
long asai_errno;
Notes
This section is used to describe any...

Programming Manual Pages
Issue  3  May 1998
9-5
asai_close (3ASAI)
Name
asai_close — Close the communication path
Synopsis
#include  
#include  
#include  
long  asai_close(fd)
int  fd;
Description
This function closes the communication path identified by fd. All activity 
associated with the specified fd is terminated.
Return Value
Upon successful completion, the function returns 0. If an error occurs, the function 
returns -1.
Errors
The type of error is indicated by the error value set in asai_errno:...

Programming Manual Pages
9-6Issue  3  May 1998 
asai_errval (3ASAI)
Name
asai_errval — Write specified error message to stderr
Synopsis
#include  
#include  
#include  
long  asai_errval(mes_buf)
char  mes_buf[C_MESIZE];
Description
This function allows the client to incorporate a specified error message with a 
message provided by the ASAI library. The programmer specifies the message in 
the null-terminated string mes_buf of maximum size C_MESIZE. The 
ASAI-supplied message maps to the value...

Programming Manual Pages
Issue  3  May 1998
9-7
asai_get_env (3ASAI)
Name
asai_get_env — Request information about a specified characteristic of a 
communication path
Synopsis
#include  
#include  
#include  
typedef union{
        version_t      version;
        ulong          num_node;
        server_type_t  server;
        char           node_id[C_NODSIZ];
}get_type;
long  asai_get_env(fd, characteristic, arg)
int  fd;
long  characteristic;
get_type  *arg;
Description
This function is used to obtain a...

Programming Manual Pages
9-8Issue  3  May 1998 
C_SERVER
The C_SERVER parameter requests information on the number and type of 
servers previously set by calls to asai_set_env(). Data of structure type 
server_type_t, defined below, is returned. If no service requests have been 
set, then num_server is returned as 0.
typedef struct{
        long            num_node;
        service_spec_t  *buf;
}server_type_t;
Within this structure, num_node indicates the number of structures of the type...