DefaultForwardPort Property

The default port of the host to which data will be forwarded.

Syntax

 wsproxy.getDefaultForwardPort([callback])
 wsproxy.setDefaultForwardPort( defaultForwardPort, [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 getDefaultForwardPort([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 setDefaultForwardPort([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

When a client connects the class will establish a new connection to the host specified in DefaultForwardHost on the port specified here. Data can then be freely sent and received between the client and host.

You may also override the default value specified here by setting the ForwardPort event parameter within the WebSocketOpenRequest event.

Data Type

Long