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: gsocketservice
27 * @title: GSocketService
28 * @short_description: Make it easy to implement a network service
29 * @see_also: #GThreadedSocketService, #GSocketListener.
31 * A #GSocketService is an object that represents a service that is
32 * provided to the network or over local sockets. When a new
33 * connection is made to the service the #GSocketService:incoming
36 * A #GSocketService is a subclass of #GSocketListener and you need
37 * to add the addresses you want to accept connections on to the
38 * with the #GSocketListener APIs.
40 * There are two options for implementing a network service based on
41 * #GSocketService. The first is to create the service using
42 * g_socket_service_new() and to connect to the #GSocketService:incoming
43 * signal. The second is to subclass #GSocketService and override the
44 * default signal handler implementation.
46 * In either case, the handler must immediately return, or else it
47 * will block additional incoming connections from being serviced.
48 * If you are interested in writing connection handlers that contain
49 * blocking code then see #GThreadedSocketService.
51 * The socket service runs on the main loop in the main thread, and is
52 * not threadsafe in general. However, the calls to start and stop
53 * the service are threadsafe so these can be used from threads that
54 * handle incoming clients.
60 #include "gsocketservice.h"
62 #include "gio-marshal.h"
64 #include "gsocketlistener.h"
65 #include "gsocketconnection.h"
69 static guint g_socket_service_incoming_signal;
71 G_DEFINE_TYPE (GSocketService, g_socket_service, G_TYPE_SOCKET_LISTENER);
73 G_LOCK_DEFINE_STATIC(active);
75 struct _GSocketServicePrivate
77 GCancellable *cancellable;
79 guint outstanding_accept : 1;
82 static void g_socket_service_ready (GObject *object,
87 g_socket_service_real_incoming (GSocketService *service,
88 GSocketConnection *connection,
89 GObject *source_object)
95 g_socket_service_init (GSocketService *service)
97 service->priv = G_TYPE_INSTANCE_GET_PRIVATE (service,
98 G_TYPE_SOCKET_SERVICE,
99 GSocketServicePrivate);
100 service->priv->cancellable = g_cancellable_new ();
101 service->priv->active = TRUE;
105 g_socket_service_finalize (GObject *object)
107 GSocketService *service = G_SOCKET_SERVICE (object);
109 g_object_unref (service->priv->cancellable);
111 G_OBJECT_CLASS (g_socket_service_parent_class)
116 do_accept (GSocketService *service)
118 g_socket_listener_accept_async (G_SOCKET_LISTENER (service),
119 service->priv->cancellable,
120 g_socket_service_ready, NULL);
121 service->priv->outstanding_accept = TRUE;
125 g_socket_service_changed (GSocketListener *listener)
127 GSocketService *service = G_SOCKET_SERVICE (listener);
131 if (service->priv->active)
133 if (service->priv->outstanding_accept)
134 g_cancellable_cancel (service->priv->cancellable);
137 g_socket_listener_accept_async (listener, service->priv->cancellable,
138 g_socket_service_ready, NULL);
139 service->priv->outstanding_accept = TRUE;
147 * g_socket_service_is_active:
148 * @service: a #GSocketService
150 * Check whether the service is active or not. An active
151 * service will accept new clients that connect, while
152 * a non-active service will let connecting clients queue
153 * up until the service is started.
155 * Returns: %TRUE if the service is active, %FALSE otherwise
160 g_socket_service_is_active (GSocketService *service)
165 active = service->priv->active;
171 * g_socket_service_start:
172 * @service: a #GSocketService
174 * Starts the service, i.e. start accepting connections
175 * from the added sockets when the mainloop runs.
177 * This call is threadsafe, so it may be called from a thread
178 * handling an incomming client request.
183 g_socket_service_start (GSocketService *service)
187 if (!service->priv->active)
189 service->priv->active = TRUE;
191 if (service->priv->outstanding_accept)
192 g_cancellable_cancel (service->priv->cancellable);
201 * g_socket_service_stop:
202 * @service: a #GSocketService
204 * Stops the service, i.e. stops accepting connections
205 * from the added sockets when the mainloop runs.
207 * This call is threadsafe, so it may be called from a thread
208 * handling an incomming client request.
213 g_socket_service_stop (GSocketService *service)
217 if (service->priv->active)
219 service->priv->active = FALSE;
221 if (service->priv->outstanding_accept)
222 g_cancellable_cancel (service->priv->cancellable);
230 g_socket_service_incoming (GSocketService *service,
231 GSocketConnection *connection,
232 GObject *source_object)
236 g_signal_emit (service, g_socket_service_incoming_signal,
237 0, connection, source_object, &result);
242 g_socket_service_class_init (GSocketServiceClass *class)
244 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
245 GSocketListenerClass *listener_class = G_SOCKET_LISTENER_CLASS (class);
247 g_type_class_add_private (class, sizeof (GSocketServicePrivate));
249 gobject_class->finalize = g_socket_service_finalize;
250 listener_class->changed = g_socket_service_changed;
251 class->incoming = g_socket_service_real_incoming;
254 * GSocketService::incoming:
255 * @service: the #GSocketService.
256 * @connection: a new #GSocketConnection object.
257 * @source_object: the source_object passed to g_socket_listener_add_address().
258 * @returns: %TRUE if @connection has been handled.
260 * The ::incoming signal is emitted when a new incoming connection
261 * to @service needs to be handled. The handler must initiate the
262 * handling of @connection, but may not block; in essence,
263 * asynchronous operations must be used.
265 * Returns: %TRUE to stop other handlers from being called
269 g_socket_service_incoming_signal =
270 g_signal_new ("incoming", G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST,
271 G_STRUCT_OFFSET (GSocketServiceClass, incoming),
272 g_signal_accumulator_true_handled, NULL,
273 _gio_marshal_BOOLEAN__OBJECT_OBJECT, G_TYPE_BOOLEAN,
274 2, G_TYPE_SOCKET_CONNECTION, G_TYPE_OBJECT);
278 g_socket_service_ready (GObject *object,
279 GAsyncResult *result,
282 GSocketListener *listener = G_SOCKET_LISTENER (object);
283 GSocketService *service = G_SOCKET_SERVICE (object);
284 GSocketConnection *connection;
285 GObject *source_object;
286 GError *error = NULL;
288 connection = g_socket_listener_accept_finish (listener, result, &source_object, &error);
291 if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
292 g_warning ("fail: %s", error->message);
293 g_error_free (error);
297 g_socket_service_incoming (service, connection, source_object);
298 g_object_unref (connection);
303 g_cancellable_reset (service->priv->cancellable);
306 service->priv->outstanding_accept = FALSE;
307 if (service->priv->active)
315 * g_socket_service_new:
317 * Creates a new #GSocketService with no sockets to listen for.
318 * New listeners can be added with e.g. g_socket_listener_add_address()
319 * or g_socket_listener_add_inet_port().
321 * Returns: a new #GSocketService.
326 g_socket_service_new (void)
328 return g_object_new (G_TYPE_SOCKET_SERVICE, NULL);
331 #define __G_SOCKET_SERVICE_C__
332 #include "gioaliasdef.c"