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

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

    Download as PDF Print this page Share this page

    Have a look at the manual Lucent Technologies DEFINITY Enterprise Communications Server Release 6 CallVisor PC ASAI Instructions Manual online for free. It’s possible to download the document as PDF or print. UserManuals.tech offer 413 Lucent Technologies manuals and user’s guides for free. Share the user manual or guide on Facebook, Twitter or Google+.

    Page
    of 458
    							Programming Manual Pages
    Issue  3  May 1998
    9-29
    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.
    See Also
    asai_send()
    C_3PANS_CONF C_3PDC_REQ C_3PDC_CONF C_3PAD C_3PAD_CONF
    C_EN_REP C_3PSH C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PM_CONF 
    C_3PSD C_3PSD_CONF C_3PCC C_3PCC_CONF C_3PRC C_3PRC_CONF 
    						
    							Programming Manual Pages
    9-30Issue  3  May 1998 
    C_3PANS_CONF (3ASAI)
    Name
    C_3PANS_CONF — Acknowledge an answer-call request
    Ty p e
    Continuing — Unacknowledged
    Usage
    typedef struct{
            asai_common_t   asai_common;
            long            cause_value;
    }a3pans_nak_t;
    Description
    The client receives this capability as a positive or negative acknowledgement to a 
    C_3PANS request.
    asai_common
    Capability is returned as C_3PANS_CONF and primitive_type is returned 
    as C_POS_ACK for a positive acknowledgement and as C_NEG_ACK for a negative 
    acknowledgement. The sao_id (also known as cluster_id) specified in the 
    answer call request is also returned.
    A positive acknowledgment confirms that the C_3PANS request has been 
    received and understood. Subsequent event reports will indicate the progress of 
    the call. In the case of a positive acknowledgement, the structure of 
    asai_common_t is the only one needed.
    cause_value
    This parameter can be any of the following:
    C_INVALID_CRV
    C_USER_BUSY
    C_NOUSE_RESP
    C_OUT_OF_SERV
    C_NETCONJ
    C_INVLDIE
    C_PROTERR
    C_RESUNAVL
    See Table 8-1 on page 8-12 for further information on cause values. 
    						
    							Programming Manual Pages
    Issue  3  May 1998
    9-31
    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_3PANS C_3PDC_REQ C_3PDC_CONF C_3PAD C_3PAD_CONF C_EN_REP 
    C_3PSH C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PM_CONF 
    C_3PSD C_3PSD_CONF C_3PCC C_3PCC_CONF C_3PRC C_3PRC_CONF 
    						
    							Programming Manual Pages
    9-32Issue  3  May 1998 
    C_3PCC (3ASAI)
    Name
    C_3PCC — Third party request to clear a call
    Ty p e
    Continuing — Acknowledged
    Usage
    asai_common_t  asai_common;
    Description
    The client sends this capability to request that a client-controlled call be cleared. 
    Clearing disconnects all parties to the specified call. To receive the server’s 
    acknowledgement (C_3PCC_CONF), the client must use asai_rcv().
    The asai_common structure contains the parameters needed to service this 
    request.
    Within asai_common, the programmer sets capability to C_3PCC and 
    primitive_type to C_REQUEST. The programmer also sets sao_id (also 
    known as cluster_id). The acknowledgement sent by the server will identify 
    the call to be cleared by this sao_id (cluster_id).
    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. 
    						
    							Programming Manual Pages
    Issue  3  May 1998
    9-33
    See Also
    asai_send()
    C_EN_REP C_3PMC_REQ C_3PMC_CONF C_3PTC_REQ C_3PTC_CONF C_3PSH
    C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PM_CONF C_3PSD
    C_3PSD_CONF C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF 
    						
    							Programming Manual Pages
    9-34Issue  3  May 1998 
    C_3PCC_CONF (3ASAI)
    Name
    C_3PCC_CONF — Acknowledge a third party clear call request
    Ty p e
    Terminating — Unacknowledged, when used as a positive acknowledgement
    Continuing — Unacknowledged, when used as a negative acknowledgement
    Usage
    typedef struct{
            asai_common_t    asai_common;
            long             cause_value;
    }a3pcc_rsp_t;
    Description
    The client receives this capability from the server in acknowledgement of a
    C_3PCC request. The structure a3pcc_rsp_t contains the parameters 
    necessary to service this capability.
    asai_common
    Within this structure, capability is returned as C_3PCC_CONF; 
    primitive_type is returned as C_POS_ACK for positive acknowledgement and 
    C_NEG_ACK for negative acknowledgement. The sao_id (also known as 
    cluster_id) specified in the C_3PCC request is also returned.
    cause_value
    This parameter can be any of the following:
      C_CALLID_TERM
      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. 
    						
    							Programming Manual Pages
    Issue  3  May 1998
    9-35
    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.
    Notes
    This capability can be issued only by the server.
    See Also
    asai_rcv()
    C_EN_REP C_3PMC_REQ C_3PMC_CONF C_3PTC_REQ C_3PTC_CONF C_3PSH
    C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PM_CONF C_3PSD
    C_3PSD_CONF C_3PCC C_3PCE C_3PRC C_3PRC_CONF 
    						
    							Programming Manual Pages
    9-36Issue  3  May 1998 
    C_3PCE (3ASAI)
    Name
    C_3PCE — End a third party call controlled by the client
    Ty p e
    Terminating — Unacknowledged
    Usage
    typedef struct {
            asai_common_t       asai_common;
            long                cause_value;
            call_id_t           call_id;
            char                pool[C_DATSZ];
    }a3pce_info_t;
    Description
    The server sends this capability to request termination of an existing call 
    controlled by a client. This capability disconnects all parties to the specified call 
    and terminates the association by freeing the sao_id (also known as
    cluster_id).
    asai_common
    Within this structure, capability is returned as C_3PCE and primitive_type 
    is set to C_REQUEST. The sao_id (also known as cluster_id) of the 
    association to be terminated is also returned.
    cause_value
    This parameter can be any of the following:
       C_CALLID_TERM
       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. 
    						
    							Programming Manual Pages
    Issue  3  May 1998
    9-37
    call_id
    Within this structure, id_length specifies the length of the ECS-assigned call 
    identifier and id_ptr points to an array of binary bytes that specifies 
    ECS-assigned call identifier of the call to be terminated.
    pool
    The pool parameter is a character array that provides buffer space for the ASAI 
    library to store program-specific information. See ‘‘Pool’’ on page 8-15 in Chapter 
    8, ‘‘ASAI Capability Primitives’’ for more information.
    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() asai_rcv()
    C_EN_REP C_3PMC_REQ C_3PMC_CONF C_3PTC_REQ C_3PTC_CONF C_3PSH
    C_3PSH_CONF C_3PR C_3PR_CONF C_3PM C_3PM_CONF C_3PSD
    C_3PSD_CONF C_3PCC C_3PCC_CONF C_3PRC C_3PRC_CONF 
    						
    							Programming Manual Pages
    9-38Issue  3  May 1998 
    C_3PDC_CONF (3ASAI)  
    Name
    C_3PDC_CONF — Acknowledge a third party domain control request
    Ty p e
    Continuing — Unacknowledged, when used as a positive acknowledgement
    Terminating — Unacknowledged, when used as a negative acknowledgement
    Usage
    typedef struct{
            asai_common_t       asai_common;
            long                num_callid;
            stn_info_t          *stninfo_list;
            char                pool[C_DATSZ];
    }a3pdc_ack_t;
    typedef struct{
            asai_common_t       asai_common;
            long                cause_value;
    }a3pdc_nak_t;
    Description
    The client receives this capability as a positive or negative acknowledgement of a 
    domain control request.
    For positive acknowledgment, a structure of type a3pdc_ack_t is returned. if the 
    domain_type has been set to C_ACD_SPLIT in the domain control request 
    (C_3PDC_REQ), then this capability includes only the asai_common structure. 
    Positive acknowledgment of the control of an ACD agent does not return these 
    parameters.
    If domain_type is set to C_EXTENSION in the domain control request, 
    a3pdc_ack_t contains status information on the call.
    asai_common
    Within this structure, capability is returned as C_3PDC_CONF; 
    primitive_type is returned as C_POS_ACK for a positive acknowledgement 
    and as C_NEG_ACK for a negative acknowledgement. The sao_id (also known 
    as cluster_id) specified in the domain control request is also returned. 
    						
    All Lucent Technologies manuals Comments (0)

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