SSLStartMode Property

Determines how the component starts the SSL negotiation.

Syntax

 check21.getSSLStartMode([callback])
 check21.setSSLStartMode( SSLStartMode, [callback])

Possible Values

  0 (sslAutomatic), 
  1 (sslImplicit), 
  2 (sslExplicit), 
  3 (sslNone)

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getSSLStartMode([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setSSLStartMode([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The SSLStartMode property may have one of the following values:


0 (sslAutomatic - default)	If the remote port is set to the standard plaintext port of the protocol (where applicable), the class will behave the same as if SSLStartMode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit).
1 (sslImplicit)	The SSL negotiation will start immediately after the connection is established.
2 (sslExplicit)	The class will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
3 (sslNone)	No SSL negotiation, no SSL security. All communication will be in plaintext mode.

Data Type

Integer