glibmm  2.33.12
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions
Gio::SocketClient Class Reference

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

#include <giomm/socketclient.h>

Inheritance diagram for Gio::SocketClient:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~SocketClient ()
GSocketClient* gobj ()
 Provides access to the underlying C GObject.
const GSocketClient* gobj () const
 Provides access to the underlying C GObject.
GSocketClient* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
SocketFamily get_family () const
 Gets the socket family of the socket client.
void set_family (SocketFamily family)
 Sets the socket family of the socket client.
SocketType get_socket_type () const
 Gets the socket type of the socket client.
void set_socket_type (SocketType type)
 Sets the socket type of the socket client.
SocketProtocol get_protocol () const
 Gets the protocol name type of the socket client.
void set_protocol (SocketProtocol protocol)
 Sets the protocol of the socket client.
Glib::RefPtr< SocketAddressget_local_address ()
 Gets the local address of the socket client.
Glib::RefPtr< const SocketAddressget_local_address () const
 Gets the local address of the socket client.
void set_local_address (const Glib::RefPtr< SocketAddress >& address)
 Sets the local address of the socket client.
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.
Glib::RefPtr< SocketConnectionconnect (const Glib::RefPtr< SocketConnectable >& connectable)
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().
Glib::RefPtr< SocketConnectionconnect_to_host (const Glib::ustring& host_and_port, guint16 default_port)
 This is a helper function for connect().
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.
Glib::RefPtr< SocketConnectionconnect_to_service (const Glib::ustring& domain, const Glib::ustring& service)
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().
Glib::RefPtr< SocketConnectionconnect_to_uri (const Glib::ustring& uri, guint16 default_port)
 This is a helper function for connect().
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().
void connect_async (const Glib::RefPtr< SocketConnectable >& connectable, const SlotAsyncReady& slot)
 This is the asynchronous version of connect().
Glib::RefPtr< SocketConnectionconnect_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes an async connect operation.
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().
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().
Glib::RefPtr< SocketConnectionconnect_to_host_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes an async connect operation.
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().
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().
Glib::RefPtr< SocketConnectionconnect_to_service_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes an async connect operation.
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().
void connect_to_uri_async (const Glib::ustring& uri, guint16 default_port, const SlotAsyncReady& slot)
 This is the asynchronous version of connect_to_uri().
Glib::RefPtr< SocketConnectionconnect_to_uri_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes an async connect operation.
bool get_enable_proxy () const
 Gets the proxy enable state; see g_socket_client_set_enable_proxy()
void set_enable_proxy (bool enable)
 Sets whether or not client attempts to make connections via a proxy server.
guint get_timeout () const
 Gets the I/O timeout time for sockets created by client.
void set_timeout (guint enable)
 Sets the I/O timeout for sockets created by client.
void add_application_proxy (const Glib::ustring& protocol)
 Enable proxy protocols to be handled by the application.
Glib::PropertyProxy< SocketFamilyproperty_family ()
 The sockets address family to use for socket construction.
Glib::PropertyProxy_ReadOnly
< SocketFamily
property_family () const
 The sockets address family to use for socket construction.
Glib::PropertyProxy
< Glib::RefPtr< SocketAddress > > 
property_local_address ()
 The local address constructed sockets will be bound to.
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< SocketAddress > > 
property_local_address () const
 The local address constructed sockets will be bound to.
Glib::PropertyProxy
< SocketProtocol
property_protocol ()
 The protocol to use for socket construction, or 0 for default.
Glib::PropertyProxy_ReadOnly
< SocketProtocol
property_protocol () const
 The protocol to use for socket construction, or 0 for default.
Glib::PropertyProxy< SocketTypeproperty_type ()
 The sockets type to use for socket construction.
Glib::PropertyProxy_ReadOnly
< SocketType
property_type () const
 The sockets type to use for socket construction.
- Public Member Functions inherited from Glib::Object
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
void set_property_value (const Glib::ustring& property_name, const Glib::ValueBase&value)
 You probably want to use a specific property_*() accessor method instead.
void get_property_value (const Glib::ustring& property_name, Glib::ValueBase&value) const
 You probably want to use a specific property_*() accessor method instead.
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.
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.
void 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, but this is necessary when using the reduced API.
sigc::connection connect_property_changed_with_return (const Glib::ustring& property_name, const sigc::slot< void >& slot)
 You can use the signal_changed() signal of the property proxy instead, but this is necessary when using the reduced API.
void freeze_notify ()
 Increases the freeze count on object.
