gsocketservice.c 11.8 KB
Newer Older
1 2 3 4 5
/* GIO - GLib Input, Output and Streaming Library
 *
 * Copyright © 2009 Codethink Limited
 * Copyright © 2009 Red Hat, Inc
 *
6 7 8 9
 * 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.1 of the License, or (at your option) any later version.
10 11 12 13 14 15 16
 *
 * 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
17
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 19 20 21 22 23
 *
 * Authors: Ryan Lortie <desrt@desrt.ca>
 *          Alexander Larsson <alexl@redhat.com>
 */

/**
24
 * SECTION:gsocketservice
25
 * @title: GSocketService
26
 * @short_description: Make it easy to implement a network service
27
 * @include: gio/gio.h
28 29
 * @see_also: #GThreadedSocketService, #GSocketListener.
 *
Matthias Clasen's avatar
Matthias Clasen committed
30 31 32
 * A #GSocketService is an object that represents a service that
 * is provided to the network or over local sockets.  When a new
 * 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 37
 * to add the addresses you want to accept connections on with the
 * #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
Matthias Clasen's avatar
Matthias Clasen committed
41
 * g_socket_service_new() and to connect to the #GSocketService::incoming
42 43
 * signal. The second is to subclass #GSocketService and override the
 * default signal handler implementation.
44 45
 *
 * In either case, the handler must immediately return, or else it
46 47
 * will block additional incoming connections from being serviced.
 * If you are interested in writing connection handlers that contain
48 49
 * blocking code then see #GThreadedSocketService.
 *
50 51 52
 * The socket service runs on the main loop of the 
 * [thread-default context][g-main-context-push-thread-default-context]
 * of the thread it is created in, and is not
53 54
 * threadsafe in general. However, the calls to start and stop the
 * service are thread-safe so these can be used from threads that
55
 * handle incoming clients.
56 57 58 59 60 61 62 63 64 65
 *
 * Since: 2.22
 */

#include "config.h"
#include "gsocketservice.h"

#include <gio/gio.h>
#include "gsocketlistener.h"
#include "gsocketconnection.h"
66
#include "glibintl.h"
67 68 69 70 71 72 73 74

struct _GSocketServicePrivate
{
  GCancellable *cancellable;
  guint active : 1;
  guint outstanding_accept : 1;
};

75 76 77 78 79 80
static guint g_socket_service_incoming_signal;

G_LOCK_DEFINE_STATIC(active);

G_DEFINE_TYPE_WITH_PRIVATE (GSocketService, g_socket_service, G_TYPE_SOCKET_LISTENER)

81 82 83 84 85 86
enum
{
  PROP_0,
  PROP_ACTIVE
};

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
static void g_socket_service_ready (GObject      *object,
				    GAsyncResult *result,
				    gpointer      user_data);

static gboolean
g_socket_service_real_incoming (GSocketService    *service,
                                GSocketConnection *connection,
                                GObject           *source_object)
{
  return FALSE;
}

static void
g_socket_service_init (GSocketService *service)
{
102
  service->priv = g_socket_service_get_instance_private (service);
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
  service->priv->cancellable = g_cancellable_new ();
  service->priv->active = TRUE;
}

static void
g_socket_service_finalize (GObject *object)
{
  GSocketService *service = G_SOCKET_SERVICE (object);

  g_object_unref (service->priv->cancellable);

  G_OBJECT_CLASS (g_socket_service_parent_class)
    ->finalize (object);
}

static void
do_accept (GSocketService  *service)
{
  g_socket_listener_accept_async (G_SOCKET_LISTENER (service),
				  service->priv->cancellable,
				  g_socket_service_ready, NULL);
  service->priv->outstanding_accept = TRUE;
}

127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
static gboolean
get_active (GSocketService *service)
{
  gboolean active;

  G_LOCK (active);
  active = service->priv->active;
  G_UNLOCK (active);

  return active;
}

