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 cause is passed end to end. When the client 
receives an abort (P_ABORT), the cause is local to the library. A structure of type 
abort_info_t contains the parameters needed to fulfill the request.
asai_common
Within this structure, the programmer sets the capability to C_ABORT and the 
primitive_type to C_REQUEST to send a user abort request. When the abort 
is a provider abort, capability is returned as C_ABORT and primitive_type 
as C_REQUEST. The sao_id (also known as cluster_id) identifying the 
association to be aborted is set by the programmer or returned.
abort_type
This parameter indicates the type of abort. C_USER_ABT is initiated by the 
application program; C_PROV_ABT is initiated by the library. The programmer sets 
C_USER_ABT to request an abort. When the library sends an abort capability, 
abort_type is returned as C_PROV_ABT.
As soon as abort request is sent or received, the specified association terminates. 
Any outstanding messages for that association are ignored and the resources for 
those messages are freed. Aborts from the ECS also have an abort_type of 
C_USER_ABT. 
						

							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 the size of 
the message when successful and -1 on failure; when it 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 or received.
Errors
See Chapter 7, ‘‘Error Messages’’ for a list of error messages with brief 
explanations of their probable causes.
Notes
Use of this capability through the asai_send() function always indicates a client 
abort. Only ASAI library service providers can issue a provider abort.
See Also
asai_send() asai_rcv() 
						

							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 set the
 sao_id (also known as cluster_id) that identifies the Event Notification 
association to be terminated.
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 client.
See Also
asai_send()
C_EN_REQ C_EN_CAN_CONF C_EN_END 
						

							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;
}enc_rsp_t;
Description
The client receives this capability as a positive or negative acknowledgement of a 
C_EN_CAN request. The union enc_rsp_t defines the necessary fields for the 
messages.
asai_common
Within this structure, capability is returned as C_EN_CAN_CONF and 
primitive_type is returned as C_POS_ACK for positive acknowledgement,
C_NEG_ACK for negative acknowledgement. The sao_id (also known as 
cluster_id) returned is the association specified in the cancel request. 
						

							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 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_CONF C_EN_REP C_EN_CAN_CONF C_EN_END 
						

							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;
Description
The client receives this capability as a positive or negative acknowledgement of a 
C_EN_REQ. The union en_rsp_t defines the necessary fields for the messages.
asai_common
Within asai_common, the capability is returned as C_EN_CONF and the 
primitive_type is returned as C_POS_ACK for positive acknowledgement,
C_NEG_ACK for negative acknowledgement. The sao_id (also known as 
cluster_id) returned is the association specified in the event notification 
request.
cause_value
This parameter can be any of the following:
  C_FACUNSUB
  C_INVLDIE
  C_INVLDNUM
  C_MAND_INFO
  C_PROTERR
  C_RESUNAVL
  C_SER_UNIMP
  C_SERV_UNAVIL 
						

							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 C_EN_CAN C_EN_CAN_CONF C_EN_END 
						

							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 to C_EN_END and the primitive_type 
to C_REQUEST. The programmer also sets the sao_id (also known as
cluster_id).
cause_value
This parameter can be any of the following:
  C_FACUNSUB
  C_INVLDIE
  C_MAND_INFO
  C_OUT_OF_SERV
  C_PROTERR
  C_RESUNAVL
  C_SER_UNIMP
  C_SERV_UNAVIL
If the ECS does not supply a cause_value, the library supplies the value of 
C_NUSE_LONG. Table 8-1 on page 8-12 provides further information on cause 
values. 
						

							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 C_EN_CAN C_EN_CAN_CONF 
						

							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                       *calling_num;
        plan_type_t                call_num_type;
        char                       *dial_num;
        plan_type_t                dial_type;
        user_user_t                uudata;
        char                       *acd_split_ext;
        trunk_id_t                 trk;
        oli_t                      oli;
        ucid_t                     ucid;    /* G3V6 */
        char                       pool[C_DATSZ];
} alert_list_t;
typedef struct {
                asai_common_t              asai_common;
                long                       event_name;
                long                       cause;
                char                       *connect_num;
                plan_type_t                con_num_type;
                call_id_t                  call_id;
                char                       *calling_num;
                plan_type_t                call_num_type;
                char                       *called_num;
                plan_type_t                called_type;
                user_user_t                uudata; 
                party_id_t                 party_id;
                char                       pool[C_DATSZ];
        } orig_list_t;