GLib.SocketConnection – gio-2.0 – Vala Binding Reference

Description:

[ CCode ( type_id = "g_socket_connection_get_type ()" ) ]
[ Version ( since = "2.22" ) ]
public class SocketConnection : IOStream

SocketConnection is a IOStream for a connected socket.

They can be created either by SocketClient when connecting to a host, or by SocketListener when accepting a new client.

The type of the SocketConnection 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 TcpConnection.

Choosing 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 factory_register_type.

To close a SocketConnection, use close. Closing both substreams of the IOStream separately will not close the underlying Socket.

Namespace: GLib

Package: gio-2.0

Content:

Properties:

public Socket socket { get; construct; }

Static methods:

public static SocketConnection factory_create_connection (Socket socket)

Creates a SocketConnection subclass of the right type for this.

public static Type factory_lookup_type (SocketFamily family, SocketType type, int protocol_id)

Looks up the Type to be used when creating socket connections on sockets with the specified family, type and protocol_id.

public static void factory_register_type (Type g_type, SocketFamily family, SocketType type, int protocol)

Looks up the Type to be used when creating socket connections on sockets with the specified family, type and protocol.

Creation methods:

Methods:

public bool connect (SocketAddress address, Cancellable? cancellable = null) throws Error

Connect this to the specified remote address.

public async bool connect_async (SocketAddress address, Cancellable? cancellable = null) throws Error

Asynchronously connect this to the specified remote address.

public SocketAddress get_local_address () throws Error

Try to get the local address of a socket connection.

public SocketAddress get_remote_address () throws Error

Try to get the remote address of a socket connection.

public unowned Socket get_socket ()

Gets the underlying Socket object of the connection.

public bool is_connected ()

Checks if this is connected.

Inherited Members:

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref

SocketConnection