WebSocketProxyConnectionForwardHost Property

This property shows the address of the forward host.

Syntax

 websocketproxy.getWebSocketProxyConnectionForwardHost(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 getWebSocketProxyConnectionForwardHost([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 setWebSocketProxyConnectionForwardHost([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 address of the forward host.

When queried this property will return the address of the host to which traffic is being forwarded.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the WebSocketProxyConnectionCount property.

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

Data Type

String