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
29 * @see_also: #GSocketService.
31 * A #GThreadedSocketService is a simple subclass of #GSocketService
32 * that handles incoming connections by creating a worker thread and
33 * dispatching the connection to it by emitting the
34 * #GThreadedSocketService::run signal in the new thread.
36 * The signal handler may perform blocking IO and need not return
37 * until the connection is closed.
39 * The service is implemented using a thread pool, so there is a
40 * limited amount of threads available to serve incoming requests.
41 * The service automatically stops the #GSocketService from accepting
42 * new connections when all threads are busy.
44 * As with #GSocketService, you may connect to #GThreadedSocketService::run,
45 * or subclass and override the default handler.
49 #include "gsocketconnection.h"
50 #include "gthreadedsocketservice.h"
54 static guint g_threaded_socket_service_run_signal
;
56 G_DEFINE_TYPE (GThreadedSocketService
,
57 g_threaded_socket_service
,
58 G_TYPE_SOCKET_SERVICE
);
67 G_LOCK_DEFINE_STATIC(job_count
);
69 struct _GThreadedSocketServicePrivate
71 GThreadPool
*thread_pool
;
78 GThreadedSocketService
*service
;
79 GSocketConnection
*connection
;
80 GObject
*source_object
;
81 } GThreadedSocketServiceData
;
84 g_threaded_socket_service_func (gpointer _data
,
87 GThreadedSocketService
*threaded
= user_data
;
88 GThreadedSocketServiceData
*data
= _data
;
91 g_signal_emit (data
->service
, g_threaded_socket_service_run_signal
,
92 0, data
->connection
, data
->source_object
, &result
);
94 g_object_unref (data
->service
);
95 g_object_unref (data
->connection
);
96 if (data
->source_object
)
97 g_object_unref (data
->source_object
);
98 g_slice_free (GThreadedSocketServiceData
, data
);
101 if (threaded
->priv
->job_count
-- == threaded
->priv
->max_threads
)
102 g_socket_service_start (G_SOCKET_SERVICE (threaded
));
103 G_UNLOCK (job_count
);
107 g_threaded_socket_service_incoming (GSocketService
*service
,
108 GSocketConnection
*connection
,
109 GObject
*source_object
)
111 GThreadedSocketService
*threaded
;
112 GThreadedSocketServiceData
*data
;
114 threaded
= G_THREADED_SOCKET_SERVICE (service
);
116 data
= g_slice_new (GThreadedSocketServiceData
);
117 data
->service
= g_object_ref (service
);
118 data
->connection
= g_object_ref (connection
);
120 data
->source_object
= g_object_ref (source_object
);
122 data
->source_object
= NULL
;
125 if (++threaded
->priv
->job_count
== threaded
->priv
->max_threads
)
126 g_socket_service_stop (service
);
127 G_UNLOCK (job_count
);
129 g_thread_pool_push (threaded
->priv
->thread_pool
, data
, NULL
);
137 g_threaded_socket_service_init (GThreadedSocketService
*service
)
139 service
->priv
= G_TYPE_INSTANCE_GET_PRIVATE (service
,
140 G_TYPE_THREADED_SOCKET_SERVICE
,
141 GThreadedSocketServicePrivate
);
142 service
->priv
->max_threads
= 10;
146 g_threaded_socket_service_constructed (GObject
*object
)
148 GThreadedSocketService
*service
= G_THREADED_SOCKET_SERVICE (object
);
150 service
->priv
->thread_pool
=
151 g_thread_pool_new (g_threaded_socket_service_func
,
153 service
->priv
->max_threads
,
160 g_threaded_socket_service_finalize (GObject
*object
)
162 GThreadedSocketService
*service
= G_THREADED_SOCKET_SERVICE (object
);
164 g_thread_pool_free (service
->priv
->thread_pool
, FALSE
, TRUE
);
166 G_OBJECT_CLASS (g_threaded_socket_service_parent_class
)
171 g_threaded_socket_service_get_property (GObject
*object
,
176 GThreadedSocketService
*service
= G_THREADED_SOCKET_SERVICE (object
);
180 case PROP_MAX_THREADS
:
181 g_value_set_int (value
, service
->priv
->max_threads
);
185 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
190 g_threaded_socket_service_set_property (GObject
*object
,
195 GThreadedSocketService
*service
= G_THREADED_SOCKET_SERVICE (object
);
199 case PROP_MAX_THREADS
:
200 service
->priv
->max_threads
= g_value_get_int (value
);
204 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, prop_id
, pspec
);
210 g_threaded_socket_service_class_init (GThreadedSocketServiceClass
*class)
212 GObjectClass
*gobject_class
= G_OBJECT_CLASS (class);
213 GSocketServiceClass
*ss_class
= &class->parent_class
;
215 g_type_class_add_private (class, sizeof (GThreadedSocketServicePrivate
));
217 gobject_class
->constructed
= g_threaded_socket_service_constructed
;
218 gobject_class
->finalize
= g_threaded_socket_service_finalize
;
219 gobject_class
->set_property
= g_threaded_socket_service_set_property
;
220 gobject_class
->get_property
= g_threaded_socket_service_get_property
;
222 ss_class
->incoming
= g_threaded_socket_service_incoming
;
225 * GThreadedSocketService::run:
226 * @service: the #GThreadedSocketService.
227 * @connection: a new #GSocketConnection object.
228 * @source_object: the source_object passed to g_socket_listener_add_address().
230 * The ::run signal is emitted in a worker thread in response to an
231 * incoming connection. This thread is dedicated to handling
232 * @connection and may perform blocking IO. The signal handler need
233 * not return until the connection is closed.
235 * Returns: %TRUE to stop further signal handlers from being called
237 g_threaded_socket_service_run_signal
=
238 g_signal_new ("run", G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST
,
239 G_STRUCT_OFFSET (GThreadedSocketServiceClass
, run
),
240 g_signal_accumulator_true_handled
, NULL
,
241 NULL
, G_TYPE_BOOLEAN
,
242 2, G_TYPE_SOCKET_CONNECTION
, G_TYPE_OBJECT
);
244 g_object_class_install_property (gobject_class
, PROP_MAX_THREADS
,
245 g_param_spec_int ("max-threads",
247 P_("The max number of threads handling clients for this service"),
251 G_PARAM_CONSTRUCT_ONLY
| G_PARAM_READWRITE
| G_PARAM_STATIC_STRINGS
));
255 * g_threaded_socket_service_new:
256 * @max_threads: the maximal number of threads to execute concurrently
257 * handling incoming clients, -1 means no limit
259 * Creates a new #GThreadedSocketService with no listeners. Listeners
260 * must be added with one of the #GSocketListener "add" methods.
262 * Returns: a new #GSocketService.
267 g_threaded_socket_service_new (int max_threads
)
269 return g_object_new (G_TYPE_THREADED_SOCKET_SERVICE
,
270 "max-threads", max_threads
,