gio/gsocketservice.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright © 2009 Codethink Limited
   4  * Copyright © 2009 Red Hat, Inc
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Lesser General Public License as published
   8  * by the Free Software Foundation; either version 2 of the licence or (at
   9  * your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General
  17  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  18  *
  19  * Authors: Ryan Lortie <desrt@desrt.ca>
  20  *          Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 /**
  24  * SECTION:gsocketservice
  25  * @title: GSocketService
  26  * @short_description: Make it easy to implement a network service
  27  * @include: gio/gio.h
  28  * @see_also: #GThreadedSocketService, #GSocketListener.
  29  *
  30  * A #GSocketService is an object that represents a service that
  31  * is provided to the network or over local sockets.  When a new
  32  * connection is made to the service the #GSocketService::incoming
  33  * signal is emitted.
  34  *
  35  * A #GSocketService is a subclass of #GSocketListener and you need
  36  * to add the addresses you want to accept connections on with the
  37  * #GSocketListener APIs.
  38  *
  39  * There are two options for implementing a network service based on
  40  * #GSocketService. The first is to create the service using
  41  * g_socket_service_new() and to connect to the #GSocketService::incoming
  42  * signal. The second is to subclass #GSocketService and override the
  43  * default signal handler implementation.
  44  *
  45  * In either case, the handler must immediately return, or else it
  46  * will block additional incoming connections from being serviced.
  47  * If you are interested in writing connection handlers that contain
  48  * blocking code then see #GThreadedSocketService.
  49  *
  50  * The socket service runs on the main loop of the
  51  * [thread-default context][g-main-context-push-thread-default-context]
  52  * of the thread it is created in, and is not
  53  * threadsafe in general. However, the calls to start and stop the
  54  * service are thread-safe so these can be used from threads that
  55  * handle incoming clients.
  56  *
  57  * Since: 2.22
  58  */
  59
  60 #include "config.h"
  61 #include "gsocketservice.h"
  62
  63 #include <gio/gio.h>
  64 #include "gsocketlistener.h"
  65 #include "gsocketconnection.h"
  66
  67 struct _GSocketServicePrivate
  68 {
  69   GCancellable *cancellable;
  70   guint active : 1;
  71   guint outstanding_accept : 1;
  72 };
  73
  74 static guint g_socket_service_incoming_signal;
  75
  76 G_LOCK_DEFINE_STATIC(active);
  77
  78 G_DEFINE_TYPE_WITH_PRIVATE (GSocketService, g_socket_service, G_TYPE_SOCKET_LISTENER)
  79
  80 static void g_socket_service_ready (GObject      *object,
  81                                     GAsyncResult *result,
  82                                     gpointer      user_data);
  83
  84 static gboolean
  85 g_socket_service_real_incoming (GSocketService    *service,
  86                                 GSocketConnection *connection,
  87                                 GObject           *source_object)
  88 {
  89   return FALSE;
  90 }
  91
  92 static void
  93 g_socket_service_init (GSocketService *service)
  94 {
  95   service->priv = g_socket_service_get_instance_private (service);
  96   service->priv->cancellable = g_cancellable_new ();
  97   service->priv->active = TRUE;
  98 }
  99
 100 static void
 101 g_socket_service_finalize (GObject *object)
 102 {
 103   GSocketService *service = G_SOCKET_SERVICE (object);
 104
 105   g_object_unref (service->priv->cancellable);
 106
 107   G_OBJECT_CLASS (g_socket_service_parent_class)
 108     ->finalize (object);
 109 }
 110
 111 static void
 112 do_accept (GSocketService  *service)
 113 {
 114   g_socket_listener_accept_async (G_SOCKET_LISTENER (service),
 115                                   service->priv->cancellable,
 116                                   g_socket_service_ready, NULL);
 117   service->priv->outstanding_accept = TRUE;
 118 }
 119
 120 static void
 121 g_socket_service_changed (GSocketListener *listener)
 122 {
 123   GSocketService  *service = G_SOCKET_SERVICE (listener);
 124
 125   G_LOCK (active);
 126
 127   if (service->priv->active)
 128     {
 129       if (service->priv->outstanding_accept)
 130         g_cancellable_cancel (service->priv->cancellable);
 131       else
 132         do_accept (service);
 133     }
 134
 135   G_UNLOCK (active);
 136 }
 137
 138 /**
 139  * g_socket_service_is_active:
 140  * @service: a #GSocketService
 141  *
 142  * Check whether the service is active or not. An active
 143  * service will accept new clients that connect, while
 144  * a non-active service will let connecting clients queue
 145  * up until the service is started.
 146  *
 147  * Returns: %TRUE if the service is active, %FALSE otherwise
 148  *
 149  * Since: 2.22
 150  */
 151 gboolean
 152 g_socket_service_is_active (GSocketService *service)
 153 {
 154   gboolean active;
 155
 156   G_LOCK (active);
 157   active = service->priv->active;
 158   G_UNLOCK (active);
 159   return active;
 160 }
 161
 162 /**
 163  * g_socket_service_start:
 164  * @service: a #GSocketService
 165  *
 166  * Starts the service, i.e. start accepting connections
 167  * from the added sockets when the mainloop runs.
 168  *
 169  * This call is thread-safe, so it may be called from a thread
 170  * handling an incoming client request.
 171  *
 172  * Since: 2.22
 173  */
 174 void
 175 g_socket_service_start (GSocketService *service)
 176 {
 177   G_LOCK (active);
 178
 179   if (!service->priv->active)
 180     {
 181       service->priv->active = TRUE;
 182
 183       if (service->priv->outstanding_accept)
 184         g_cancellable_cancel (service->priv->cancellable);
 185       else
 186         do_accept (service);
 187     }
 188
 189   G_UNLOCK (active);
 190 }
 191
 192 /**
 193  * g_socket_service_stop:
 194  * @service: a #GSocketService
 195  *
 196  * Stops the service, i.e. stops accepting connections
 197  * from the added sockets when the mainloop runs.
 198  *
 199  * This call is thread-safe, so it may be called from a thread
 200  * handling an incoming client request.
 201  *
 202  * Note that this only stops accepting new connections; it does not
 203  * close the listening sockets, and you can call
 204  * g_socket_service_start() again later to begin listening again. To
 205  * close the listening sockets, call g_socket_listener_close(). (This
 206  * will happen automatically when the #GSocketService is finalized.)
 207  *
 208  * Since: 2.22
 209  */
 210 void
 211 g_socket_service_stop (GSocketService *service)
 212 {
 213   G_LOCK (active);
 214
 215   if (service->priv->active)
 216     {
 217       service->priv->active = FALSE;
 218
 219       if (service->priv->outstanding_accept)
 220         g_cancellable_cancel (service->priv->cancellable);
 221     }
 222
 223   G_UNLOCK (active);
 224 }
 225
 226
 227 static gboolean
 228 g_socket_service_incoming (GSocketService    *service,
 229                            GSocketConnection *connection,
 230                            GObject           *source_object)
 231 {
 232   gboolean result;
 233
 234   g_signal_emit (service, g_socket_service_incoming_signal,
 235                  0, connection, source_object, &result);
 236   return result;
 237 }
 238
 239 static void
 240 g_socket_service_class_init (GSocketServiceClass *class)
 241 {
 242   GObjectClass *gobject_class = G_OBJECT_CLASS (class);
 243   GSocketListenerClass *listener_class = G_SOCKET_LISTENER_CLASS (class);
 244
 245   gobject_class->finalize = g_socket_service_finalize;
 246   listener_class->changed = g_socket_service_changed;
 247   class->incoming = g_socket_service_real_incoming;
 248
 249   /**
 250    * GSocketService::incoming:
 251    * @service: the #GSocketService
 252    * @connection: a new #GSocketConnection object
 253    * @source_object: (allow-none): the source_object passed to
 254    *     g_socket_listener_add_address()
 255    *
 256    * The ::incoming signal is emitted when a new incoming connection
 257    * to @service needs to be handled. The handler must initiate the
 258    * handling of @connection, but may not block; in essence,
 259    * asynchronous operations must be used.
 260    *
 261    * @connection will be unreffed once the signal handler returns,
 262    * so you need to ref it yourself if you are planning to use it.
 263    *
 264    * Returns: %TRUE to stop other handlers from being called
 265    *
 266    * Since: 2.22
 267    */
 268   g_socket_service_incoming_signal =
 269     g_signal_new ("incoming", G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST,
 270                   G_STRUCT_OFFSET (GSocketServiceClass, incoming),
 271                   g_signal_accumulator_true_handled, NULL,
 272                   NULL, G_TYPE_BOOLEAN,
 273                   2, G_TYPE_SOCKET_CONNECTION, G_TYPE_OBJECT);
 274 }
 275
 276 static void
 277 g_socket_service_ready (GObject      *object,
 278                         GAsyncResult *result,
 279                         gpointer      user_data)
 280 {
 281   GSocketListener *listener = G_SOCKET_LISTENER (object);
 282   GSocketService *service = G_SOCKET_SERVICE (object);
 283   GSocketConnection *connection;
 284   GObject *source_object;
 285   GError *error = NULL;
 286
 287   connection = g_socket_listener_accept_finish (listener, result, &source_object, &error);
 288   if (error)
 289     {
 290       if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
 291         g_warning ("fail: %s", error->message);
 292       g_error_free (error);
 293     }
 294   else
 295     {
 296       g_socket_service_incoming (service, connection, source_object);
 297       g_object_unref (connection);
 298     }
 299
 300   G_LOCK (active);
 301
 302   g_cancellable_reset (service->priv->cancellable);
 303
 304   /* requeue */
 305   service->priv->outstanding_accept = FALSE;
 306   if (service->priv->active)
 307     do_accept (service);
 308
 309   G_UNLOCK (active);
 310 }
 311
 312
 313 /**
 314  * g_socket_service_new:
 315  *
 316  * Creates a new #GSocketService with no sockets to listen for.
 317  * New listeners can be added with e.g. g_socket_listener_add_address()
 318  * or g_socket_listener_add_inet_port().
 319  *
 320  * Returns: a new #GSocketService.
 321  *
 322  * Since: 2.22
 323  */
 324 GSocketService *
 325 g_socket_service_new (void)
 326 {
 327   return g_object_new (G_TYPE_SOCKET_SERVICE, NULL);
 328 }