GATE
C/C++ Framework
|
console stream interface More...
#include <console.h>
Public Member Functions | |
gate_result_t | await_char (gate_char32_t *ptr_char, gate_uint32_t timeout_ms) |
Awaits the availabilty of a character to be read from the input stream or until a timeout is reached. | |
gate_result_t | read_char (gate_char32_t *ptr_char) |
Reads a single input character from the console in a given time range. | |
gate_result_t | write_err (char const *buffer, gate_size_t bufferlength, gate_size_t *written) |
Writes the contents of the given buffer to the error ouput side of the stream. | |
gate_result_t | flush_err () |
Flushes the error output side of the stream. | |
Public Member Functions inherited from gate_resourcestream_t | |
gate_result_t | get_resource (gate_int32_t resource_type, gate_uintptr_t *resource_handle) |
Returns a resouce handle to the requested resource type (GATE_STREAM_RESOURCE_*) | |
Public Member Functions inherited from gate_stream_t | |
gate_result_t | read (char *buffer, gate_size_t bufferlength, gate_size_t *returned) |
Read bytes from stream and stores them in the given buffer. | |
gate_result_t | peek (char *buffer, gate_size_t bufferlength, gate_size_t *returned) |
Tries to read bytes from the stream, but leaves them in its input buffer to be read again. | |
gate_result_t | write (char const *buffer, gate_size_t bufferlength, gate_size_t *written) |
Writes bytes from the given buffer into the stream. | |
gate_result_t | flush () |
Instructs the stream to flush its internal buffers and make current status persistent. | |
Public Member Functions inherited from gate_object_t | |
char const * | get_interface_name () |
Returns on object's interface path name. | |
void | release () |
Decrease object's reference counter, releases the object when count reaches zero. | |
int | retain () |
Increase object's reference counter. |
console stream interface
gate_result_t await_char | ( | gate_char32_t * | ptr_char, |
gate_uint32_t | timeout_ms ) |
Awaits the availabilty of a character to be read from the input stream or until a timeout is reached.
[out] | ptr_char | Pointer to UTF-32 character that is filled with retrieved input |
[in] | timeout_ms | Timeout in milliseconds to wait for and to return GATE_RESULT_TIMEOUT |
gate_result_t read_char | ( | gate_char32_t * | ptr_char | ) |
Reads a single input character from the console in a given time range.
[out] | ptr_char | Pointer to UTF-32 character that is filled with retrieved input |
gate_result_t write_err | ( | char const * | buffer, |
gate_size_t | bufferlength, | ||
gate_size_t * | written ) |
Writes the contents of the given buffer to the error ouput side of the stream.
[in] | buffer | Pointer to buffer thats content is written to error-side of console stream |
[in] | bufferlength | Length of buffer in bytes |
[out] | written | Pointer to variable the amount of bytes that could be written |
gate_result_t flush_err | ( | ) |
Flushes the error output side of the stream.