static void
set_active (GSocketService *service, gboolean active)
{
  gboolean notify = FALSE;

  active = !!active;

  G_LOCK (active);

  if (active != service->priv->active)
    {
      service->priv->active = active;
      notify = TRUE;

      if (active)
        {
          if (service->priv->outstanding_accept)
            g_cancellable_cancel (service->priv->cancellable);
          else
            do_accept (service);
        }
      else
        {
          if (service->priv->outstanding_accept)
            g_cancellable_cancel (service->priv->cancellable);
        }
    }

  G_UNLOCK (active);

  if (notify)
    g_object_notify (G_OBJECT (service), "active");
}

static void
g_socket_service_get_property (GObject    *object,
                               guint       prop_id,
                               GValue     *value,
                               GParamSpec *pspec)
{
  GSocketService *service = G_SOCKET_SERVICE (object);

  switch (prop_id)
    {
    case PROP_ACTIVE:
      g_value_set_boolean (value, get_active (service));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
g_socket_service_set_property (GObject      *object,
                               guint         prop_id,
                               const GValue *value,
                               GParamSpec   *pspec)
{
  GSocketService *service = G_SOCKET_SERVICE (object);

  switch (prop_id)
    {
    case PROP_ACTIVE:
      set_active (service, g_value_get_boolean (value));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

211 212 213 214 215 216 217 218 219 220 221 222
static void
g_socket_service_changed (GSocketListener *listener)
{
  GSocketService  *service = G_SOCKET_SERVICE (listener);

  G_LOCK (active);

  if (service->priv->active)
    {
      if (service->priv->outstanding_accept)
	g_cancellable_cancel (service->priv->cancellable);
      else
223
	do_accept (service);
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
    }

  G_UNLOCK (active);
}

/**
 * g_socket_service_is_active:
 * @service: a #GSocketService
 *
 * Check whether the service is active or not. An active
 * service will accept new clients that connect, while
 * a non-active service will let connecting clients queue
 * up until the service is started.
 *
 * Returns: %TRUE if the service is active, %FALSE otherwise
 *
 * Since: 2.22
241
 */
242 243 244
gboolean
g_socket_service_is_active (GSocketService *service)
{
245
  g_return_val_if_fail (G_IS_SOCKET_SERVICE (service), FALSE);
246

247
  return get_active (service);
248 249 250 251 252 253
}

/**
 * g_socket_service_start:
 * @service: a #GSocketService
 *
254 255 256 257
 * Restarts the service, i.e. start accepting connections
 * from the added sockets when the mainloop runs. This only needs
 * to be called after the service has been stopped from
 * g_socket_service_stop().
258
 *
259
 * This call is thread-safe, so it may be called from a thread
Matthias Clasen's avatar
Matthias Clasen committed
260
 * handling an incoming client request.
261 262
 *
 * Since: 2.22
263
 */
264 265 266
void
g_socket_service_start (GSocketService *service)
{
267
  g_return_if_fail (G_IS_SOCKET_SERVICE (service));
268

269
  set_active (service, TRUE);
270 271 272 273 274 275 276 277 278
}

/**
 * g_socket_service_stop:
 * @service: a #GSocketService
 *
 * Stops the service, i.e. stops accepting connections
 * from the added sockets when the mainloop runs.
 *
279
 * This call is thread-safe, so it may be called from a thread
Matthias Clasen's avatar
Matthias Clasen committed
280
 * handling an incoming client request.
281
 *
282 283 284 285 286 287
 * Note that this only stops accepting new connections; it does not
 * close the listening sockets, and you can call
 * g_socket_service_start() again later to begin listening again. To
 * close the listening sockets, call g_socket_listener_close(). (This
 * will happen automatically when the #GSocketService is finalized.)
 *
288 289 290 291
 * This must be called before calling g_socket_listener_close() as
 * the socket service will start accepting connections immediately
 * when a new socket is added.
 *
292
 * Since: 2.22
293
 */
294
void
295
g_socket_service_stop (GSocketService *service)
296
{
297
  g_return_if_fail (G_IS_SOCKET_SERVICE (service));
298

299
  set_active (service, FALSE);
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
}

static gboolean
g_socket_service_incoming (GSocketService    *service,
                           GSocketConnection *connection,
                           GObject           *source_object)
{
  gboolean result;

  g_signal_emit (service, g_socket_service_incoming_signal,
                 0, connection, source_object, &result);
  return result;
}

static void
g_socket_service_class_init (GSocketServiceClass *class)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (class);
  GSocketListenerClass *listener_class = G_SOCKET_LISTENER_CLASS (class);

  gobject_class->finalize = g_socket_service_finalize;
321 322
  gobject_class->set_property = g_socket_service_set_property;
  gobject_class->get_property = g_socket_service_get_property;
323 324 325 326 327
  listener_class->changed = g_socket_service_changed;
  class->incoming = g_socket_service_real_incoming;

  /**
   * GSocketService::incoming:
Matthias Clasen's avatar
Matthias Clasen committed
328 329
   * @service: the #GSocketService
   * @connection: a new #GSocketConnection object
330
   * @source_object: (nullable): the source_object passed to
331
   *     g_socket_listener_add_address()
332 333
   *
   * The ::incoming signal is emitted when a new incoming connection
334
   * to @service needs to be handled. The handler must initiate the
335 336 337
   * handling of @connection, but may not block; in essence,
   * asynchronous operations must be used.
   *
Matthias Clasen's avatar
Matthias Clasen committed
338 339
   * @connection will be unreffed once the signal handler returns,
   * so you need to ref it yourself if you are planning to use it.
340
   *
341 342 343 344
   * Returns: %TRUE to stop other handlers from being called
   *
   * Since: 2.22
   */
345
  g_socket_service_incoming_signal =
346
    g_signal_new (I_("incoming"), G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST,
347 348
                  G_STRUCT_OFFSET (GSocketServiceClass, incoming),
                  g_signal_accumulator_true_handled, NULL,
349
                  NULL, G_TYPE_BOOLEAN,
350
                  2, G_TYPE_SOCKET_CONNECTION, G_TYPE_OBJECT);
351 352 353 354 355 356 357 358 359 360 361 362 363 364

  /**
   * GSocketService:active:
   *
   * Whether the service is currently accepting connections.
   *
   * Since: 2.46
   */
  g_object_class_install_property (gobject_class, PROP_ACTIVE,
                                   g_param_spec_boolean ("active",
                                                         P_("Active"),
                                                         P_("Whether the service is currently accepting connections"),
                                                         TRUE,
                                                         G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
}

static void
g_socket_service_ready (GObject      *object,
                        GAsyncResult *result,
                        gpointer      user_data)
{
  GSocketListener *listener = G_SOCKET_LISTENER (object);
  GSocketService *service = G_SOCKET_SERVICE (object);
  GSocketConnection *connection;
  GObject *source_object;
  GError *error = NULL;

  connection = g_socket_listener_accept_finish (listener, result, &source_object, &error);
  if (error)
    {
      if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
	g_warning ("fail: %s", error->message);
      g_error_free (error);
    }
  else
    {
      g_socket_service_incoming (service, connection, source_object);
      g_object_unref (connection);
    }

  G_LOCK (active);

  g_cancellable_reset (service->priv->cancellable);

  /* requeue */
  service->priv->outstanding_accept = FALSE;
  if (service->priv->active)
    do_accept (service);

  G_UNLOCK (active);
}

/**
 * g_socket_service_new:
 *
 * Creates a new #GSocketService with no sockets to listen for.
 * New listeners can be added with e.g. g_socket_listener_add_address()
 * or g_socket_listener_add_inet_port().
 *
410 411 412 413
 * New services are created active, there is no need to call
 * g_socket_service_start(), unless g_socket_service_stop() has been
 * called before.
 *
414 415 416
 * Returns: a new #GSocketService.
 *
 * Since: 2.22
417
 */
418 419 420 421 422
GSocketService *
g_socket_service_new (void)
{
  return g_object_new (G_TYPE_SOCKET_SERVICE, NULL);
}