/* GIO - GLib Input, Output and Streaming Library * * Copyright © 2008, 2009 codethink * Copyright © 2009 Red Hat, Inc * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General * Public License along with this library; if not, write to the * Free Software Foundation, Inc., 59 Temple Place, Suite 330, * Boston, MA 02111-1307, USA. * * Authors: Ryan Lortie * Alexander Larsson */ #include "config.h" #include "gsocketclient.h" #include #include #include #include #include #include #include #include #include #include #include #include #include "glibintl.h" #include "gioalias.h" /** * SECTION:gsocketclient * @short_description: Helper for connecting to a network service * @include: gio/gio.h * @see_also: #GSocketConnection, #GSocketListener * * #GSocketClient is a high-level utility class for connecting to a * network host using a connection oriented socket type. * * You create a #GSocketClient object, set any options you want, then * call a sync or async connect operation, which returns a #GSocketConnection * subclass on success. * * The type of the #GSocketConnection 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 #GTcpConnection. * * Since: 2.22 */ G_DEFINE_TYPE (GSocketClient, g_socket_client, G_TYPE_OBJECT); enum { PROP_NONE, PROP_FAMILY, PROP_TYPE, PROP_PROTOCOL, PROP_LOCAL_ADDRESS }; struct _GSocketClientPrivate { GSocketFamily family; GSocketType type; GSocketProtocol protocol; GSocketAddress *local_address; }; static GSocket * create_socket (GSocketClient *client, GSocketAddress *dest_address, GError **error) { GSocketFamily family; GSocket *socket; family = client->priv->family; if (family == G_SOCKET_FAMILY_INVALID && client->priv->local_address != NULL) family = g_socket_address_get_family (client->priv->local_address); if (family == G_SOCKET_FAMILY_INVALID) family = g_socket_address_get_family (dest_address); socket = g_socket_new (family, client->priv->type, client->priv->protocol, error); if (socket == NULL) return NULL; if (client->priv->local_address) { if (!g_socket_bind (socket, client->priv->local_address, FALSE, error)) { g_object_unref (socket); return NULL; } } return socket; } static void g_socket_client_init (GSocketClient *client) { client->priv = G_TYPE_INSTANCE_GET_PRIVATE (client, G_TYPE_SOCKET_CLIENT, GSocketClientPrivate); client->priv->type = G_SOCKET_TYPE_STREAM; } /** * g_socket_client_new: * * Creates a new #GSocketClient with the default options. * * Returns: a #GSocketClient. * Free the returned object with g_object_unref(). * * Since: 2.22 */ GSocketClient * g_socket_client_new (void) { return g_object_new (G_TYPE_SOCKET_CLIENT, NULL); } static void g_socket_client_finalize (GObject *object) { GSocketClient *client = G_SOCKET_CLIENT (object); if (client->priv->local_address) g_object_unref (client->priv->local_address); if (G_OBJECT_CLASS (g_socket_client_parent_class)->finalize) (*G_OBJECT_CLASS (g_socket_client_parent_class)->finalize) (object); } static void g_socket_client_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec) { GSocketClient *client = G_SOCKET_CLIENT (object); switch (prop_id) { case PROP_FAMILY: g_value_set_enum (value, client->priv->family); break; case PROP_TYPE: g_value_set_enum (value, client->priv->type); break; case PROP_PROTOCOL: g_value_set_enum (value, client->priv->protocol); break; case PROP_LOCAL_ADDRESS: g_value_set_object (value, client->priv->local_address); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); } } static void g_socket_client_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec) { GSocketClient *client = G_SOCKET_CLIENT (object); switch (prop_id) { case PROP_FAMILY: g_socket_client_set_family (client, g_value_get_enum (value)); break; case PROP_TYPE: g_socket_client_set_socket_type (client, g_value_get_enum (value)); break; case PROP_PROTOCOL: g_socket_client_set_protocol (client, g_value_get_enum (value)); break; case PROP_LOCAL_ADDRESS: g_socket_client_set_local_address (client, g_value_get_object (value)); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); } } /** * g_socket_client_get_family: * @client: a #GSocketClient. * * Gets the socket family of the socket client. * * See g_socket_client_set_family() for details. * * Returns: a #GSocketFamily * * Since: 2.22 */ GSocketFamily g_socket_client_get_family (GSocketClient *client) { return client->priv->family; } /** * g_socket_client_set_family: * @client: a #GSocketClient. * @family: a #GSocketFamily * * Sets the socket family of the socket client. * If this is set to something other than %G_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: 2.22 */ void g_socket_client_set_family (GSocketClient *client, GSocketFamily family) { if (client->priv->family == family) return; client->priv->family = family; g_object_notify (G_OBJECT (client), "family"); } /** * g_socket_client_get_socket_type: * @client: a #GSocketClient. * * Gets the socket type of the socket client. * * See g_socket_client_set_socket_type() for details. * * Returns: a #GSocketFamily * * Since: 2.22 */ GSocketType g_socket_client_get_socket_type (GSocketClient *client) { return client->priv->type; } /** * g_socket_client_set_socket_type: * @client: a #GSocketClient. * @type: a #GSocketType * * 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 %G_SOCKET_TYPE_DATAGRAM, * as GSocketClient is used for connection oriented services. * * Since: 2.22 */ void g_socket_client_set_socket_type (GSocketClient *client, GSocketType type) { if (client->priv->type == type) return; client->priv->type = type; g_object_notify (G_OBJECT (client), "type"); } /** * g_socket_client_get_protocol: * @client: a #GSocketClient * * Gets the protocol name type of the socket client. * * See g_socket_client_set_protocol() for details. * * Returns: a #GSocketProtocol * * Since: 2.22 */ GSocketProtocol g_socket_client_get_protocol (GSocketClient *client) { return client->priv->protocol; } /** * g_socket_client_set_protocol: * @client: a #GSocketClient. * @protocol: a #GSocketProtocol * * 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: 2.22 */ void g_socket_client_set_protocol (GSocketClient *client, GSocketProtocol protocol) { if (client->priv->protocol == protocol) return; client->priv->protocol = protocol; g_object_notify (G_OBJECT (client), "protocol"); } /** * g_socket_client_get_local_address: * @client: a #GSocketClient. * * Gets the local address of the socket client. * * See g_socket_client_set_local_address() for details. * * Returns: a #GSocketAddres or %NULL. don't free * * Since: 2.22 */ GSocketAddress * g_socket_client_get_local_address (GSocketClient *client) { return client->priv->local_address; } /** * g_socket_client_set_local_address: * @client: a #GSocketClient. * @address: a #GSocketAddress, or %NULL * * Sets the local address of the socket client. * The sockets created by this object will bound to the * specified address (if not %NULL) before connecting. * * This is useful if you want to ensure the the local * side of the connection is on a specific port, or on * a specific interface. * * Since: 2.22 */ void g_socket_client_set_local_address (GSocketClient *client, GSocketAddress *address) { if (address) g_object_ref (address); if (client->priv->local_address) { g_object_unref (client->priv->local_address); } client->priv->local_address = address; g_object_notify (G_OBJECT (client), "local-address"); } static void g_socket_client_class_init (GSocketClientClass *class) { GObjectClass *gobject_class = G_OBJECT_CLASS (class); g_type_class_add_private (class, sizeof (GSocketClientPrivate)); gobject_class->finalize = g_socket_client_finalize; gobject_class->set_property = g_socket_client_set_property; gobject_class->get_property = g_socket_client_get_property; g_object_class_install_property (gobject_class, PROP_FAMILY, g_param_spec_enum ("family", P_("Socket family"), P_("The sockets address family to use for socket construction"), G_TYPE_SOCKET_FAMILY, G_SOCKET_FAMILY_INVALID, G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property (gobject_class, PROP_TYPE, g_param_spec_enum ("type", P_("Socket type"), P_("The sockets type to use for socket construction"), G_TYPE_SOCKET_TYPE, G_SOCKET_TYPE_STREAM, G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property (gobject_class, PROP_PROTOCOL, g_param_spec_enum ("protocol", P_("Socket protocol"), P_("The protocol to use for socket construction, or 0 for default"), G_TYPE_SOCKET_PROTOCOL, G_SOCKET_PROTOCOL_DEFAULT, G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property (gobject_class, PROP_LOCAL_ADDRESS, g_param_spec_object ("local-address", P_("Local address"), P_("The local address constructed sockets will be bound to"), G_TYPE_SOCKET_ADDRESS, G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); } /** * g_socket_client_connect: * @client: a #GSocketClient. * @connectable: a #GSocketConnectable specifying the remote address. * @cancellable: optional #GCancellable object, %NULL to ignore. * @error: #GError for error reporting, or %NULL to ignore. * * Tries to resolve the @connectable and make a network connection to it.. * * Upon a successful connection, a new #GSocketConnection 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 #GSocketConnection object returned depends on the type of * the underlying socket that is used. For instance, for a TCP/IP connection * it will be a #GTcpConnection. * * The socket created will be the same family as the 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 %G_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. * * Returns: a #GSocketConnection on success, %NULL on error. * * Since: 2.22 */ GSocketConnection * g_socket_client_connect (GSocketClient *client, GSocketConnectable *connectable, GCancellable *cancellable, GError **error) { GSocketConnection *connection = NULL; GSocketAddressEnumerator *enumerator; GError *last_error, *tmp_error; last_error = NULL; enumerator = g_socket_connectable_enumerate (connectable); while (connection == NULL) { GSocketAddress *address; GSocket *socket; if (g_cancellable_is_cancelled (cancellable)) { g_clear_error (error); g_cancellable_set_error_if_cancelled (cancellable, error); break; } tmp_error = NULL; address = g_socket_address_enumerator_next (enumerator, cancellable, &tmp_error); if (address == NULL) { if (tmp_error) { g_clear_error (&last_error); g_propagate_error (error, tmp_error); } else if (last_error) { g_propagate_error (error, tmp_error); } else g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED, _("Unknown error on connect")); break; } /* clear error from previous attempt */ g_clear_error (&last_error); socket = create_socket (client, address, &last_error); if (socket != NULL) { if (g_socket_connect (socket, address, cancellable, &last_error)) connection = g_socket_connection_factory_create_connection (socket); g_object_unref (socket); } g_object_unref (address); } g_object_unref (enumerator); return connection; } /** * g_socket_client_connect_to_host: * @client: a #SocketClient * @host_and_port: the name and optionally port of the host to connect to * @default_port: the default port to connect to * @cancellable: a #GCancellable, or %NULL * @error: a pointer to a #GError, or %NULL * * 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 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 #GSocketConnection 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) %NULL is returned and @error (if non-%NULL) is set * accordingly. * Returns: a #GSocketConnection on success, %NULL on error. * * Since: 2.22 */ GSocketConnection * g_socket_client_connect_to_host (GSocketClient *client, const gchar *host_and_port, guint16 default_port, GCancellable *cancellable, GError **error) { GSocketConnectable *connectable; GSocketConnection *connection; connectable = g_network_address_parse (host_and_port, default_port, error); if (connectable == NULL) return NULL; connection = g_socket_client_connect (client, connectable, cancellable, error); g_object_unref (connectable); return connection; } /** * g_socket_client_connect_to_service: * @client: a #GSocketConnection * @domain: a domain name * @service: the name of the service to connect to * @cancellable: a #GCancellable, or %NULL * @error: a pointer to a #GError, or %NULL * @returns: a #GSocketConnection if successful, or %NULL on error * * 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 #GSocketConnection 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) %NULL is returned and @error (if non-%NULL) is set * accordingly. */ GSocketConnection * g_socket_client_connect_to_service (GSocketClient *client, const gchar *domain, const gchar *service, GCancellable *cancellable, GError **error) { GSocketConnectable *connectable; GSocketConnection *connection; connectable = g_network_service_new (service, "tcp", domain); connection = g_socket_client_connect (client, connectable, cancellable, error); g_object_unref (connectable); return connection; } typedef struct { GSimpleAsyncResult *result; GCancellable *cancellable; GSocketClient *client; GSocketAddressEnumerator *enumerator; GSocket *current_socket; GError *last_error; } GSocketClientAsyncConnectData; static void g_socket_client_async_connect_complete (GSocketClientAsyncConnectData *data) { GSocketConnection *connection; if (data->last_error) { g_simple_async_result_set_from_error (data->result, data->last_error); g_error_free (data->last_error); } else { g_assert (data->current_socket); g_socket_set_blocking (data->current_socket, TRUE); connection = g_socket_connection_factory_create_connection (data->current_socket); g_simple_async_result_set_op_res_gpointer (data->result, connection, g_object_unref); } g_simple_async_result_complete (data->result); g_object_unref (data->result); } static void g_socket_client_enumerator_callback (GObject *object, GAsyncResult *result, gpointer user_data); static void set_last_error (GSocketClientAsyncConnectData *data, GError *error) { g_clear_error (&data->last_error); data->last_error = error; } static gboolean g_socket_client_socket_callback (GSocket *socket, GIOCondition condition, GSocketClientAsyncConnectData *data) { GError *error = NULL; if (g_cancellable_is_cancelled (data->cancellable)) { /* Cancelled, return done with last error being cancelled */ g_clear_error (&data->last_error); g_object_unref (data->current_socket); data->current_socket = NULL; g_cancellable_set_error_if_cancelled (data->cancellable, &data->last_error); } else { /* socket is ready for writing means connect done, did it succeed? */ if (!g_socket_check_connect_result (data->current_socket, &error)) { set_last_error (data, error); /* try next one */ g_socket_address_enumerator_next_async (data->enumerator, data->cancellable, g_socket_client_enumerator_callback, data); return FALSE; } } g_socket_client_async_connect_complete (data); return FALSE; } static void g_socket_client_enumerator_callback (GObject *object, GAsyncResult *result, gpointer user_data) { GSocketClientAsyncConnectData *data = user_data; GSocketAddress *address; GSocket *socket; GError *tmp_error = NULL; if (g_cancellable_is_cancelled (data->cancellable)) { g_clear_error (&data->last_error); g_cancellable_set_error_if_cancelled (data->cancellable, &data->last_error); g_socket_client_async_connect_complete (data); return; } address = g_socket_address_enumerator_next_finish (data->enumerator, result, &tmp_error); if (address == NULL) { if (tmp_error) set_last_error (data, tmp_error); else if (data->last_error == NULL) g_set_error_literal (&data->last_error, G_IO_ERROR, G_IO_ERROR_FAILED, _("Unknown error on connect")); g_socket_client_async_connect_complete (data); return; } g_clear_error (&data->last_error); socket = create_socket (data->client, address, &data->last_error); if (socket != NULL) { g_socket_set_blocking (socket, FALSE); if (g_socket_connect (socket, address, data->cancellable, &tmp_error)) { data->current_socket = socket; g_socket_client_async_connect_complete (data); g_object_unref (address); return; } else if (g_error_matches (tmp_error, G_IO_ERROR, G_IO_ERROR_PENDING)) { GSource *source; data->current_socket = socket; g_error_free (tmp_error); source = g_socket_create_source (socket, G_IO_OUT, data->cancellable); g_source_set_callback (source, (GSourceFunc) g_socket_client_socket_callback, data, NULL); g_source_attach (source, g_main_context_get_thread_default ()); g_source_unref (source); g_object_unref (address); return; } else { data->last_error = tmp_error; g_object_unref (socket); } g_object_unref (address); } g_socket_address_enumerator_next_async (data->enumerator, data->cancellable, g_socket_client_enumerator_callback, data); } /** * g_socket_client_connect_async: * @client: a #GTcpClient * @connectable: a #GSocketConnectable specifying the remote address. * @cancellable: a #GCancellable, or %NULL * @callback: a #GAsyncReadyCallback * @user_data: user data for the callback * * 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: 2.22 */ void g_socket_client_connect_async (GSocketClient *client, GSocketConnectable *connectable, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data) { GSocketClientAsyncConnectData *data; g_return_if_fail (G_IS_SOCKET_CLIENT (client)); data = g_slice_new (GSocketClientAsyncConnectData); data->result = g_simple_async_result_new (G_OBJECT (client), callback, user_data, g_socket_client_connect_async); data->client = client; if (cancellable) data->cancellable = g_object_ref (cancellable); else data->cancellable = NULL; data->last_error = NULL; data->enumerator = g_socket_connectable_enumerate (connectable); g_socket_address_enumerator_next_async (data->enumerator, cancellable, g_socket_client_enumerator_callback, data); } /** * g_socket_client_connect_to_host_async: * @client: a #GTcpClient * @host_and_port: the name and optionally the port of the host to connect to * @default_port: the default port to connect to * @cancellable: a #GCancellable, or %NULL * @callback: a #GAsyncReadyCallback * @user_data: user data for the callback * * 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: 2.22 */ void g_socket_client_connect_to_host_async (GSocketClient *client, const gchar *host_and_port, guint16 default_port, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data) { GSocketConnectable *connectable; GError *error; error = NULL; connectable = g_network_address_parse (host_and_port, default_port, &error); if (connectable == NULL) { g_simple_async_report_gerror_in_idle (G_OBJECT (client), callback, user_data, error); g_error_free (error); } else { g_socket_client_connect_async (client, connectable, cancellable, callback, user_data); g_object_unref (connectable); } } /** * g_socket_client_connect_to_service_async: * @client: a #GSocketClient * @domain: a domain name * @service: the name of the service to connect to * @cancellable: a #GCancellable, or %NULL * @callback: a #GAsyncReadyCallback * @user_data: user data for the callback * * This is the asynchronous version of * g_socket_client_connect_to_service(). * * Since: 2.22 */ void g_socket_client_connect_to_service_async (GSocketClient *client, const gchar *domain, const gchar *service, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data) { GSocketConnectable *connectable; connectable = g_network_service_new (service, "tcp", domain); g_socket_client_connect_async (client, connectable, cancellable, callback, user_data); g_object_unref (connectable); } /** * g_socket_client_connect_finish: * @client: a #GSocketClient. * @result: a #GAsyncResult. * @error: a #GError location to store the error occuring, or %NULL to * ignore. * * Finishes an async connect operation. See g_socket_client_connect_async() * * Returns: a #GSocketConnection on success, %NULL on error. * * Since: 2.22 */ GSocketConnection * g_socket_client_connect_finish (GSocketClient *client, GAsyncResult *result, GError **error) { GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result); if (g_simple_async_result_propagate_error (simple, error)) return NULL; return g_object_ref (g_simple_async_result_get_op_res_gpointer (simple)); } /** * g_socket_client_connect_to_host_finish: * @client: a #GSocketClient. * @result: a #GAsyncResult. * @error: a #GError location to store the error occuring, or %NULL to * ignore. * * Finishes an async connect operation. See g_socket_client_connect_to_host_async() * * Returns: a #GSocketConnection on success, %NULL on error. * * Since: 2.22 */ GSocketConnection * g_socket_client_connect_to_host_finish (GSocketClient *client, GAsyncResult *result, GError **error) { return g_socket_client_connect_finish (client, result, error); } /** * g_socket_client_connect_to_service_finish: * @client: a #GSocketClient. * @result: a #GAsyncResult. * @error: a #GError location to store the error occuring, or %NULL to * ignore. * * Finishes an async connect operation. See g_socket_client_connect_to_service_async() * * Returns: a #GSocketConnection on success, %NULL on error. * * Since: 2.22 */ GSocketConnection * g_socket_client_connect_to_service_finish (GSocketClient *client, GAsyncResult *result, GError **error) { return g_socket_client_connect_finish (client, result, error); } #define __G_SOCKET_CLIENT_C__ #include "gioaliasdef.c"