stream_peek_short_array :: Quanser C Functions

navigation bar

stream_peek_short_array

Peeks ahead in the input stream to read an array of short (16-bit) integers from a client stream.

Description

This function peeks ahead in the input stream to read an array of short (16-bit) integers from a client stream. It either peeks all of the array or none of it. If the stream has been configured to swap bytes using stream_set_swap_bytes or stream_set_byte_order then this function will swap the order of the bytes within each element that it peeks before storing them in the given buffer.

The stream_peek_begin function must be called to initialize the peek state. No data peeked will be removed from the input stream until stream_peek_end is called. If stream_peek_end is not called before the next stream_peek_begin then the peeked data is read again.

See the stream_peek_begin function for more information and an example.

The size of the stream receive buffer must be at least num_elements * sizeof(t_short) bytes in length.

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 peeked. Blocking may occur because data may be read from the underlying communication channel. However, the contents of stream buffer are never overwritten until stream_peek_end is called to indicate that the peeked data may be removed from the input stream.

If stream_listen or stream_connect was called with the non-blocking flag set to true (1), then this function does not block. If fewer bytes are available then the size of the entire array then it returns -QERR_WOULD_BLOCK. In this case, the stream_poll function may be used with the STREAM_POLL_RECEIVE flag to determine when data becomes available. Otherwise it returns 1.

If the connection has been closed gracefully then it returns 0 only if there are fewer bytes left to peek than the size of the entire array. Otherwise it returns 1. Once there are fewer bytes left to peek than the size of the entire array then it will return 0 to indicate the connection has been closed. Use stream_peek to peek any remaining bytes if required. If an error occurs, then it returns a negative error code.

This function does not support two threads peeking data at the same time. However, data may be sent or the stream flushed by another thread at the same time as data is being peeked.

The BSD socket API has no equivalent to this function.

Prototype

t_int
stream_peek_short_array(t_stream stream, t_stream_peek_state * state, t_short * buffer, t_int num_elements);

Parameters

t_stream stream

A client stream established using stream_connect or stream_accept.

t_stream_peek_state * state

The "peek state" initialized using stream_peek_begin.

t_short * buffer

A pointer to an array of short integers in which the peeked data will be stored. It must be at least num_elements in length.

t_int num_elements

The number of elements to peek.

Return value

Returns 1 on success. If not enough data is available and the connection has been closed gracefully then 0 is returned. If an error occurs then a negative error code is returned.

Error codes

This function does not return any error code.

Requirements

Include Files	Libraries
quanser_stream.h	quanser_communications.lib;quanser_runtime.lib;quanser_common.lib