stream_receive_uint16
Receives a 16-bit unsigned integer from a stream.
[data, would_block] = stream_receive_uint16(stream)
This function receives a single 16-bit unsigned integer over a client stream.
If stream_listen or 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 16-bit integer 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 stream_listen or 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 stream_poll function may be used with the 'receive' flag to determine when data becomes available. Otherwise it returns the 16-bit integer received.
This operation is not valid on listening streams created using stream_listen.
stream
Stream handle returned by stream_connect or stream_accept.
data
The 16-bit integer received, as an uint16. 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.
would_block
Whether the function would have blocked. Always false for blocking streams.
data = stream_receive_uint16(stream); % Receive one 16-bit unsigned integer
See Also
Copyright ©2024 Quanser Inc. This page was generated 2024-10-17. Submit feedback to Quanser about this page.
Link to this page.