ClientLocalAddress Property

This property shows the IP address of the interface through which the connection is passing.

Syntax

 sshtunnel.getClientLocalAddress(index, [callback])

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 getClientLocalAddress([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 setClientLocalAddress([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 shows the IP address of the interface through which the connection is passing.

ClientLocalAddress is important for multi-homed hosts where it can be used to find which particular network interface an individual connection is going through.

The size of the array is controlled by the ClientCount property.

This property is read-only and not available at design time.

Data Type

String