Back to Seed Clases

Gio

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gio.IOStream
Gio.SocketConnection
Gio.UnixConnection

Class Gio.UnixConnection

Import line:	Gio = imports.gi.Gio;
GIR File:	Gio-2.0.gir
C documentation:	GUnixConnection
Class :	UnixConnection
Extends:	Gio.SocketConnection

This is the subclass of GSocketConnection that is created
for UNIX domain sockets.
It contains functions to do some of the UNIX socket specific
functionality like passing file descriptors.
Note that <gio/gunixconnection.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.

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 : Gio.SocketConnection read only	Gio.UnixConnection
	priv : Gio.UnixConnectionPrivate read only	Gio.UnixConnection
	socket : Gio.Socket	Gio.SocketConnection

Methods / Constructors
Method / Constructor		Defined By
	new Gio.UnixConnection (Object *properties) Create a new Gio.UnixConnection Create a new Gio.UnixConnection Parameters: Object properties*
	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_local_address () : Gio.SocketAddress Try to get the local address of a socket connection. Try to get the local address of a socket connection. Free the returned object with g_object_unref(). Returns: Gio.SocketAddress a GSocketAddress or NULL on error.	Gio.SocketConnection
	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
	get_remote_address () : Gio.SocketAddress Try to get the remote address of a socket connection. Try to get the remote address of a socket connection. Free the returned object with g_object_unref(). Returns: Gio.SocketAddress a GSocketAddress or NULL on error.	Gio.SocketConnection
	get_socket () : Gio.Socket Gets the underlying GSocket object of the connection. Gets the underlying GSocket object of the connection. This can be useful if you want to do something unusual on it not supported by the GSocketConnection APIs. Returns: Gio.Socket a GSocketAddress or NULL on error.	Gio.SocketConnection
	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
	receive_credentials (Cancellable *cancellable) : Gio.Credentials Receives credentials from the sending end of the connection. Receives credentials from the sending end of the connection. The sending end has to call g_unix_connection_send_credentials() (or similar) for this to work. As well as reading the credentials this also reads (and discards) a single byte from the stream, as this is required for credentials passing to work on some implementations. Other ways to exchange credentials with a foreign peer includes the GUnixCredentialsMessage* type and g_socket_get_credentials() function. g_object_unref()), NULL if error is set. Parameters: Gio.Cancellable cancellable A GCancellable or NULL. Returns: Gio.Credentials Received credentials on success (free with	Gio.UnixConnection
	receive_fd (Cancellable *cancellable) : gint32 Receives a file descriptor from the sending end of the connection. Receives a file descriptor from the sending end of the connection. The sending end has to call g_unix_connection_send_fd() for this to work. As well as reading the fd this also reads a single byte from the stream, as this is required for fd passing to work on some implementations. Parameters: Gio.Cancellable cancellable* optional GCancellable object, NULL to ignore Returns: gint32 a file descriptor on success, -1 on error.	Gio.UnixConnection
	send_credentials (Cancellable *cancellable) : gboolean Passes the credentials of the current user the receiving side of the connection. Passes the credentials of the current user the receiving side of the connection. The recieving end has to call g_unix_connection_receive_credentials() (or similar) to accept the credentials. As well as sending the credentials this also writes a single NUL byte to the stream, as this is required for credentials passing to work on some implementations. Other ways to exchange credentials with a foreign peer includes the GUnixCredentialsMessage* type and g_socket_get_credentials() function. Parameters: Gio.Cancellable cancellable A GCancellable or NULL. Returns: gboolean TRUE on success, FALSE if error is set.	Gio.UnixConnection
	send_fd (gint32 fd, Cancellable *cancellable) : gboolean Passes a file descriptor to the recieving side of the connection. Passes a file descriptor to the recieving side of the connection. The recieving end has to call g_unix_connection_receive_fd() to accept the file descriptor. As well as sending the fd this also writes a single byte to the stream, as this is required for fd passing to work on some implementations. Parameters: gint32 fd Required (not null) a file descriptor Gio.Cancellable cancellable* optional GCancellable object, NULL to ignore. Returns: gboolean a TRUE on success, NULL on error.	Gio.UnixConnection
	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