Back to Seed Clases

Gio

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gio.IOStream

Class Gio.IOStream

Import line:	Gio = imports.gi.Gio;
GIR File:	Gio-2.0.gir
C documentation:	GIOStream
Class :	IOStream
Subclasses:	Gio.FileIOStream
Extends:	GObject.Object

GIOStream represents an object that has both read and write streams.
Generally the two streams acts as separate input and output streams,
but they share some common resources and state. For instance, for
seekable streams they may use the same position in both streams.
Examples of GIOStream objects are GSocketConnection which represents
a two-way network connection, and GFileIOStream which represent a
file handle opened in read-write mode.
To do the actual reading and writing you need to get the substreams
with g_io_stream_get_input_stream() and g_io_stream_get_output_stream().
The GIOStream object owns the input and the output streams, not the other
way around, so keeping the substreams alive will not keep the GIOStream
object alive. If the GIOStream object is freed it will be closed, thus
closing the substream, so even if the substreams stay alive they will
always just return a G_IO_ERROR_CLOSED for all operations.
To close a stream use g_io_stream_close() which will close the common
stream object and also the individual substreams. You can also close
the substreams themselves. In most cases this only marks the
substream as closed, so further I/O on it fails. However, some streams
may support "half-closed" states where one direction of the stream
is actually shut down.

Properties
Properties		Defined By
	closed : gboolean	Gio.IOStream
	input_stream : Gio.InputStream read only	Gio.IOStream
	output_stream : Gio.OutputStream read only	Gio.IOStream
	parent_instance : GObject.Object read only	Gio.IOStream
	priv : Gio.IOStreamPrivate read only	Gio.IOStream

