ForwardingHost Property
The address to which traffic will automatically be forwarded.
Syntax
azurerelayreceiver.getForwardingHost([callback]) azurerelayreceiver.setForwardingHost( forwardingHost, [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 getForwardingHost([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 setForwardingHost([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
ForwardingHost optionally specifies an address to which traffic will be automatically forwarded. Traffic will only be forwarded if both ForwardingHost and ForwardingPort are specified.
When a connection is made the class will automatically establish a connection to ForwardingHost on the port specified by ForwardingPort. Data will then flow freely between the connected client and the ForwardingHost.
Note: This functionality is not applicable to HTTP requests.
Data Type
String