irChanIS, irChanOOS - place a channel in or out of service
#include <irapi.h>
int irChanIS (channel_id cid, int tag);
int irChanOOS (channel_id cid, int tag);
The irChanIS function places a channel in-service. It is used by maintenance or related processes to place the channel in an idle or on-hook state as appropriate for the network interface. This function typically is called just before irDeinit or irReturn when restoring a channel to service.
The irChanOOS function places a channel out-of-service. It is used by maintenance or related processes (such as MTC_PROXY) to place the channel in a busy-out or off-hook state as appropriate for the network interface. This function typically is called just after a channel has been granted via a call to irInit or irForceInit.
The irChanOOS function tells the remote switch or PBX that the CONVERSANT VIS will not accept incoming calls on this channel. Unfortunately, there is a brief period of time between the start of the irInit (or irForceInit) and the irChanOOS during which the remote switch could try to initiate an incoming call. If an incoming call occurs, the irChanOOS function waits for the completion of the busy-out or off-hook command. If an incoming call occurs, the IRAPI may internally attempt to clear the incoming call (that is, hangup on the caller) and again try to busy-out the channel. The automatic clearing of incoming calls is not a committed feature so there could be very rare cases where a caller gets connected to a disabled channel (the caller presumably hangs up after a few seconds even if the VIS does not).
The cid is likely to temporarily be in the IRS_GOING_OOS library state while waiting for the completion of the irChanOOS request. The IRE_CHAN_OOS_DONE event is generated with the IREM_COMPLETE modifier when the request has been successfully completed.
The cid is likely to temporarily be in the IRS_GOING_IS library state while waiting for the completion of the irChanIS request. The IRE_CHAN_IS_DONE event is generated with the IREM_COMPLETE modifier when the request has been successfully completed.
Both functions return IRR_OK when the request is successfully initiated.
Both functions return IRR_FAIL if an error occurs.
irError is set as follows if an error occurs:
IRER_INVALID if the cid is not valid
IRER_DRIVERROR if a driver call failure occurs (see irSysError for additional information)
IRER_SYSERROR if a system or driver call failure occurs (see irSysError for additional information)
irInit(3IRAPI), irForceInit(3IRAPI)
This is version 12/17/02 of this man page.