1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-server.c DBusServer object
4 * Copyright (C) 2002, 2003, 2004, 2005 Red Hat Inc.
6 * Licensed under the Academic Free License version 2.1
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "dbus-server.h"
26 #include "dbus-server-unix.h"
27 #include "dbus-server-socket.h"
28 #include "dbus-string.h"
29 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
30 #include "dbus-server-debug-pipe.h"
32 #include "dbus-address.h"
33 #include "dbus-protocol.h"
36 * @defgroup DBusServer DBusServer
38 * @brief Server that listens for new connections.
40 * A DBusServer represents a server that other applications
41 * can connect to. Each connection from another application
42 * is represented by a #DBusConnection.
44 * @todo Thread safety hasn't been tested much for #DBusServer
45 * @todo Need notification to apps of disconnection, may matter for some transports
49 * @defgroup DBusServerInternals DBusServer implementation details
50 * @ingroup DBusInternals
51 * @brief Implementation details of DBusServer
56 #ifndef _dbus_server_trace_ref
58 _dbus_server_trace_ref (DBusServer *server,
63 static int enabled = -1;
65 _dbus_trace_ref ("DBusServer", server, old_refcount, new_refcount, why,
66 "DBUS_SERVER_TRACE", &enabled);
70 /* this is a little fragile since it assumes the address doesn't
71 * already have a guid, but it shouldn't
74 copy_address_with_guid_appended (const DBusString *address,
75 const DBusString *guid_hex)
80 if (!_dbus_string_init (&with_guid))
83 if (!_dbus_string_copy (address, 0, &with_guid,
84 _dbus_string_get_length (&with_guid)) ||
85 !_dbus_string_append (&with_guid, ",guid=") ||
86 !_dbus_string_copy (guid_hex, 0,
87 &with_guid, _dbus_string_get_length (&with_guid)))
89 _dbus_string_free (&with_guid);
94 _dbus_string_steal_data (&with_guid, &retval);
96 _dbus_string_free (&with_guid);
98 return retval; /* may be NULL if steal_data failed */
102 * Initializes the members of the DBusServer base class.
103 * Chained up to by subclass constructors.
105 * @param server the server.
106 * @param vtable the vtable for the subclass.
107 * @param address the server's address
108 * @returns #TRUE on success.
111 _dbus_server_init_base (DBusServer *server,
112 const DBusServerVTable *vtable,
113 const DBusString *address)
115 server->vtable = vtable;
117 #ifdef DBUS_DISABLE_ASSERT
118 _dbus_atomic_inc (&server->refcount);
121 dbus_int32_t old_refcount = _dbus_atomic_inc (&server->refcount);
123 _dbus_assert (old_refcount == 0);
127 server->address = NULL;
128 server->watches = NULL;
129 server->timeouts = NULL;
130 server->published_address = FALSE;
132 if (!_dbus_string_init (&server->guid_hex))
135 _dbus_generate_uuid (&server->guid);
137 if (!_dbus_uuid_encode (&server->guid, &server->guid_hex))
140 server->address = copy_address_with_guid_appended (address,
142 if (server->address == NULL)
145 _dbus_rmutex_new_at_location (&server->mutex);
146 if (server->mutex == NULL)
149 server->watches = _dbus_watch_list_new ();
150 if (server->watches == NULL)
153 server->timeouts = _dbus_timeout_list_new ();
154 if (server->timeouts == NULL)
157 _dbus_data_slot_list_init (&server->slot_list);
159 _dbus_verbose ("Initialized server on address %s\n", server->address);
164 _dbus_rmutex_free_at_location (&server->mutex);
165 server->mutex = NULL;
168 _dbus_watch_list_free (server->watches);
169 server->watches = NULL;
171 if (server->timeouts)
173 _dbus_timeout_list_free (server->timeouts);
174 server->timeouts = NULL;
178 dbus_free (server->address);
179 server->address = NULL;
181 _dbus_string_free (&server->guid_hex);
186 static void mini_vtable_dummy_func(DBusServer *server)
188 // Used to prevent assert errors. Pointer to function is passed to
189 // DBusServerVTable which is passed to server->vtable in
190 // dbus_server_init_mini function.
194 dbus_server_init_mini (char* address)
198 static const DBusServerVTable dbus_server_init_mini_vtable = {
199 mini_vtable_dummy_func,
200 mini_vtable_dummy_func
203 server = dbus_new0(struct DBusServer, 1);
207 memset(server, 0, sizeof(struct DBusServer));
208 _dbus_rmutex_new_at_location (&server->mutex);
209 if (server->mutex == NULL)
211 server->address = address;
213 server->vtable = &dbus_server_init_mini_vtable;
215 _dbus_atomic_inc (&server->refcount);
217 server->watches = _dbus_watch_list_new ();
218 if (server->watches == NULL)
221 server->timeouts = _dbus_timeout_list_new();
222 if (server->timeouts == NULL)
234 * Finalizes the members of the DBusServer base class.
235 * Chained up to by subclass finalizers.
237 * @param server the server.
240 _dbus_server_finalize_base (DBusServer *server)
242 /* We don't have the lock, but nobody should be accessing
243 * concurrently since they don't have a ref
245 #ifndef DBUS_DISABLE_CHECKS
246 _dbus_assert (!server->have_server_lock);
248 _dbus_assert (server->disconnected);
250 /* calls out to application code... */
251 _dbus_data_slot_list_free (&server->slot_list);
253 dbus_server_set_new_connection_function (server, NULL, NULL, NULL);
255 _dbus_watch_list_free (server->watches);
256 _dbus_timeout_list_free (server->timeouts);
258 _dbus_rmutex_free_at_location (&server->mutex);
260 dbus_free (server->address);
262 dbus_free_string_array (server->auth_mechanisms);
264 _dbus_string_free (&server->guid_hex);
268 /** Function to be called in protected_change_watch() with refcount held */
269 typedef dbus_bool_t (* DBusWatchAddFunction) (DBusWatchList *list,
271 /** Function to be called in protected_change_watch() with refcount held */
272 typedef void (* DBusWatchRemoveFunction) (DBusWatchList *list,
274 /** Function to be called in protected_change_watch() with refcount held */
275 typedef void (* DBusWatchToggleFunction) (DBusWatchList *list,
277 dbus_bool_t enabled);
280 protected_change_watch (DBusServer *server,
282 DBusWatchAddFunction add_function,
283 DBusWatchRemoveFunction remove_function,
284 DBusWatchToggleFunction toggle_function,
287 DBusWatchList *watches;
290 HAVE_LOCK_CHECK (server);
292 /* This isn't really safe or reasonable; a better pattern is the "do
293 * everything, then drop lock and call out" one; but it has to be
294 * propagated up through all callers
297 watches = server->watches;
300 server->watches = NULL;
301 _dbus_server_ref_unlocked (server);
302 SERVER_UNLOCK (server);
305 retval = (* add_function) (watches, watch);
306 else if (remove_function)
309 (* remove_function) (watches, watch);
314 (* toggle_function) (watches, watch, enabled);
317 SERVER_LOCK (server);
318 server->watches = watches;
319 _dbus_server_unref_unlocked (server);
328 * Adds a watch for this server, chaining out to application-provided
331 * @param server the server.
332 * @param watch the watch to add.
335 _dbus_server_add_watch (DBusServer *server,
338 HAVE_LOCK_CHECK (server);
339 return protected_change_watch (server, watch,
340 _dbus_watch_list_add_watch,
345 * Removes a watch previously added with _dbus_server_remove_watch().
347 * @param server the server.
348 * @param watch the watch to remove.
351 _dbus_server_remove_watch (DBusServer *server,
354 HAVE_LOCK_CHECK (server);
355 protected_change_watch (server, watch,
357 _dbus_watch_list_remove_watch,
362 * Toggles a watch and notifies app via server's
363 * DBusWatchToggledFunction if available. It's an error to call this
364 * function on a watch that was not previously added.
366 * @param server the server.
367 * @param watch the watch to toggle.
368 * @param enabled whether to enable or disable
371 _dbus_server_toggle_watch (DBusServer *server,
375 _dbus_assert (watch != NULL);
377 HAVE_LOCK_CHECK (server);
378 protected_change_watch (server, watch,
380 _dbus_watch_list_toggle_watch,
384 /** Function to be called in protected_change_timeout() with refcount held */
385 typedef dbus_bool_t (* DBusTimeoutAddFunction) (DBusTimeoutList *list,
386 DBusTimeout *timeout);
387 /** Function to be called in protected_change_timeout() with refcount held */
388 typedef void (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
389 DBusTimeout *timeout);
390 /** Function to be called in protected_change_timeout() with refcount held */
391 typedef void (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
392 DBusTimeout *timeout,
393 dbus_bool_t enabled);
397 protected_change_timeout (DBusServer *server,
398 DBusTimeout *timeout,
399 DBusTimeoutAddFunction add_function,
400 DBusTimeoutRemoveFunction remove_function,
401 DBusTimeoutToggleFunction toggle_function,
404 DBusTimeoutList *timeouts;
407 HAVE_LOCK_CHECK (server);
409 /* This isn't really safe or reasonable; a better pattern is the "do everything, then
410 * drop lock and call out" one; but it has to be propagated up through all callers
413 timeouts = server->timeouts;
416 server->timeouts = NULL;
417 _dbus_server_ref_unlocked (server);
418 SERVER_UNLOCK (server);
421 retval = (* add_function) (timeouts, timeout);
422 else if (remove_function)
425 (* remove_function) (timeouts, timeout);
430 (* toggle_function) (timeouts, timeout, enabled);
433 SERVER_LOCK (server);
434 server->timeouts = timeouts;
435 _dbus_server_unref_unlocked (server);
444 * Adds a timeout for this server, chaining out to
445 * application-provided timeout handlers. The timeout should be
446 * repeatedly handled with dbus_timeout_handle() at its given interval
447 * until it is removed.
449 * @param server the server.
450 * @param timeout the timeout to add.
453 _dbus_server_add_timeout (DBusServer *server,
454 DBusTimeout *timeout)
456 return protected_change_timeout (server, timeout,
457 _dbus_timeout_list_add_timeout,
462 * Removes a timeout previously added with _dbus_server_add_timeout().
464 * @param server the server.
465 * @param timeout the timeout to remove.
468 _dbus_server_remove_timeout (DBusServer *server,
469 DBusTimeout *timeout)
471 protected_change_timeout (server, timeout,
473 _dbus_timeout_list_remove_timeout,
478 * Toggles a timeout and notifies app via server's
479 * DBusTimeoutToggledFunction if available. It's an error to call this
480 * function on a timeout that was not previously added.
482 * @param server the server.
483 * @param timeout the timeout to toggle.
484 * @param enabled whether to enable or disable
487 _dbus_server_toggle_timeout (DBusServer *server,
488 DBusTimeout *timeout,
491 protected_change_timeout (server, timeout,
493 _dbus_timeout_list_toggle_timeout,
499 * Like dbus_server_ref() but does not acquire the lock (must already be held)
501 * @param server the server.
504 _dbus_server_ref_unlocked (DBusServer *server)
506 dbus_int32_t old_refcount;
508 _dbus_assert (server != NULL);
509 HAVE_LOCK_CHECK (server);
511 old_refcount = _dbus_atomic_inc (&server->refcount);
512 _dbus_assert (old_refcount > 0);
513 _dbus_server_trace_ref (server, old_refcount, old_refcount + 1,
518 * Like dbus_server_unref() but does not acquire the lock (must already be held)
520 * @param server the server.
523 _dbus_server_unref_unlocked (DBusServer *server)
525 dbus_int32_t old_refcount;
527 /* Keep this in sync with dbus_server_unref */
529 _dbus_assert (server != NULL);
531 HAVE_LOCK_CHECK (server);
533 old_refcount = _dbus_atomic_dec (&server->refcount);
534 _dbus_assert (old_refcount > 0);
536 _dbus_server_trace_ref (server, old_refcount, old_refcount - 1,
539 if (old_refcount == 1)
541 _dbus_assert (server->disconnected);
543 SERVER_UNLOCK (server);
545 _dbus_assert (server->vtable->finalize != NULL);
547 (* server->vtable->finalize) (server);
554 * @addtogroup DBusServer
561 * @typedef DBusServer
563 * An opaque object representing a server that listens for
564 * connections from other applications. Each time a connection
565 * is made, a new DBusConnection is created and made available
566 * via an application-provided DBusNewConnectionFunction.
567 * The DBusNewConnectionFunction is provided with
568 * dbus_server_set_new_connection_function().
572 static const struct {
573 DBusServerListenResult (* func) (DBusAddressEntry *entry,
574 DBusServer **server_p,
577 { _dbus_server_listen_socket }
578 , { _dbus_server_listen_platform_specific }
579 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
580 , { _dbus_server_listen_debug_pipe }
585 * Listens for new connections on the given address. If there are
586 * multiple semicolon-separated address entries in the address, tries
587 * each one and listens on the first one that works.
589 * Returns #NULL and sets error if listening fails for any reason.
590 * Otherwise returns a new #DBusServer.
591 * dbus_server_set_new_connection_function(),
592 * dbus_server_set_watch_functions(), and
593 * dbus_server_set_timeout_functions() should be called immediately to
594 * render the server fully functional.
596 * To free the server, applications must call first
597 * dbus_server_disconnect() and then dbus_server_unref().
599 * @param address the address of this server.
600 * @param error location to store reason for failure.
601 * @returns a new #DBusServer, or #NULL on failure.
605 dbus_server_listen (const char *address,
609 DBusAddressEntry **entries;
611 DBusError first_connect_error = DBUS_ERROR_INIT;
612 dbus_bool_t handled_once;
614 _dbus_return_val_if_fail (address != NULL, NULL);
615 _dbus_return_val_if_error_is_set (error, NULL);
617 if (!dbus_parse_address (address, &entries, &len, error))
621 handled_once = FALSE;
623 for (i = 0; i < len; i++)
627 for (j = 0; j < (int) _DBUS_N_ELEMENTS (listen_funcs); ++j)
629 DBusServerListenResult result;
630 DBusError tmp_error = DBUS_ERROR_INIT;
632 result = (* listen_funcs[j].func) (entries[i],
636 if (result == DBUS_SERVER_LISTEN_OK)
638 _dbus_assert (server != NULL);
639 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
643 else if (result == DBUS_SERVER_LISTEN_ADDRESS_ALREADY_USED)
645 _dbus_assert (server == NULL);
646 dbus_set_error (error,
647 DBUS_ERROR_ADDRESS_IN_USE,
648 "Address '%s' already used",
649 dbus_address_entry_get_method (entries[0]));
653 else if (result == DBUS_SERVER_LISTEN_BAD_ADDRESS)
655 _dbus_assert (server == NULL);
656 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
657 dbus_move_error (&tmp_error, error);
661 else if (result == DBUS_SERVER_LISTEN_NOT_HANDLED)
663 _dbus_assert (server == NULL);
664 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
666 /* keep trying addresses */
668 else if (result == DBUS_SERVER_LISTEN_DID_NOT_CONNECT)
670 _dbus_assert (server == NULL);
671 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
672 if (!dbus_error_is_set (&first_connect_error))
673 dbus_move_error (&tmp_error, &first_connect_error);
675 dbus_error_free (&tmp_error);
679 /* keep trying addresses */
683 _dbus_assert (server == NULL);
684 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
691 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
693 dbus_set_error (error,
694 DBUS_ERROR_BAD_ADDRESS,
695 "Unknown address type '%s'",
696 dbus_address_entry_get_method (entries[0]));
698 dbus_set_error (error,
699 DBUS_ERROR_BAD_ADDRESS,
700 "Empty address '%s'",
704 dbus_address_entries_free (entries);
708 _dbus_assert (error == NULL || dbus_error_is_set (&first_connect_error) ||
709 dbus_error_is_set (error));
711 if (error && dbus_error_is_set (error))
713 /* already set the error */
717 /* didn't set the error but either error should be
718 * NULL or first_connect_error should be set.
720 _dbus_assert (error == NULL || dbus_error_is_set (&first_connect_error));
721 dbus_move_error (&first_connect_error, error);
724 _DBUS_ASSERT_ERROR_IS_CLEAR (&first_connect_error); /* be sure we freed it */
725 _DBUS_ASSERT_ERROR_IS_SET (error);
731 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
737 * Increments the reference count of a DBusServer.
739 * @param server the server.
740 * @returns the server
743 dbus_server_ref (DBusServer *server)
745 dbus_int32_t old_refcount;
747 _dbus_return_val_if_fail (server != NULL, NULL);
749 old_refcount = _dbus_atomic_inc (&server->refcount);
751 #ifndef DBUS_DISABLE_CHECKS
752 if (_DBUS_UNLIKELY (old_refcount <= 0))
754 _dbus_atomic_dec (&server->refcount);
755 _dbus_warn_check_failed (_dbus_return_if_fail_warning_format,
756 _DBUS_FUNCTION_NAME, "old_refcount > 0",
762 _dbus_server_trace_ref (server, old_refcount, old_refcount + 1, "ref");
768 * Decrements the reference count of a DBusServer. Finalizes the
769 * server if the reference count reaches zero.
771 * The server must be disconnected before the refcount reaches zero.
773 * @param server the server.
776 dbus_server_unref (DBusServer *server)
778 dbus_int32_t old_refcount;
780 /* keep this in sync with unref_unlocked */
782 _dbus_return_if_fail (server != NULL);
784 old_refcount = _dbus_atomic_dec (&server->refcount);
786 #ifndef DBUS_DISABLE_CHECKS
787 if (_DBUS_UNLIKELY (old_refcount <= 0))
789 /* undo side-effect first
790 * please do not try to simplify the code here by using
791 * _dbus_atomic_get(), why we don't use it is
792 * because it issues another atomic operation even though
793 * DBUS_DISABLE_CHECKS defined.
794 * Bug: https://bugs.freedesktop.org/show_bug.cgi?id=68303
796 _dbus_atomic_inc (&server->refcount);
797 _dbus_warn_check_failed (_dbus_return_if_fail_warning_format,
798 _DBUS_FUNCTION_NAME, "old_refcount > 0",
804 _dbus_server_trace_ref (server, old_refcount, old_refcount - 1, "unref");
806 if (old_refcount == 1)
809 _dbus_assert (server->disconnected);
811 _dbus_assert (server->vtable->finalize != NULL);
813 (* server->vtable->finalize) (server);
818 * Releases the server's address and stops listening for
819 * new clients. If called more than once, only the first
820 * call has an effect. Does not modify the server's
823 * @param server the server.
826 dbus_server_disconnect (DBusServer *server)
828 _dbus_return_if_fail (server != NULL);
830 dbus_server_ref (server);
831 SERVER_LOCK (server);
833 _dbus_assert (server->vtable->disconnect != NULL);
835 if (!server->disconnected)
837 /* this has to be first so recursive calls to disconnect don't happen */
838 server->disconnected = TRUE;
840 (* server->vtable->disconnect) (server);
843 SERVER_UNLOCK (server);
844 dbus_server_unref (server);
848 * Returns #TRUE if the server is still listening for new connections.
850 * @param server the server.
853 dbus_server_get_is_connected (DBusServer *server)
857 _dbus_return_val_if_fail (server != NULL, FALSE);
859 SERVER_LOCK (server);
860 retval = !server->disconnected;
861 SERVER_UNLOCK (server);
867 * Returns the address of the server, as a newly-allocated
868 * string which must be freed by the caller.
870 * @param server the server
871 * @returns the address or #NULL if no memory
874 dbus_server_get_address (DBusServer *server)
878 _dbus_return_val_if_fail (server != NULL, NULL);
880 SERVER_LOCK (server);
881 retval = _dbus_strdup (server->address);
882 SERVER_UNLOCK (server);
888 * Returns the unique ID of the server, as a newly-allocated
889 * string which must be freed by the caller. This ID is
890 * normally used by clients to tell when two #DBusConnection
891 * would be equivalent (because the server address passed
892 * to dbus_connection_open() will have the same guid in the
893 * two cases). dbus_connection_open() can re-use an existing
894 * connection with the same ID instead of opening a new
897 * This is an ID unique to each #DBusServer. Remember that
898 * a #DBusServer represents only one mode of connecting,
899 * so e.g. a bus daemon can listen on multiple addresses
900 * which will mean it has multiple #DBusServer each with
903 * The ID is not a UUID in the sense of RFC4122; the details
904 * are explained in the D-Bus specification.
906 * @param server the server
907 * @returns the id of the server or #NULL if no memory
910 dbus_server_get_id (DBusServer *server)
914 _dbus_return_val_if_fail (server != NULL, NULL);
916 SERVER_LOCK (server);
918 _dbus_string_copy_data (&server->guid_hex, &retval);
919 SERVER_UNLOCK (server);
925 * Sets a function to be used for handling new connections. The given
926 * function is passed each new connection as the connection is
927 * created. If the new connection function increments the connection's
928 * reference count, the connection will stay alive. Otherwise, the
929 * connection will be unreferenced and closed. The new connection
930 * function may also close the connection itself, which is considered
931 * good form if the connection is not wanted.
933 * The connection here is private in the sense of
934 * dbus_connection_open_private(), so if the new connection function
935 * keeps a reference it must arrange for the connection to be closed.
936 * i.e. libdbus does not own this connection once the new connection
937 * function takes a reference.
939 * @param server the server.
940 * @param function a function to handle new connections.
941 * @param data data to pass to the new connection handler.
942 * @param free_data_function function to free the data.
945 dbus_server_set_new_connection_function (DBusServer *server,
946 DBusNewConnectionFunction function,
948 DBusFreeFunction free_data_function)
950 DBusFreeFunction old_free_function;
953 _dbus_return_if_fail (server != NULL);
955 SERVER_LOCK (server);
956 old_free_function = server->new_connection_free_data_function;
957 old_data = server->new_connection_data;
959 server->new_connection_function = function;
960 server->new_connection_data = data;
961 server->new_connection_free_data_function = free_data_function;
962 SERVER_UNLOCK (server);
964 if (old_free_function != NULL)
965 (* old_free_function) (old_data);
969 * Sets the watch functions for the server. These functions are
970 * responsible for making the application's main loop aware of file
971 * descriptors that need to be monitored for events.
973 * This function behaves exactly like dbus_connection_set_watch_functions();
974 * see the documentation for that routine.
976 * @param server the server.
977 * @param add_function function to begin monitoring a new descriptor.
978 * @param remove_function function to stop monitoring a descriptor.
979 * @param toggled_function function to notify when the watch is enabled/disabled
980 * @param data data to pass to add_function and remove_function.
981 * @param free_data_function function to be called to free the data.
982 * @returns #FALSE on failure (no memory)
985 dbus_server_set_watch_functions (DBusServer *server,
986 DBusAddWatchFunction add_function,
987 DBusRemoveWatchFunction remove_function,
988 DBusWatchToggledFunction toggled_function,
990 DBusFreeFunction free_data_function)
993 DBusWatchList *watches;
995 _dbus_return_val_if_fail (server != NULL, FALSE);
997 SERVER_LOCK (server);
998 watches = server->watches;
999 server->watches = NULL;
1002 SERVER_UNLOCK (server);
1003 result = _dbus_watch_list_set_functions (watches,
1008 free_data_function);
1009 SERVER_LOCK (server);
1013 _dbus_warn_check_failed ("Re-entrant call to %s\n", _DBUS_FUNCTION_NAME);
1016 server->watches = watches;
1017 SERVER_UNLOCK (server);
1023 * Sets the timeout functions for the server. These functions are
1024 * responsible for making the application's main loop aware of timeouts.
1026 * This function behaves exactly like dbus_connection_set_timeout_functions();
1027 * see the documentation for that routine.
1029 * @param server the server.
1030 * @param add_function function to add a timeout.
1031 * @param remove_function function to remove a timeout.
1032 * @param toggled_function function to notify when the timeout is enabled/disabled
1033 * @param data data to pass to add_function and remove_function.
1034 * @param free_data_function function to be called to free the data.
1035 * @returns #FALSE on failure (no memory)
1038 dbus_server_set_timeout_functions (DBusServer *server,
1039 DBusAddTimeoutFunction add_function,
1040 DBusRemoveTimeoutFunction remove_function,
1041 DBusTimeoutToggledFunction toggled_function,
1043 DBusFreeFunction free_data_function)
1046 DBusTimeoutList *timeouts;
1048 _dbus_return_val_if_fail (server != NULL, FALSE);
1050 SERVER_LOCK (server);
1051 timeouts = server->timeouts;
1052 server->timeouts = NULL;
1055 SERVER_UNLOCK (server);
1056 result = _dbus_timeout_list_set_functions (timeouts,
1061 free_data_function);
1062 SERVER_LOCK (server);
1066 _dbus_warn_check_failed ("Re-entrant call to %s\n", _DBUS_FUNCTION_NAME);
1069 server->timeouts = timeouts;
1070 SERVER_UNLOCK (server);
1076 * Sets the authentication mechanisms that this server offers to
1077 * clients, as a #NULL-terminated array of mechanism names. This
1078 * function only affects connections created <em>after</em> it is
1079 * called. Pass #NULL instead of an array to use all available
1080 * mechanisms (this is the default behavior).
1082 * The D-Bus specification describes some of the supported mechanisms.
1084 * @param server the server
1085 * @param mechanisms #NULL-terminated array of mechanisms
1086 * @returns #FALSE if no memory
1089 dbus_server_set_auth_mechanisms (DBusServer *server,
1090 const char **mechanisms)
1094 _dbus_return_val_if_fail (server != NULL, FALSE);
1096 SERVER_LOCK (server);
1098 if (mechanisms != NULL)
1100 copy = _dbus_dup_string_array (mechanisms);
1107 dbus_free_string_array (server->auth_mechanisms);
1108 server->auth_mechanisms = copy;
1110 SERVER_UNLOCK (server);
1115 static DBusDataSlotAllocator slot_allocator =
1116 _DBUS_DATA_SLOT_ALLOCATOR_INIT (_DBUS_LOCK_NAME (server_slots));
1119 * Allocates an integer ID to be used for storing application-specific
1120 * data on any DBusServer. The allocated ID may then be used
1121 * with dbus_server_set_data() and dbus_server_get_data().
1122 * The slot must be initialized with -1. If a nonnegative
1123 * slot is passed in, the refcount is incremented on that
1124 * slot, rather than creating a new slot.
1126 * The allocated slot is global, i.e. all DBusServer objects will have
1127 * a slot with the given integer ID reserved.
1129 * @param slot_p address of global variable storing the slot ID
1130 * @returns #FALSE on no memory
1133 dbus_server_allocate_data_slot (dbus_int32_t *slot_p)
1135 return _dbus_data_slot_allocator_alloc (&slot_allocator,
1140 * Deallocates a global ID for server data slots.
1141 * dbus_server_get_data() and dbus_server_set_data()
1142 * may no longer be used with this slot.
1143 * Existing data stored on existing DBusServer objects
1144 * will be freed when the server is finalized,
1145 * but may not be retrieved (and may only be replaced
1146 * if someone else reallocates the slot).
1148 * @param slot_p address of the slot to deallocate
1151 dbus_server_free_data_slot (dbus_int32_t *slot_p)
1153 _dbus_return_if_fail (*slot_p >= 0);
1155 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
1159 * Stores a pointer on a DBusServer, along
1160 * with an optional function to be used for freeing
1161 * the data when the data is set again, or when
1162 * the server is finalized. The slot number
1163 * must have been allocated with dbus_server_allocate_data_slot().
1165 * @param server the server
1166 * @param slot the slot number
1167 * @param data the data to store
1168 * @param free_data_func finalizer function for the data
1169 * @returns #TRUE if there was enough memory to store the data
1172 dbus_server_set_data (DBusServer *server,
1175 DBusFreeFunction free_data_func)
1177 DBusFreeFunction old_free_func;
1181 _dbus_return_val_if_fail (server != NULL, FALSE);
1183 SERVER_LOCK (server);
1185 retval = _dbus_data_slot_list_set (&slot_allocator,
1187 slot, data, free_data_func,
1188 &old_free_func, &old_data);
1191 SERVER_UNLOCK (server);
1195 /* Do the actual free outside the server lock */
1197 (* old_free_func) (old_data);
1204 * Retrieves data previously set with dbus_server_set_data().
1205 * The slot must still be allocated (must not have been freed).
1207 * @param server the server
1208 * @param slot the slot to get data from
1209 * @returns the data, or #NULL if not found
1212 dbus_server_get_data (DBusServer *server,
1217 _dbus_return_val_if_fail (server != NULL, NULL);
1219 SERVER_LOCK (server);
1221 res = _dbus_data_slot_list_get (&slot_allocator,
1225 SERVER_UNLOCK (server);
1232 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
1233 #include "dbus-test.h"
1237 _dbus_server_test (void)
1239 const char *valid_addresses[] = {
1241 "tcp:host=localhost,port=1234",
1242 "tcp:host=localhost,port=1234;tcp:port=5678",
1244 "unix:path=./boogie",
1245 "tcp:port=1234;unix:path=./boogie",
1252 for (i = 0; i < _DBUS_N_ELEMENTS (valid_addresses); i++)
1254 DBusError error = DBUS_ERROR_INIT;
1258 server = dbus_server_listen (valid_addresses[i], &error);
1261 _dbus_warn ("server listen error: %s: %s\n", error.name, error.message);
1262 dbus_error_free (&error);
1263 _dbus_assert_not_reached ("Failed to listen for valid address.");
1266 id = dbus_server_get_id (server);
1267 _dbus_assert (id != NULL);
1268 address = dbus_server_get_address (server);
1269 _dbus_assert (address != NULL);
1271 if (strstr (address, id) == NULL)
1273 _dbus_warn ("server id '%s' is not in the server address '%s'\n",
1275 _dbus_assert_not_reached ("bad server id or address");
1279 dbus_free (address);
1281 dbus_server_disconnect (server);
1282 dbus_server_unref (server);
1288 #endif /* DBUS_ENABLE_EMBEDDED_TESTS */