gnio/gtcpclient.c

   1 /* GNIO - GLib Network Layer of GIO
   2  *
   3  * Copyright (C) 2008 Christian Kellner, Samuel Cormier-Iijima
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Authors: Christian Kellner <gicmo@gnome.org>
  21  *          Samuel Cormier-Iijima <sciyoshi@gmail.com>
  22  */
  23
  24 #include <config.h>
  25 #include <glib.h>
  26 #include <gio/gio.h>
  27 #include <gnio/gnio.h>
  28
  29 #include <string.h>
  30 #include <errno.h>
  31
  32 G_DEFINE_TYPE (GTcpClient, g_tcp_client, G_TYPE_OBJECT);
  33
  34 enum
  35 {
  36   PROP_0,
  37   PROP_ADDRESS,
  38   PROP_HOSTNAME,
  39   PROP_PORT,
  40   PROP_INPUT_STREAM,
  41   PROP_OUTPUT_STREAM
  42 };
  43
  44 struct _GTcpClientPrivate
  45 {
  46   GInetSocketAddress   *address;
  47   gchar                *hostname;
  48   gushort               port;
  49   GSocket              *socket;
  50   GNetworkInputStream  *input;
  51   GNetworkOutputStream *output;
  52 };
  53
  54 static void
  55 g_tcp_client_constructed (GObject *object)
  56 {
  57   GTcpClient *client = G_TCP_CLIENT (object);
  58
  59   if (client->priv->address)
  60     {
  61       // we've been constructed with an address, extract hostname+port
  62       client->priv->hostname = g_inet_address_to_string (g_inet_socket_address_get_address (client->priv->address));
  63       client->priv->port = g_inet_socket_address_get_port (client->priv->address);
  64       return;
  65     }
  66 }
  67
  68 static void
  69 g_tcp_client_get_property (GObject    *object,
  70                            guint       prop_id,
  71                            GValue     *value,
  72                            GParamSpec *pspec)
  73 {
  74   GTcpClient *client = G_TCP_CLIENT (object);
  75
  76   switch (prop_id)
  77     {
  78       case PROP_ADDRESS:
  79         g_value_set_object (value, client->priv->address);
  80         break;
  81
  82       case PROP_HOSTNAME:
  83         g_value_set_string (value, client->priv->hostname);
  84         break;
  85
  86       case PROP_PORT:
  87         g_value_set_uint (value, client->priv->port);
  88         break;
  89
  90       case PROP_INPUT_STREAM:
  91         g_value_set_object (value, g_tcp_client_get_input_stream (client));
  92         break;
  93
  94       case PROP_OUTPUT_STREAM:
  95         g_value_set_object (value, g_tcp_client_get_output_stream (client));
  96         break;
  97
  98       default:
  99         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 100     }
 101 }
 102
 103 static void
 104 g_tcp_client_set_property (GObject      *object,
 105                            guint         prop_id,
 106                            const GValue *value,
 107                            GParamSpec   *pspec)
 108 {
 109   GTcpClient *client = G_TCP_CLIENT (object);
 110
 111   switch (prop_id)
 112     {
 113       case PROP_ADDRESS:
 114         // sink the address' floating reference
 115         client->priv->address = G_INET_SOCKET_ADDRESS (g_value_get_object (value));
 116         if (client->priv->address)
 117           g_object_ref_sink (client->priv->address);
 118         break;
 119
 120       case PROP_HOSTNAME:
 121         client->priv->hostname = g_value_dup_string (value);
 122         break;
 123
 124       case PROP_PORT:
 125         client->priv->port = g_value_get_uint (value);
 126         break;
 127
 128       default:
 129         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 130     }
 131 }
 132
 133 static void
 134 g_tcp_client_finalize (GObject *object)
 135 {
 136   GTcpClient *client = G_TCP_CLIENT (object);
 137
 138   g_object_unref (client->priv->address);
 139
 140   if (G_OBJECT_CLASS (g_tcp_client_parent_class)->finalize)
 141     (*G_OBJECT_CLASS (g_tcp_client_parent_class)->finalize) (object);
 142 }
 143
 144 static void
 145 g_tcp_client_dispose (GObject *object)
 146 {
 147   GTcpClient *client = G_TCP_CLIENT (object);
 148
 149   g_free (client->priv->hostname);
 150
 151   if (G_OBJECT_CLASS (g_tcp_client_parent_class)->dispose)
 152     (*G_OBJECT_CLASS (g_tcp_client_parent_class)->dispose) (object);
 153 }
 154
 155 static void
 156 g_tcp_client_class_init (GTcpClientClass *klass)
 157 {
 158   GObjectClass *gobject_class G_GNUC_UNUSED = G_OBJECT_CLASS (klass);
 159
 160   g_type_class_add_private (klass, sizeof (GTcpClientPrivate));
 161
 162   gobject_class->finalize = g_tcp_client_finalize;
 163   gobject_class->dispose = g_tcp_client_dispose;
 164   gobject_class->constructed = g_tcp_client_constructed;
 165   gobject_class->set_property = g_tcp_client_set_property;
 166   gobject_class->get_property = g_tcp_client_get_property;
 167
 168   g_object_class_install_property (gobject_class, PROP_ADDRESS,
 169                                    g_param_spec_object ("address",
 170                                                         "address",
 171                                                         "the remote address the socket will connect to",
 172                                                         G_TYPE_INET_SOCKET_ADDRESS,
 173                                                         G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 174
 175   g_object_class_install_property (gobject_class, PROP_HOSTNAME,
 176                                    g_param_spec_string ("hostname",
 177                                                         "hostname",
 178                                                         "the hostname of the remote address the socket will connect to",
 179                                                         NULL,
 180                                                         G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 181
 182   g_object_class_install_property (gobject_class, PROP_PORT,
 183                                    g_param_spec_uint ("port",
 184                                                       "port",
 185                                                       "the remote port the socket will connect to",
 186                                                       0,
 187                                                       G_MAXUSHORT,
 188                                                       0,
 189                                                       G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 190
 191   g_object_class_install_property (gobject_class, PROP_INPUT_STREAM,
 192                                    g_param_spec_object ("input-stream",
 193                                                         "input stream",
 194                                                         "the GNetworkInputStream for reading from this socket",
 195                                                         G_TYPE_NETWORK_INPUT_STREAM,
 196                                                         G_PARAM_READABLE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 197
 198   g_object_class_install_property (gobject_class, PROP_OUTPUT_STREAM,
 199                                    g_param_spec_object ("output-stream",
 200                                                         "output stream",
 201                                                         "the GNetworkOutputStream for writing to this socket",
 202                                                         G_TYPE_NETWORK_OUTPUT_STREAM,
 203                                                         G_PARAM_READABLE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
 204 }
 205
 206 static void
 207 g_tcp_client_init (GTcpClient *client)
 208 {
 209   client->priv = G_TYPE_INSTANCE_GET_PRIVATE (client, G_TYPE_TCP_CLIENT, GTcpClientPrivate);
 210
 211   client->priv->address = NULL;
 212   client->priv->hostname = NULL;
 213   client->priv->port = 0;
 214   client->priv->socket = NULL;
 215   client->priv->input = NULL;
 216   client->priv->output = NULL;
 217 }
 218
 219 GTcpClient *
 220 g_tcp_client_new (const gchar *hostname,
 221                   gushort      port)
 222 {
 223   return G_TCP_CLIENT (g_object_new (G_TYPE_TCP_CLIENT, "hostname", hostname, "port", port, NULL));
 224 }
 225
 226 GTcpClient *
 227 g_tcp_client_new_from_address (GInetSocketAddress *address)
 228 {
 229   return G_TCP_CLIENT (g_object_new (G_TYPE_TCP_CLIENT, "address", address, NULL));
 230 }
 231
 232 GNetworkInputStream *
 233 g_tcp_client_get_input_stream (GTcpClient *client)
 234 {
 235   if (!client->priv->socket)
 236     return NULL;
 237
 238   if (client->priv->input)
 239     return client->priv->input;
 240
 241   // TODO: should we set g_object_notify here, or just create both these streams earlier?
 242
 243   return (client->priv->input = _g_network_input_stream_new (client->priv->socket));
 244 }
 245
 246 GNetworkOutputStream *
 247 g_tcp_client_get_output_stream (GTcpClient *client)
 248 {
 249   if (!client->priv->socket)
 250     return NULL;
 251
 252   if (client->priv->output)
 253     return client->priv->output;
 254
 255   // TODO: should we set g_object_notify here, or just create both these streams earlier?
 256
 257   return (client->priv->output = _g_network_output_stream_new (client->priv->socket));
 258 }
 259
 260 gboolean
 261 g_tcp_client_connect (GTcpClient    *client,
 262                       GCancellable  *cancellable,
 263                       GError       **error)
 264 {
 265   GInetAddress *address;
 266
 267   g_return_val_if_fail (G_IS_TCP_CLIENT (client), FALSE);
 268
 269   if (!client->priv->address)
 270     {
 271       // we've been constructed with just hostname+port, resolve
 272       GResolver *resolver = g_resolver_new ();
 273
 274       address = g_resolver_resolve (resolver, client->priv->hostname, cancellable, error);
 275
 276       if (!address)
 277         return FALSE;
 278
 279       client->priv->address = g_inet_socket_address_new (address, client->priv->port);
 280
 281       g_object_unref (resolver);
 282
 283       g_object_ref_sink (client->priv->address);
 284     }
 285   else
 286     {
 287       address = g_inet_socket_address_get_address (client->priv->address);
 288     }
 289
 290   if (G_IS_INET4_ADDRESS (address))
 291     client->priv->socket = g_socket_new (G_SOCKET_DOMAIN_INET, G_SOCKET_TYPE_STREAM, NULL);
 292   else if (G_IS_INET6_ADDRESS (address))
 293     client->priv->socket = g_socket_new (G_SOCKET_DOMAIN_INET6, G_SOCKET_TYPE_STREAM, NULL);
 294   else
 295     {
 296       g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, "unsupported address domain");
 297       return FALSE;
 298     }
 299
 300   if (g_socket_has_error (client->priv->socket, error))
 301     return FALSE;
 302
 303   if (g_cancellable_set_error_if_cancelled (cancellable, error))
 304     return FALSE;
 305
 306   if (!g_socket_connect (client->priv->socket, G_SOCKET_ADDRESS (client->priv->address), error))
 307     return FALSE;
 308
 309   return TRUE;
 310 }
 311
 312 typedef struct {
 313   GAsyncReadyCallback  callback;
 314   GCancellable        *cancellable;
 315   gpointer             user_data;
 316   GTcpClient          *client;
 317 } ConnectData;
 318
 319 static gboolean
 320 connect_callback (ConnectData *data,
 321                   GIOCondition condition,
 322                   gint fd)
 323 {
 324   GTcpClient *client;
 325   GSimpleAsyncResult *result;
 326   GError *error = NULL;
 327
 328   client = data->client;
 329
 330   if (condition & G_IO_OUT)
 331     {
 332       result = g_simple_async_result_new (G_OBJECT (client), data->callback, data->user_data, g_tcp_client_connect_async);
 333     }
 334   else
 335     {
 336       if (!g_socket_has_socket_error (client->priv->socket, &error))
 337         g_warning ("got G_IO_ERR but socket does not have error");
 338
 339       result = g_simple_async_result_new_from_error (G_OBJECT (client), data->callback, data->user_data, error);
 340     }
 341
 342   g_simple_async_result_complete (result);
 343
 344   g_object_unref (result);
 345
 346   return FALSE;
 347 }
 348
 349 static void
 350 resolve_callback (GObject      *source,
 351                   GAsyncResult *result,
 352                   gpointer      user_data)
 353 {
 354   ConnectData *data = (ConnectData *) user_data;
 355   GInetAddress *address;
 356   GSimpleAsyncResult *error_result;
 357   GError *error = NULL;
 358
 359   address = g_resolver_resolve_finish (G_RESOLVER (source), result, &error);
 360
 361   g_object_unref (G_RESOLVER (source));
 362
 363   if (!address)
 364     {
 365       error_result = g_simple_async_result_new_from_error (G_OBJECT (data->client), data->callback, data->user_data, error);
 366
 367       g_simple_async_result_complete (error_result);
 368
 369       g_object_unref (error_result);
 370     }
 371   else
 372     {
 373       data->client->priv->address = g_inet_socket_address_new (address, data->client->priv->port);
 374
 375       g_object_ref_sink (data->client->priv->address);
 376
 377       // at this point, the address has been resolved, so connect_async again
 378       g_tcp_client_connect_async (data->client, data->cancellable, data->callback, data->user_data);
 379     }
 380
 381   g_free (data);
 382 }
 383
 384 void
 385 g_tcp_client_connect_async (GTcpClient          *client,
 386                             GCancellable        *cancellable,
 387                             GAsyncReadyCallback  callback,
 388                             gpointer             user_data)
 389 {
 390   GInetAddress *address;
 391   GSimpleAsyncResult *result;
 392   GSource *source;
 393   ConnectData *data;
 394   GError *error = NULL;
 395
 396   g_return_if_fail (G_IS_TCP_CLIENT (client));
 397
 398   if (!client->priv->address)
 399     {
 400       // we've been constructed with just hostname+port, resolve
 401       GResolver *resolver = g_resolver_new ();
 402
 403       data = g_new (ConnectData, 1);
 404
 405       data->client = client;
 406       data->callback = callback;
 407       data->cancellable = cancellable;
 408       data->user_data = user_data;
 409
 410       g_resolver_resolve_async (resolver, client->priv->hostname, cancellable, resolve_callback, data);
 411
 412       return;
 413     }
 414
 415   address = g_inet_socket_address_get_address (client->priv->address);
 416
 417   if (G_IS_INET4_ADDRESS (address))
 418     client->priv->socket = g_socket_new (G_SOCKET_DOMAIN_INET, G_SOCKET_TYPE_STREAM, NULL, &error);
 419   else if (G_IS_INET6_ADDRESS (address))
 420     client->priv->socket = g_socket_new (G_SOCKET_DOMAIN_INET6, G_SOCKET_TYPE_STREAM, NULL, &error);
 421   else
 422     {
 423       g_simple_async_report_error_in_idle (G_OBJECT (client), callback, user_data, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, "unsupported address domain");
 424       return;
 425     }
 426
 427   if (!client->priv->socket)
 428     {
 429       g_simple_async_report_gerror_in_idle (G_OBJECT (client), callback, user_data, error);
 430       return;
 431     }
 432
 433   g_socket_set_blocking (client->priv->socket, FALSE);
 434
 435   if (!g_socket_connect (client->priv->socket, G_SOCKET_ADDRESS (client->priv->address), &error))
 436     {
 437       if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_PENDING))
 438         {
 439           // the connection is in progress
 440           source = g_socket_create_source (client->priv->socket, G_IO_OUT | G_IO_ERR | G_IO_HUP, cancellable);
 441
 442           data = g_new (ConnectData, 1);
 443
 444           data->client = client;
 445           data->callback = callback;
 446           data->cancellable = cancellable;
 447           data->user_data = user_data;
 448
 449           g_source_set_callback (source, (GSourceFunc) connect_callback, data, g_free);
 450
 451           g_source_attach (source, NULL);
 452         }
 453       else
 454         {
 455           g_simple_async_report_gerror_in_idle (G_OBJECT (client), callback, user_data, error);
 456         }
 457     }
 458   else
 459     {
 460       // the connection is already completed
 461       result = g_simple_async_result_new (G_OBJECT (client), callback, user_data, g_tcp_client_connect_async);
 462
 463       g_simple_async_result_complete_in_idle (result);
 464
 465       g_object_unref (result);
 466     }
 467 }
 468
 469 gboolean
 470 g_tcp_client_connect_finish (GTcpClient    *client,
 471                              GAsyncResult  *result,
 472                              GError       **error)
 473 {
 474   GSimpleAsyncResult *simple;
 475
 476   g_return_val_if_fail (G_IS_TCP_CLIENT (client), FALSE);
 477
 478   simple = G_SIMPLE_ASYNC_RESULT (result);
 479
 480   if (g_simple_async_result_propagate_error (simple, error))
 481     return FALSE;
 482
 483   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_tcp_client_connect_async);
 484
 485   return TRUE;
 486 }
 487
 488 void
 489 g_tcp_client_close (GTcpClient *tcp_client)
 490 {
 491   g_return_if_fail (G_IS_TCP_CLIENT (tcp_client));
 492 }