PollableInputStreamT

Description GPollableInputStream is implemented by GInputStreams that can be polled for readiness to read. This can be used when interfacing with a non-GIO API that expects UNIX-file-descriptor-style asynchronous I/O rather than GIO-style.

Members

Functions

canPoll
int canPoll()

Checks if stream is actually pollable. Some classes may implement GPollableInputStream but have only certain instances of that class be pollable. If this method returns FALSE, then the behavior of other GPollableInputStream methods is undefined. For any given stream, the value returned by this method is constant; a stream cannot switch from pollable to non-pollable or vice versa. Since 2.28

createSource
Source createSource(Cancellable cancellable)

Creates a GSource that triggers when stream can be read, or cancellable is triggered or an error occurs. The callback on the source is of the GPollableSourceFunc type. As with g_pollable_input_stream_is_readable(), it is possible that the stream may not actually be readable even after the source triggers, so you should use g_pollable_input_stream_read_nonblocking() rather than g_input_stream_read() from the callback. Since 2.28

getPollableInputStreamTStruct
GPollableInputStream* getPollableInputStreamTStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
isReadable
int isReadable()

Checks if stream can be read. Note that some stream types may not be able to implement this 100% reliably, and it is possible that a call to g_input_stream_read() after this returns TRUE would still block. To guarantee non-blocking behavior, you should always use g_pollable_input_stream_read_nonblocking(), which will return a G_IO_ERROR_WOULD_BLOCK error rather than blocking. Since 2.28

readNonblocking
gssize readNonblocking(void[] buffer, Cancellable cancellable)

Attempts to read up to size bytes from stream into buffer, as with g_input_stream_read(). If stream is not currently readable, this will immediately return G_IO_ERROR_WOULD_BLOCK, and you can use g_pollable_input_stream_create_source() to create a GSource that will be triggered when stream is readable. Note that since this method never blocks, you cannot actually use cancellable to cancel it. However, it will return an error if cancellable has already been cancelled when you call, which may happen if you call this method after a source triggers due to having been cancelled. Virtual: read_nonblocking

Static functions

gPollableSourceNew
Source gPollableSourceNew(ObjectG pollableStream)

Utility method for GPollableInputStream and GPollableOutputStream implementations. Creates a new GSource that expects a callback of type GPollableSourceFunc. The new source does not actually do anything on its own; use g_source_add_child_source() to add other sources to it to cause it to trigger. Since 2.28

Variables

gPollableInputStream
GPollableInputStream* gPollableInputStream;

the main Gtk struct

Meta