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_BUILD_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 /* this is a little fragile since it assumes the address doesn't
57 * already have a guid, but it shouldn't
60 copy_address_with_guid_appended (const DBusString *address,
61 const DBusString *guid_hex)
66 if (!_dbus_string_init (&with_guid))
69 if (!_dbus_string_copy (address, 0, &with_guid,
70 _dbus_string_get_length (&with_guid)) ||
71 !_dbus_string_append (&with_guid, ",guid=") ||
72 !_dbus_string_copy (guid_hex, 0,
73 &with_guid, _dbus_string_get_length (&with_guid)))
75 _dbus_string_free (&with_guid);
80 _dbus_string_steal_data (&with_guid, &retval);
82 _dbus_string_free (&with_guid);
84 return retval; /* may be NULL if steal_data failed */
88 * Initializes the members of the DBusServer base class.
89 * Chained up to by subclass constructors.
91 * @param server the server.
92 * @param vtable the vtable for the subclass.
93 * @param address the server's address
94 * @returns #TRUE on success.
97 _dbus_server_init_base (DBusServer *server,
98 const DBusServerVTable *vtable,
99 const DBusString *address)
101 server->vtable = vtable;
102 server->refcount.value = 1;
104 server->address = NULL;
105 server->watches = NULL;
106 server->timeouts = NULL;
107 server->published_address = FALSE;
109 if (!_dbus_string_init (&server->guid_hex))
112 _dbus_generate_uuid (&server->guid);
114 if (!_dbus_uuid_encode (&server->guid, &server->guid_hex))
117 server->address = copy_address_with_guid_appended (address,
119 if (server->address == NULL)
122 _dbus_mutex_new_at_location (&server->mutex);
123 if (server->mutex == NULL)
126 server->watches = _dbus_watch_list_new ();
127 if (server->watches == NULL)
130 server->timeouts = _dbus_timeout_list_new ();
131 if (server->timeouts == NULL)
134 _dbus_data_slot_list_init (&server->slot_list);
136 _dbus_verbose ("Initialized server on address %s\n", server->address);
141 _dbus_mutex_free_at_location (&server->mutex);
142 server->mutex = NULL;
145 _dbus_watch_list_free (server->watches);
146 server->watches = NULL;
148 if (server->timeouts)
150 _dbus_timeout_list_free (server->timeouts);
151 server->timeouts = NULL;
155 dbus_free (server->address);
156 server->address = NULL;
158 _dbus_string_free (&server->guid_hex);
164 * Finalizes the members of the DBusServer base class.
165 * Chained up to by subclass finalizers.
167 * @param server the server.
170 _dbus_server_finalize_base (DBusServer *server)
172 /* We don't have the lock, but nobody should be accessing
173 * concurrently since they don't have a ref
175 #ifndef DBUS_DISABLE_CHECKS
176 _dbus_assert (!server->have_server_lock);
178 _dbus_assert (server->disconnected);
180 /* calls out to application code... */
181 _dbus_data_slot_list_free (&server->slot_list);
183 dbus_server_set_new_connection_function (server, NULL, NULL, NULL);
185 _dbus_watch_list_free (server->watches);
186 _dbus_timeout_list_free (server->timeouts);
188 _dbus_mutex_free_at_location (&server->mutex);
190 dbus_free (server->address);
192 dbus_free_string_array (server->auth_mechanisms);
194 _dbus_string_free (&server->guid_hex);
198 /** Function to be called in protected_change_watch() with refcount held */
199 typedef dbus_bool_t (* DBusWatchAddFunction) (DBusWatchList *list,
201 /** Function to be called in protected_change_watch() with refcount held */
202 typedef void (* DBusWatchRemoveFunction) (DBusWatchList *list,
204 /** Function to be called in protected_change_watch() with refcount held */
205 typedef void (* DBusWatchToggleFunction) (DBusWatchList *list,
207 dbus_bool_t enabled);
210 protected_change_watch (DBusServer *server,
212 DBusWatchAddFunction add_function,
213 DBusWatchRemoveFunction remove_function,
214 DBusWatchToggleFunction toggle_function,
217 DBusWatchList *watches;
220 HAVE_LOCK_CHECK (server);
222 /* This isn't really safe or reasonable; a better pattern is the "do
223 * everything, then drop lock and call out" one; but it has to be
224 * propagated up through all callers
227 watches = server->watches;
230 server->watches = NULL;
231 _dbus_server_ref_unlocked (server);
232 SERVER_UNLOCK (server);
235 retval = (* add_function) (watches, watch);
236 else if (remove_function)
239 (* remove_function) (watches, watch);
244 (* toggle_function) (watches, watch, enabled);
247 SERVER_LOCK (server);
248 server->watches = watches;
249 _dbus_server_unref_unlocked (server);
258 * Adds a watch for this server, chaining out to application-provided
261 * @param server the server.
262 * @param watch the watch to add.
265 _dbus_server_add_watch (DBusServer *server,
268 HAVE_LOCK_CHECK (server);
269 return protected_change_watch (server, watch,
270 _dbus_watch_list_add_watch,
275 * Removes a watch previously added with _dbus_server_remove_watch().
277 * @param server the server.
278 * @param watch the watch to remove.
281 _dbus_server_remove_watch (DBusServer *server,
284 HAVE_LOCK_CHECK (server);
285 protected_change_watch (server, watch,
287 _dbus_watch_list_remove_watch,
292 * Toggles a watch and notifies app via server's
293 * DBusWatchToggledFunction if available. It's an error to call this
294 * function on a watch that was not previously added.
296 * @param server the server.
297 * @param watch the watch to toggle.
298 * @param enabled whether to enable or disable
301 _dbus_server_toggle_watch (DBusServer *server,
305 _dbus_assert (watch != NULL);
307 HAVE_LOCK_CHECK (server);
308 protected_change_watch (server, watch,
310 _dbus_watch_list_toggle_watch,
314 /** Function to be called in protected_change_timeout() with refcount held */
315 typedef dbus_bool_t (* DBusTimeoutAddFunction) (DBusTimeoutList *list,
316 DBusTimeout *timeout);
317 /** Function to be called in protected_change_timeout() with refcount held */
318 typedef void (* DBusTimeoutRemoveFunction) (DBusTimeoutList *list,
319 DBusTimeout *timeout);
320 /** Function to be called in protected_change_timeout() with refcount held */
321 typedef void (* DBusTimeoutToggleFunction) (DBusTimeoutList *list,
322 DBusTimeout *timeout,
323 dbus_bool_t enabled);
327 protected_change_timeout (DBusServer *server,
328 DBusTimeout *timeout,
329 DBusTimeoutAddFunction add_function,
330 DBusTimeoutRemoveFunction remove_function,
331 DBusTimeoutToggleFunction toggle_function,
334 DBusTimeoutList *timeouts;
337 HAVE_LOCK_CHECK (server);
339 /* This isn't really safe or reasonable; a better pattern is the "do everything, then
340 * drop lock and call out" one; but it has to be propagated up through all callers
343 timeouts = server->timeouts;
346 server->timeouts = NULL;
347 _dbus_server_ref_unlocked (server);
348 SERVER_UNLOCK (server);
351 retval = (* add_function) (timeouts, timeout);
352 else if (remove_function)
355 (* remove_function) (timeouts, timeout);
360 (* toggle_function) (timeouts, timeout, enabled);
363 SERVER_LOCK (server);
364 server->timeouts = timeouts;
365 _dbus_server_unref_unlocked (server);
374 * Adds a timeout for this server, chaining out to
375 * application-provided timeout handlers. The timeout should be
376 * repeatedly handled with dbus_timeout_handle() at its given interval
377 * until it is removed.
379 * @param server the server.
380 * @param timeout the timeout to add.
383 _dbus_server_add_timeout (DBusServer *server,
384 DBusTimeout *timeout)
386 return protected_change_timeout (server, timeout,
387 _dbus_timeout_list_add_timeout,
392 * Removes a timeout previously added with _dbus_server_add_timeout().
394 * @param server the server.
395 * @param timeout the timeout to remove.
398 _dbus_server_remove_timeout (DBusServer *server,
399 DBusTimeout *timeout)
401 protected_change_timeout (server, timeout,
403 _dbus_timeout_list_remove_timeout,
408 * Toggles a timeout and notifies app via server's
409 * DBusTimeoutToggledFunction if available. It's an error to call this
410 * function on a timeout that was not previously added.
412 * @param server the server.
413 * @param timeout the timeout to toggle.
414 * @param enabled whether to enable or disable
417 _dbus_server_toggle_timeout (DBusServer *server,
418 DBusTimeout *timeout,
421 protected_change_timeout (server, timeout,
423 _dbus_timeout_list_toggle_timeout,
429 * Like dbus_server_ref() but does not acquire the lock (must already be held)
431 * @param server the server.
434 _dbus_server_ref_unlocked (DBusServer *server)
436 _dbus_assert (server != NULL);
437 _dbus_assert (server->refcount.value > 0);
439 HAVE_LOCK_CHECK (server);
441 #ifdef DBUS_HAVE_ATOMIC_INT
442 _dbus_atomic_inc (&server->refcount);
444 _dbus_assert (server->refcount.value > 0);
446 server->refcount.value += 1;
451 * Like dbus_server_unref() but does not acquire the lock (must already be held)
453 * @param server the server.
456 _dbus_server_unref_unlocked (DBusServer *server)
458 dbus_bool_t last_unref;
460 /* Keep this in sync with dbus_server_unref */
462 _dbus_assert (server != NULL);
463 _dbus_assert (server->refcount.value > 0);
465 HAVE_LOCK_CHECK (server);
467 #ifdef DBUS_HAVE_ATOMIC_INT
468 last_unref = (_dbus_atomic_dec (&server->refcount) == 1);
470 _dbus_assert (server->refcount.value > 0);
472 server->refcount.value -= 1;
473 last_unref = (server->refcount.value == 0);
478 _dbus_assert (server->disconnected);
480 SERVER_UNLOCK (server);
482 _dbus_assert (server->vtable->finalize != NULL);
484 (* server->vtable->finalize) (server);
491 * @addtogroup DBusServer
498 * @typedef DBusServer
500 * An opaque object representing a server that listens for
501 * connections from other applications. Each time a connection
502 * is made, a new DBusConnection is created and made available
503 * via an application-provided DBusNewConnectionFunction.
504 * The DBusNewConnectionFunction is provided with
505 * dbus_server_set_new_connection_function().
509 static const struct {
510 DBusServerListenResult (* func) (DBusAddressEntry *entry,
511 DBusServer **server_p,
514 { _dbus_server_listen_socket }
515 , { _dbus_server_listen_platform_specific }
516 #ifdef DBUS_BUILD_TESTS
517 , { _dbus_server_listen_debug_pipe }
522 * Listens for new connections on the given address. If there are
523 * multiple semicolon-separated address entries in the address, tries
524 * each one and listens on the first one that works.
526 * Returns #NULL and sets error if listening fails for any reason.
527 * Otherwise returns a new #DBusServer.
528 * dbus_server_set_new_connection_function(),
529 * dbus_server_set_watch_functions(), and
530 * dbus_server_set_timeout_functions() should be called immediately to
531 * render the server fully functional.
533 * To free the server, applications must call first
534 * dbus_server_disconnect() and then dbus_server_unref().
536 * @param address the address of this server.
537 * @param error location to store reason for failure.
538 * @returns a new #DBusServer, or #NULL on failure.
542 dbus_server_listen (const char *address,
546 DBusAddressEntry **entries;
548 DBusError first_connect_error = DBUS_ERROR_INIT;
549 dbus_bool_t handled_once;
551 _dbus_return_val_if_fail (address != NULL, NULL);
552 _dbus_return_val_if_error_is_set (error, NULL);
554 if (!dbus_parse_address (address, &entries, &len, error))
558 handled_once = FALSE;
560 for (i = 0; i < len; i++)
564 for (j = 0; j < (int) _DBUS_N_ELEMENTS (listen_funcs); ++j)
566 DBusServerListenResult result;
567 DBusError tmp_error = DBUS_ERROR_INIT;
569 result = (* listen_funcs[j].func) (entries[i],
573 if (result == DBUS_SERVER_LISTEN_OK)
575 _dbus_assert (server != NULL);
576 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
580 else if (result == DBUS_SERVER_LISTEN_BAD_ADDRESS)
582 _dbus_assert (server == NULL);
583 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
584 dbus_move_error (&tmp_error, error);
588 else if (result == DBUS_SERVER_LISTEN_NOT_HANDLED)
590 _dbus_assert (server == NULL);
591 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
593 /* keep trying addresses */
595 else if (result == DBUS_SERVER_LISTEN_DID_NOT_CONNECT)
597 _dbus_assert (server == NULL);
598 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
599 if (!dbus_error_is_set (&first_connect_error))
600 dbus_move_error (&tmp_error, &first_connect_error);
602 dbus_error_free (&tmp_error);
606 /* keep trying addresses */
610 _dbus_assert (server == NULL);
611 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
618 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
620 dbus_set_error (error,
621 DBUS_ERROR_BAD_ADDRESS,
622 "Unknown address type '%s'",
623 dbus_address_entry_get_method (entries[0]));
625 dbus_set_error (error,
626 DBUS_ERROR_BAD_ADDRESS,
627 "Empty address '%s'",
631 dbus_address_entries_free (entries);
635 _dbus_assert (error == NULL || dbus_error_is_set (&first_connect_error) ||
636 dbus_error_is_set (error));
638 if (error && dbus_error_is_set (error))
640 /* already set the error */
644 /* didn't set the error but either error should be
645 * NULL or first_connect_error should be set.
647 _dbus_assert (error == NULL || dbus_error_is_set (&first_connect_error));
648 dbus_move_error (&first_connect_error, error);
651 _DBUS_ASSERT_ERROR_IS_CLEAR (&first_connect_error); /* be sure we freed it */
652 _DBUS_ASSERT_ERROR_IS_SET (error);
658 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
664 * Increments the reference count of a DBusServer.
666 * @param server the server.
667 * @returns the server
670 dbus_server_ref (DBusServer *server)
672 _dbus_return_val_if_fail (server != NULL, NULL);
673 _dbus_return_val_if_fail (server->refcount.value > 0, NULL);
675 #ifdef DBUS_HAVE_ATOMIC_INT
676 _dbus_atomic_inc (&server->refcount);
678 SERVER_LOCK (server);
679 _dbus_assert (server->refcount.value > 0);
681 server->refcount.value += 1;
682 SERVER_UNLOCK (server);
689 * Decrements the reference count of a DBusServer. Finalizes the
690 * server if the reference count reaches zero.
692 * The server must be disconnected before the refcount reaches zero.
694 * @param server the server.
697 dbus_server_unref (DBusServer *server)
699 dbus_bool_t last_unref;
701 /* keep this in sync with unref_unlocked */
703 _dbus_return_if_fail (server != NULL);
704 _dbus_return_if_fail (server->refcount.value > 0);
706 #ifdef DBUS_HAVE_ATOMIC_INT
707 last_unref = (_dbus_atomic_dec (&server->refcount) == 1);
709 SERVER_LOCK (server);
711 _dbus_assert (server->refcount.value > 0);
713 server->refcount.value -= 1;
714 last_unref = (server->refcount.value == 0);
716 SERVER_UNLOCK (server);
722 _dbus_assert (server->disconnected);
724 _dbus_assert (server->vtable->finalize != NULL);
726 (* server->vtable->finalize) (server);
731 * Releases the server's address and stops listening for
732 * new clients. If called more than once, only the first
733 * call has an effect. Does not modify the server's
736 * @param server the server.
739 dbus_server_disconnect (DBusServer *server)
741 _dbus_return_if_fail (server != NULL);
742 _dbus_return_if_fail (server->refcount.value > 0);
744 SERVER_LOCK (server);
745 _dbus_server_ref_unlocked (server);
747 _dbus_assert (server->vtable->disconnect != NULL);
749 if (!server->disconnected)
751 /* this has to be first so recursive calls to disconnect don't happen */
752 server->disconnected = TRUE;
754 (* server->vtable->disconnect) (server);
757 SERVER_UNLOCK (server);
758 dbus_server_unref (server);
762 * Returns #TRUE if the server is still listening for new connections.
764 * @param server the server.
767 dbus_server_get_is_connected (DBusServer *server)
771 _dbus_return_val_if_fail (server != NULL, FALSE);
773 SERVER_LOCK (server);
774 retval = !server->disconnected;
775 SERVER_UNLOCK (server);
781 * Returns the address of the server, as a newly-allocated
782 * string which must be freed by the caller.
784 * @param server the server
785 * @returns the address or #NULL if no memory
788 dbus_server_get_address (DBusServer *server)
792 _dbus_return_val_if_fail (server != NULL, NULL);
794 SERVER_LOCK (server);
795 retval = _dbus_strdup (server->address);
796 SERVER_UNLOCK (server);
802 * Returns the unique ID of the server, as a newly-allocated
803 * string which must be freed by the caller. This ID is
804 * normally used by clients to tell when two #DBusConnection
805 * would be equivalent (because the server address passed
806 * to dbus_connection_open() will have the same guid in the
807 * two cases). dbus_connection_open() can re-use an existing
808 * connection with the same ID instead of opening a new
811 * This is an ID unique to each #DBusServer. Remember that
812 * a #DBusServer represents only one mode of connecting,
813 * so e.g. a bus daemon can listen on multiple addresses
814 * which will mean it has multiple #DBusServer each with
817 * The ID is not a UUID in the sense of RFC4122; the details
818 * are explained in the D-Bus specification.
820 * @param server the server
821 * @returns the id of the server or #NULL if no memory
824 dbus_server_get_id (DBusServer *server)
828 _dbus_return_val_if_fail (server != NULL, NULL);
830 SERVER_LOCK (server);
832 _dbus_string_copy_data (&server->guid_hex, &retval);
833 SERVER_UNLOCK (server);
839 * Sets a function to be used for handling new connections. The given
840 * function is passed each new connection as the connection is
841 * created. If the new connection function increments the connection's
842 * reference count, the connection will stay alive. Otherwise, the
843 * connection will be unreferenced and closed. The new connection
844 * function may also close the connection itself, which is considered
845 * good form if the connection is not wanted.
847 * The connection here is private in the sense of
848 * dbus_connection_open_private(), so if the new connection function
849 * keeps a reference it must arrange for the connection to be closed.
850 * i.e. libdbus does not own this connection once the new connection
851 * function takes a reference.
853 * @param server the server.
854 * @param function a function to handle new connections.
855 * @param data data to pass to the new connection handler.
856 * @param free_data_function function to free the data.
859 dbus_server_set_new_connection_function (DBusServer *server,
860 DBusNewConnectionFunction function,
862 DBusFreeFunction free_data_function)
864 DBusFreeFunction old_free_function;
867 _dbus_return_if_fail (server != NULL);
869 SERVER_LOCK (server);
870 old_free_function = server->new_connection_free_data_function;
871 old_data = server->new_connection_data;
873 server->new_connection_function = function;
874 server->new_connection_data = data;
875 server->new_connection_free_data_function = free_data_function;
876 SERVER_UNLOCK (server);
878 if (old_free_function != NULL)
879 (* old_free_function) (old_data);
883 * Sets the watch functions for the server. These functions are
884 * responsible for making the application's main loop aware of file
885 * descriptors that need to be monitored for events.
887 * This function behaves exactly like dbus_connection_set_watch_functions();
888 * see the documentation for that routine.
890 * @param server the server.
891 * @param add_function function to begin monitoring a new descriptor.
892 * @param remove_function function to stop monitoring a descriptor.
893 * @param toggled_function function to notify when the watch is enabled/disabled
894 * @param data data to pass to add_function and remove_function.
895 * @param free_data_function function to be called to free the data.
896 * @returns #FALSE on failure (no memory)
899 dbus_server_set_watch_functions (DBusServer *server,
900 DBusAddWatchFunction add_function,
901 DBusRemoveWatchFunction remove_function,
902 DBusWatchToggledFunction toggled_function,
904 DBusFreeFunction free_data_function)
907 DBusWatchList *watches;
909 _dbus_return_val_if_fail (server != NULL, FALSE);
911 SERVER_LOCK (server);
912 watches = server->watches;
913 server->watches = NULL;
916 SERVER_UNLOCK (server);
917 result = _dbus_watch_list_set_functions (watches,
923 SERVER_LOCK (server);
927 _dbus_warn_check_failed ("Re-entrant call to %s\n", _DBUS_FUNCTION_NAME);
930 server->watches = watches;
931 SERVER_UNLOCK (server);
937 * Sets the timeout functions for the server. These functions are
938 * responsible for making the application's main loop aware of timeouts.
940 * This function behaves exactly like dbus_connection_set_timeout_functions();
941 * see the documentation for that routine.
943 * @param server the server.
944 * @param add_function function to add a timeout.
945 * @param remove_function function to remove a timeout.
946 * @param toggled_function function to notify when the timeout is enabled/disabled
947 * @param data data to pass to add_function and remove_function.
948 * @param free_data_function function to be called to free the data.
949 * @returns #FALSE on failure (no memory)
952 dbus_server_set_timeout_functions (DBusServer *server,
953 DBusAddTimeoutFunction add_function,
954 DBusRemoveTimeoutFunction remove_function,
955 DBusTimeoutToggledFunction toggled_function,
957 DBusFreeFunction free_data_function)
960 DBusTimeoutList *timeouts;
962 _dbus_return_val_if_fail (server != NULL, FALSE);
964 SERVER_LOCK (server);
965 timeouts = server->timeouts;
966 server->timeouts = NULL;
969 SERVER_UNLOCK (server);
970 result = _dbus_timeout_list_set_functions (timeouts,
976 SERVER_LOCK (server);
980 _dbus_warn_check_failed ("Re-entrant call to %s\n", _DBUS_FUNCTION_NAME);
983 server->timeouts = timeouts;
984 SERVER_UNLOCK (server);
990 * Sets the authentication mechanisms that this server offers to
991 * clients, as a #NULL-terminated array of mechanism names. This
992 * function only affects connections created <em>after</em> it is
993 * called. Pass #NULL instead of an array to use all available
994 * mechanisms (this is the default behavior).
996 * The D-Bus specification describes some of the supported mechanisms.
998 * @param server the server
999 * @param mechanisms #NULL-terminated array of mechanisms
1000 * @returns #FALSE if no memory
1003 dbus_server_set_auth_mechanisms (DBusServer *server,
1004 const char **mechanisms)
1008 _dbus_return_val_if_fail (server != NULL, FALSE);
1010 SERVER_LOCK (server);
1012 if (mechanisms != NULL)
1014 copy = _dbus_dup_string_array (mechanisms);
1021 dbus_free_string_array (server->auth_mechanisms);
1022 server->auth_mechanisms = copy;
1024 SERVER_UNLOCK (server);
1030 static DBusDataSlotAllocator slot_allocator;
1031 _DBUS_DEFINE_GLOBAL_LOCK (server_slots);
1034 * Allocates an integer ID to be used for storing application-specific
1035 * data on any DBusServer. The allocated ID may then be used
1036 * with dbus_server_set_data() and dbus_server_get_data().
1037 * The slot must be initialized with -1. If a nonnegative
1038 * slot is passed in, the refcount is incremented on that
1039 * slot, rather than creating a new slot.
1041 * The allocated slot is global, i.e. all DBusServer objects will have
1042 * a slot with the given integer ID reserved.
1044 * @param slot_p address of global variable storing the slot ID
1045 * @returns #FALSE on no memory
1048 dbus_server_allocate_data_slot (dbus_int32_t *slot_p)
1050 return _dbus_data_slot_allocator_alloc (&slot_allocator,
1051 (DBusMutex **)&_DBUS_LOCK_NAME (server_slots),
1056 * Deallocates a global ID for server data slots.
1057 * dbus_server_get_data() and dbus_server_set_data()
1058 * may no longer be used with this slot.
1059 * Existing data stored on existing DBusServer objects
1060 * will be freed when the server is finalized,
1061 * but may not be retrieved (and may only be replaced
1062 * if someone else reallocates the slot).
1064 * @param slot_p address of the slot to deallocate
1067 dbus_server_free_data_slot (dbus_int32_t *slot_p)
1069 _dbus_return_if_fail (*slot_p >= 0);
1071 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
1075 * Stores a pointer on a DBusServer, along
1076 * with an optional function to be used for freeing
1077 * the data when the data is set again, or when
1078 * the server is finalized. The slot number
1079 * must have been allocated with dbus_server_allocate_data_slot().
1081 * @param server the server
1082 * @param slot the slot number
1083 * @param data the data to store
1084 * @param free_data_func finalizer function for the data
1085 * @returns #TRUE if there was enough memory to store the data
1088 dbus_server_set_data (DBusServer *server,
1091 DBusFreeFunction free_data_func)
1093 DBusFreeFunction old_free_func;
1097 _dbus_return_val_if_fail (server != NULL, FALSE);
1099 SERVER_LOCK (server);
1101 retval = _dbus_data_slot_list_set (&slot_allocator,
1103 slot, data, free_data_func,
1104 &old_free_func, &old_data);
1107 SERVER_UNLOCK (server);
1111 /* Do the actual free outside the server lock */
1113 (* old_free_func) (old_data);
1120 * Retrieves data previously set with dbus_server_set_data().
1121 * The slot must still be allocated (must not have been freed).
1123 * @param server the server
1124 * @param slot the slot to get data from
1125 * @returns the data, or #NULL if not found
1128 dbus_server_get_data (DBusServer *server,
1133 _dbus_return_val_if_fail (server != NULL, NULL);
1135 SERVER_LOCK (server);
1137 res = _dbus_data_slot_list_get (&slot_allocator,
1141 SERVER_UNLOCK (server);
1148 #ifdef DBUS_BUILD_TESTS
1149 #include "dbus-test.h"
1153 _dbus_server_test (void)
1155 const char *valid_addresses[] = {
1157 "tcp:host=localhost,port=1234",
1158 "tcp:host=localhost,port=1234;tcp:port=5678",
1160 "unix:path=./boogie",
1161 "tcp:port=1234;unix:path=./boogie",
1168 for (i = 0; i < _DBUS_N_ELEMENTS (valid_addresses); i++)
1170 DBusError error = DBUS_ERROR_INIT;
1174 server = dbus_server_listen (valid_addresses[i], &error);
1177 _dbus_warn ("server listen error: %s: %s\n", error.name, error.message);
1178 dbus_error_free (&error);
1179 _dbus_assert_not_reached ("Failed to listen for valid address.");
1182 id = dbus_server_get_id (server);
1183 _dbus_assert (id != NULL);
1184 address = dbus_server_get_address (server);
1185 _dbus_assert (address != NULL);
1187 if (strstr (address, id) == NULL)
1189 _dbus_warn ("server id '%s' is not in the server address '%s'\n",
1191 _dbus_assert_not_reached ("bad server id or address");
1195 dbus_free (address);
1197 dbus_server_disconnect (server);
1198 dbus_server_unref (server);
1204 #endif /* DBUS_BUILD_TESTS */