stream_send_int8s :: QUARC MATLAB Functions

navigation bar

stream_send_int8s

Sends an array of 8-bit integer data over a stream.

Syntax

[items_sent, would_block] = stream_send_int8s(stream, values)

Description

This function writes data to the stream buffer. It attempts to store the values array in the stream buffer as an array of 8-bit integers. If there is enough room available in the stream buffer then it stores the data in the buffer and returns immediately. The data is not written to the actual communication channel until the stream is flushed using stream_flush or there is no more room available in the stream buffer. If an error occurs, then it issues an error message. If the connection is closed it is considered an error condition.

If stream_listen or stream_connect was called with the non-blocking flag set to false (0), then this function may block attempting to flush the stream buffer. All the data will be consumed and the total number of elements sent is returned. Some of the data may remain in the stream buffer and not be sent until the next time stream_flush is called or there is no more room available in the stream buffer. If an error occurs then an error is issued and the stream should be closed.

If stream_listen or stream_connect was called with the non-blocking flag set to true (1), then this function does not block. It returns the number of elements sent successfully, which will be between 1 and the number of elements in the values array (unless is empty). If no elements could be sent without blocking, then would_block is set to true (1). If an error occurs then an error is issued and the stream should be closed.

This operation is not valid on listening streams created using stream_listen.

Parameters

stream

Stream handle returned by stream_connect or stream_accept.

values

The values to send. Any numeric datatype may be used but each array element will be cast to an int8 prior to writing the data to the stream.

Outputs

items_sent

The number of array elements actually written to the stream buffer, which may be less than the length of the array for non-blocking streams. For blocking streams, a value of 0 is returned only if the values array is empty.

would_block

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

Examples

values = [5 -2 8 9];
items_sent = stream_send_int8s(stream, values);    % Send four 8-bit integers