glibmm: Gio::SocketClient Class Reference

Helper for connecting to a network service. More...

#include </home/kjell/checkout/gnome/glibmm/gio/giomm/socketclient.h>

Inheritance diagram for Gio::SocketClient:

Public Member Functions

 SocketClient (SocketClient&& src) noexcept
 
SocketClientoperator= (SocketClient&& src) noexcept
 
 ~SocketClient () noexcept override
 
GSocketClient* gobj ()
 Provides access to the underlying C GObject. More...

 
const GSocketClient* gobj () const
 Provides access to the underlying C GObject. More...

 
GSocketClient* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

 
SocketFamily get_family () const
 Gets the socket family of the socket client. More...

 
void set_family (SocketFamily family)
 Sets the socket family of the socket client. More...

 
Socket::Type get_socket_type () const
 Gets the socket type of the socket client. More...

 
void set_socket_type (Socket::Type type)
 Sets the socket type of the socket client. More...

 
Socket::Protocol get_protocol () const
 Gets the protocol name type of the socket client. More...

 
void set_protocol (Socket::Protocol protocol)
 Sets the protocol of the socket client. More...

 
Glib::RefPtr< SocketAddressget_local_address ()
 Gets the local address of the socket client. More...

 
Glib::RefPtr< const SocketAddressget_local_address () const
 Gets the local address of the socket client. More...

 
void set_local_address (const Glib::RefPtr< SocketAddress >& address)
 Sets the local address of the socket client. More...

 
Glib::RefPtr< SocketConnectionconnect (const Glib::RefPtr< SocketConnectable >& connectable, const Glib::RefPtr< Cancellable >& cancellable)
 Tries to resolve the connectable and make a network connection to it. More...

 
Glib::RefPtr< SocketConnectionconnect (const Glib::RefPtr< SocketConnectable >& connectable)
 A connect() convenience overload. More...

 
Glib::RefPtr< SocketConnectionconnect_to_host (const Glib::ustring& host_and_port, guint16 default_port, const Glib::RefPtr< Cancellable >& cancellable)
 This is a helper function for g_socket_client_connect(). More...

 
Glib::RefPtr< SocketConnectionconnect_to_host (const Glib::ustring& host_and_port, guint16 default_port)
 A connect_to_host() convenience overload. More...

 
Glib::RefPtr< SocketConnectionconnect_to_service (const Glib::ustring& domain, const Glib::ustring& service, const Glib::RefPtr< Cancellable >& cancellable)
 Attempts to create a TCP connection to a service. More...

 
Glib::RefPtr< SocketConnectionconnect_to_service (const Glib::ustring& domain, const Glib::ustring& service)
 A connect_to_service() convenience overload. More...

 
Glib::RefPtr< SocketConnectionconnect_to_uri (const Glib::ustring& uri, guint16 default_port, const Glib::RefPtr< Cancellable >& cancellable)
 This is a helper function for g_socket_client_connect(). More...

 
Glib::RefPtr< SocketConnectionconnect_to_uri (const Glib::ustring& uri, guint16 default_port)
 A connect_to_uri() convenience overload. More...

 
void connect_async (const Glib::RefPtr< SocketConnectable >& connectable, const Glib::RefPtr< Cancellable >& cancellable, const SlotAsyncReady& slot)
 This is the asynchronous version of g_socket_client_connect(). More...

 
void connect_async (const Glib::RefPtr< SocketConnectable >& connectable, const SlotAsyncReady& slot)
 This is the asynchronous version of connect(). More...

 
Glib::RefPtr< SocketConnectionconnect_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes an async connect operation. More...

 
void connect_to_host_async (const Glib::ustring& host_and_port, guint16 default_port, const Glib::RefPtr< Cancellable >& cancellable, const SlotAsyncReady& slot)
 This is the asynchronous version of g_socket_client_connect_to_host(). More...

 
void connect_to_host_async (const Glib::ustring& host_and_port, guint16 default_port, const SlotAsyncReady& slot)
 This is the asynchronous version of connect_to_host(). More...

 
Glib::RefPtr< SocketConnectionconnect_to_host_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes an async connect operation. More...

 
void connect_to_service_async (const Glib::ustring& domain, const Glib::ustring& service, const Glib::RefPtr< Cancellable >& cancellable, const SlotAsyncReady& slot)
 This is the asynchronous version of g_socket_client_connect_to_service(). More...

 
void connect_to_service_async (const Glib::ustring& domain, const Glib::ustring& service, const SlotAsyncReady& slot)
 This is the asynchronous version of connect_to_service(). More...

 
