stream_receive_utf16_char :: Quanser C Functions

navigation bar

stream_receive_utf16_char

Receives a full UTF-16 character over a client stream.

Description

This function receives a full UTF-16 character over a client stream. Since UTF-16 characters are variable-sized and may be up to two code units (words) long, this function may return between 1 or 2 words, extracting a complete UTF-16 character from the input stream. The return value is the number of code units (words) stored in the buffer.

If the buffer is too small for the UTF-16 character (possible if last character does not fit in buffer) then -QERR_BUFFER_TOO_SMALL is returned and nothing is read from the input stream. Hence, a subsequent call with a larger buffer can succeed in reading the UTF-16 character.

If an illegal UTF-8 character is encountered then -QERR_ILLEGAL_UTF8_CHARACTER is returned. If the lead byte was valid then the number of bytes indicated by the lead byte (1-4) are removed from the input stream. If the lead byte was not valid then only the invalid lead byte is removed from the input stream.

If an illegal UTF-16 character is encountered then -QERR_ILLEGAL_UTF16_CHARACTER is returned. If the lead code unit was valid then the number of words indicated by the lead code unit (1-2) are removed from the input stream. If the lead code unit was not valid then only the invalid lead code unit is removed from the input stream.

If an illegal UTF-32 character is encountered then -QERR_ILLEGAL_UTF32_CHARACTER is returned. The invalid character is removed from the input stream.

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 that it receives before storing them in the given buffer. Note that stream_set_character_format changes the swap bytes setting of the stream if the STREAM_FORMAT_AUTO format is used and it detects a different byte order in the UTF byte-order marker (BOM).

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 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 a character 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 the number of characters received.

If the connection has been closed gracefully then it returns 0 only if there are fewer bytes left to receive than the size of a character. Otherwise it returns the number of characters read before the connection closed. Once there are fewer bytes left to receive than the size of a character then it will return 0 to indicate the connection has been closed. Use stream_receive to receive any remaining bytes if required. If an error occurs, then it returns a negative error code.

This function does not support two threads receiving 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 received.

The BSD socket API has no equivalent to this function.

Prototype

t_int
stream_receive_utf16_char(t_stream stream, t_utf16_char * buffer, t_int max_code_units);

Parameters

t_stream stream

A client stream established using stream_connect or stream_accept.

t_utf16_char * buffer

A pointer to an array of t_utf16_char's in which the received character will be stored. This buffer should contain at least 2 elements to ensure that a full UTF-16 character is received (UTF-16 characters may be up to 2 code units or words in length).

t_int max_code_units

The size of the buffer in code units (bytes).

Return value

The number of characters received, which may be less than the requested number for non-blocking streams. If fewer bytes than the size of a character are 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