gthreadedsocketservice.c 7.71 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/* GIO - GLib Input, Output and Streaming Library
 *
 * Copyright © 2009 Codethink Limited
 * Copyright © 2009 Red Hat, Inc
 *
 * This program 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 licence 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
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:gthreadedsocketservice
25
 * @title: GThreadedSocketService
Matthias Clasen's avatar
Matthias Clasen committed
26
 * @short_description: A threaded GSocketService
27
 * @include: gio/gio.h
28 29 30 31
 * @see_also: #GSocketService.
 *
 * A #GThreadedSocketService is a simple subclass of #GSocketService
 * that handles incoming connections by creating a worker thread and
Matthias Clasen's avatar
Matthias Clasen committed
32 33
 * dispatching the connection to it by emitting the
 * #GThreadedSocketService::run signal in the new thread.
34 35 36 37 38
 *
 * The signal handler may perform blocking IO and need not return
 * until the connection is closed.
 *
 * The service is implemented using a thread pool, so there is a
39
 * limited amount of threads available to serve incoming requests.
40 41 42
 * The service automatically stops the #GSocketService from accepting
 * new connections when all threads are busy.
 *
Matthias Clasen's avatar
Matthias Clasen committed
43
 * As with #GSocketService, you may connect to #GThreadedSocketService::run,
44
 * or subclass and override the default handler.
45 46 47 48 49
 */

#include "config.h"
#include "gsocketconnection.h"
#include "gthreadedsocketservice.h"
50
#include "glibintl.h"
51

52 53 54 55 56 57
struct _GThreadedSocketServicePrivate
{
  GThreadPool *thread_pool;
  int max_threads;
  gint job_count;
};
58 59 60

static guint g_threaded_socket_service_run_signal;

61 62 63
G_DEFINE_TYPE_WITH_PRIVATE (GThreadedSocketService,
                            g_threaded_socket_service,
                            G_TYPE_SOCKET_SERVICE)
64 65 66 67 68 69 70

enum
{
  PROP_0,
  PROP_MAX_THREADS
};

71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
G_LOCK_DEFINE_STATIC(job_count);

typedef struct
{
  GSocketConnection *connection;
  GObject *source_object;
} GThreadedSocketServiceData;

static void
g_threaded_socket_service_func (gpointer _data,
				gpointer user_data)
{
  GThreadedSocketService *threaded = user_data;
  GThreadedSocketServiceData *data = _data;
  gboolean result;

87
  g_signal_emit (threaded, g_threaded_socket_service_run_signal,
88 89 90 91 92 93 94 95 96 97 98
                 0, data->connection, data->source_object, &result);

  g_object_unref (data->connection);
  if (data->source_object)
    g_object_unref (data->source_object);
  g_slice_free (GThreadedSocketServiceData, data);

  G_LOCK (job_count);
  if (threaded->priv->job_count-- == threaded->priv->max_threads)
    g_socket_service_start (G_SOCKET_SERVICE (threaded));
  G_UNLOCK (job_count);
99 100

  g_object_unref (threaded);
101 102 103 104 105 106 107 108 109 110 111 112 113
}

static gboolean
g_threaded_socket_service_incoming (GSocketService    *service,
                                    GSocketConnection *connection,
                                    GObject           *source_object)
{
  GThreadedSocketService *threaded;
  GThreadedSocketServiceData *data;

  threaded = G_THREADED_SOCKET_SERVICE (service);

  data = g_slice_new (GThreadedSocketServiceData);
114 115 116 117

  /* Ref the socket service for the thread */
  g_object_ref (service);

118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
  data->connection = g_object_ref (connection);
  if (source_object)
    data->source_object = g_object_ref (source_object);
  else
    data->source_object = NULL;

  G_LOCK (job_count);
  if (++threaded->priv->job_count == threaded->priv->max_threads)
    g_socket_service_stop (service);
  G_UNLOCK (job_count);

  g_thread_pool_push (threaded->priv->thread_pool, data, NULL);



  return FALSE;
}

