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

							Programming Manual Pages
Issue  3  May 1998
9-79
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 client.
See Also
asai_send()
C_EN_REP C_3PMC_REQ C_3PMC_CONF C_3PTC_REQ C_3PTC_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-80Issue  3  May 1998 
C_3PSH_CONF (3ASAI)
Name
C_3PSH_CONF — Acknowledge a third party selective hold request
Ty p e
Continuing — Unacknowledged
Usage
typedef struct{
        asai_common_t        asai_common;
        long                 cause_value;
}a3psh_rsp_t;
Description
The client receives this capability as a positive or negative acknowledgement of a 
C_3PSH request.
asai_common
Within this structure, capability is returned as C_3PSH_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 selective hold request is also returned.
cause_value
This parameter can be any of the following:
  C_CALLID_TERM
  C_FACUNSUB
  C_INCOM_ST
  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-81
Return Value
When this capability is used in an asai_rcv(), the function returns the size of 
the message upon success 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_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-82Issue  3  May 1998 
C_3PSL_DISC (3ASAI) 
Name
 C_3PSL_DISC — Disconnect the listen path for selected parties 
Ty p e
Continuing — Acknowledged
Usage
    typedef struct {
        asai_common_t   asai_common;
        party_id_t      from_party_id;
        party_id_t      to_party_id;
    } a3psl_disc_t;
Description
The client sends this capability to request that listen path(s) between parties on a 
controlled call be dropped. A structure of type a3psl_disc_t contains the 
parameters needed to fulfill the request.
asai_common
The programmer sets capability to C_3PSL_DISC 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 disconnected.
from_party_id, to_party_id
from_party_id is a required parameter and specifies the party to be 
disconnected from listening. to_party_id is an optional parameter. When the 
to_party_id is specified, the only path that will be removed is between the 
“talk” and “listen” parties. Otherwise, all listening paths to from_party_id are 
disconnected. For each party id that is specified, 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.
 Return Value 
When this capability is used in an asai_send(), the function returns a 
nonnegative value upon success and -1 on failure. A return value of 0 does not 
indicate an error, it merely indicates that no data has been sent. 
						

							Programming Manual Pages
Issue  3  May 1998
9-83
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_3PSL_RECONN C_3PSL_DISC_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-84Issue  3  May 1998 
C_3PSL_DISC_ACK (3ASAI)
Name
 C_3PSL_DISC_ACK — Acknowledge a third party selective listen disconnect  
Ty p e
Continuing — Unacknowledged
Usage
typedef struct {
asai_common_t        asai_common;
long                 cause_value;
}a3psl_disc_nak_t;
typedef union{
asai_common_t        asai_common;
a3psl_disc_nak_t     a3psl_disc_nak;
} a3psl_disc_ack_t;
Description
The client receives this capability as a positive or negative acknowledgement of a  
C_3PSL_DISC request.
asai_common
Within this structure, capability is returned as C_3PSL_DISC_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_3PSL_DISC request is also returned.
cause_value
This parameter can be any of the following:
            C_INVLDNUM
            C_PROTERR
            C_RESUNAVL
            C_MAND_INFO
            C_INVLDI
            C_INCOM_ST
See Table 8-1 on page 8-12 for further information on cause values. 
						

							Programming Manual Pages
Issue  3  May 1998
9-85
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, it merely indicates 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_3PSL_DISC C_3PSL_RECONN 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-86Issue  3  May 1998 
C_3PSL_RECONN (3ASAI)
Name
 C_3PSL_RECONN — Reconnect the listen path for selected parties
Ty p e
Continuing — Acknowledged
Usage
typedef struct {
asai_common_t  asai_common;
party_id_t      from_party_id;
party_id_t      to_party_id;
} a3psl_reconn_t;
Description
The client sends this capability to request that a listen path between parties on a 
controlled call be reconnected. A structure of type a3psl_reconn_t contains 
the parameters needed to fulfill the request.
asai_common
The programmer sets capability to C_3PSL_RECONN 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 
reconnected.
from_party_id, to_party_id 
from_party_id is a required parameter and specifies the party listening. 
to_party_id is an optional parameter. When the to_party_id is specified, 
the only path that will be reconnected is between the “talk” and “listen” parties. 
Otherwise, all parties who were disconnected from_party_id are reconnected. 
For party identifiers, the length of the identifier is id_length. The binary array 
pointed to by id_ptr contains the party id. See the ‘‘Identifiers’’ section 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. 
						

							Programming Manual Pages
Issue  3  May 1998
9-87
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_3PSL_DISC C_3PSL_DISC_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-88Issue  3  May 1998 
C_3PSL_RECONN_ACK (3ASAI)
Name
 C_3PSL_RECONN_ACK — Acknowledge a third party selective listen reconnect 
Ty p e
Continuing — Unacknowledged
Usage
typedef struct{
asai_common_t        asai_common;
long                 cause_value;
}a3psl_reconn_nak_t;
typedef union{
asai_common_t        asai_common;
a3psl_reconn_nak_t   a3psl_reconn_nak;
} a3psl_reconn_ack_t;
Description
The client receives this capability as a positive or negative acknowledgement of a  
C_3PSL_RECONN request.
asai_common
Within this structure, capability is returned as C_3PSL_RECONN_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_3PSL_RECONN request is also returned.
cause_value
This parameter can be any of the following:
              C_INVLDNUM
              C_PROTERR
              C_RESUNAVL
              C_MAND_INFO
              C_INVLDIE
              C_INCOM_ST
See Table 8-1 on page 8-12 for further information on cause values.