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

Programming Manual Pages
Issue  3  May 1998
9-99
C_ABORT (3ASAI)
Name
C_ABORT — Abort an association
Ty p e
Terminating — Unacknowledged
Usage
typedef struct{
        asai_common_t       asai_common;
        long                abort_type;
        long                cause_value;
}abort_info_t;
Description
The client sends this capability to request a user (program-initiated) abort or 
receives this capability as a provider (library-initiated) abort request. When the 
client sends an abort (U_ABORT), the...

Programming Manual Pages
9-100Issue  3  May 1998 
cause_value
This mandatory parameter carries the cause of the abort request. It can be any of 
the following:
  C_CLUST_TERM
  C_INCOM_ST
  C_INVALID_CRV
  C_INVLDNUM
  C_MISSING_IE
  C_NETCONJ
  C_NOLOGIN
  C_NOSPLIT_MEM
  C_NOUSE_RESP
  C_PERM_DENIED
  C_PROTERR
  C_REC_TIMER
  C_RESUNAVL
  C_USER_C_BUSY
See Table 8-1 on page 8-12 for further information on cause values.
Return Value
When this capability is used in an asai_rcv(), the function returns...

Programming Manual Pages
Issue  3  May 1998
9-101
C_EN_CAN (3ASAI)
Name
C_EN_CAN — Request termination of an event notification request
Ty p e
Continuing — Acknowledged
Usage
asai_common_t   asai_common;
Description
The client sends this capability to request termination of event notification. A 
structure of type asai_common_t contains the parameters needed to fulfill the 
request. Within asai_common, the programmer sets capability to C_EN_CAN 
and primitive_type to C_REQUEST. The programmer must also...

Programming Manual Pages
9-102Issue  3  May 1998 
C_EN_CAN_CONF (3ASAI)
Name
C_EN_CAN_CONF — Acknowledge an event notification cancel request
Ty p e
Terminating — Unacknowledged, when received as a positive acknowledgement
Continuing — Unacknowledged, when received as a negative acknowledgement
Usage
typedef struct{
        asai_common_t        asai_common;
        long                 cause_value;
}enc_nak_t;
typedef union{
        asai_common_t        asai_common;
        enc_nak_t            enc_nak;...

Programming Manual Pages
Issue  3  May 1998
9-103
cause_value
This parameter can be any one of the following:
  C_FACUNSUB
  C_INVLDIE
  C_MAND_INFO
  C_PROTERR
  C_RESUNAVL
  C_SER_UNIMP
  C_SERV_UNAVIL
See Table 8-1 on page 8-12 for further information on cause values.
Return Value
When this capability is used in an asai_rcv(), the function returns the size of 
the message when successful and -1 on failure. A return value of 0 does not 
indicate an error, but that no data has been received.
Errors
See...

Programming Manual Pages
9-104Issue  3  May 1998 
C_EN_CONF (3ASAI)
Name
C_EN_CONF — Acknowledge an event notification request
Ty p e
Continuing — Unacknowledged, when received for positive acknowledgement
Terminating — Unacknowledged, when received for negative acknowledgement
Usage
typedef struct{
        asai_common_t        asai_common;
        long                 cause_value;
}en_nak_t;
typedef union{
        asai_common_t        asai_common;
        en_nak_t             en_nak;
}en_rsp_t;...

Programming Manual Pages
Issue  3  May 1998
9-105
See Table 8-1 on page 8-12 for further information on cause values.
Return Value
When this capability is used in an asai_rcv(), the function returns the size of 
the message when successful and -1 on failure. A return value of 0 does not 
indicate an error, but that no data has been received.
Errors
See Chapter 7, ‘‘Error Messages’’ for a list of error messages with brief 
explanations of their probable causes.
See Also
asai_rcv()
C_EN_REQ C_EN_REP...

Programming Manual Pages
9-106Issue  3  May 1998 
C_EN_END (3ASAI)
Name
C_EN_END — Terminate the generation of event reports
Ty p e
Terminating — Unacknowledged
Usage
typedef struct{
      asai_common_t        asai_common;
      long                 cause_value;
}ene_info_t;
Description
The ECS sends this capability as an unacknowledged request to terminate a
C_EN_REQ. A structure of type ene_info_t contains the information needed to 
fulfill this request.
asai_common
The programmer sets the capability...

Programming Manual Pages
Issue  3  May 1998
9-107
Return Value
When this capability is used in an asai_send(), the function returns a 
nonnegative value when successful and -1 on failure. A return value of 0 does not 
indicate an error, it merely indicates that no data has been sent.
Errors
See Chapter 7, ‘‘Error Messages’’ for a list of error messages with brief 
explanations of their probable causes.
Notes
This capability can be issued only by a server.
See Also
asai_send()
C_EN_REQ C_EN_CONF C_EN_REP...

Programming Manual Pages
9-108Issue  3  May 1998 
C_EN_REP (3ASAI)
Name
C_EN_REP — Send or receive an event report
Ty p e
Continuing — Unacknowledged
Usage
typedef struct{
        asai_common_t              asai_common;
        long                       event_name;
        call_id_t                  call_id;
        long                       cause;
        char                       *connect_num;
        plan_type_t                con_num_type;
        party_id_t                 party_id;
        char...