GUnixInputStream

GUnixInputStream — Streaming input operations for UNIX file descriptors

Properties

gboolean close-fd Read / Write
gint fd Read / Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── GInputStream
        ╰── GUnixInputStream

Implemented Interfaces

GUnixInputStream implements GPollableInputStream and GFileDescriptorBased.

Includes

#include <gio/gunixinputstream.h>

Description

GUnixInputStream implements GInputStream 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 when using it.

Functions

g_unix_input_stream_new ()

GInputStream *
g_unix_input_stream_new (gint fd,
                         gboolean close_fd);

Creates a new GUnixInputStream for the given fd .

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

Parameters

fd

a UNIX file descriptor

 

close_fd

TRUE to close the file descriptor when done

 

Returns

a new GUnixInputStream


g_unix_input_stream_set_close_fd ()

void
g_unix_input_stream_set_close_fd (GUnixInputStream *stream,
                                  gboolean close_fd);

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

Parameters

stream

a GUnixInputStream

 

close_fd

TRUE to close the file descriptor when done

 

Since: 2.20


g_unix_input_stream_get_close_fd ()

gboolean
g_unix_input_stream_get_close_fd (GUnixInputStream *stream);

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

Parameters

stream

a GUnixInputStream

 

Returns

TRUE if the file descriptor is closed when done

Since: 2.20


g_unix_input_stream_get_fd ()

gint
g_unix_input_stream_get_fd (GUnixInputStream *stream);

Return the UNIX file descriptor that the stream reads from.

Parameters

stream

a GUnixInputStream

 

Returns

The file descriptor of stream

Since: 2.20

Types and Values

struct GUnixInputStream

struct GUnixInputStream;

Implements GInputStream for reading from selectable unix file descriptors

Property Details

The “close-fd” property

  “close-fd”                 gboolean

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

Flags: Read / Write

Default value: TRUE

Since: 2.20


The “fd” property

  “fd”                       gint

The file descriptor that the stream reads from.

Flags: Read / Write / Construct Only

Default value: -1

Since: 2.20

See Also

GInputStream