|
Packit |
ae235b |
|
|
Packit |
ae235b |
<html>
|
|
Packit |
ae235b |
<head>
|
|
Packit |
ae235b |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
ae235b |
<title>GIOStream: GIO Reference Manual</title>
|
|
Packit |
ae235b |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
|
Packit |
ae235b |
<link rel="home" href="index.html" title="GIO Reference Manual">
|
|
Packit |
ae235b |
<link rel="up" href="streaming.html" title="Streaming I/O">
|
|
Packit |
ae235b |
<link rel="prev" href="GOutputStream.html" title="GOutputStream">
|
|
Packit |
ae235b |
<link rel="next" href="GSimpleIOStream.html" title="GSimpleIOStream">
|
|
Packit |
ae235b |
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
|
|
Packit |
ae235b |
<link rel="stylesheet" href="style.css" type="text/css">
|
|
Packit |
ae235b |
</head>
|
|
Packit |
ae235b |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Top |
|
|
Packit |
ae235b |
Description |
|
|
Packit |
ae235b |
Object Hierarchy |
|
|
Packit |
ae235b |
Properties
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
GIOStream
|
|
Packit |
ae235b |
GIOStream — Base class for implementing read/write streams
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Functions
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
GInputStream *
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_get_input_stream ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
GOutputStream *
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_get_output_stream ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_splice_async ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_splice_finish ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_close ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_close_async ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_close_finish ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_is_closed ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_has_pending ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_set_pending ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_clear_pending ()
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Properties
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
closed
|
|
Packit |
ae235b |
Read
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
GInputStream *
|
|
Packit |
ae235b |
input-stream
|
|
Packit |
ae235b |
Read
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
GOutputStream *
|
|
Packit |
ae235b |
output-stream
|
|
Packit |
ae235b |
Read
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Types and Values
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
enum
|
|
Packit |
ae235b |
GIOStreamSpliceFlags
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
GIOStream
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Object Hierarchy
|
|
Packit |
ae235b |
GObject
|
|
Packit |
ae235b |
╰── GIOStream
|
|
Packit |
ae235b |
├── GFileIOStream
|
|
Packit |
ae235b |
├── GSimpleIOStream
|
|
Packit |
ae235b |
├── GSocketConnection
|
|
Packit |
ae235b |
╰── GTlsConnection
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Includes
|
|
Packit |
ae235b |
#include <gio/gio.h>
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Description
|
|
Packit |
ae235b |
GIOStream represents an object that has both read and write streams.
|
|
Packit |
ae235b |
Generally the two streams act as separate input and output streams,
|
|
Packit |
ae235b |
but they share some common resources and state. For instance, for
|
|
Packit |
ae235b |
seekable streams, both streams may use the same position.
|
|
Packit |
ae235b |
Examples of GIOStream objects are GSocketConnection, which represents
|
|
Packit |
ae235b |
a two-way network connection; and GFileIOStream, which represents a
|
|
Packit |
ae235b |
file handle opened in read-write mode.
|
|
Packit |
ae235b |
To do the actual reading and writing you need to get the substreams
|
|
Packit |
ae235b |
with g_io_stream_get_input_stream() and g_io_stream_get_output_stream().
|
|
Packit |
ae235b |
The GIOStream object owns the input and the output streams, not the other
|
|
Packit |
ae235b |
way around, so keeping the substreams alive will not keep the GIOStream
|
|
Packit |
ae235b |
object alive. If the GIOStream object is freed it will be closed, thus
|
|
Packit |
ae235b |
closing the substreams, so even if the substreams stay alive they will
|
|
Packit |
ae235b |
always return G_IO_ERROR_CLOSED for all operations.
|
|
Packit |
ae235b |
To close a stream use g_io_stream_close() which will close the common
|
|
Packit |
ae235b |
stream object and also the individual substreams. You can also close
|
|
Packit |
ae235b |
the substreams themselves. In most cases this only marks the
|
|
Packit |
ae235b |
substream as closed, so further I/O on it fails but common state in the
|
|
Packit |
ae235b |
GIOStream may still be open. However, some streams may support
|
|
Packit |
ae235b |
"half-closed" states where one direction of the stream is actually shut down.
|
|
Packit |
ae235b |
Operations on GIOStreams cannot be started while another operation on the
|
|
Packit |
ae235b |
GIOStream or its substreams is in progress. Specifically, an application can
|
|
Packit |
ae235b |
read from the GInputStream and write to the GOutputStream simultaneously
|
|
Packit |
ae235b |
(either in separate threads, or as asynchronous operations in the same
|
|
Packit |
ae235b |
thread), but an application cannot start any GIOStream operation while there
|
|
Packit |
ae235b |
is a GIOStream, GInputStream or GOutputStream operation in progress, and
|
|
Packit |
ae235b |
an application can’t start any GInputStream or GOutputStream operation
|
|
Packit |
ae235b |
while there is a GIOStream operation in progress.
|
|
Packit |
ae235b |
This is a product of individual stream operations being associated with a
|
|
Packit |
ae235b |
given GMainContext (the thread-default context at the time the operation was
|
|
Packit |
ae235b |
started), rather than entire streams being associated with a single
|
|
Packit |
ae235b |
GMainContext.
|
|
Packit |
ae235b |
GIO may run operations on GIOStreams from other (worker) threads, and this
|
|
Packit |
ae235b |
may be exposed to application code in the behaviour of wrapper streams, such
|
|
Packit |
ae235b |
as GBufferedInputStream or GTlsConnection. With such wrapper APIs,
|
|
Packit |
ae235b |
application code may only run operations on the base (wrapped) stream when
|
|
Packit |
ae235b |
the wrapper stream is idle. Note that the semantics of such operations may
|
|
Packit |
ae235b |
not be well-defined due to the state the wrapper stream leaves the base
|
|
Packit |
ae235b |
stream in (though they are guaranteed not to crash).
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Functions
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_get_input_stream ()
|
|
Packit |
ae235b |
GInputStream *
|
|
Packit |
ae235b |
g_io_stream_get_input_stream (GIOStream *stream);
|
|
Packit |
ae235b |
Gets the input stream for this object. This is used
|
|
Packit |
ae235b |
for reading.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
stream
|
|
Packit |
ae235b |
a GIOStream
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
a GInputStream, owned by the GIOStream.
|
|
Packit |
ae235b |
Do not free.
|
|
Packit |
ae235b |
[transfer none]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.22
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_get_output_stream ()
|
|
Packit |
ae235b |
GOutputStream *
|
|
Packit |
ae235b |
g_io_stream_get_output_stream (GIOStream *stream);
|
|
Packit |
ae235b |
Gets the output stream for this object. This is used for
|
|
Packit |
ae235b |
writing.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
stream
|
|
Packit |
ae235b |
a GIOStream
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
a GOutputStream, owned by the GIOStream.
|
|
Packit |
ae235b |
Do not free.
|
|
Packit |
ae235b |
[transfer none]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.22
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_splice_async ()
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
g_io_stream_splice_async (GIOStream *stream1,
|
|
Packit |
ae235b |
GIOStream *stream2,
|
|
Packit |
ae235b |
GIOStreamSpliceFlags flags,
|
|
Packit |
ae235b |
int io_priority,
|
|
Packit |
ae235b |
GCancellable *cancellable,
|
|
Packit |
ae235b |
GAsyncReadyCallback callback,
|
|
Packit |
ae235b |
gpointer user_data);
|
|
Packit |
ae235b |
Asyncronously splice the output stream of stream1
|
|
Packit |
ae235b |
to the input stream of
|
|
Packit |
ae235b |
stream2
|
|
Packit |
ae235b |
, and splice the output stream of stream2
|
|
Packit |
ae235b |
to the input stream of
|
|
Packit |
ae235b |
stream1
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
When the operation is finished callback
|
|
Packit |
ae235b |
will be called.
|
|
Packit |
ae235b |
You can then call g_io_stream_splice_finish() to get the
|
|
Packit |
ae235b |
result of the operation.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
stream1
|
|
Packit |
ae235b |
a GIOStream.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
stream2
|
|
Packit |
ae235b |
a GIOStream.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
flags
|
|
Packit |
ae235b |
a set of GIOStreamSpliceFlags.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
io_priority
|
|
Packit |
ae235b |
the io priority of the request.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
cancellable
|
|
Packit |
ae235b |
optional GCancellable object, NULL to ignore.
|
|
Packit |
ae235b |
[nullable]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
callback
|
|
Packit |
ae235b |
a GAsyncReadyCallback.
|
|
Packit |
ae235b |
[scope async]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
user_data
|
|
Packit |
ae235b |
user data passed to callback
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
[closure]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.28
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_splice_finish ()
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
g_io_stream_splice_finish (GAsyncResult *result,
|
|
Packit |
ae235b |
GError **error);
|
|
Packit |
ae235b |
Finishes an asynchronous io stream splice operation.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
result
|
|
Packit |
ae235b |
a GAsyncResult.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
error
|
|
Packit |
ae235b |
a GError location to store the error occurring, or NULL to
|
|
Packit |
ae235b |
ignore.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
TRUE on success, FALSE otherwise.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.28
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_close ()
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
g_io_stream_close (GIOStream *stream,
|
|
Packit |
ae235b |
GCancellable *cancellable,
|
|
Packit |
ae235b |
GError **error);
|
|
Packit |
ae235b |
Closes the stream, releasing resources related to it. This will also
|
|
Packit |
ae235b |
close the individual input and output streams, if they are not already
|
|
Packit |
ae235b |
closed.
|
|
Packit |
ae235b |
Once the stream is closed, all other operations will return
|
|
Packit |
ae235b |
G_IO_ERROR_CLOSED. Closing a stream multiple times will not
|
|
Packit |
ae235b |
return an error.
|
|
Packit |
ae235b |
Closing a stream will automatically flush any outstanding buffers
|
|
Packit |
ae235b |
in the stream.
|
|
Packit |
ae235b |
Streams will be automatically closed when the last reference
|
|
Packit |
ae235b |
is dropped, but you might want to call this function to make sure
|
|
Packit |
ae235b |
resources are released as early as possible.
|
|
Packit |
ae235b |
Some streams might keep the backing store of the stream (e.g. a file
|
|
Packit |
ae235b |
descriptor) open after the stream is closed. See the documentation for
|
|
Packit |
ae235b |
the individual stream for details.
|
|
Packit |
ae235b |
On failure the first error that happened will be reported, but the
|
|
Packit |
ae235b |
close operation will finish as much as possible. A stream that failed
|
|
Packit |
ae235b |
to close will still return G_IO_ERROR_CLOSED for all operations.
|
|
Packit |
ae235b |
Still, it is important to check and report the error to the user,
|
|
Packit |
ae235b |
otherwise there might be a loss of data as all data might not be written.
|
|
Packit |
ae235b |
If cancellable
|
|
Packit |
ae235b |
is not NULL, then the operation can be cancelled by
|
|
Packit |
ae235b |
triggering the cancellable object from another thread. If the operation
|
|
Packit |
ae235b |
was cancelled, the error G_IO_ERROR_CANCELLED will be returned.
|
|
Packit |
ae235b |
Cancelling a close will still leave the stream closed, but some streams
|
|
Packit |
ae235b |
can use a faster close that doesn't block to e.g. check errors.
|
|
Packit |
ae235b |
The default implementation of this method just calls close on the
|
|
Packit |
ae235b |
individual input/output streams.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
stream
|
|
Packit |
ae235b |
a GIOStream
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
cancellable
|
|
Packit |
ae235b |
optional GCancellable object, NULL to ignore.
|
|
Packit |
ae235b |
[nullable]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
error
|
|
Packit |
ae235b |
location to store the error occurring, or NULL to ignore
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
TRUE on success, FALSE on failure
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.22
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_close_async ()
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
g_io_stream_close_async (GIOStream *stream,
|
|
Packit |
ae235b |
int io_priority,
|
|
Packit |
ae235b |
GCancellable *cancellable,
|
|
Packit |
ae235b |
GAsyncReadyCallback callback,
|
|
Packit |
ae235b |
gpointer user_data);
|
|
Packit |
ae235b |
Requests an asynchronous close of the stream, releasing resources
|
|
Packit |
ae235b |
related to it. When the operation is finished callback
|
|
Packit |
ae235b |
will be
|
|
Packit |
ae235b |
called. You can then call g_io_stream_close_finish() to get
|
|
Packit |
ae235b |
the result of the operation.
|
|
Packit |
ae235b |
For behaviour details see g_io_stream_close().
|
|
Packit |
ae235b |
The asynchronous methods have a default fallback that uses threads
|
|
Packit |
ae235b |
to implement asynchronicity, so they are optional for inheriting
|
|
Packit |
ae235b |
classes. However, if you override one you must override all.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
stream
|
|
Packit |
ae235b |
a GIOStream
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
io_priority
|
|
Packit |
ae235b |
the io priority of the request
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
cancellable
|
|
Packit |
ae235b |
optional cancellable object.
|
|
Packit |
ae235b |
[nullable]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
callback
|
|
Packit |
ae235b |
callback to call when the request is satisfied.
|
|
Packit |
ae235b |
[scope async]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
user_data
|
|
Packit |
ae235b |
the data to pass to callback function.
|
|
Packit |
ae235b |
[closure]
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.22
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_close_finish ()
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
g_io_stream_close_finish (GIOStream *stream,
|
|
Packit |
ae235b |
GAsyncResult *result,
|
|
Packit |
ae235b |
GError **error);
|
|
Packit |
ae235b |
Closes a stream.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
stream
|
|
Packit |
ae235b |
a GIOStream
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
result
|
|
Packit |
ae235b |
a GAsyncResult
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
error
|
|
Packit |
ae235b |
a GError location to store the error occurring, or NULL to
|
|
Packit |
ae235b |
ignore
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
TRUE if stream was successfully closed, FALSE otherwise.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.22
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_is_closed ()
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
g_io_stream_is_closed (GIOStream *stream);
|
|
Packit |
ae235b |
Checks if a stream is closed.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
stream
|
|
Packit |
ae235b |
a GIOStream
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
TRUE if the stream is closed.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.22
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_has_pending ()
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
g_io_stream_has_pending (GIOStream *stream);
|
|
Packit |
ae235b |
Checks if a stream has pending actions.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
stream
|
|
Packit |
ae235b |
a GIOStream
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
TRUE if stream
|
|
Packit |
ae235b |
has pending actions.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.22
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_set_pending ()
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
g_io_stream_set_pending (GIOStream *stream,
|
|
Packit |
ae235b |
GError **error);
|
|
Packit |
ae235b |
Sets stream
|
|
Packit |
ae235b |
to have actions pending. If the pending flag is
|
|
Packit |
ae235b |
already set or stream
|
|
Packit |
ae235b |
is closed, it will return FALSE and set
|
|
Packit |
ae235b |
error
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
stream
|
|
Packit |
ae235b |
a GIOStream
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
error
|
|
Packit |
ae235b |
a GError location to store the error occurring, or NULL to
|
|
Packit |
ae235b |
ignore
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Returns
|
|
Packit |
ae235b |
TRUE if pending was previously unset and is now set.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.22
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_io_stream_clear_pending ()
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
g_io_stream_clear_pending (GIOStream *stream);
|
|
Packit |
ae235b |
Clears the pending flag on stream
|
|
Packit |
ae235b |
.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Parameters
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
stream
|
|
Packit |
ae235b |
a GIOStream
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.22
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Types and Values
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
enum GIOStreamSpliceFlags
|
|
Packit |
ae235b |
GIOStreamSpliceFlags determine how streams should be spliced.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Members
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
G_IO_STREAM_SPLICE_NONE
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Do not close either stream.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
G_IO_STREAM_SPLICE_CLOSE_STREAM1
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Close the first stream after
|
|
Packit |
ae235b |
the splice.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
G_IO_STREAM_SPLICE_CLOSE_STREAM2
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Close the second stream after
|
|
Packit |
ae235b |
the splice.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
G_IO_STREAM_SPLICE_WAIT_FOR_BOTH
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Wait for both splice operations to finish
|
|
Packit |
ae235b |
before calling the callback.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Since: 2.28
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
GIOStream
|
|
Packit |
ae235b |
typedef struct _GIOStream GIOStream;
|
|
Packit |
ae235b |
Base class for read-write streams.
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Property Details
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
The “closed” property
|
|
Packit |
ae235b |
“closed” gboolean
|
|
Packit |
ae235b |
Is the stream closed.
|
|
Packit |
ae235b |
Flags: Read
|
|
Packit |
ae235b |
Default value: FALSE
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
The “input-stream” property
|
|
Packit |
ae235b |
“input-stream” GInputStream *
|
|
Packit |
ae235b |
The GInputStream to read from.
|
|
Packit |
ae235b |
Flags: Read
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
The “output-stream” property
|
|
Packit |
ae235b |
“output-stream” GOutputStream *
|
|
Packit |
ae235b |
The GOutputStream to write to.
|
|
Packit |
ae235b |
Flags: Read
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
See Also
|
|
Packit |
ae235b |
GInputStream, GOutputStream
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
Generated by GTK-Doc V1.27
|
|
Packit |
ae235b |
</body>
|
|
Packit |
ae235b |
</html>
|