1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright © 2009 Codethink Limited
4 * Copyright © 2009 Red Hat, Inc
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.
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.
16 * You should have received a copy of the GNU Lesser General
17 * Public License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
19 * Boston, MA 02111-1307, USA.
21 * Authors: Ryan Lortie <desrt@desrt.ca>
22 * Alexander Larsson <alexl@redhat.com>
26 * SECTION:gthreadedsocketservice
27 * @title: GThreadedSocketService
28 * @short_description: A threaded GSocketService
30 * @see_also: #GSocketService.
32 * A #GThreadedSocketService is a simple subclass of #GSocketService
33 * that handles incoming connections by creating a worker thread and
34 * dispatching the connection to it by emitting the
35 * #GThreadedSocketService::run signal in the new thread.
37 * The signal handler may perform blocking IO and need not return
38 * until the connection is closed.
40 * The service is implemented using a thread pool, so there is a
41 * limited amount of threads available to serve incoming requests.
42 * The service automatically stops the #GSocketService from accepting
43 * new connections when all threads are busy.
45 * As with #GSocketService, you may connect to #GThreadedSocketService::run,
46 * or subclass and override the default handler.
50 #include "gsocketconnection.h"
51 #include "gthreadedsocketservice.h"
54 struct _GThreadedSocketServicePrivate
56 GThreadPool *thread_pool;
61 static guint g_threaded_socket_service_run_signal;
63 G_DEFINE_TYPE_WITH_PRIVATE (GThreadedSocketService,
64 g_threaded_socket_service,
65 G_TYPE_SOCKET_SERVICE)
73 G_LOCK_DEFINE_STATIC(job_count);
77 GThreadedSocketService *service;
78 GSocketConnection *connection;
79 GObject *source_object;
80 } GThreadedSocketServiceData;
83 g_threaded_socket_service_func (gpointer _data,
86 GThreadedSocketService *threaded = user_data;
87 GThreadedSocketServiceData *data = _data;
90 g_signal_emit (data->service, g_threaded_socket_service_run_signal,
91 0, data->connection, data->source_object, &result);
93 g_object_unref (data->service);
94 g_object_unref (data->connection);
95 if (data->source_object)
96 g_object_unref (data->source_object);
97 g_slice_free (GThreadedSocketServiceData, data);
100 if (threaded->priv->job_count-- == threaded->priv->max_threads)
101 g_socket_service_start (G_SOCKET_SERVICE (threaded));
102 G_UNLOCK (job_count);
106 g_threaded_socket_service_incoming (GSocketService *service,
107 GSocketConnection *connection,
108 GObject *source_object)
110 GThreadedSocketService *threaded;
111 GThreadedSocketServiceData *data;
113 threaded = G_THREADED_SOCKET_SERVICE (service);
115 data = g_slice_new (GThreadedSocketServiceData);
116 data->service = g_object_ref (service);
117 data->connection = g_object_ref (connection);
119 data->source_object = g_object_ref (source_object);
121 data->source_object = NULL;
124 if (++threaded->priv->job_count == threaded->priv->max_threads)
125 g_socket_service_stop (service);
126 G_UNLOCK (job_count);
128 g_thread_pool_push (threaded->priv->thread_pool, data, NULL);
136 g_threaded_socket_service_init (GThreadedSocketService *service)
138 service->priv = g_threaded_socket_service_get_instance_private (service);
139 service->priv->max_threads = 10;
143 g_threaded_socket_service_constructed (GObject *object)
145 GThreadedSocketService *service = G_THREADED_SOCKET_SERVICE (object);
147 service->priv->thread_pool =
148 g_thread_pool_new (g_threaded_socket_service_func,
150 service->priv->max_threads,
157 g_threaded_socket_service_finalize (GObject *object)
159 GThreadedSocketService *service = G_THREADED_SOCKET_SERVICE (object);
161 g_thread_pool_free (service->priv->thread_pool, FALSE, TRUE);
163 G_OBJECT_CLASS (g_threaded_socket_service_parent_class)
168 g_threaded_socket_service_get_property (GObject *object,
173 GThreadedSocketService *service = G_THREADED_SOCKET_SERVICE (object);
177 case PROP_MAX_THREADS:
178 g_value_set_int (value, service->priv->max_threads);
182 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
187 g_threaded_socket_service_set_property (GObject *object,
192 GThreadedSocketService *service = G_THREADED_SOCKET_SERVICE (object);
196 case PROP_MAX_THREADS:
197 service->priv->max_threads = g_value_get_int (value);
201 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
207 g_threaded_socket_service_class_init (GThreadedSocketServiceClass *class)
209 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
210 GSocketServiceClass *ss_class = &class->parent_class;
212 gobject_class->constructed = g_threaded_socket_service_constructed;
213 gobject_class->finalize = g_threaded_socket_service_finalize;
214 gobject_class->set_property = g_threaded_socket_service_set_property;
215 gobject_class->get_property = g_threaded_socket_service_get_property;
217 ss_class->incoming = g_threaded_socket_service_incoming;
220 * GThreadedSocketService::run:
221 * @service: the #GThreadedSocketService.
222 * @connection: a new #GSocketConnection object.
223 * @source_object: the source_object passed to g_socket_listener_add_address().
225 * The ::run signal is emitted in a worker thread in response to an
226 * incoming connection. This thread is dedicated to handling
227 * @connection and may perform blocking IO. The signal handler need
228 * not return until the connection is closed.
230 * Returns: %TRUE to stop further signal handlers from being called
232 g_threaded_socket_service_run_signal =
233 g_signal_new ("run", G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST,
234 G_STRUCT_OFFSET (GThreadedSocketServiceClass, run),
235 g_signal_accumulator_true_handled, NULL,
236 NULL, G_TYPE_BOOLEAN,
237 2, G_TYPE_SOCKET_CONNECTION, G_TYPE_OBJECT);
239 g_object_class_install_property (gobject_class, PROP_MAX_THREADS,
240 g_param_spec_int ("max-threads",
242 P_("The max number of threads handling clients for this service"),
246 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
250 * g_threaded_socket_service_new:
251 * @max_threads: the maximal number of threads to execute concurrently
252 * handling incoming clients, -1 means no limit
254 * Creates a new #GThreadedSocketService with no listeners. Listeners
255 * must be added with one of the #GSocketListener "add" methods.
257 * Returns: a new #GSocketService.
262 g_threaded_socket_service_new (int max_threads)
264 return g_object_new (G_TYPE_THREADED_SOCKET_SERVICE,
265 "max-threads", max_threads,