Back to product page

DataReady property


Holds the total numbers of bytes waiting to be received by your application.

Type

A Long value. Total bytes in the incoming buffer.

Syntax

  • Basic
object.DataReady [= value]
The DataReady(object,value) syntax has these parts:
objectAn expression evaluating to an object of type wodSSH.
valueA Long value.

Remarks

The DataReady property will return the total number of bytes currently waiting in wodSSH's buffers, for you to read with the Receive method. You shouldn't rely too much on its accuracy since its value can change internally very quickly as more data arrives in wodSSH. In Blocking mode it is often better not to call the Receive method and wait for the timeout to expire if there is no data waiting already.

You can set this value to 0, or to any value lower than it currently contains. In this case wodSSH will "consume" bytes up to the value that you define.

Platforms

Windows