Cisco Cisco Computer Telephony Integration Option 9.0 Developer's Guide

Page of 546
 
8-9
Cisco ICM Software CTI OS Developer’s Guide Release 6.0(0)
 
Chapter 8      Session Object
Methods
Remarks
A successful request will result in an OnConnection event.
A failure will result in an OnConnectionFailure event. This means that the CIL is 
in failover. The CIL will continue to attempt to connect, alternating between hosts 
CTIOS_CTIOSA and CTIOS_CTIOSB until connection succeeds at which point 
CIL will fire OnConnection. If application wishes to stop failover, it must call 
Disconnect. 
In some cases, additional failure codes and events may occur:
Connect will return a failure code of -1 if it cannot connect with the initial 
side of the duplexed CTIOS server pair chosen from the connect parameters. 
This error code requires no action on the part of the developer as the CIL will 
automatically attempt to connect using the parameters corresponding to the 
other side of the duplexed pair. 
The CIL will retry the connection attempt five times and then will not attempt 
to reconnect any longer. The final OnConnectionFailure event will contain 
the keyword "FinalAttempt" which informs the client application that the CIL 
has discontinued its attempts to reconnect. 
Note
This behavior will only occur after global settings download has 
completed. If global settings download has not completed, the CIL will 
continue to retry until successful. 
The Connect method will cause an OnCTIOSFailure event to be fired to the 
client indicating the current state of the system. This is in addition to 
OnConnection or OnConnectionFailure. 
The following error codes can occur:
CIL_OK - no obvious errors, application should wait for an event indicating 
whether or not Connect has succeeded 
CIL_FAIL - initial attempt to connect with host has failed. CIL will fire 
OnConnectionFailure and go into failover mode. CIL will continue to attempt 
to connect, alternating between hosts CTIOS_CTIOSA and CTIOS_CTIOSB 
until connection succeeds at which point CIL will fire OnConnection. If 
application wishes to stop failover, it must call Disconnect.
E_CTIOS_INVALID_ARGUMENT - a null Arguments parameter was 
supplied. Connect is aborted. No events are fired.