* 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.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
*
* Authors: Christian Kellner <gicmo@gnome.org>
* Samuel Cormier-Iijima <sciyoshi@gmail.com>
#include "gsocketoutputstream.h"
#include "gsocketinputstream.h"
+#include "gioprivate.h"
#include <gio/giostream.h>
-#include <gio/gsimpleasyncresult.h>
+#include <gio/gtask.h>
#include "gunixconnection.h"
#include "gtcpconnection.h"
#include "glibintl.h"
* depends on the type of the underlying socket that is in use. For
* instance, for a TCP/IP connection it will be a #GTcpConnection.
*
- * Chosing what type of object to construct is done with the socket
+ * Choosing what type of object to construct is done with the socket
* connection factory, and it is possible for 3rd parties to register
* custom socket connection types for specific combination of socket
* family/type/protocol using g_socket_connection_factory_register_type().
*
+ * To close a #GSocketConnection, use g_io_stream_close(). Closing both
+ * substreams of the #GIOStream separately will not close the underlying
+ * #GSocket.
+ *
* Since: 2.22
*/
-G_DEFINE_TYPE (GSocketConnection,
- g_socket_connection, G_TYPE_IO_STREAM);
-
enum
{
PROP_NONE,
GInputStream *input_stream;
GOutputStream *output_stream;
+ GSocketAddress *cached_remote_address;
+
gboolean in_dispose;
};
GAsyncResult *result,
GError **error);
+G_DEFINE_TYPE_WITH_PRIVATE (GSocketConnection, g_socket_connection, G_TYPE_IO_STREAM)
+
static GInputStream *
g_socket_connection_get_input_stream (GIOStream *io_stream)
{
}
/**
+ * g_socket_connection_is_connected:
+ * @connection: a #GSocketConnection
+ *
+ * Checks if @connection is connected. This is equivalent to calling
+ * g_socket_is_connected() on @connection's underlying #GSocket.
+ *
+ * Returns: whether @connection is connected
+ *
+ * Since: 2.32
+ */
+gboolean
+g_socket_connection_is_connected (GSocketConnection *connection)
+{
+ return g_socket_is_connected (connection->priv->socket);
+}
+
+/**
+ * g_socket_connection_connect:
+ * @connection: a #GSocketConnection
+ * @address: a #GSocketAddress specifying the remote address.
+ * @cancellable: (allow-none): a %GCancellable or %NULL
+ * @error: #GError for error reporting, or %NULL to ignore.
+ *
+ * Connect @connection to the specified remote address.
+ *
+ * Returns: %TRUE if the connection succeeded, %FALSE on error
+ *
+ * Since: 2.32
+ */
+gboolean
+g_socket_connection_connect (GSocketConnection *connection,
+ GSocketAddress *address,
+ GCancellable *cancellable,
+ GError **error)
+{
+ g_return_val_if_fail (G_IS_SOCKET_CONNECTION (connection), FALSE);
+ g_return_val_if_fail (G_IS_SOCKET_ADDRESS (address), FALSE);
+
+ return g_socket_connect (connection->priv->socket, address,
+ cancellable, error);
+}
+
+static gboolean g_socket_connection_connect_callback (GSocket *socket,
+ GIOCondition condition,
+ gpointer user_data);
+
+/**
+ * g_socket_connection_connect_async:
+ * @connection: a #GSocketConnection
+ * @address: a #GSocketAddress specifying the remote address.
+ * @cancellable: (allow-none): a %GCancellable or %NULL
+ * @callback: (scope async): a #GAsyncReadyCallback
+ * @user_data: (closure): user data for the callback
+ *
+ * Asynchronously connect @connection to the specified remote address.
+ *
+ * This clears the #GSocket:blocking flag on @connection's underlying
+ * socket if it is currently set.
+ *
+ * Use g_socket_connection_connect_finish() to retrieve the result.
+ *
+ * Since: 2.32
+ */
+void
+g_socket_connection_connect_async (GSocketConnection *connection,
+ GSocketAddress *address,
+ GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data)
+{
+ GTask *task;
+ GError *tmp_error = NULL;
+
+ g_return_if_fail (G_IS_SOCKET_CONNECTION (connection));
+ g_return_if_fail (G_IS_SOCKET_ADDRESS (address));
+
+ task = g_task_new (connection, cancellable, callback, user_data);
+
+ g_socket_set_blocking (connection->priv->socket, FALSE);
+
+ if (g_socket_connect (connection->priv->socket, address,
+ cancellable, &tmp_error))
+ {
+ g_task_return_boolean (task, TRUE);
+ g_object_unref (task);
+ }
+ else if (g_error_matches (tmp_error, G_IO_ERROR, G_IO_ERROR_PENDING))
+ {
+ GSource *source;
+
+ g_error_free (tmp_error);
+ source = g_socket_create_source (connection->priv->socket,
+ G_IO_OUT, cancellable);
+ g_task_attach_source (task, source,
+ (GSourceFunc) g_socket_connection_connect_callback);
+ g_source_unref (source);
+ }
+ else
+ {
+ g_task_return_error (task, tmp_error);
+ g_object_unref (task);
+ }
+}
+
+static gboolean
+g_socket_connection_connect_callback (GSocket *socket,
+ GIOCondition condition,
+ gpointer user_data)
+{
+ GTask *task = user_data;
+ GSocketConnection *connection = g_task_get_source_object (task);
+ GError *error = NULL;
+
+ if (g_socket_check_connect_result (connection->priv->socket, &error))
+ g_task_return_boolean (task, TRUE);
+ else
+ g_task_return_error (task, error);
+
+ g_object_unref (task);
+ return FALSE;
+}
+
+/**
+ * g_socket_connection_connect_finish:
+ * @connection: a #GSocketConnection
+ * @result: the #GAsyncResult
+ * @error: #GError for error reporting, or %NULL to ignore.
+ *
+ * Gets the result of a g_socket_connection_connect_async() call.
+ *
+ * Returns: %TRUE if the connection succeeded, %FALSE on error
+ *
+ * Since: 2.32
+ */
+gboolean
+g_socket_connection_connect_finish (GSocketConnection *connection,
+ GAsyncResult *result,
+ GError **error)
+{
+ g_return_val_if_fail (G_IS_SOCKET_CONNECTION (connection), FALSE);
+ g_return_val_if_fail (g_task_is_valid (result, connection), FALSE);
+
+ return g_task_propagate_boolean (G_TASK (result), error);
+}
+
+/**
* g_socket_connection_get_socket:
* @connection: a #GSocketConnection
*
*
* Try to get the remote address of a socket connection.
*
+ * Since GLib 2.40, when used with g_socket_client_connect() or
+ * g_socket_client_connect_async(), during emission of
+ * %G_SOCKET_CLIENT_CONNECTING, this function will return the remote
+ * address that will be used for the connection. This allows
+ * applications to print e.g. "Connecting to example.com
+ * (10.42.77.3)...".
+ *
* Returns: (transfer full): a #GSocketAddress or %NULL on error.
* Free the returned object with g_object_unref().
*
g_socket_connection_get_remote_address (GSocketConnection *connection,
GError **error)
{
+ if (!g_socket_is_connected (connection->priv->socket))
+ {
+ return connection->priv->cached_remote_address ?
+ g_object_ref (connection->priv->cached_remote_address) : NULL;
+ }
return g_socket_get_remote_address (connection->priv->socket, error);
}
+/* Private API allowing applications to retrieve the resolved address
+ * now, before we start connecting.
+ *
+ * https://bugzilla.gnome.org/show_bug.cgi?id=712547
+ */
+void
+g_socket_connection_set_cached_remote_address (GSocketConnection *connection,
+ GSocketAddress *address)
+{
+ g_clear_object (&connection->priv->cached_remote_address);
+ connection->priv->cached_remote_address = address ? g_object_ref (address) : NULL;
+}
+
static void
g_socket_connection_get_property (GObject *object,
guint prop_id,
connection->priv->in_dispose = TRUE;
+ g_clear_object (&connection->priv->cached_remote_address);
+
G_OBJECT_CLASS (g_socket_connection_parent_class)
->dispose (object);
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
GIOStreamClass *stream_class = G_IO_STREAM_CLASS (klass);
- g_type_class_add_private (klass, sizeof (GSocketConnectionPrivate));
-
gobject_class->set_property = g_socket_connection_set_property;
gobject_class->get_property = g_socket_connection_get_property;
gobject_class->constructed = g_socket_connection_constructed;
static void
g_socket_connection_init (GSocketConnection *connection)
{
- connection->priv = G_TYPE_INSTANCE_GET_PRIVATE (connection,
- G_TYPE_SOCKET_CONNECTION,
- GSocketConnectionPrivate);
+ connection->priv = g_socket_connection_get_instance_private (connection);
}
static gboolean
GAsyncReadyCallback callback,
gpointer user_data)
{
- GSimpleAsyncResult *res;
+ GTask *task;
GIOStreamClass *class;
GError *error;
class = G_IO_STREAM_GET_CLASS (stream);
+ task = g_task_new (stream, cancellable, callback, user_data);
+
/* socket close is not blocked, just do it! */
error = NULL;
if (class->close_fn &&
!class->close_fn (stream, cancellable, &error))
- {
- g_simple_async_report_gerror_in_idle (G_OBJECT (stream),
- callback, user_data,
- error);
- g_error_free (error);
- return;
- }
+ g_task_return_error (task, error);
+ else
+ g_task_return_boolean (task, TRUE);
- res = g_simple_async_result_new (G_OBJECT (stream),
- callback,
- user_data,
- g_socket_connection_close_async);
- g_simple_async_result_complete_in_idle (res);
- g_object_unref (res);
+ g_object_unref (task);
}
static gboolean
GAsyncResult *result,
GError **error)
{
- return TRUE;
+ return g_task_propagate_boolean (G_TASK (result), error);
}
typedef struct {
* @protocol: a protocol id
*
* Looks up the #GType to be used when creating socket connections on
- * sockets with the specified @family,@type and @protocol.
+ * sockets with the specified @family, @type and @protocol.
*
* If no type is registered, the #GSocketConnection base type is returned.
*
static void
init_builtin_types (void)
{
- volatile GType a_type;
#ifndef G_OS_WIN32
- a_type = g_unix_connection_get_type ();
+ g_type_ensure (G_TYPE_UNIX_CONNECTION);
#endif
- a_type = g_tcp_connection_get_type ();
+ g_type_ensure (G_TYPE_TCP_CONNECTION);
}
/**
* @protocol_id: a protocol id
*
* Looks up the #GType to be used when creating socket connections on
- * sockets with the specified @family,@type and @protocol_id.
+ * sockets with the specified @family, @type and @protocol_id.
*
* If no type is registered, the #GSocketConnection base type is returned.
*
projects / platform / upstream / glib.git / blobdiff