ProxySSL Property

This property determines when to use SSL for the connection to the proxy.

Syntax

 client.getProxySSL([callback])
 client.setProxySSL( proxySSL, [callback])

Possible Values

  0 (psAutomatic), 
  1 (psAlways), 
  2 (psNever), 
  3 (psTunnel)

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 getProxySSL([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 setProxySSL([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

This property determines when to use SSL for the connection to the proxy. The applicable values are the following:


psAutomatic (0)	Default setting. If the URL is an "https" URL, the class will use the `psTunnel` option. If the URL is a "http" URL, the class will use the `psNever` option.
psAlways (1)	The connection is always SSL-enabled.
psNever (2)	The connection is not SSL-enabled.
psTunnel (3)	The connection is through a tunneling (HTTP) proxy.

Data Type

Integer