GioUnix.InputStream

Subclasses:

None

Methods

Inherited:

Gio.InputStream (19), GObject.Object (37), Gio.PollableInputStream (4), GioUnix.FileDescriptorBased (1)

Structs:

GObject.ObjectClass (5)

class	get_close_fd (stream)
class	get_fd (stream)
class	new (fd, close_fd)
class	set_close_fd (stream, close_fd)

Virtual Methods

Inherited:

Gio.InputStream (9), GObject.Object (7), Gio.PollableInputStream (4)

Properties

Name	Type	Flags	Short Description
close-fd	bool	r/w
fd	int	r/w/co

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent_instance	Gio.InputStream	r

Class Details

class GioUnix.InputStream(**kwargs)

Bases:

Gio.InputStream, Gio.PollableInputStream, GioUnix.FileDescriptorBased

Abstract:

No

Structure:

GioUnix.InputStreamClass

GUnixInputStream implements [class`Gio`.InputStream] for reading from a UNIX file descriptor, including asynchronous operations. (If the file descriptor refers to a socket or pipe, this will use poll() to do asynchronous I/O. If it refers to a regular file, it will fall back to doing asynchronous I/O in another thread.)

Note that <gio/gunixinputstream.h> belongs to the UNIX-specific GIO interfaces, thus you have to use the gio-unix-2.0.pc pkg-config file or the GioUnix-2.0 GIR namespace when using it.

classmethod get_close_fd(stream)

Parameters:

stream (Gio.UnixInputStream) – a GioUnix.InputStream

Returns:

True if the file descriptor is closed when done

Return type:

bool

Returns whether the file descriptor of stream will be closed when the stream is closed.

New in version 2.20.

classmethod get_fd(stream)

Parameters:

stream (Gio.UnixInputStream) – a GioUnix.InputStream

Returns:

The file descriptor of stream

Return type:

int

Return the UNIX file descriptor that the stream reads from.

New in version 2.20.

classmethod new(fd, close_fd)

Parameters:

• fd (int) – a UNIX file descriptor

• close_fd (bool) – True to close the file descriptor when done

Returns:

a new GioUnix.InputStream

Return type:

Gio.InputStream

Creates a new GioUnix.InputStream for the given fd.

If close_fd is True, the file descriptor will be closed when the stream is closed.

classmethod set_close_fd(stream, close_fd)

Parameters:

• stream (Gio.UnixInputStream) – a GioUnix.InputStream

• close_fd (bool) – True to close the file descriptor when done

Sets whether the file descriptor of stream shall be closed when the stream is closed.

New in version 2.20.

Property Details

GioUnix.InputStream.props.close_fd

Name:

close-fd

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE

Whether to close the file descriptor when the stream is closed.

New in version 2.20.

GioUnix.InputStream.props.fd

Name:

fd

Type:

int

Default Value:

-1

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The file descriptor that the stream reads from.

New in version 2.20.