Glib::RefPtr< SocketConnectionconnect_to_service_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes an async connect operation. More...

 
void connect_to_uri_async (const Glib::ustring& uri, guint16 default_port, const Glib::RefPtr< Cancellable >& cancellable, const SlotAsyncReady& slot)
 This is the asynchronous version of g_socket_client_connect_to_uri(). More...

 
void connect_to_uri_async (const Glib::ustring& uri, guint16 default_port, const SlotAsyncReady& slot)
 This is the asynchronous version of connect_to_uri(). More...

 
Glib::RefPtr< SocketConnectionconnect_to_uri_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes an async connect operation. More...

 
bool get_enable_proxy () const
 Gets the proxy enable state; see g_socket_client_set_enable_proxy() More...

 
void set_enable_proxy (bool enable)
 Sets whether or not client attempts to make connections via a proxy server. More...

 
bool get_tls () const
 Gets whether client creates TLS connections. More...

 
void set_tls (bool tls=true)
 Sets whether client creates TLS (aka SSL) connections. More...

 
TlsCertificateFlags get_tls_validation_flags () const
 Gets the TLS validation flags used creating TLS connections via client. More...

 
void set_tls_validation_flags (TlsCertificateFlags flags)
 Sets the TLS validation flags used when creating TLS connections via client. More...

 
Glib::RefPtr< ProxyResolverget_proxy_resolver ()
 Gets the ProxyResolver being used by client. More...

 
Glib::RefPtr< const ProxyResolverget_proxy_resolver () const
 Gets the ProxyResolver being used by client. More...

 
void set_proxy_resolver (const Glib::RefPtr< ProxyResolver >& proxy_resolver)
 Overrides the ProxyResolver used by client. More...

 
guint get_timeout () const
 Gets the I/O timeout time for sockets created by client. More...

 
void set_timeout (guint timeout)
 Sets the I/O timeout for sockets created by client. More...

 
void add_application_proxy (const Glib::ustring& protocol)
 Enable proxy protocols to be handled by the application. More...

 
Glib::PropertyProxy< SocketFamilyproperty_family ()
 The sockets address family to use for socket construction. More...

 
Glib::PropertyProxy_ReadOnly< SocketFamilyproperty_family () const
 The sockets address family to use for socket construction. More...

 
Glib::PropertyProxy< Glib::RefPtr< SocketAddress > > property_local_address ()
 The local address constructed sockets will be bound to. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< SocketAddress > > property_local_address () const
 The local address constructed sockets will be bound to. More...

 
Glib::PropertyProxy< Socket::Protocolproperty_protocol ()
 The protocol to use for socket construction, or 0 for default. More...

 
Glib::PropertyProxy_ReadOnly< Socket::Protocolproperty_protocol () const
 The protocol to use for socket construction, or 0 for default. More...

 
Glib::PropertyProxy< Socket::Typeproperty_type ()
 The sockets type to use for socket construction. More...

 
Glib::PropertyProxy_ReadOnly< Socket::Typeproperty_type () const
 The sockets type to use for socket construction. More...

 
Glib::PropertyProxy< guint > property_timeout ()
 The I/O timeout for sockets, or 0 for none. More...

 
Glib::PropertyProxy_ReadOnly< guint > property_timeout () const
 The I/O timeout for sockets, or 0 for none. More...

 
Glib::PropertyProxy< bool > property_enable_proxy ()
 Enable proxy support. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_enable_proxy () const
 Enable proxy support. More...

 
Glib::PropertyProxy< bool > property_tls ()
 Whether to create TLS connections. More...

 
Glib::PropertyProxy_ReadOnly< bool > property_tls () const
 Whether to create TLS connections. More...

 
Glib::PropertyProxy< TlsCertificateFlagsproperty_tls_validation_flags ()
 TLS validation flags to use. More...

 
Glib::PropertyProxy_ReadOnly< TlsCertificateFlagsproperty_tls_validation_flags () const
 TLS validation flags to use. More...

 
Glib::PropertyProxy< Glib::RefPtr< ProxyResolver > > property_proxy_resolver ()
 The proxy resolver to use. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< ProxyResolver > > property_proxy_resolver () const
 The proxy resolver to use. More...

 
Glib::SignalProxy< void(SocketClientEvent, const Glib::RefPtr< SocketConnectable >&, const Glib::RefPtr< IOStream >&)> signal_event ()
 
- Public Member Functions inherited from Glib::Object
 Object (const Object&)=delete
 
Objectoperator= (const Object&)=delete
 
 Object (Object&& src) noexcept
 
