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
32 * is 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 with the
38 * #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 of the <link
52 * linkend="g-main-context-push-thread-default-context">thread-default
53 * context</link> of the thread it is created in, and is not
54 * threadsafe in general. However, the calls to start and stop the
55 * service are thread-safe so these can be used from threads that
56 * handle incoming clients.
62 #include "gsocketservice.h"
65 #include "gsocketlistener.h"
66 #include "gsocketconnection.h"
68 struct _GSocketServicePrivate
70 GCancellable *cancellable;
72 guint outstanding_accept : 1;
75 static guint g_socket_service_incoming_signal;
77 G_LOCK_DEFINE_STATIC(active);
79 G_DEFINE_TYPE_WITH_PRIVATE (GSocketService, g_socket_service, G_TYPE_SOCKET_LISTENER)
81 static void g_socket_service_ready (GObject *object,
86 g_socket_service_real_incoming (GSocketService *service,
87 GSocketConnection *connection,
88 GObject *source_object)
94 g_socket_service_init (GSocketService *service)
96 service->priv = g_socket_service_get_private (service);
97 service->priv->cancellable = g_cancellable_new ();
98 service->priv->active = TRUE;
102 g_socket_service_finalize (GObject *object)
104 GSocketService *service = G_SOCKET_SERVICE (object);
106 g_object_unref (service->priv->cancellable);
108 G_OBJECT_CLASS (g_socket_service_parent_class)
113 do_accept (GSocketService *service)
115 g_socket_listener_accept_async (G_SOCKET_LISTENER (service),
116 service->priv->cancellable,
117 g_socket_service_ready, NULL);
118 service->priv->outstanding_accept = TRUE;
122 g_socket_service_changed (GSocketListener *listener)
124 GSocketService *service = G_SOCKET_SERVICE (listener);
128 if (service->priv->active)
130 if (service->priv->outstanding_accept)
131 g_cancellable_cancel (service->priv->cancellable);
134 g_socket_listener_accept_async (listener, service->priv->cancellable,
135 g_socket_service_ready, NULL);
136 service->priv->outstanding_accept = TRUE;
144 * g_socket_service_is_active:
145 * @service: a #GSocketService
147 * Check whether the service is active or not. An active
148 * service will accept new clients that connect, while
149 * a non-active service will let connecting clients queue
150 * up until the service is started.
152 * Returns: %TRUE if the service is active, %FALSE otherwise
157 g_socket_service_is_active (GSocketService *service)
162 active = service->priv->active;
168 * g_socket_service_start:
169 * @service: a #GSocketService
171 * Starts the service, i.e. start accepting connections
172 * from the added sockets when the mainloop runs.
174 * This call is thread-safe, so it may be called from a thread
175 * handling an incoming client request.
180 g_socket_service_start (GSocketService *service)
184 if (!service->priv->active)
186 service->priv->active = TRUE;
188 if (service->priv->outstanding_accept)
189 g_cancellable_cancel (service->priv->cancellable);
198 * g_socket_service_stop:
199 * @service: a #GSocketService
201 * Stops the service, i.e. stops accepting connections
202 * from the added sockets when the mainloop runs.
204 * This call is thread-safe, so it may be called from a thread
205 * handling an incoming client request.
210 g_socket_service_stop (GSocketService *service)
214 if (service->priv->active)
216 service->priv->active = FALSE;
218 if (service->priv->outstanding_accept)
219 g_cancellable_cancel (service->priv->cancellable);
227 g_socket_service_incoming (GSocketService *service,
228 GSocketConnection *connection,
229 GObject *source_object)
233 g_signal_emit (service, g_socket_service_incoming_signal,
234 0, connection, source_object, &result);
239 g_socket_service_class_init (GSocketServiceClass *class)
241 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
242 GSocketListenerClass *listener_class = G_SOCKET_LISTENER_CLASS (class);
244 gobject_class->finalize = g_socket_service_finalize;
245 listener_class->changed = g_socket_service_changed;
246 class->incoming = g_socket_service_real_incoming;
249 * GSocketService::incoming:
250 * @service: the #GSocketService
251 * @connection: a new #GSocketConnection object
252 * @source_object: (allow-none): the source_object passed to
253 * g_socket_listener_add_address()
255 * The ::incoming signal is emitted when a new incoming connection
256 * to @service needs to be handled. The handler must initiate the
257 * handling of @connection, but may not block; in essence,
258 * asynchronous operations must be used.
260 * @connection will be unreffed once the signal handler returns,
261 * so you need to ref it yourself if you are planning to use it.
263 * Returns: %TRUE to stop other handlers from being called
267 g_socket_service_incoming_signal =
268 g_signal_new ("incoming", G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST,
269 G_STRUCT_OFFSET (GSocketServiceClass, incoming),
270 g_signal_accumulator_true_handled, NULL,
271 NULL, G_TYPE_BOOLEAN,
272 2, G_TYPE_SOCKET_CONNECTION, G_TYPE_OBJECT);
276 g_socket_service_ready (GObject *object,
277 GAsyncResult *result,
280 GSocketListener *listener = G_SOCKET_LISTENER (object);
281 GSocketService *service = G_SOCKET_SERVICE (object);
282 GSocketConnection *connection;
283 GObject *source_object;
284 GError *error = NULL;
286 connection = g_socket_listener_accept_finish (listener, result, &source_object, &error);
289 if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
290 g_warning ("fail: %s", error->message);
291 g_error_free (error);
295 g_socket_service_incoming (service, connection, source_object);
296 g_object_unref (connection);
301 g_cancellable_reset (service->priv->cancellable);
304 service->priv->outstanding_accept = FALSE;
305 if (service->priv->active)
313 * g_socket_service_new:
315 * Creates a new #GSocketService with no sockets to listen for.
316 * New listeners can be added with e.g. g_socket_listener_add_address()
317 * or g_socket_listener_add_inet_port().
319 * Returns: a new #GSocketService.
324 g_socket_service_new (void)
326 return g_object_new (G_TYPE_SOCKET_SERVICE, NULL);