Methods / Constructors
Method / Constructor		Defined By
	new Gio.IOStream (Object *properties) Create a new Gio.IOStream Create a new Gio.IOStream Parameters: Object properties*
	Gio.IOStream.splice_finish (AsyncResult *result) : gboolean Finishes an asynchronous io stream splice operation. Finishes an asynchronous io stream splice operation. Parameters: Gio.AsyncResult result* Required (not null) a GAsyncResult. Returns: gboolean TRUE on success, FALSE otherwise.	Gio.IOStream
	clear_pending () : none Clears the pending flag on stream. Clears the pending flag on stream. Returns: none	Gio.IOStream
	close (Cancellable *cancellable) : gboolean Closes the stream, releasing resources related to it. 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. Parameters: Gio.Cancellable cancellable optional GCancellable object, NULL to ignore Returns: gboolean TRUE on success, FALSE on failure	Gio.IOStream
	close_async (gint32 *io_priority, Cancellable cancellable, Function callback, void *user_data) : none Requests an asynchronous close of the stream, releasing resources related to it. 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. Parameters: gint32 io_priority Required (not null) the io priority of the request Gio.Cancellable cancellable optional cancellable object Function (Object *source_object, AsyncResult res, void *user_data) : none Required (not null) callback to call when the request is satisfied void user_data Required (not null) the data to pass to callback function Returns: none	Gio.IOStream
	close_finish (AsyncResult *result) : gboolean Closes a stream. Closes a stream. Parameters: Gio.AsyncResult result* Required (not null) a GAsyncResult Returns: gboolean TRUE if stream was successfully closed, FALSE otherwise.	Gio.IOStream
	get_input_stream () : Gio.InputStream Gets the input stream for this object. Gets the input stream for this object. This is used for reading. Do not free. Returns: Gio.InputStream a GInputStream, owned by the GIOStream.	Gio.IOStream
	get_output_stream () : Gio.OutputStream Gets the output stream for this object. Gets the output stream for this object. This is used for writing. Do not free. Returns: Gio.OutputStream a GOutputStream, owned by the GIOStream.	Gio.IOStream
	has_pending () : gboolean Checks if a stream has pending actions. Checks if a stream has pending actions. Returns: gboolean TRUE if stream has pending actions.	Gio.IOStream
	is_closed () : gboolean Checks if a stream is closed. Checks if a stream is closed. Returns: gboolean TRUE if the stream is closed.	Gio.IOStream
	set_pending () : gboolean Sets stream to have actions pending. Sets stream to have actions pending. If the pending flag is already set or stream is closed, it will return FALSE and set Returns: gboolean TRUE if pending was previously unset and is now set.	Gio.IOStream
	splice_async (IOStream *stream2, IOStreamSpliceFlags flags, gint32 io_priority, Cancellable cancellable, Function callback, void *user_data) : none Asyncronously splice the output stream of stream1 to the input stream of When the operation is finished callback* will be called. Asyncronously splice the output stream of stream1 to the input stream of 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. Parameters: Gio.IOStream stream2 Required (not null) a GIOStream. Gio.IOStreamSpliceFlags flags Required (not null) a set of GIOStreamSpliceFlags. gint32 io_priority Required (not null) the io priority of the request. Gio.Cancellable cancellable optional GCancellable object, NULL to ignore. Function (Object *source_object, AsyncResult res, void *user_data) : none Required (not null) a GAsyncReadyCallback. void user_data Required (not null) user data passed to callback. Returns: none	Gio.IOStream

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gio Method	Gio.dbus_address_get_stream_finish (AsyncResult *res, String out_guid*) : Gio.IOStream Finishes an operation started with g_dbus_address_get_stream().
Gio Method	Gio.dbus_address_get_stream_sync (String *address, String out_guid, Cancellable cancellable) : Gio.IOStream Synchronously connects to an endpoint specified by address* and sets up the connection so it is in a state to run the client-side of the D-Bus authentication conversation.
Gio.DBusAuthObserver Signal	authorize_authenticated_peer (DBusAuthObserver *self, IOStream stream, Credentials credentials*) : gboolean Emitted to check if a peer that is successfully authenticated is authorized.
Gio.DBusAuthObserver Method	authorize_authenticated_peer (IOStream *stream, Credentials credentials) : gboolean Emits the GDBusAuthObserver::authorize-authenticated-peer signal on observer*.
Gio.DBusConnection Property	stream : Gio.IOStream The underlying GIOStream used for I/O.
Gio.DBusConnection Method	new Gio.DBusConnection.sync (IOStream *stream, String guid, DBusConnectionFlags flags, DBusAuthObserver observer, Cancellable cancellable*) : Gio.DBusConnection Create a new Gio.DBusConnection
Gio.DBusConnection Method	Gio.DBusConnection.c_new (IOStream *stream, String guid, DBusConnectionFlags flags, DBusAuthObserver observer, Cancellable cancellable, Function callback, void *user_data) : none Asynchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by stream*.
Gio.DBusConnection Method	get_stream () : Gio.IOStream Gets the underlying stream used for IO.
Gio.Proxy Method	connect (IOStream *connection, ProxyAddress proxy_address, Cancellable cancellable) : Gio.IOStream Given connection* to communicate with a proxy (eg, a GSocketConnection that is connected to the proxy server), this does the necessary handshake to connect to proxy_address, and if required, wraps the GIOStream to handle proxy payload.
Gio.Proxy Method	connect_async (IOStream *connection, ProxyAddress proxy_address, Cancellable cancellable, Function callback, void *user_data*) : none Asynchronous version of g_proxy_connect().
Gio.Proxy Method	connect_finish (AsyncResult *result*) : Gio.IOStream See g_proxy_connect().
Gio.TcpWrapperConnection Property	base_io_stream : Gio.IOStream
Gio.TcpWrapperConnection Method	new Gio.TcpWrapperConnection.c_new (IOStream *base_io_stream, Socket socket*) : Gio.SocketConnection Create a new Gio.TcpWrapperConnection
Gio.TcpWrapperConnection Method	get_base_io_stream () : Gio.IOStream Get's conn's base GIOStream
Gio.TlsConnection Property	base_io_stream : Gio.IOStream The GIOStream that the connection wraps