Listening Property

If True, the component accepts incoming connections on LocalPort.

Syntax

 sshtunnel.getListening([callback])
 sshtunnel.setListening( listening, [callback])

Default Value

FALSE

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 getListening([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 setListening([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

Use this property to make the class 'listen' (accept connections) on the port specified by the LocalPort property. Setting this property to False will make the class stop listening. (Please note that this does not close any existing connections).

This property is not available at design time.

Data Type

Boolean