Connect Method

Connects to the Azure Relay Service.

Syntax

azurerelaysender.connect([callback])

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 this 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

Connect establishes a WebSocket connection to the Azure Relay Service. The following properties are applicable when calling this method:

• AccessKey (required)
• AccessKeyName (required)
• HybridConnection (required)
• NamespaceAddress (required)
• Timeout

After the connection is established data may be sent by setting the DataToSend property or by calling Send, SendText, or SendFile.

Incoming data is received through the DataIn event.

To disconnect call the Disconnect method.