readUntil

readUntil(delimiter: Binary;
          maxLength: Integer): Binary;

The readUntil method of the JadeMultiWorkerTcpConnection class reads binary data from the connection and returns when the delimiter specified in the delimiter parameter is found in the data stream. Use this method if you use delimiters as an end-of-message mechanism as part of your communications protocol so that you do not have to read a character at a time and scan or handle your own data buffering.

You can use the maxLength parameter to specify a maximum read size if the specified delimiter cannot be found. (A value of zero (0) indicates that there is no maximum read size.)

This method can be called only when the value of the state property is Connected.

If the value of the timeout property is not zero (0), the read operation can terminate with an exception and return less than the specified length.

The delimiter is not included in the returned data.