Back to Seed Clases

Gio

Classes

Interfaces

Structs

Unions

Enums

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

Class Gio.SocketConnection

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

GSocketConnection is a GIOStream for a connected socket. They
can be created either by GSocketClient when connecting to a host,
or by GSocketListener when accepting a new client.
The type of the GSocketConnection object returned from these calls
depends on the type of the underlying socket that is in use. For
instance, for a TCP/IP connection it will be a GTcpConnection.
Chosing what type of object to construct is done with the socket
connection factory, and it is possible for 3rd parties to register
custom socket connection types for specific combination of socket
family/type/protocol using g_socket_connection_factory_register_type().

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

Methods / Constructors
Method / Constructor		Defined By
	new Gio.SocketConnection (Object *properties) Create a new Gio.SocketConnection Create a new Gio.SocketConnection Parameters: Object properties*
	Gio.SocketConnection.factory_lookup_type (SocketFamily *family, SocketType type, gint32 protocol_id) : Number Looks up the GType* to be used when creating socket connections on sockets with the specified family,type and protocol_id. Looks up the GType to be used when creating socket connections on sockets with the specified family,type and protocol_id. If no type is registered, the GSocketConnection base type is returned. Parameters: Gio.SocketFamily family Required (not null) a GSocketFamily Gio.SocketType type Required (not null) a GSocketType gint32 protocol_id Required (not null) a protocol id Returns: Number a GType	Gio.SocketConnection
	Gio.SocketConnection.factory_register_type (Number *g_type, SocketFamily family, SocketType type, gint32 protocol) : none Looks up the GType* to be used when creating socket connections on sockets with the specified family,type and protocol. Looks up the GType to be used when creating socket connections on sockets with the specified family,type and protocol. If no type is registered, the GSocketConnection base type is returned. Parameters: Number g_type Required (not null) a GType, inheriting from G_TYPE_SOCKET_CONNECTION Gio.SocketFamily family Required (not null) a GSocketFamily Gio.SocketType type Required (not null) a GSocketType gint32 protocol Required (not null) a protocol id Returns: none	Gio.SocketConnection
	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
	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.Socket Method	connection_factory_create_connection () : Gio.SocketConnection Creates a GSocketConnection subclass of the right type for
Gio.SocketClient Method	connect (SocketConnectable *connectable, Cancellable cancellable) : Gio.SocketConnection Tries to resolve the connectable* and make a network connection to it.
Gio.SocketClient Method	connect_finish (AsyncResult *result*) : Gio.SocketConnection Finishes an async connect operation.
Gio.SocketClient Method	connect_to_host (String *host_and_port, guint16 default_port, Cancellable cancellable*) : Gio.SocketConnection This is a helper function for g_socket_client_connect().
Gio.SocketClient Method	connect_to_host_finish (AsyncResult *result*) : Gio.SocketConnection Finishes an async connect operation.
Gio.SocketClient Method	connect_to_service (String *domain, String service, Cancellable cancellable*) : Gio.SocketConnection Attempts to create a TCP connection to a service.
Gio.SocketClient Method	connect_to_service_finish (AsyncResult *result*) : Gio.SocketConnection Finishes an async connect operation.
Gio.SocketClient Method	connect_to_uri (String *uri, guint16 default_port, Cancellable cancellable*) : Gio.SocketConnection This is a helper function for g_socket_client_connect().
Gio.SocketClient Method	connect_to_uri_finish (AsyncResult *result*) : Gio.SocketConnection Finishes an async connect operation.
Gio.SocketListener Method	accept (Object *out_values, Cancellable cancellable*) : Gio.SocketConnection Blocks waiting for a client to connect to any of the sockets added to the listener.
Gio.SocketListener Method	accept_finish (AsyncResult *result, Object out_values*) : Gio.SocketConnection Finishes an async accept operation.
Gio.SocketService Signal	incoming (SocketService *self, SocketConnection connection, Object source_object) : gboolean The ::incoming signal is emitted when a new incoming connection to service* needs to be handled.
Gio.ThreadedSocketService Signal	run (ThreadedSocketService *self, SocketConnection connection, Object source_object*) : gboolean The ::run signal is emitted in a worker thread in response to an incoming connection.
TelepathyGLib.StreamTubeConnection Property	socket_connection : Gio.SocketConnection