quanser.communications.stream.receive_uint16s

navigation bar

Receives an array of 16-bit unsigned integer data from a stream.

Syntax

        [data, would_block] = stream.receive_uint16s(num_uint16s)

Description

This function receives data over a client stream. It attempts to receive num_uint16s 16-bit unsigned integers from the communication channel.

If quanser.communications.stream.listen or quanser.communications.stream.connect was called with the non-blocking flag set to false (0), then this function blocks until all the data is read. If the connection has been closed gracefully then it returns an empty array only once there is no more data to receive. Otherwise it returns the array of 16-bit integers read before the connection closed. Once all the data in the stream buffer is exhausted it will return an empty array to indicate the connection has been closed. If an error occurs, then it issues an error message.

If quanser.communications.stream.listen or quanser.communications.stream.connect was called with the non-blocking flag set to true (1), then this function does not block. If no data is available at all then it returns would_block equal to true. In this case, the poll function may be used with the 'receive' flag to determine when data becomes available. Otherwise it returns the array of 16-bit integers received.

The BSD socket API has no equivalent function.

This operation is not valid on listening streams created using quanser.communications.stream.listen.

Parameters

stream

Stream handle returned by quanser.communications.stream.connect or accept.

num_uint16s

The number of uint16s to receive.

Outputs

data

An array of uint16's containing the 16-bit integers received. For blocking streams, if this array is empty then the connection has been closed gracefully. For non-blocking streams, would_block must also be false to indicate closure. The array may have fewer than num_uint16s elements if the stream is non-blocking or the connection was closed and these were the remaining 16-bit integers.

would_block

Whether the function would have blocked. Always false for blocking streams.

Examples

data = stream.receive_uint16s(1000);    % Receive 1000 16-bit unsigned integers