1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright © 2008 Christian Kellner, Samuel Cormier-Iijima
4 * Copyright © 2009 codethink
5 * Copyright © 2009 Red Hat, Inc
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20 * Boston, MA 02111-1307, USA.
22 * Authors: Christian Kellner <gicmo@gnome.org>
23 * Samuel Cormier-Iijima <sciyoshi@gmail.com>
24 * Ryan Lortie <desrt@desrt.ca>
25 * Alexander Larsson <alexl@redhat.com>
29 #include "gsocketlistener.h"
31 #include <gio/gsimpleasyncresult.h>
32 #include <gio/gcancellable.h>
33 #include <gio/gsocketaddress.h>
34 #include <gio/ginetaddress.h>
35 #include <gio/gioerror.h>
36 #include <gio/gsocket.h>
37 #include <gio/gsocketconnection.h>
38 #include <gio/ginetsocketaddress.h>
44 * SECTION: gsocketlistener
45 * @title: GSocketListener
46 * @short_description: Helper for accepting network client connections
47 * @see_also: #GThreadedSocketService, #GSocketService.
49 * A #GSocketListener is an object that keeps track of a set
50 * of server sockets and helps you accept sockets from any of the
51 * socket, either sync or async.
53 * If you want to implement a network server, also look at #GSocketService
54 * and #GThreadedSocketService which are subclass of #GSocketListener
55 * that makes this even easier.
60 G_DEFINE_TYPE (GSocketListener, g_socket_listener, G_TYPE_OBJECT);
69 static GQuark source_quark = 0;
71 struct _GSocketListenerPrivate
74 GMainContext *main_context;
80 g_socket_listener_finalize (GObject *object)
82 GSocketListener *listener = G_SOCKET_LISTENER (object);
84 if (listener->priv->main_context)
85 g_main_context_unref (listener->priv->main_context);
87 if (!listener->priv->closed)
88 g_socket_listener_close (listener);
90 g_ptr_array_free (listener->priv->sockets, TRUE);
92 G_OBJECT_CLASS (g_socket_listener_parent_class)
97 g_socket_listener_get_property (GObject *object,
102 GSocketListener *listener = G_SOCKET_LISTENER (object);
106 case PROP_LISTEN_BACKLOG:
107 g_value_set_int (value, listener->priv->listen_backlog);
111 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
116 g_socket_listener_set_property (GObject *object,
121 GSocketListener *listener = G_SOCKET_LISTENER (object);
125 case PROP_LISTEN_BACKLOG:
126 g_socket_listener_set_backlog (listener, g_value_get_int (value));
130 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
136 g_socket_listener_class_init (GSocketListenerClass *klass)
138 GObjectClass *gobject_class G_GNUC_UNUSED = G_OBJECT_CLASS (klass);
140 g_type_class_add_private (klass, sizeof (GSocketListenerPrivate));
142 gobject_class->finalize = g_socket_listener_finalize;
143 gobject_class->set_property = g_socket_listener_set_property;
144 gobject_class->get_property = g_socket_listener_get_property;
145 g_object_class_install_property (gobject_class, PROP_LISTEN_BACKLOG,
146 g_param_spec_int ("listen-backlog",
147 P_("Listen backlog"),
148 P_("outstanding connections in the listen queue"),
152 G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
154 source_quark = g_quark_from_static_string ("g-socket-listener-source");
158 g_socket_listener_init (GSocketListener *listener)
160 listener->priv = G_TYPE_INSTANCE_GET_PRIVATE (listener,
161 G_TYPE_SOCKET_LISTENER,
162 GSocketListenerPrivate);
163 listener->priv->sockets =
164 g_ptr_array_new_with_free_func ((GDestroyNotify) g_object_unref);
165 listener->priv->listen_backlog = 10;
169 * g_socket_listener_new:
171 * Creates a new #GSocketListener with no sockets to listen for.
172 * New listeners can be added with e.g. g_socket_listener_add_address()
173 * or g_socket_listener_add_inet_port().
175 * Returns: a new #GSocketListener.
180 g_socket_listener_new (void)
182 return g_object_new (G_TYPE_SOCKET_LISTENER, NULL);
186 check_listener (GSocketListener *listener,
189 if (listener->priv->closed)
191 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_CLOSED,
192 _("Listener is already closed"));
200 * g_socket_listener_add_socket:
201 * @listener: a #GSocketListener
202 * @socket: a listening #GSocket
203 * @source_object: Optional #GObject identifying this source
204 * @error: #GError for error reporting, or %NULL to ignore.
206 * Adds @socket to the set of sockets that we try to accept
207 * new clients from. The socket must be bound to a local
208 * address and listened to.
210 * @source_object will be passed out in the various calls
211 * to accept to identify this particular source, which is
212 * useful if you're listening on multiple addresses and do
213 * different things depending on what address is connected to.
215 * Returns: %TRUE on success, %FALSE on error.
220 g_socket_listener_add_socket (GSocketListener *listener,
222 GObject *source_object,
225 if (!check_listener (listener, error))
228 /* TODO: Check that socket it is bound & not closed? */
230 if (g_socket_is_closed (socket))
232 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
233 _("Added socket is closed"));
237 g_ptr_array_add (listener->priv->sockets, socket);
240 g_object_set_qdata_full (G_OBJECT (socket), source_quark,
241 g_object_ref (source_object), g_object_unref);
247 * g_socket_listener_add_address:
248 * @listener: a #GSocketListener
249 * @address: a #GSocketAddres
250 * @type: a #GSocketType
251 * @protocol: a protocol name, or %NULL
252 * @source_object: Optional #GObject identifying this source
253 * @error: #GError for error reporting, or %NULL to ignore.
255 * Creates a socket of type @type and protocol @protocol, binds
256 * it to @address and adds it to the set of sockets we're accepting
259 * @source_object will be passed out in the various calls
260 * to accept to identify this particular source, which is
261 * useful if you're listening on multiple addresses and do
262 * different things depending on what address is connected to.
264 * Returns: %TRUE on success, %FALSE on error.
269 g_socket_listener_add_address (GSocketListener *listener,
270 GSocketAddress *address,
272 const char *protocol,
273 GObject *source_object,
276 GSocketFamily family;
279 if (!check_listener (listener, error))
282 family = g_socket_address_get_family (address);
283 socket = g_socket_new (family, type,
284 g_socket_protocol_id_lookup_by_name (protocol), error);
288 g_socket_set_listen_backlog (socket, listener->priv->listen_backlog);
290 if (!g_socket_bind (socket, address, TRUE, error) ||
291 !g_socket_listen (socket, error) ||
292 !g_socket_listener_add_socket (listener, socket,
296 g_object_unref (socket);
300 if (G_SOCKET_LISTENER_GET_CLASS (listener)->changed)
301 G_SOCKET_LISTENER_GET_CLASS (listener)->changed (listener);
307 * g_socket_listener_add_inet_port:
308 * @listener: a #GSocketListener
309 * @port: an ip port number
310 * @source_object: Optional #GObject identifying this source
311 * @error: #GError for error reporting, or %NULL to ignore.
313 * Helper function for g_socket_listener_add_address() that
314 * creates a TCP/IP socket listening on IPv4 and IPv6 (if
315 * supported) on the specified port on all interfaces.
317 * @source_object will be passed out in the various calls
318 * to accept to identify this particular source, which is
319 * useful if you're listening on multiple addresses and do
320 * different things depending on what address is connected to.
322 * Returns: %TRUE on success, %FALSE on error.
327 g_socket_listener_add_inet_port (GSocketListener *listener,
329 GObject *source_object,
332 GSocketAddress *address4, *address6;
333 GInetAddress *inet_address;
336 if (!check_listener (listener, error))
339 inet_address = g_inet_address_new_any (G_SOCKET_FAMILY_IPV4);
340 address4 = g_inet_socket_address_new (inet_address, port);
341 g_object_unref (inet_address);
343 inet_address = g_inet_address_new_any (G_SOCKET_FAMILY_IPV6);
344 address6 = g_inet_socket_address_new (inet_address, port);
345 g_object_unref (inet_address);
347 if (!g_socket_listener_add_address (listener,
349 G_SOCKET_TYPE_STREAM,
354 /* Failed, to create ipv6, socket, just use ipv4,
356 res = g_socket_listener_add_address (listener,
358 G_SOCKET_TYPE_STREAM,
365 /* Succeeded with ipv6, also try ipv4 in case its ipv6 only,
366 but ignore errors here */
368 g_socket_listener_add_address (listener,
370 G_SOCKET_TYPE_STREAM,
376 g_object_unref (address4);
377 g_object_unref (address6);
383 add_sources (GSocketListener *listener,
384 GSocketSourceFunc callback,
385 gpointer callback_data,
386 GCancellable *cancellable,
387 GMainContext *context)
395 for (i = 0; i < listener->priv->sockets->len; i++)
397 socket = listener->priv->sockets->pdata[i];
399 source = g_socket_create_source (socket, G_IO_IN, cancellable);
400 g_source_set_callback (source,
401 (GSourceFunc) callback,
402 callback_data, NULL);
403 g_source_attach (source, context);
405 sources = g_list_prepend (sources, source);
412 free_sources (GList *sources)
415 while (sources != NULL)
417 source = sources->data;
418 sources = g_list_delete_link (sources, sources);
419 g_source_destroy (source);
420 g_source_unref (source);
430 accept_callback (GSocket *socket,
431 GIOCondition condition,
434 struct AcceptData *data = user_data;
436 data->socket = socket;
437 g_main_loop_quit (data->loop);
443 * g_socket_listener_accept_socket:
444 * @listener: a #GSocketListener
445 * @source_object: location where #GObject pointer will be stored, or %NULL
446 * @cancellable: optional #GCancellable object, %NULL to ignore.
447 * @error: #GError for error reporting, or %NULL to ignore.
449 * Blocks waiting for a client to connect to any of the sockets added
450 * to the listener. Returns the #GSocket that was accepted.
452 * If you want to accept the high-level #GSocketConnection, not a #GSocket,
453 * which is often the case, then you should use g_socket_listener_accept()
456 * If @source_object is not %NULL it will be filled out with the source
457 * object specified when the corresponding socket or address was added
460 * If @cancellable is not NULL, then the operation can be cancelled by
461 * triggering the cancellable object from another thread. If the operation
462 * was cancelled, the error G_IO_ERROR_CANCELLED will be returned.
464 * Returns: a #GSocket on success, %NULL on error.
469 g_socket_listener_accept_socket (GSocketListener *listener,
470 GObject **source_object,
471 GCancellable *cancellable,
474 GSocket *accept_socket, *socket;
476 g_return_val_if_fail (G_IS_SOCKET_LISTENER (listener), NULL);
478 if (!check_listener (listener, error))
481 if (listener->priv->sockets->len == 1)
483 accept_socket = listener->priv->sockets->pdata[0];
484 if (!g_socket_condition_wait (accept_socket, G_IO_IN,
491 struct AcceptData data;
494 if (listener->priv->main_context == NULL)
495 listener->priv->main_context = g_main_context_new ();
497 loop = g_main_loop_new (listener->priv->main_context, FALSE);
499 sources = add_sources (listener,
503 listener->priv->main_context);
504 g_main_loop_run (loop);
505 accept_socket = data.socket;
506 free_sources (sources);
507 g_main_loop_unref (loop);
510 if (!(socket = g_socket_accept (accept_socket, error)))
514 *source_object = g_object_get_qdata (G_OBJECT (accept_socket), source_quark);
520 * g_socket_listener_accept:
521 * @listener: a #GSocketListener
522 * @source_object: location where #GObject pointer will be stored, or %NULL
523 * @cancellable: optional #GCancellable object, %NULL to ignore.
524 * @error: #GError for error reporting, or %NULL to ignore.
526 * Blocks waiting for a client to connect to any of the sockets added
527 * to the listener. Returns a #GSocketConnection for the socket that was
530 * If @source_object is not %NULL it will be filled out with the source
531 * object specified when the corresponding socket or address was added
534 * If @cancellable is not NULL, then the operation can be cancelled by
535 * triggering the cancellable object from another thread. If the operation
536 * was cancelled, the error G_IO_ERROR_CANCELLED will be returned.
538 * Returns: a #GSocketConnection on success, %NULL on error.
543 g_socket_listener_accept (GSocketListener *listener,
544 GObject **source_object,
545 GCancellable *cancellable,
548 GSocketConnection *connection;
551 socket = g_socket_listener_accept_socket (listener,
558 connection = g_socket_connection_factory_create_connection (socket);
559 g_object_unref (socket);
564 struct AcceptAsyncData {
565 GSimpleAsyncResult *simple;
566 GCancellable *cancellable;
571 accept_ready (GSocket *accept_socket,
572 GIOCondition condition,
575 struct AcceptAsyncData *data = _data;
576 GError *error = NULL;
578 if (!g_cancellable_set_error_if_cancelled (data->cancellable,
582 GObject *source_object;
584 socket = g_socket_accept (accept_socket, &error);
587 g_simple_async_result_set_op_res_gpointer (data->simple, socket,
589 source_object = g_object_get_qdata (G_OBJECT (accept_socket), source_quark);
591 g_object_set_qdata_full (G_OBJECT (data->simple),
593 g_object_ref (source_object), g_object_unref);
599 g_simple_async_result_set_from_error (data->simple, error);
600 g_error_free (error);
603 g_simple_async_result_complete_in_idle (data->simple);
604 g_object_unref (data->simple);
605 free_sources (data->sources);
612 * g_socket_listener_accept_socket_async:
613 * @listener: a #GSocketListener
614 * @cancellable: a #GCancellable, or %NULL
615 * @callback: a #GAsyncReadyCallback
616 * @user_data: user data for the callback
618 * This is the asynchronous version of g_socket_listener_accept_socket().
620 * When the operation is finished @callback will be
621 * called. You can then call g_socket_listener_accept_socket_finish() to get
622 * the result of the operation.
627 g_socket_listener_accept_socket_async (GSocketListener *listener,
628 GCancellable *cancellable,
629 GAsyncReadyCallback callback,
632 struct AcceptAsyncData *data;
633 GError *error = NULL;
635 if (!check_listener (listener, &error))
637 g_simple_async_report_gerror_in_idle (G_OBJECT (listener),
640 g_error_free (error);
644 data = g_new0 (struct AcceptAsyncData, 1);
645 data->simple = g_simple_async_result_new (G_OBJECT (listener),
647 g_socket_listener_accept_socket_async);
648 data->cancellable = cancellable;
649 data->sources = add_sources (listener,
657 * g_socket_listener_accept_socket_finish:
658 * @listener: a #GSocketListener
659 * @result: a #GAsyncResult.
660 * @source_object: Optional #GObject identifying this source
661 * @error: a #GError location to store the error occuring, or %NULL to
664 * Finishes an async accept operation. See g_socket_listener_accept_socket_async()
666 * Returns: a #GSocket on success, %NULL on error.
671 g_socket_listener_accept_socket_finish (GSocketListener *listener,
672 GAsyncResult *result,
673 GObject **source_object,
677 GSimpleAsyncResult *simple;
679 g_return_val_if_fail (G_IS_SOCKET_LISTENER (listener), FALSE);
681 simple = G_SIMPLE_ASYNC_RESULT (result);
683 if (g_simple_async_result_propagate_error (simple, error))
686 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_socket_listener_accept_socket_async);
688 socket = g_simple_async_result_get_op_res_gpointer (simple);
691 *source_object = g_object_get_qdata (G_OBJECT (result), source_quark);
693 return g_object_ref (socket);
697 * g_socket_listener_accept_async:
698 * @listener: a #GSocketListener
699 * @cancellable: a #GCancellable, or %NULL
700 * @callback: a #GAsyncReadyCallback
701 * @user_data: user data for the callback
703 * This is the asynchronous version of g_socket_listener_accept().
705 * When the operation is finished @callback will be
706 * called. You can then call g_socket_listener_accept_socket() to get
707 * the result of the operation.
712 g_socket_listener_accept_async (GSocketListener *listener,
713 GCancellable *cancellable,
714 GAsyncReadyCallback callback,
717 g_socket_listener_accept_socket_async (listener,
724 * g_socket_listener_accept_finish:
725 * @listener: a #GSocketListener
726 * @result: a #GAsyncResult.
727 * @source_object: Optional #GObject identifying this source
728 * @error: a #GError location to store the error occuring, or %NULL to
731 * Finishes an async accept operation. See g_socket_listener_accept_async()
733 * Returns: a #GSocketConnection on success, %NULL on error.
738 g_socket_listener_accept_finish (GSocketListener *listener,
739 GAsyncResult *result,
740 GObject **source_object,
744 GSocketConnection *connection;
746 socket = g_socket_listener_accept_socket_finish (listener,
753 connection = g_socket_connection_factory_create_connection (socket);
754 g_object_unref (socket);
759 * g_socket_listener_set_backlog:
760 * @listener: a #GSocketListener
761 * @listen_backlog: an integer
763 * Sets the listen backlog on the sockets in the listener.
765 * See g_socket_set_listen_backlog() for details
770 g_socket_listener_set_backlog (GSocketListener *listener,
776 if (listener->priv->closed)
779 listener->priv->listen_backlog = listen_backlog;
781 for (i = 0; i < listener->priv->sockets->len; i++)
783 socket = listener->priv->sockets->pdata[i];
784 g_socket_set_listen_backlog (socket, listen_backlog);
789 * g_socket_listener_close:
790 * @listener: a #GSocketListener
792 * Closes all the sockets in the listener.
797 g_socket_listener_close (GSocketListener *listener)
802 g_return_if_fail (G_IS_SOCKET_LISTENER (listener));
804 if (listener->priv->closed)
807 for (i = 0; i < listener->priv->sockets->len; i++)
809 socket = listener->priv->sockets->pdata[i];
810 g_socket_close (socket, NULL);
812 listener->priv->closed = TRUE;
815 #define __G_SOCKET_LISTENER_C__
816 #include "gioaliasdef.c"