Module: Gio::PollableInputStream

Defined in:
lib/gio2/pollable-input-stream.rb

Overview

GPollableInputStream is implemented by [classGio.InputStream]s 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.

Some classes may implement GPollableInputStream but have only certain instances of that class be pollable. If [methodGio.PollableInputStream.can_poll] returns false, then the behavior of other GPollableInputStream methods is undefined.

Instance Method Summary collapse

Instance Method Details

#can_poll ⇒ Boolean

Checks if stream is actually pollable. Some classes may implement GPollable::InputStream but have only certain instances of that class be pollable. If this method returns false, then the behavior of other GPollable::InputStream 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.

Returns:

  • (Boolean) —

    true if stream is pollable, false if not.

#create_source(&block) ⇒ GLib::Source

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 GPollable::SourceFunc 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.

The behaviour of this method is undefined if g_pollable_input_stream_can_poll() returns false for stream.

Parameters:

Returns:

  • (GLib::Source) —

    a new #GSource



20
21
22
23
24
25
 
# File 'lib/gio2/pollable-input-stream.rb', line 20

def create_source(&block)
  source = create_source_raw
  source.extend(PollableSource)
  source.set_callback(&block)
  source
end

#create_source_raw ⇒ GLib::Source

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 GPollable::SourceFunc 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.

The behaviour of this method is undefined if g_pollable_input_stream_can_poll() returns false for stream.

Parameters:

Returns:

  • (GLib::Source) —

    a new #GSource




# File 'lib/gio2/pollable-input-stream.rb', line 19

#is_readable ⇒ Boolean

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.

The behaviour of this method is undefined if g_pollable_input_stream_can_poll() returns false for stream.

Returns:

  • (Boolean) —

    true if stream is readable, false if not. If an error has occurred on stream, this will result in g_pollable_input_stream_is_readable() returning true, and the next attempt to read will return the error.

#read_nonblocking(size = nil) ⇒ Gio::gssize

Attempts to read up to count 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.

The behaviour of this method is undefined if g_pollable_input_stream_can_poll() returns false for stream.

Parameters:

  • buffer (Array<Integer>) —

    a buffer to read data into (which should be at least count bytes long).

  • count (Integer) —

    the number of bytes you want to read

  • cancellable (Gio::Cancellable) —

    a #GCancellable, or nil

Returns:

  • (Gio::gssize) —

    the number of bytes read, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK).



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/gio2/pollable-input-stream.rb', line 28

def read_nonblocking(size=nil)
  if size.nil?
    all = "".b
    buffer_size = 8192
    buffer = " ".b * buffer_size
    loop do
      begin
        read_bytes = read_nonblocking_raw_compatible(buffer)
      rescue IOError::WouldBlock
        break
      end
      all << buffer.byteslice(0, read_bytes)
      break if read_bytes != buffer_size
    end
    all
  else
    buffer = " ".b * size
    read_bytes = read_nonblocking_raw_compatible(buffer)
    buffer.replace(buffer.byteslice(0, read_bytes))
    buffer
  end
end

#read_nonblocking_raw ⇒ Gio::gssize

Attempts to read up to count 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.

The behaviour of this method is undefined if g_pollable_input_stream_can_poll() returns false for stream.

Parameters:

  • buffer (Array<Integer>) —

    a buffer to read data into (which should be at least count bytes long).

  • count (Integer) —

    the number of bytes you want to read

  • cancellable (Gio::Cancellable) —

    a #GCancellable, or nil

Returns:

  • (Gio::gssize) —

    the number of bytes read, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK).




# File 'lib/gio2/pollable-input-stream.rb', line 27