Gio.UnixOutputStream

g GObject.GInterface GObject.GInterface Gio.FileDescriptorBased Gio.FileDescriptorBased GObject.GInterface->Gio.FileDescriptorBased Gio.PollableOutputStream Gio.PollableOutputStream GObject.GInterface->Gio.PollableOutputStream GObject.Object GObject.Object Gio.OutputStream Gio.OutputStream GObject.Object->Gio.OutputStream Gio.UnixOutputStream Gio.UnixOutputStream Gio.FileDescriptorBased->Gio.UnixOutputStream Gio.OutputStream->Gio.UnixOutputStream Gio.PollableOutputStream->Gio.UnixOutputStream

Subclasses:

None

Methods

Inherited:

Gio.OutputStream (29), GObject.Object (37), Gio.FileDescriptorBased (1), Gio.PollableOutputStream (5)

Structs:

GObject.ObjectClass (5)

class

new (fd, close_fd)

get_close_fd ()

get_fd ()

set_close_fd (close_fd)

Virtual Methods

Inherited:

Gio.OutputStream (15), GObject.Object (7), Gio.FileDescriptorBased (1), Gio.PollableOutputStream (5)

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.OutputStream

r

Class Details

class Gio.UnixOutputStream(**kwargs)
Bases:

Gio.OutputStream, Gio.FileDescriptorBased, Gio.PollableOutputStream

Abstract:

No

Structure:

Gio.UnixOutputStreamClass

GUnixOutputStream implements [class`Gio`.OutputStream] for writing to 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/gunixoutputstream.h> belongs to the UNIX-specific GIO interfaces, thus you have to use the gio-unix-2.0.pc pkg-config file file or the GioUnix-2.0 GIR namespace when using it.

classmethod new(fd, close_fd)[source]
Parameters:
  • fd (int) – a UNIX file descriptor

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

Returns:

a new Gio.OutputStream

Return type:

Gio.OutputStream

Creates a new Gio.UnixOutputStream for the given fd.

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

get_close_fd()[source]
Returns:

True if the file descriptor is closed when done

Return type:

bool

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

New in version 2.20.

get_fd()[source]
Returns:

The file descriptor of self

Return type:

int

Return the UNIX file descriptor that the stream writes to.

New in version 2.20.

set_close_fd(close_fd)[source]
Parameters:

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

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

New in version 2.20.

Property Details

Gio.UnixOutputStream.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.

Gio.UnixOutputStream.props.fd
Name:

fd

Type:

int

Default Value:

-1

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The file descriptor that the stream writes to.

New in version 2.20.