enum GIOStreamSpliceFlags

typedef enum {
  G_IO_STREAM_SPLICE_NONE          = 0,
  G_IO_STREAM_SPLICE_CLOSE_STREAM1 = (1 << 0),
  G_IO_STREAM_SPLICE_CLOSE_STREAM2 = (1 << 1),
  G_IO_STREAM_SPLICE_WAIT_FOR_BOTH = (1 << 2)
} GIOStreamSpliceFlags;

GIOStreamSpliceFlags determine how streams should be spliced.

Since 2.28

GIOStream

typedef struct _GIOStream GIOStream;

Base class for read-write streams.

g_io_stream_get_input_stream ()

GInputStream *      g_io_stream_get_input_stream        (GIOStream *stream);

Gets the input stream for this object. This is used for reading.

Since 2.22

g_io_stream_get_output_stream ()

GOutputStream *     g_io_stream_get_output_stream       (GIOStream *stream);

Gets the output stream for this object. This is used for writing.

Since 2.22

g_io_stream_splice_async ()

void                g_io_stream_splice_async            (GIOStream *stream1,
                                                         GIOStream *stream2,
                                                         GIOStreamSpliceFlags flags,
                                                         int io_priority,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Asyncronously splice the output stream of stream1 to the input stream of stream2, and splice the output stream of stream2 to the input stream of stream1.

When the operation is finished callback will be called. You can then call g_io_stream_splice_finish() to get the result of the operation.

Since 2.28

g_io_stream_splice_finish ()

gboolean            g_io_stream_splice_finish           (GAsyncResult *result,
                                                         GError **error);

Finishes an asynchronous io stream splice operation.

Since 2.28

g_io_stream_close ()

gboolean            g_io_stream_close                   (GIOStream *stream,
                                                         GCancellable *cancellable,
                                                         GError **error);

Closes the stream, releasing resources related to it. This will also closes the individual input and output streams, if they are not already closed.

Once the stream is closed, all other operations will return G_IO_ERROR_CLOSED. Closing a stream multiple times will not return an error.

Closing a stream will automatically flush any outstanding buffers in the stream.

Streams will be automatically closed when the last reference is dropped, but you might want to call this function to make sure resources are released as early as possible.

Some streams might keep the backing store of the stream (e.g. a file descriptor) open after the stream is closed. See the documentation for the individual stream for details.

On failure the first error that happened will be reported, but the close operation will finish as much as possible. A stream that failed to close will still return G_IO_ERROR_CLOSED for all operations. Still, it is important to check and report the error to the user, otherwise there might be a loss of data as all data might not be written.

If cancellable is not NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error G_IO_ERROR_CANCELLED will be returned. Cancelling a close will still leave the stream closed, but some streams can use a faster close that doesn't block to e.g. check errors.

The default implementation of this method just calls close on the individual input/output streams.

Since 2.22

g_io_stream_close_async ()

void                g_io_stream_close_async             (GIOStream *stream,
                                                         int io_priority,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished callback will be called. You can then call g_io_stream_close_finish() to get the result of the operation.

For behaviour details see g_io_stream_close().

The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all.

Since 2.22

g_io_stream_close_finish ()

gboolean            g_io_stream_close_finish            (GIOStream *stream,
                                                         GAsyncResult *result,
                                                         GError **error);

Closes a stream.

Since 2.22

g_io_stream_is_closed ()

gboolean            g_io_stream_is_closed               (GIOStream *stream);

Checks if a stream is closed.

Since 2.22

g_io_stream_has_pending ()

gboolean            g_io_stream_has_pending             (GIOStream *stream);

Checks if a stream has pending actions.

Since 2.22

g_io_stream_set_pending ()

gboolean            g_io_stream_set_pending             (GIOStream *stream,
                                                         GError **error);

Sets stream to have actions pending. If the pending flag is already set or stream is closed, it will return FALSE and set error.

Since 2.22

g_io_stream_clear_pending ()

void                g_io_stream_clear_pending           (GIOStream *stream);

Clears the pending flag on stream.

Since 2.22

The "closed" property

  "closed"                   gboolean              : Read / Write

Is the stream closed.

Default value: FALSE

The "input-stream" property

  "input-stream"             GInputStream*         : Read

The GInputStream to read from.

The "output-stream" property

  "output-stream"            GOutputStream*        : Read

The GOutputStream to write to.