Objectoperator= (Object&& src) noexcept
 
void* get_data (const QueryQuark& key)
 
void set_data (const Quark& key, void* data)
 
void set_data (const Quark& key, void* data, DestroyNotify notify)
 
void remove_data (const QueryQuark& quark)
 
void* steal_data (const QueryQuark& quark)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase&)=delete
 
ObjectBaseoperator= (const ObjectBase&)=delete
 
void set_property_value (const Glib::ustring& property_name, const Glib::ValueBase& value)
 You probably want to use a specific property_*() accessor method instead. More...

 
void get_property_value (const Glib::ustring& property_name, Glib::ValueBase& value) const
 You probably want to use a specific property_*() accessor method instead. More...

 
template<class PropertyType >
void set_property (const Glib::ustring& property_name, const PropertyType& value)
 You probably want to use a specific property_*() accessor method instead. More...

 
template<class PropertyType >
void get_property (const Glib::ustring& property_name, PropertyType& value) const
 You probably want to use a specific property_*() accessor method instead. More...

 
template<class PropertyType >
PropertyType get_property (const Glib::ustring& property_name) const
 You probably want to use a specific property_*() accessor method instead. More...

 
sigc::connection connect_property_changed (const Glib::ustring& property_name, const sigc::slot< void()>& slot)
 You can use the signal_changed() signal of the property proxy instead. More...

 
sigc::connection connect_property_changed (const Glib::ustring& property_name, sigc::slot< void()>&& slot)
 You can use the signal_changed() signal of the property proxy instead. More...

 
void freeze_notify ()
 Increases the freeze count on object. More...

 
void thaw_notify ()
 Reverts the effect of a previous call to freeze_notify(). More...

 
virtual void reference () const
 Increment the reference count for this object. More...

 
virtual void unreference () const
 Decrement the reference count for this object. More...

 
GObject* gobj ()
 Provides access to the underlying C GObject. More...

 
const GObject* gobj () const
 Provides access to the underlying C GObject. More...

 
GObject* gobj_copy () const
 Give a ref-ed copy to someone. Use for direct struct access. More...

 
- Public Member Functions inherited from sigc::trackable
 trackable () noexcept
 
 trackable (const trackable &src) noexcept
 
 trackable (trackable &&src) noexcept
 
 ~trackable ()
 
void add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src) noexcept
 
void remove_destroy_notify_callback (notifiable *data) const
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
static Glib::RefPtr< SocketClientcreate ()
 

Protected Member Functions

 SocketClient ()
 
virtual void on_event (SocketClientEvent event, const Glib::RefPtr< SocketConnectable >& connectable, const Glib::RefPtr< IOStream >& connection)
 This is a default handler for the signal signal_event(). More...

 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams& construct_params)
 
 Object (GObject* castitem)
 
 ~Object () noexcept override
 
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 This default constructor is called implicitly from the constructor of user-derived classes, even if, for instance, Gtk::Button calls a different ObjectBase constructor. More...

 
 ObjectBase (const char* custom_type_name)
 A derived constructor always overrides this choice. More...

 
 ObjectBase (const std::type_info& custom_type_info)
 This constructor is a special feature to allow creation of derived types on the fly, without having to use g_object_new() manually. More...

 
 ObjectBase (ObjectBase&& src) noexcept
 
ObjectBaseoperator= (ObjectBase&& src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject* castitem)
 
