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

							Programming Manual Pages
Issue  3  May 1998
9-39
num_callid
This parameter shows the number of structures and calls, listed in
stninfo_list.
stninfo_list
See ‘‘Identifiers’’ on page 8-5 in Chapter 8, ‘‘ASAI Capability Primitives.’’
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.
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
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_REP C_3PSH C_3PDC_REQ C_3PDC_CONF C_3PAD C_3PAD_CONF
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 C_3PRC_CONF 
						

							Programming Manual Pages
9-40Issue  3  May 1998 
C_3PDC_REQ (3ASAI)
Name
C_3PDC_REQ — Domain control of an ACD or station
Ty p e
Initiating — Acknowledged
Usage
typedef struct{
        asai_common_t        asai_common;
        long                 domain_type;
        char                 *extension;
        char                 pool[C_DATSZ];
}a3pdc_info_t;
Description
The client sends this capability to request control of an extension domain. The 
parameters used in gaining control of the extension domain are defined in the 
structure of type a3pdc_info_t.
When a station domain control request is positively acknowledged by the ECS, all 
the third party call control capabilities can be applied to the controlled domain, 
except for the following:
C_3PTC_REQ/CONF, C_3PMC_REQ/CONF,C_3PCC/_CONF, C_3PCE.
If the request is denied by ECS, error and cause values are returned.
asai_common
Within this structure, the programmer sets capability to C_3PDC_REQ and 
primitive_type to C_REQUEST. The programmer also sets the sao_id 
(also known as cluster_id).
extension
The extension parameter is a pointer to a character array that specifies the 
domain to be controlled.
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. 
						

							Programming Manual Pages
Issue  3  May 1998
9-41
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_EN_REP C_3PSH C_3PDC_REQ C_3PDC_CONF C_3PAD C_3PAD_CONF
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-42Issue  3  May 1998 
C_3PDCE (3ASAI)
Name
C_3PDCE — End the domain control
Ty p e
Terminating — Unacknowledged
Usage
typedef struct {
 asai_common_t        asai_common;
 long                 cause_value;
}a3pdce_info_t;
Description
The server sends this capability to indicate that it will end a previous 
C_3PDC_REQ. This indication terminates the association and is generally provided 
when the affected domain is removed or changed administratively from ECS.
 asai_common
Within this structure, the programmer sets capability to C_3PDCE and 
primitive_type to C_REQUEST. The programmer also sets the association 
identifier to the sao_id (also known as cluster_id) specified in the C_3PDC_
REQ.
 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
See Table 8-1 on page 8-12 for further information on cause values. 
						

							Programming Manual Pages
Issue  3  May 1998
9-43
 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()
C_EN_REP C_3PDC_REQ C_3PDC_CONF C_3PAD C_3PAD_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-44Issue  3  May 1998 
C_3PM (3ASAI)
Name
C_3PM — Merge two calls
Ty p e
Continuing — Acknowledged
Usage
typedef struct{
        asai_common_t       asai_common;
        party_id_t          com_party_id;
        call_id_t           call_id;
        call_id_t           held_call_id;
        long                conf_flag;
        char                pool[C_DATSZ];
}a3pm_info_t;
Description
The client sends this capability to request that two client-controlled calls that have 
a common party be merged. The common party can be retained on the call by 
conferencing the two calls or it can be disconnected after effectively transferring 
one of the other parties. A structure of type a3pm_info_t contains the 
parameters needed to service this capability.
asai_common
Within this structure, the programmer sets capability to C_3PM and 
primitive_type to C_REQUEST. The programmer sets sao_id (also known as 
cluster_id) to the association identifier of one of the calls. 
com_party_id
The common party is a conditional parameter and is identified by a party_id 
structure. The com_party_id parameter must be used when the association has 
been started through C_3PMC_REQ or C_3PTC_REQ. When it is started with 
C_3PDC_REQ, the parameter is not used. See also party_id.
call_id
Specifies the call to be merged with the held call. The call identified by this 
parameter must be a call initiated by the C_3PMC_REQ capability or a call 
controlled by the C_3PDC_REQ capability. 
						

							Programming Manual Pages
Issue  3  May 1998
9-45
held_call_id
Specifies the held call. The held call parameter is used only if the extension is 
controlled by C_3PDC_REQ.
conf_flag
When conf_flag is set to C_CONF_ON, the party identified by com_party_id 
remains connected to the merged call; when conf_flag is set to C_CONF_OFF, 
the common party is disconnected.
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
The use of this capability in asai_send() is restricted to clients.
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_CONF C_3PSD
C_3PSD_CONF C_3PCC C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF 
						

							Programming Manual Pages
9-46Issue  3  May 1998 
C_3PM_CONF (3ASAI)
Name
C_3PM_CONF — Acknowledge a third party merge request
Ty p e
Continuing — Unacknowledged
Usage
typedef struct{
        asai_common_t       asai_common;
        call_id_t           call_id;
        long                num_merge_ext;
        merge_ext_t         *party_list;
        ucid_t              ucid;           /* G3V6 */
        char                pool[C_DATSZ];
}a3pm_ack_t;
typedef struct{
        asai_common_t       asai_common;
        long                cause_value;
}a3pm_nak_t;
Description
The client receives this capability as a positive or negative acknowledgment of a 
C_3PM request. Structures of the type a3pm_ack_t and a3pm_nak_t contain 
the asai_common structure that specifies the parameters used in 
acknowledgments. Positive acknowledgment parameters are specified by the 
structure of type a3pm_ack_t. Negative acknowledgment parameters are 
specified by the structure of type a3pm_nak_t.
asai_common
Within this structure, capability is returned as C_3PM_CONF and 
primitive_type as C_POS_ACK for a positive acknowledgment and C_NEG_
ACK for a negative acknowledgment. The sao_id (also known as cluster_id) 
specified in the C_3PM request is also returned.
call_id
Within a3pm_ack_t, call_id specifies ECS-assigned call identifier of the 
merged call. 
num_merge_ext
This parameter specifies the number of parties connected to the merged call. 
						

							Programming Manual Pages
Issue  3  May 1998
9-47
party_list
Within a3pm_ack_t, party_list is a pointer to a structure of the type
merge_ext_t. Each element of this list, up to and including the element 
identified by num_merge_ext, contains information about the parties connected 
to the merged call. In each of these structures, id_ptr is a pointer to 
ECS-assigned party identifier; id_length indicates the length of the party 
identifier. extension points to a null-terminated character string, indicating the 
extension or station number associated with that party.
ucid
Within a 3pm_ack_t, this parameter specifies the resulting ucid assigned 
by the ECS.
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.
cause_value
This parameter can be any of the following:
  C_CALLID_TERM
  C_FACUNSUB
  C_INCOM_ST
  C_INVALID_CRV
  C_INVLDIE
  C_INVLDNUM
  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. 
						

							Programming Manual Pages
9-48Issue  3  May 1998 
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_3PSD C_3PSD_CONF 
C_3PCC C_3PCC_CONF C_3PCE C_3PRC C_3PRC_CONF