void thaw_notify ()
 Reverts the effect of a previous call to freeze_notify().
virtual void reference () const
 Increment the reference count for this object.
virtual void unreference () const
 Decrement the reference count for this object.
GObject* gobj_copy () const
 Give a ref-ed copy to someone. Use for direct struct access.
- Public Member Functions inherited from sigc::trackable
 trackable (const trackable &src)
trackableoperator= (const trackable &src)
void add_destroy_notify_callback (void *data, func_destroy_notify func) const
void remove_destroy_notify_callback (void *data) const
void notify_callbacks ()

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
static Glib::RefPtr< SocketClientcreate ()

Protected Member Functions

 SocketClient ()
- Protected Member Functions inherited from Glib::Object
 Object ()
 Object (const Glib::ConstructParams& construct_params)
 Object (GObject* castitem)
virtual ~Object ()
- 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.
 ObjectBase (const char* custom_type_name)
 A derived constructor always overrides this choice.
 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.
virtual ~ObjectBase ()=0
void initialize (GObject* castitem)

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.

Additional Inherited Members

- Public Types inherited from Glib::Object
typedef void(* DestroyNotify )(gpointer data)

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

virtual Gio::SocketClient::~SocketClient ( )
virtual
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 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, 0 to ignore.
Returns:
A SocketConnection on success, 0 on error.
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect ( const Glib::RefPtr< SocketConnectable >&  connectable)
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 callback 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 0.
callbackA AsyncReadyCallback.
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()

\xrefitem since_2_22 127. @param result A AsyncResult.
@return A SocketConnection on success, <tt>0</tt> on 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) 0 is returned and error (if non-0) 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 0.
Returns:
A SocketConnection on success, 0 on error.
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect_to_host ( const Glib::ustring host_and_port,
guint16  default_port 
)

This is a helper function for connect().

This attempts to create a TCP connection to the named host.

host_and_port may be in any of a number of recognised 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 overide 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.

In the event of any failure (DNS error, service not found, no hosts connectable) an exception is thrown.

Parameters:
host_and_portThe name and optionally port of the host to connect to.
default_portThe default port to connect to.
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 callback 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 0.
callbackA AsyncReadyCallback.
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()

\xrefitem since_2_22 129. @param result A AsyncResult.
@return A SocketConnection on success, <tt>0</tt> on 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) 0 is returned and error (if non-0) is set accordingly.

Parameters:
domainA domain name.
serviceThe name of the service to connect to.
cancellableA Cancellable, or 0.
Returns:
A SocketConnection if successful, or 0 on error.
Glib::RefPtr<SocketConnection> Gio::SocketClient::connect_to_service ( const Glib::ustring domain,
const Glib::ustring service 
)
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 0.
callbackA AsyncReadyCallback.
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()

\xrefitem since_2_22 131. @param result A AsyncResult.
@return A SocketConnection on success, <tt>0</tt> on 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) 0 is returned and error (if non-0) is set accordingly.

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

This is a helper function for connect().

This 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 "tls" is true. (GSocketClient does not know to automatically assume TLS for certain URI schemes.)

Using this rather than connect() or 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.

In the event of any failure (DNS error, service not found, no hosts connectable) an exception is thrown.

Parameters:
uriA network URI
default_portThe default port to connect to.
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 callback 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 0.
callbackA AsyncReadyCallback.
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()

\xrefitem since_2_26 258. @param result A AsyncResult.
@return A SocketConnection on success, <tt>0</tt> on 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 0. 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 0. Do not free.
SocketProtocol 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 SocketProtocol.
SocketType 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.
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.

Reimplemented from Glib::ObjectBase.

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

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

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.

Glib::PropertyProxy< SocketFamily > Gio::SocketClient::property_family ( )

The sockets address family to use for socket construction.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, 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.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, 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.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, 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.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

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

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

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

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

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

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

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

The sockets type to use for socket construction.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

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

The sockets type to use for socket construction.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, 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.

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 SOCKET_FAMILY_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 0) 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 0.
void Gio::SocketClient::set_protocol ( SocketProtocol  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 SocketProtocol.
void Gio::SocketClient::set_socket_type ( SocketType  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 SOCKET_TYPE_DATAGRAM, as GSocketClient is used for connection oriented services.

Since glibmm 2.22:
Parameters:
typeA SocketType.
void Gio::SocketClient::set_timeout ( guint  enable)

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 IO_ERROR_TIMED_OUT.

Since glibmm 2.26:
Parameters:
timeoutThe timeout.

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.