AzureRelayConnectionDataToSend Property

This property contains a string of data to be sent to the remote host.

Syntax

 azurerelayreceiver.setAzureRelayConnectionDataToSend(index,  azureRelayConnectionDataToSend_Buffer, [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 getAzureRelayConnectionDataToSend([callback]) method is defined as:

function(err, buffer){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'buffer' is the value returned by the method.

The callback for the setAzureRelayConnectionDataToSend([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 contains a string of data to be sent to the remote host. Write-only property.

Assigning a string to the AzureRelayConnectionDataToSend makes the class send the string to the remote host. The Send method provides similar functionality.

If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, DataToSend fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again. (However, please note that ReadyToSend is not fired when part of the data is successfully sent).

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

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

Data Type

Buffer