static void
g_threaded_socket_service_init (GThreadedSocketService *service)
{
139
  service->priv = g_threaded_socket_service_get_instance_private (service);
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
  service->priv->max_threads = 10;
}

static void
g_threaded_socket_service_constructed (GObject *object)
{
  GThreadedSocketService *service = G_THREADED_SOCKET_SERVICE (object);

  service->priv->thread_pool =
    g_thread_pool_new  (g_threaded_socket_service_func,
			service,
			service->priv->max_threads,
			FALSE,
			NULL);
}


static void
g_threaded_socket_service_finalize (GObject *object)
{
  GThreadedSocketService *service = G_THREADED_SOCKET_SERVICE (object);

162
  g_thread_pool_free (service->priv->thread_pool, FALSE, FALSE);
163 164 165 166 167

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

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
static void
g_threaded_socket_service_get_property (GObject    *object,
					guint       prop_id,
					GValue     *value,
					GParamSpec *pspec)
{
  GThreadedSocketService *service = G_THREADED_SOCKET_SERVICE (object);

  switch (prop_id)
    {
      case PROP_MAX_THREADS:
	g_value_set_int (value, service->priv->max_threads);
	break;

      default:
	G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

static void
g_threaded_socket_service_set_property (GObject      *object,
					guint         prop_id,
					const GValue *value,
					GParamSpec   *pspec)
{
  GThreadedSocketService *service = G_THREADED_SOCKET_SERVICE (object);

  switch (prop_id)
    {
      case PROP_MAX_THREADS:
	service->priv->max_threads = g_value_get_int (value);
	break;

      default:
	G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

206 207 208 209 210 211 212 213 214

static void
g_threaded_socket_service_class_init (GThreadedSocketServiceClass *class)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (class);
  GSocketServiceClass *ss_class = &class->parent_class;

  gobject_class->constructed = g_threaded_socket_service_constructed;
  gobject_class->finalize = g_threaded_socket_service_finalize;
215 216
  gobject_class->set_property = g_threaded_socket_service_set_property;
  gobject_class->get_property = g_threaded_socket_service_get_property;
217 218 219 220 221 222 223 224 225 226

  ss_class->incoming = g_threaded_socket_service_incoming;

  /**
   * GThreadedSocketService::run:
   * @service: the #GThreadedSocketService.
   * @connection: a new #GSocketConnection object.
   * @source_object: the source_object passed to g_socket_listener_add_address().
   *
   * The ::run signal is emitted in a worker thread in response to an
227 228
   * incoming connection. This thread is dedicated to handling
   * @connection and may perform blocking IO. The signal handler need
229 230
   * not return until the connection is closed.
   *
231
   * Returns: %TRUE to stop further signal handlers from being called
232
   */
233
  g_threaded_socket_service_run_signal =
234
    g_signal_new (I_("run"), G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST,
235 236
		  G_STRUCT_OFFSET (GThreadedSocketServiceClass, run),
		  g_signal_accumulator_true_handled, NULL,
237
		  NULL, G_TYPE_BOOLEAN,
238 239 240 241 242 243 244 245 246 247
		  2, G_TYPE_SOCKET_CONNECTION, G_TYPE_OBJECT);

  g_object_class_install_property (gobject_class, PROP_MAX_THREADS,
				   g_param_spec_int ("max-threads",
						     P_("Max threads"),
						     P_("The max number of threads handling clients for this service"),
						     -1,
						     G_MAXINT,
						     10,
						     G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
248 249 250 251
}

/**
 * g_threaded_socket_service_new:
252
 * @max_threads: the maximal number of threads to execute concurrently
253
 *   handling incoming clients, -1 means no limit
254
 *
255
 * Creates a new #GThreadedSocketService with no listeners. Listeners
256
 * must be added with one of the #GSocketListener "add" methods.
257 258 259 260 261
 *
 * Returns: a new #GSocketService.
 *
 * Since: 2.22
 */
262
GSocketService *
263
g_threaded_socket_service_new (int max_threads)
264
{
265 266 267
  return g_object_new (G_TYPE_THREADED_SOCKET_SERVICE,
		       "max-threads", max_threads,
		       NULL);
268
}