Listening Property
If True, connects to the Azure Relay Service and listens for incoming connections.
Syntax
azurerelayreceiver.getListening([callback]) azurerelayreceiver.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
This setting controls whether the class accepts incoming connections. When set to True the class will connect to the Azure Service and begin listening for incoming connections. The following properties are applicable when calling this method:
- AccessKey (required)
- AccessKeyName (required)
- HybridConnection (required)
- NamespaceAddress (required)
- DefaultTimeout
- ForwardingHost
- ForwardingPort
This property is not available at design time.
Data Type
Boolean