Purpose
Open the signaling interface.
Library
The signaling interface library (libsl.a).
C syntax
#include <slsigpr.h>
...
SL_RET_CODE sl_open (
SL_PROC_TYPE sl_proc_type,
SL_CONFIG_ST * psl_config_st,
SL_HANDLE * psl_handle
);
Description
This subroutine is called by the signaling process to open the signaling
interface. The signaling process passes an initialized configuration structure
that describes its capabilities. The signaling interface returns a signaling
handle, which must be passed on further calls to the signaling interface by
the signaling process.
Note: There can only be one signaling process per signaling process
type.
Once a signaling process has opened the signaling interface it may issue
signaling interface calls that require a signaling handle.
Parameters
- sl_proc_type
- The signaling process type.
- psl_config_st
- A pointer to the configuration structure, with all fields initialized,
for the signaling process.
- psl_handle
- The pointer to the signaling handle which must be passed on all future
calls to the signaling interface. See SL_HANDLE (signaling interface handle).
Return values
- SLRC_OK
- Successful.
- SLRC_INVALID_SL_TYPE
- The value of sl_proc_type is not one of those defined
in the SL_PROC_TYPE enumeration.
- SLRC_INVALID_ARGS
- The value of psl_config_st is NULL, or the installed field in the configuration structure is set to FALSE,
or psl_handle is NULL.
- SLRC_INVALID_SIGPROC_CLASS
- The signaling process class specified in psl_config_st–>SigprocClass is invalid. The only values a signaling process can specify are SL_SIGPROC_CLASS_EDL and SL_SIGPROC_CLASS_CCS.
- SLRC_INVALID_CAPABILITY_CC
- The signaling process capabilities specified in psl_config_st–>SigprocCapabilitySet are invalid. A signaling process of class SL_SIGPROC_CLASS_EDL cannot specify the capability SL_SIGPROC_CAPABILITY_CALL_CONTROL. A signaling process of class SL_SIGPROC_CLASS_CCS must specify this capability.
- SLRC_INVALID_CAPABILITY_CHNEG
- The signaling process capabilities specified in psl_config_st–>SigprocCapabilitySet are invalid. A signaling process of class SL_SIGPROC_CLASS_EDL cannot specify the capability SL_SIGPROC_CAPABILITY_CHANNEL_NEG. A signaling process of class SL_SIGPROC_CLASS_CCS must specify this capability.
- SLRC_INVALID_CAPABILITY_FAC
- The signaling process capabilities specified in psl_config_st–>SigprocCapabilitySet are invalid. The capability SL_SIGPROC_CAPABILITY_FACILITY is reserved for future use by Blueworx Voice Response.
- SLRC_INVALID_CAPABILITY_TRUNK
- The signaling process capabilities specified in psl_config_st–>SigprocCapabilitySet are invalid. The capability SL_SIGPROC_CAPABILITY_TRUNK_MGMT is reserved for future use by Blueworx Voice Response.
- SLRC_INVALID_CAPABILITY_FEHUP
- The signaling process capabilities specified in psl_config_st–>SigprocCapabilitySet are invalid. A signaling process of class SL_SIGPROC_CLASS_CCS must support the capability SL_SIGPROC_CAPABILITY_FE_HUP.
- SLRC_NO_MEM
- An attempt to allocate memory from AIX failed.
- SLRC_ERRNO
- An AIX error has occurred. Check the value of errno for more
information.
- SLRC_ERROR_READING_CONFIG
- An error occurred reading the Blueworx Voice Response signaling interface configuration.