IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

DataToSend Property

A string of data to be sent to the remote host. Write-only property.

Syntax


 udpport.setDataToSend( dataToSend_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 getDataToSend([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 setDataToSend([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

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

Attempts to send the string assigned to DataToSend as a complete message. If system buffers are full, or the message cannot be delivered for any other reason, an error is fired, and no portion of the message is sent. This is different from TCP where portions of the messages can be sent. UDP sends either a complete message or nothing at all.

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.

Example (Send Data)


UDPPortControl.LocalPort = 8765 
UDPPortControl.RemotePort = 8765 
UDPPortControl.RemoteHost = "HostNameOrIPAddress"
UDPPortControl.Active = True
UDPPortControl.DataToSend = "Hello!"

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

Data Type

Buffer

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0