void initialize_move (GObject* castitem, Glib::ObjectBase* previous_wrapper)
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gio::SocketClientwrap (GSocketClient* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...

 

Additional Inherited Members

- Public Types inherited from Glib::Object
using DestroyNotify = void(*)(gpointer data)
 
- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 
- Public Types inherited from sigc::notifiable
typedef internal::func_destroy_notify func_destroy_notify
 

Detailed Description

Helper for connecting to a network service.

See also
SocketConnection, SocketListener

SocketClient is a high-level utility class for connecting to a network host using a connection oriented socket type.

You create a SocketClient object, set any options you want, then call a sync or async connect operation, which returns a SocketConnection subclass on success.

The type of the SocketConnection object returned depends on the type of the underlying socket that is in use. For instance, for a TCP/IP connection it will be a TcpConnection.

Since glibmm 2.24:

Constructor & Destructor Documentation

Gio::SocketClient::SocketClient ( SocketClient&&  src)
noexcept
Gio::SocketClient::~SocketClient ( )
overridenoexcept
Gio::SocketClient::SocketClient ( )
protected

Member Function Documentation

void Gio::SocketClient::add_application_proxy ( const Glib::ustring protocol)

Enable proxy protocols to be handled by the application.

When the indicated proxy protocol is returned by the ProxyResolver, SocketClient will consider this protocol as supported but will not try to find a Proxy instance to handle handshaking. The application must check for this case by calling g_socket_connection_get_remote_address() on the returned SocketConnection, and seeing if it's a ProxyAddress of the appropriate type, to determine whether or not it needs to handle the proxy handshaking itself.

This should be used for proxy protocols that are dialects of another protocol such as HTTP proxy. It also allows cohabitation of proxy protocols that are reused between protocols. A good example is HTTP. It can be used to proxy HTTP, FTP and Gopher and can also be use as generic socket proxy through the HTTP CONNECT method.

When the proxy is detected as being an application proxy, TLS handshake will be skipped. This is required to let the application do the proxy specific handshake.

Parameters
protocolThe proxy protocol.
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect ( const Glib::RefPtr< SocketConnectable >&  connectable,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Tries to resolve the connectable and make a network connection to it.

Upon a successful connection, a new SocketConnection is constructed and returned. The caller owns this new object and must drop their reference to it when finished with it.

The type of the SocketConnection object returned depends on the type of the underlying socket that is used. For instance, for a TCP/IP connection it will be a TcpConnection.

The socket created will be the same family as the address that the connectable resolves to, unless family is set with g_socket_client_set_family() or indirectly via g_socket_client_set_local_address(). The socket type defaults to Gio::Socket::Type::STREAM but can be set with g_socket_client_set_socket_type().

If a local address is specified with g_socket_client_set_local_address() the socket will be bound to this address before connecting.

Since glibmm 2.22:
Parameters
connectableA SocketConnectable specifying the remote address.
cancellableOptional Cancellable object, nullptr to ignore.
Returns
A SocketConnection on success, nullptr on error.
Exceptions
Glib::Error
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect ( const Glib::RefPtr< SocketConnectable >&  connectable)

A connect() convenience overload.

void Gio::SocketClient::connect_async ( const Glib::RefPtr< SocketConnectable >&  connectable,
const Glib::RefPtr< Cancellable >&  cancellable,
const SlotAsyncReady slot 
)

This is the asynchronous version of g_socket_client_connect().

When the operation is finished slot will be called. You can then call g_socket_client_connect_finish() to get the result of the operation.

Since glibmm 2.22:
Parameters
connectableA SocketConnectable specifying the remote address.
cancellableA Cancellable, or nullptr.
slotA SlotAsyncReady.
user_dataUser data for the callback.
void Gio::SocketClient::connect_async ( const Glib::RefPtr< SocketConnectable >&  connectable,
const SlotAsyncReady slot 
)

This is the asynchronous version of connect().

When the operation is finished slot will be called. You can then call finish() to get the result of the operation.

Parameters
connectableA SocketConnectable specifying the remote address.
slotA callback slot to call after the operation completes.
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect_finish ( const Glib::RefPtr< AsyncResult >&  result)

Finishes an async connect operation.

See g_socket_client_connect_async()

Since glibmm 2.22:
Parameters
resultA AsyncResult.
Returns
A SocketConnection on success, nullptr on error.
Exceptions
Glib::Error
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect_to_host ( const Glib::ustring host_and_port,
guint16  default_port,
const Glib::RefPtr< Cancellable >&  cancellable 
)

This is a helper function for g_socket_client_connect().

Attempts to create a TCP connection to the named host.

host_and_port may be in any of a number of recognized formats; an IPv6 address, an IPv4 address, or a domain name (in which case a DNS lookup is performed). Quoting with [] is supported for all address types. A port override may be specified in the usual way with a colon. Ports may be given as decimal numbers or symbolic names (in which case an /etc/services lookup is performed).

If no port override is given in host_and_port then default_port will be used as the port number to connect to.

In general, host_and_port is expected to be provided by the user (allowing them to give the hostname, and a port override if necessary) and default_port is expected to be provided by the application.

In the case that an IP address is given, a single connection attempt is made. In the case that a name is given, multiple connection attempts may be made, in turn and according to the number of address records in DNS, until a connection succeeds.

Upon a successful connection, a new SocketConnection is constructed and returned. The caller owns this new object and must drop their reference to it when finished with it.

In the event of any failure (DNS error, service not found, no hosts connectable) nullptr is returned and error (if non-nullptr) is set accordingly.

Since glibmm 2.22:
Parameters
host_and_portThe name and optionally port of the host to connect to.
default_portThe default port to connect to.
cancellableA Cancellable, or nullptr.
Returns
A SocketConnection on success, nullptr on error.
Exceptions
Glib::Error
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect_to_host ( const Glib::ustring host_and_port,
guint16  default_port 
)

A connect_to_host() convenience overload.

void Gio::SocketClient::connect_to_host_async ( const Glib::ustring host_and_port,
guint16  default_port,
const Glib::RefPtr< Cancellable >&  cancellable,
const SlotAsyncReady slot 
)

This is the asynchronous version of g_socket_client_connect_to_host().

When the operation is finished slot will be called. You can then call g_socket_client_connect_to_host_finish() to get the result of the operation.

Since glibmm 2.22:
Parameters
host_and_portThe name and optionally the port of the host to connect to.
default_portThe default port to connect to.
cancellableA Cancellable, or nullptr.
slotA SlotAsyncReady.
user_dataUser data for the callback.
void Gio::SocketClient::connect_to_host_async ( const Glib::ustring host_and_port,
guint16  default_port,
const SlotAsyncReady slot 
)

This is the asynchronous version of connect_to_host().

When the operation is finished slot will be called. You can then call connect_to_host_finish() to get the result of the operation.

Parameters
host_and_portThe name and optionally the port of the host to connect to.
default_portThe default port to connect to.
slotA callback slot to call after the opration completes.
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect_to_host_finish ( const Glib::RefPtr< AsyncResult >&  result)

Finishes an async connect operation.

See g_socket_client_connect_to_host_async()

Since glibmm 2.22:
Parameters
resultA AsyncResult.
Returns
A SocketConnection on success, nullptr on error.
Exceptions
Glib::Error
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect_to_service ( const Glib::ustring domain,
const Glib::ustring service,
const Glib::RefPtr< Cancellable >&  cancellable 
)

Attempts to create a TCP connection to a service.

This call looks up the SRV record for service at domain for the "tcp" protocol. It then attempts to connect, in turn, to each of the hosts providing the service until either a connection succeeds or there are no hosts remaining.

Upon a successful connection, a new SocketConnection is constructed and returned. The caller owns this new object and must drop their reference to it when finished with it.

In the event of any failure (DNS error, service not found, no hosts connectable) nullptr is returned and error (if non-nullptr) is set accordingly.

Parameters
domainA domain name.
serviceThe name of the service to connect to.
cancellableA Cancellable, or nullptr.
Returns
A SocketConnection if successful, or nullptr on error.
Exceptions
Glib::Error
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect_to_service ( const Glib::ustring domain,
const Glib::ustring service 
)

A connect_to_service() convenience overload.

void Gio::SocketClient::connect_to_service_async ( const Glib::ustring domain,
const Glib::ustring service,
const Glib::RefPtr< Cancellable >&  cancellable,
const SlotAsyncReady slot 
)

This is the asynchronous version of g_socket_client_connect_to_service().

Since glibmm 2.22:
Parameters
domainA domain name.
serviceThe name of the service to connect to.
cancellableA Cancellable, or nullptr.
slotA SlotAsyncReady.
user_dataUser data for the callback.
void Gio::SocketClient::connect_to_service_async ( const Glib::ustring domain,
const Glib::ustring service,
const SlotAsyncReady slot 
)

This is the asynchronous version of connect_to_service().

Parameters
domainA domain name.
serviceThe name of the service to connect to
slotA callback slot to call after the opration completes.
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect_to_service_finish ( const Glib::RefPtr< AsyncResult >&  result)

Finishes an async connect operation.

See g_socket_client_connect_to_service_async()

Since glibmm 2.22:
Parameters
resultA AsyncResult.
Returns
A SocketConnection on success, nullptr on error.
Exceptions
Glib::Error
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect_to_uri ( const Glib::ustring uri,
guint16  default_port,
const Glib::RefPtr< Cancellable >&  cancellable 
)

This is a helper function for g_socket_client_connect().

Attempts to create a TCP connection with a network URI.

uri may be any valid URI containing an "authority" (hostname/port) component. If a port is not specified in the URI, default_port will be used. TLS will be negotiated if SocketClient::property_tls() is true. (SocketClient does not know to automatically assume TLS for certain URI schemes.)

Using this rather than g_socket_client_connect() or g_socket_client_connect_to_host() allows SocketClient to determine when to use application-specific proxy protocols.

Upon a successful connection, a new SocketConnection is constructed and returned. The caller owns this new object and must drop their reference to it when finished with it.

In the event of any failure (DNS error, service not found, no hosts connectable) nullptr is returned and error (if non-nullptr) is set accordingly.

Since glibmm 2.26:
Parameters
uriA network URI.
default_portThe default port to connect to.
cancellableA Cancellable, or nullptr.
Returns
A SocketConnection on success, nullptr on error.
Exceptions
Glib::Error
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect_to_uri ( const Glib::ustring uri,
guint16  default_port 
)

A connect_to_uri() convenience overload.

void Gio::SocketClient::connect_to_uri_async ( const Glib::ustring uri,
guint16  default_port,
const Glib::RefPtr< Cancellable >&  cancellable,
const SlotAsyncReady slot 
)

This is the asynchronous version of g_socket_client_connect_to_uri().

When the operation is finished slot will be called. You can then call g_socket_client_connect_to_uri_finish() to get the result of the operation.

Since glibmm 2.26:
Parameters
uriA network uri.
default_portThe default port to connect to.
cancellableA Cancellable, or nullptr.
slotA SlotAsyncReady.
user_dataUser data for the callback.
void Gio::SocketClient::connect_to_uri_async ( const Glib::ustring uri,
guint16  default_port,
const SlotAsyncReady slot 
)

This is the asynchronous version of connect_to_uri().

Parameters
uriA network URI.
default_portThe default port to connect to.
slotA callback slot to call after the opration completes.
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect_to_uri_finish ( const Glib::RefPtr< AsyncResult >&  result)

Finishes an async connect operation.

See g_socket_client_connect_to_uri_async()

Since glibmm 2.26:
Parameters
resultA AsyncResult.
Returns
A SocketConnection on success, nullptr on error.
Exceptions
Glib::Error
static Glib::RefPtr<SocketClient> Gio::SocketClient::create ( )
static
bool Gio::SocketClient::get_enable_proxy ( ) const

Gets the proxy enable state; see g_socket_client_set_enable_proxy()

Since glibmm 2.26:
Returns
Whether proxying is enabled.
SocketFamily Gio::SocketClient::get_family ( ) const

Gets the socket family of the socket client.

See g_socket_client_set_family() for details.

Since glibmm 2.22:
Returns
A SocketFamily.
Glib::RefPtr<SocketAddress> Gio::SocketClient::get_local_address ( )

Gets the local address of the socket client.

See g_socket_client_set_local_address() for details.

Since glibmm 2.22:
Returns
A SocketAddress or nullptr. Do not free.
Glib::RefPtr<const SocketAddress> Gio::SocketClient::get_local_address ( ) const

Gets the local address of the socket client.

See g_socket_client_set_local_address() for details.

Since glibmm 2.22:
Returns
A SocketAddress or nullptr. Do not free.
Socket::Protocol Gio::SocketClient::get_protocol ( ) const

Gets the protocol name type of the socket client.

See g_socket_client_set_protocol() for details.

Since glibmm 2.22:
Returns
A Gio::Socket::Protocol.
Glib::RefPtr<ProxyResolver> Gio::SocketClient::get_proxy_resolver ( )

Gets the ProxyResolver being used by client.

Normally, this will be the resolver returned by g_proxy_resolver_get_default(), but you can override it with g_socket_client_set_proxy_resolver().

Since glibmm 2.36:
Returns
The ProxyResolver being used by client.
Glib::RefPtr<const ProxyResolver> Gio::SocketClient::get_proxy_resolver ( ) const

Gets the ProxyResolver being used by client.

Normally, this will be the resolver returned by g_proxy_resolver_get_default(), but you can override it with g_socket_client_set_proxy_resolver().

Since glibmm 2.36:
Returns
The ProxyResolver being used by client.
Socket::Type Gio::SocketClient::get_socket_type ( ) const

Gets the socket type of the socket client.

See g_socket_client_set_socket_type() for details.

Since glibmm 2.22:
Returns
A SocketFamily.
guint Gio::SocketClient::get_timeout ( ) const

Gets the I/O timeout time for sockets created by client.

See g_socket_client_set_timeout() for details.

Since glibmm 2.26:
Returns
The timeout in seconds.
bool Gio::SocketClient::get_tls ( ) const

Gets whether client creates TLS connections.

See g_socket_client_set_tls() for details.

Since glibmm 2.28:
Returns
Whether client uses TLS.
TlsCertificateFlags Gio::SocketClient::get_tls_validation_flags ( ) const

Gets the TLS validation flags used creating TLS connections via client.

Since glibmm 2.28:
Returns
The TLS validation flags.
static GType Gio::SocketClient::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

GSocketClient* Gio::SocketClient::gobj ( )
inline

Provides access to the underlying C GObject.

const GSocketClient* Gio::SocketClient::gobj ( ) const
inline

Provides access to the underlying C GObject.

GSocketClient* Gio::SocketClient::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

virtual void Gio::SocketClient::on_event ( SocketClientEvent  event,
const Glib::RefPtr< SocketConnectable >&  connectable,
const Glib::RefPtr< IOStream >&  connection 
)
protectedvirtual

This is a default handler for the signal signal_event().

SocketClient& Gio::SocketClient::operator= ( SocketClient&&  src)
noexcept
Glib::PropertyProxy< bool > Gio::SocketClient::property_enable_proxy ( )

Enable proxy support.

Default value: true

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gio::SocketClient::property_enable_proxy ( ) const

Enable proxy support.

Default value: true

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< SocketFamily > Gio::SocketClient::property_family ( )

The sockets address family to use for socket construction.

Default value: Gio::SocketFamily::INVALID

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< SocketFamily > Gio::SocketClient::property_family ( ) const

The sockets address family to use for socket construction.

Default value: Gio::SocketFamily::INVALID

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::RefPtr<SocketAddress> > Gio::SocketClient::property_local_address ( )

The local address constructed sockets will be bound to.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<SocketAddress> > Gio::SocketClient::property_local_address ( ) const

The local address constructed sockets will be bound to.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Socket::Protocol > Gio::SocketClient::property_protocol ( )

The protocol to use for socket construction, or 0 for default.

Default value: Gio::Socket::Protocol::DEFAULT

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Socket::Protocol > Gio::SocketClient::property_protocol ( ) const

The protocol to use for socket construction, or 0 for default.

Default value: Gio::Socket::Protocol::DEFAULT

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::RefPtr<ProxyResolver> > Gio::SocketClient::property_proxy_resolver ( )

The proxy resolver to use.

Since glibmm 2.36:
Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<ProxyResolver> > Gio::SocketClient::property_proxy_resolver ( ) const

The proxy resolver to use.

Since glibmm 2.36:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< guint > Gio::SocketClient::property_timeout ( )

The I/O timeout for sockets, or 0 for none.

Default value: 0

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< guint > Gio::SocketClient::property_timeout ( ) const

The I/O timeout for sockets, or 0 for none.

Default value: 0

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gio::SocketClient::property_tls ( )

Whether to create TLS connections.

Default value: false

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gio::SocketClient::property_tls ( ) const

Whether to create TLS connections.

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< TlsCertificateFlags > Gio::SocketClient::property_tls_validation_flags ( )

TLS validation flags to use.

Default value: Gio::TlsCertificateFlags::UNKNOWN_CA | Gio::TlsCertificateFlags::BAD_IDENTITY | Gio::TlsCertificateFlags::NOT_ACTIVATED | Gio::TlsCertificateFlags::EXPIRED | Gio::TlsCertificateFlags::REVOKED | Gio::TlsCertificateFlags::INSECURE | Gio::TlsCertificateFlags::GENERIC_ERROR

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< TlsCertificateFlags > Gio::SocketClient::property_tls_validation_flags ( ) const

TLS validation flags to use.

Default value: Gio::TlsCertificateFlags::UNKNOWN_CA | Gio::TlsCertificateFlags::BAD_IDENTITY | Gio::TlsCertificateFlags::NOT_ACTIVATED | Gio::TlsCertificateFlags::EXPIRED | Gio::TlsCertificateFlags::REVOKED | Gio::TlsCertificateFlags::INSECURE | Gio::TlsCertificateFlags::GENERIC_ERROR

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Socket::Type > Gio::SocketClient::property_type ( )

The sockets type to use for socket construction.

Default value: Gio::Socket::Type::STREAM

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Socket::Type > Gio::SocketClient::property_type ( ) const

The sockets type to use for socket construction.

Default value: Gio::Socket::Type::STREAM

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gio::SocketClient::set_enable_proxy ( bool  enable)

Sets whether or not client attempts to make connections via a proxy server.

When enabled (the default), SocketClient will use a ProxyResolver to determine if a proxy protocol such as SOCKS is needed, and automatically do the necessary proxy negotiation.

See also g_socket_client_set_proxy_resolver().

Since glibmm 2.26:
Parameters
enableWhether to enable proxies.
void Gio::SocketClient::set_family ( SocketFamily  family)

Sets the socket family of the socket client.

If this is set to something other than Gio::SocketFamily::INVALID then the sockets created by this object will be of the specified family.

This might be useful for instance if you want to force the local connection to be an ipv4 socket, even though the address might be an ipv6 mapped to ipv4 address.

Since glibmm 2.22:
Parameters
familyA SocketFamily.
void Gio::SocketClient::set_local_address ( const Glib::RefPtr< SocketAddress >&  address)

Sets the local address of the socket client.

The sockets created by this object will bound to the specified address (if not nullptr) before connecting.

This is useful if you want to ensure that the local side of the connection is on a specific port, or on a specific interface.

Since glibmm 2.22:
Parameters
addressA SocketAddress, or nullptr.
void Gio::SocketClient::set_protocol ( Socket::Protocol  protocol)

Sets the protocol of the socket client.

The sockets created by this object will use of the specified protocol.

If protocol is %0 that means to use the default protocol for the socket family and type.

Since glibmm 2.22:
Parameters
protocolA Gio::Socket::Protocol.
void Gio::SocketClient::set_proxy_resolver ( const Glib::RefPtr< ProxyResolver >&  proxy_resolver)

Overrides the ProxyResolver used by client.

You can call this if you want to use specific proxies, rather than using the system default proxy settings.

Note that whether or not the proxy resolver is actually used depends on the setting of SocketClient::property_enable_proxy(), which is not changed by this function (but which is true by default)

Since glibmm 2.36:
Parameters
proxy_resolverA ProxyResolver, or nullptr for the default.
void Gio::SocketClient::set_socket_type ( Socket::Type  type)

Sets the socket type of the socket client.

The sockets created by this object will be of the specified type.

It doesn't make sense to specify a type of Gio::Socket::Type::DATAGRAM, as GSocketClient is used for connection oriented services.

Since glibmm 2.22:
Parameters
typeA Gio::Socket::Type.
void Gio::SocketClient::set_timeout ( guint  timeout)

Sets the I/O timeout for sockets created by client.

timeout is a time in seconds, or 0 for no timeout (the default).

The timeout value affects the initial connection attempt as well, so setting this may cause calls to g_socket_client_connect(), etc, to fail with Gio::Error::TIMED_OUT.

Since glibmm 2.26:
Parameters
timeoutThe timeout.
void Gio::SocketClient::set_tls ( bool  tls = true)

Sets whether client creates TLS (aka SSL) connections.

If tls is true, client will wrap its connections in a TlsClientConnection and perform a TLS handshake when connecting.

Note that since SocketClient must return a SocketConnection, but TlsClientConnection is not a SocketConnection, this actually wraps the resulting TlsClientConnection in a TcpWrapperConnection when returning it. You can use g_tcp_wrapper_connection_get_base_io_stream() on the return value to extract the TlsClientConnection.

If you need to modify the behavior of the TLS handshake (eg, by setting a client-side certificate to use, or connecting to the TlsConnection::signal_accept_certificate() signal), you can connect to client's SocketClient::signal_event() signal and wait for it to be emitted with Gio::SocketClientEvent::TLS_HANDSHAKING, which will give you a chance to see the TlsClientConnection before the handshake starts.

Since glibmm 2.28:
Parameters
tlsWhether to use TLS.
void Gio::SocketClient::set_tls_validation_flags ( TlsCertificateFlags  flags)

Sets the TLS validation flags used when creating TLS connections via client.

The default value is Gio::TlsCertificateFlags::VALIDATE_ALL.

Since glibmm 2.28:
Parameters
flagsThe validation flags.
Glib::SignalProxy<void(SocketClientEvent, const Glib::RefPtr<SocketConnectable>&, const Glib::RefPtr<IOStream>&)> Gio::SocketClient::signal_event ( )
Slot Prototype:
void on_my_event(SocketClientEvent event, const Glib::RefPtr<SocketConnectable>& connectable, const Glib::RefPtr<IOStream>& connection)

Flags: Run Last

Emitted when client's activity on connectable changes state. Among other things, this can be used to provide progress information about a network connection in the UI. The meanings of the different event values are as follows:

Each event except Gio::SocketClientEvent::COMPLETE may be emitted multiple times (or not at all) for a given connectable (in particular, if client ends up attempting to connect to more than one address). However, if client emits the SocketClient::signal_event() signal at all for a given connectable, that it will always emit it with Gio::SocketClientEvent::COMPLETE when it is done.

Note that there may be additional SocketClientEvent values in the future; unrecognized event values should be ignored.

Since glibmm 2.32:
Parameters
eventThe event that is occurring.
connectableThe SocketConnectable that event is occurring on.
connectionThe current representation of the connection.

Friends And Related Function Documentation

Glib::RefPtr< Gio::SocketClient > wrap ( GSocketClient *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.