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

							Programming Manual Pages
Issue  3  May 1998
9-59
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_REP C_3PMC_REQ C_3PMC_CONF C_3PTC_REQ C_3PTC_CONF 
C_3PSH C_3PSH_CONF C_3PR C_3PM C_3PM_CONF C_3PSD C_3PSD_CONF 
C_3PCC C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF 
						

							Programming Manual Pages
9-60Issue  3  May 1998 
C_3PRC (3ASAI)
Name
C_3PRC — Relinquish control of a call without disconnecting the parties to 
the call
Ty p e
Terminating — Acknowledged
Usage
asai_common_t   asai_common;
Description
The client sends this capability to request that control of a client-controlled call be 
relinquished. This terminates the association. The asai_common structure 
contains the parameters needed to fulfill the request.
The programmer sets capability to C_3PRC and primitive_type to 
C_REQUEST. The programmer also sets the sao_id (also known as 
cluster_id). The use of this capability does not disconnect the parties to the 
call or free the resources necessary to maintain the call connection.
Return Value
When this capability is used in an asai_send(), the function returns a 
nonnegative value on success 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-61
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 C_3PCC_CONF C_3PCE C_3PRC_CONF 
						

							Programming Manual Pages
9-62Issue  3  May 1998 
C_3PRC_CONF (3ASAI)
Name
C_3PRC_CONF — Acknowledge a third party relinquish control 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;
}a3prc_nak_t;
typedef union{
        asai_common_t        asai_common;
        a3prc_nak_t          a3prc_nak;
}a3prc_rsp_t;
Description
The client receives this capability as a positive or negative acknowledgement of a 
C_3PRC request, specified by a3prc_rsp_t.
asai_common
Within asai_common, capability is returned as C_3PRC_CONF and 
primitive_type is returned as C_POS_ACK for positive acknowledgement and 
as C_NEG_ACK for negative acknowledgement. The sao_id (also known as 
cluster_id) specified in the C_3PRC request is also returned.
cause_value
cause_value can be any of the following values:
  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-63
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_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_3PCE C_3PRC 
						

							Programming Manual Pages
9-64Issue  3  May 1998 
C_3PREDIR (3ASAI)
Name
C_3PREDIR — Redirects an alerting call
Ty p e
Continuing — Acknowledged
Usage
typedef struct{
        asai_common_t   asai_common;
        call_id_t       call_id;
        number_id_t     redir_num;
        party_id_t      party_id;
        char            pool[C_DATSZ];
} a3predir_info_t;
Description
The client sends this capability to request that an alerting call be redirected to 
another number. A structure of type a3predir_info_t contains the 
parameters needed to fulfill the request.
asai_common
The programmer sets capability to C_3PREDIR and primitive_type to 
C_REQUEST. The programmer also sets the sao_id (also known as 
cluster_id) to identify the association that controls the alerting call.
call_id
call_id is required for domain control associations and is ignored with call 
control associations. Two fields, id_length and id_ptr, are in a call id. If 
id_length is zero, the field is omitted; otherwise, id_ptr contains a binary 
representation for the call_id (typically, received in an earlier ASAI message).
redir_num
The required parameter redir_num identifies the destination of the redirected 
call. Two fields, plan_type and s, are in a number id. 
s is a null-terminated 
string containing the destination number. plan_type is described in ‘‘Identifiers’’ 
on page 8-5 of Chapter 8. 
						

							Programming Manual Pages
Issue  3  May 1998
9-65
party_id
party_id is required for call control associations. It specifies the 
redirected_from party on the call.
The length of the party identifier is id_length. The character array pointed to by 
id_ptr contains the party_id. See ‘‘Identifiers’’ on page 8-5 in Chapter 8, 
‘‘ASAI Capability Primitives’’ for more information.
Pool
The pool parameter is a character array that provides buffer space for the ASAI 
library to store program-specific information. See the section ‘‘Pool’’ 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 there is no data to be 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_3PREDIR_ACK C_3PSL_RECONN_ACK 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_CONF C_3PCC
C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF 
						

							Programming Manual Pages
9-66Issue  3  May 1998 
C_3PREDIR_ACK (3ASAI)
Name
C_3PREDIR_ACK — Acknowledge a third party redirect alerting call request
Ty p e
Continuing — Unacknowledged
Usage
typedef struct{
        asai_common_t        asai_common;
        long                 cause_value;
}a3predir_nak_t;
typedef union{
        asai_common_t        asai_common;
        a3psl_disc_nak_t     a3psl_disc_nak;
} a3predir_ack_t;
Description
The client receives this capability as a positive or negative acknowledgement of a 
C_3PREDIR request.
asai_common
Within this structure, capability is returned as C_3PREDIR_ACK; 
primitive_type is returned as C_POS_ACK for positive acknowledgement and 
as C_NEG_ACK for negative acknowledgement.
The sao_id (also known as cluster_id) specified in the C_3PREDIR request 
is also returned.
cause_value
This parameter can be any of the following:
  C_USER_BUSY
  C_INVLDNUM
  C_PROTERR
  C_RESUNAVL
  C_MAND_INFO
  C_INVLDIE
  C_INCOM_ST
  C_NETCONJ
  C_INVALID_CRV 
						

							Programming Manual Pages
Issue  3  May 1998
9-67
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_3PPREDIR 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_3PCC C_3PCC_CONF C_3PCE C_3PRC
C_3PRC_CONF 
						

							Programming Manual Pages
9-68Issue  3  May 1998 
C_3PSD (3ASAI)
Name
C_3PSD — Drop selected parties from a client-controlled call
Ty p e
Continuing — Acknowledged
Usage
typedef struct{
asai_common_t      asai_common;
party_id_t         party_id;
call_id_t          call_id;
user_user_t        uudata;
long               resource;
char               pool[C_DATSZ];
}a3psd_info_t;
Description
The client sends this capability to request that a party to a call controlled by the 
client be dropped from the call. Any tone connected to a call, except ringback 
tones, may be dropped. A structure of type a3psd_info_t contains the 
parameters needed to fulfill the request.
asai_common
The programmer sets capability to C_3PSD and primitive_type to 
C_REQUEST. The programmer also sets the sao_id (also known as 
cluster_id) to identify the association that controls the call to be dropped.
party_id
party_id is a conditional parameter and specifies the party to be dropped. The 
length of the identifier is id_length. party_id must be used when the 
association is initiated by the C_3PMC_REQ or C_3PTC_REQ capabilities and the 
resource identifier is not specified. 
NOTE:
party_id and call_id are not ASCII null-terminated strings but rather an 
array of binary bytes of the specified length. See ‘‘Identifiers’’ on page 8-5 in 
Chapter 8, ‘‘ASAI Capability Primitives’’ for more information.