D-Bus 1.12.2
dbus-server.c
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-server.c DBusServer object
3 *
4 * Copyright (C) 2002, 2003, 2004, 2005 Red Hat Inc.
5 *
6 * Licensed under the Academic Free License version 2.1
7 *
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.
12 *
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.
17 *
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
21 *
22 */
23
24#include <config.h>
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"
31#endif
32#include "dbus-address.h"
33#include "dbus-protocol.h"
34
56#ifndef _dbus_server_trace_ref
57void
58_dbus_server_trace_ref (DBusServer *server,
59 int old_refcount,
60 int new_refcount,
61 const char *why)
62{
63 static int enabled = -1;
64
65 _dbus_trace_ref ("DBusServer", server, old_refcount, new_refcount, why,
66 "DBUS_SERVER_TRACE", &enabled);
67}
68#endif
69
70/* this is a little fragile since it assumes the address doesn't
71 * already have a guid, but it shouldn't
72 */
73static char*
74copy_address_with_guid_appended (const DBusString *address,
75 const DBusString *guid_hex)
76{
77 DBusString with_guid;
78 char *retval;
79
80 if (!_dbus_string_init (&with_guid))
81 return NULL;
82
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)))
88 {
89 _dbus_string_free (&with_guid);
90 return NULL;
91 }
92
93 retval = NULL;
94 _dbus_string_steal_data (&with_guid, &retval);
95
96 _dbus_string_free (&with_guid);
97
98 return retval; /* may be NULL if steal_data failed */
99}
100
113 const DBusServerVTable *vtable,
114 const DBusString *address,
115 DBusError *error)
116{
117 server->vtable = vtable;
118
119#ifdef DBUS_DISABLE_ASSERT
120 _dbus_atomic_inc (&server->refcount);
121#else
122 {
123 dbus_int32_t old_refcount = _dbus_atomic_inc (&server->refcount);
124
125 _dbus_assert (old_refcount == 0);
126 }
127#endif
128
129 server->address = NULL;
130 server->watches = NULL;
131 server->timeouts = NULL;
132 server->published_address = FALSE;
133
134 if (!_dbus_string_init (&server->guid_hex))
135 {
136 _DBUS_SET_OOM (error);
137 return FALSE;
138 }
139
140 if (!_dbus_generate_uuid (&server->guid, error))
141 goto failed;
142
143 if (!_dbus_uuid_encode (&server->guid, &server->guid_hex))
144 goto oom;
145
146 server->address = copy_address_with_guid_appended (address,
147 &server->guid_hex);
148 if (server->address == NULL)
149 goto oom;
150
152 if (server->mutex == NULL)
153 goto oom;
154
155 server->watches = _dbus_watch_list_new ();
156 if (server->watches == NULL)
157 goto oom;
158
159 server->timeouts = _dbus_timeout_list_new ();
160 if (server->timeouts == NULL)
161 goto oom;
162
164
165 _dbus_verbose ("Initialized server on address %s\n", server->address);
166
167 return TRUE;
168
169 oom:
170 _DBUS_SET_OOM (error);
171 failed:
173 server->mutex = NULL;
174 if (server->watches)
175 {
177 server->watches = NULL;
178 }
179 if (server->timeouts)
180 {
182 server->timeouts = NULL;
183 }
184 if (server->address)
185 {
186 dbus_free (server->address);
187 server->address = NULL;
188 }
189 _dbus_string_free (&server->guid_hex);
190
191 return FALSE;
192}
193
200void
202{
203 /* We don't have the lock, but nobody should be accessing
204 * concurrently since they don't have a ref
205 */
206#ifndef DBUS_DISABLE_CHECKS
208#endif
209 _dbus_assert (server->disconnected);
210
211 /* calls out to application code... */
213
215
218
220
221 dbus_free (server->address);
222
224
225 _dbus_string_free (&server->guid_hex);
226}
227
228
231 DBusWatch *watch);
234 DBusWatch *watch);
237 DBusWatch *watch,
238 dbus_bool_t enabled);
239
240static dbus_bool_t
241protected_change_watch (DBusServer *server,
242 DBusWatch *watch,
243 DBusWatchAddFunction add_function,
244 DBusWatchRemoveFunction remove_function,
245 DBusWatchToggleFunction toggle_function,
246 dbus_bool_t enabled)
247{
248 DBusWatchList *watches;
249 dbus_bool_t retval;
250
251 HAVE_LOCK_CHECK (server);
252
253 /* This isn't really safe or reasonable; a better pattern is the "do
254 * everything, then drop lock and call out" one; but it has to be
255 * propagated up through all callers
256 */
257
258 watches = server->watches;
259 if (watches)
260 {
261 server->watches = NULL;
263 SERVER_UNLOCK (server);
264
265 if (add_function)
266 retval = (* add_function) (watches, watch);
267 else if (remove_function)
268 {
269 retval = TRUE;
270 (* remove_function) (watches, watch);
271 }
272 else
273 {
274 retval = TRUE;
275 (* toggle_function) (watches, watch, enabled);
276 }
277
278 SERVER_LOCK (server);
279 server->watches = watches;
281
282 return retval;
283 }
284 else
285 return FALSE;
286}
287
297 DBusWatch *watch)
298{
299 HAVE_LOCK_CHECK (server);
300 return protected_change_watch (server, watch,
302 NULL, NULL, FALSE);
303}
304
311void
313 DBusWatch *watch)
314{
315 HAVE_LOCK_CHECK (server);
316 protected_change_watch (server, watch,
317 NULL,
319 NULL, FALSE);
320}
321
329void
335
338 DBusTimeout *timeout);
341 DBusTimeout *timeout);
344 DBusTimeout *timeout,
345 dbus_bool_t enabled);
346
347
348static dbus_bool_t
349protected_change_timeout (DBusServer *server,
350 DBusTimeout *timeout,
351 DBusTimeoutAddFunction add_function,
352 DBusTimeoutRemoveFunction remove_function,
353 DBusTimeoutToggleFunction toggle_function,
354 dbus_bool_t enabled)
355{
356 DBusTimeoutList *timeouts;
357 dbus_bool_t retval;
358
359 HAVE_LOCK_CHECK (server);
360
361 /* This isn't really safe or reasonable; a better pattern is the "do everything, then
362 * drop lock and call out" one; but it has to be propagated up through all callers
363 */
364
365 timeouts = server->timeouts;
366 if (timeouts)
367 {
368 server->timeouts = NULL;
370 SERVER_UNLOCK (server);
371
372 if (add_function)
373 retval = (* add_function) (timeouts, timeout);
374 else if (remove_function)
375 {
376 retval = TRUE;
377 (* remove_function) (timeouts, timeout);
378 }
379 else
380 {
381 retval = TRUE;
382 (* toggle_function) (timeouts, timeout, enabled);
383 }
384
385 SERVER_LOCK (server);
386 server->timeouts = timeouts;
388
389 return retval;
390 }
391 else
392 return FALSE;
393}
394
406 DBusTimeout *timeout)
407{
408 return protected_change_timeout (server, timeout,
410 NULL, NULL, FALSE);
411}
412
419void
421 DBusTimeout *timeout)
422{
423 protected_change_timeout (server, timeout,
424 NULL,
426 NULL, FALSE);
427}
428
438void
440 DBusTimeout *timeout,
441 dbus_bool_t enabled)
442{
443 protected_change_timeout (server, timeout,
444 NULL, NULL,
446 enabled);
447}
448
449
455void
457{
458 dbus_int32_t old_refcount;
459
460 _dbus_assert (server != NULL);
461 HAVE_LOCK_CHECK (server);
462
463 old_refcount = _dbus_atomic_inc (&server->refcount);
464 _dbus_assert (old_refcount > 0);
465 _dbus_server_trace_ref (server, old_refcount, old_refcount + 1,
466 "ref_unlocked");
467}
468
474void
476{
477 dbus_int32_t old_refcount;
478
479 /* Keep this in sync with dbus_server_unref */
480
481 _dbus_assert (server != NULL);
482
483 HAVE_LOCK_CHECK (server);
484
485 old_refcount = _dbus_atomic_dec (&server->refcount);
486 _dbus_assert (old_refcount > 0);
487
488 _dbus_server_trace_ref (server, old_refcount, old_refcount - 1,
489 "unref_unlocked");
490
491 if (old_refcount == 1)
492 {
493 _dbus_assert (server->disconnected);
494
495 SERVER_UNLOCK (server);
496
497 _dbus_assert (server->vtable->finalize != NULL);
498
499 (* server->vtable->finalize) (server);
500 }
501}
502
524static const struct {
525 DBusServerListenResult (* func) (DBusAddressEntry *entry,
526 DBusServer **server_p,
527 DBusError *error);
528} listen_funcs[] = {
531#ifdef DBUS_ENABLE_EMBEDDED_TESTS
532 , { _dbus_server_listen_debug_pipe }
533#endif
534};
535
557dbus_server_listen (const char *address,
558 DBusError *error)
559{
560 DBusServer *server;
561 DBusAddressEntry **entries;
562 int len, i;
563 DBusError first_connect_error = DBUS_ERROR_INIT;
564 dbus_bool_t handled_once;
565
566 _dbus_return_val_if_fail (address != NULL, NULL);
567 _dbus_return_val_if_error_is_set (error, NULL);
568
569 if (!dbus_parse_address (address, &entries, &len, error))
570 return NULL;
571
572 server = NULL;
573 handled_once = FALSE;
574
575 for (i = 0; i < len; i++)
576 {
577 int j;
578
579 for (j = 0; j < (int) _DBUS_N_ELEMENTS (listen_funcs); ++j)
580 {
581 DBusServerListenResult result;
582 DBusError tmp_error = DBUS_ERROR_INIT;
583
584 result = (* listen_funcs[j].func) (entries[i],
585 &server,
586 &tmp_error);
587
588 if (result == DBUS_SERVER_LISTEN_OK)
589 {
590 _dbus_assert (server != NULL);
591 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
592 handled_once = TRUE;
593 goto out;
594 }
595 else if (result == DBUS_SERVER_LISTEN_ADDRESS_ALREADY_USED)
596 {
597 _dbus_assert (server == NULL);
598 dbus_set_error (error,
600 "Address '%s' already used",
601 dbus_address_entry_get_method (entries[0]));
602 handled_once = TRUE;
603 goto out;
604 }
605 else if (result == DBUS_SERVER_LISTEN_BAD_ADDRESS)
606 {
607 _dbus_assert (server == NULL);
608 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
609 dbus_move_error (&tmp_error, error);
610 handled_once = TRUE;
611 goto out;
612 }
613 else if (result == DBUS_SERVER_LISTEN_NOT_HANDLED)
614 {
615 _dbus_assert (server == NULL);
616 _DBUS_ASSERT_ERROR_IS_CLEAR (&tmp_error);
617
618 /* keep trying addresses */
619 }
620 else if (result == DBUS_SERVER_LISTEN_DID_NOT_CONNECT)
621 {
622 _dbus_assert (server == NULL);
623 _DBUS_ASSERT_ERROR_IS_SET (&tmp_error);
624 if (!dbus_error_is_set (&first_connect_error))
625 dbus_move_error (&tmp_error, &first_connect_error);
626 else
627 dbus_error_free (&tmp_error);
628
629 handled_once = TRUE;
630
631 /* keep trying addresses */
632 }
633 }
634
635 _dbus_assert (server == NULL);
636 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
637 }
638
639 out:
640
641 if (!handled_once)
642 {
643 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
644 if (len > 0)
645 dbus_set_error (error,
647 "Unknown address type '%s'",
648 dbus_address_entry_get_method (entries[0]));
649 else
650 dbus_set_error (error,
652 "Empty address '%s'",
653 address);
654 }
655
657
658 if (server == NULL)
659 {
660 _dbus_assert (error == NULL || dbus_error_is_set (&first_connect_error) ||
661 dbus_error_is_set (error));
662
663 if (error && dbus_error_is_set (error))
664 {
665 /* already set the error */
666 }
667 else
668 {
669 /* didn't set the error but either error should be
670 * NULL or first_connect_error should be set.
671 */
672 _dbus_assert (error == NULL || dbus_error_is_set (&first_connect_error));
673 dbus_move_error (&first_connect_error, error);
674 }
675
676 _DBUS_ASSERT_ERROR_IS_CLEAR (&first_connect_error); /* be sure we freed it */
677 _DBUS_ASSERT_ERROR_IS_SET (error);
678
679 return NULL;
680 }
681 else
682 {
683 _DBUS_ASSERT_ERROR_IS_CLEAR (error);
684 return server;
685 }
686}
687
696{
697 dbus_int32_t old_refcount;
698
699 _dbus_return_val_if_fail (server != NULL, NULL);
700
701 old_refcount = _dbus_atomic_inc (&server->refcount);
702
703#ifndef DBUS_DISABLE_CHECKS
704 if (_DBUS_UNLIKELY (old_refcount <= 0))
705 {
706 _dbus_atomic_dec (&server->refcount);
707 _dbus_warn_return_if_fail (_DBUS_FUNCTION_NAME, "old_refcount > 0",
708 __FILE__, __LINE__);
709 return NULL;
710 }
711#endif
712
713 _dbus_server_trace_ref (server, old_refcount, old_refcount + 1, "ref");
714
715 return server;
716}
717
726void
728{
729 dbus_int32_t old_refcount;
730
731 /* keep this in sync with unref_unlocked */
732
733 _dbus_return_if_fail (server != NULL);
734
735 old_refcount = _dbus_atomic_dec (&server->refcount);
736
737#ifndef DBUS_DISABLE_CHECKS
738 if (_DBUS_UNLIKELY (old_refcount <= 0))
739 {
740 /* undo side-effect first
741 * please do not try to simplify the code here by using
742 * _dbus_atomic_get(), why we don't use it is
743 * because it issues another atomic operation even though
744 * DBUS_DISABLE_CHECKS defined.
745 * Bug: https://bugs.freedesktop.org/show_bug.cgi?id=68303
746 */
747 _dbus_atomic_inc (&server->refcount);
748 _dbus_warn_return_if_fail (_DBUS_FUNCTION_NAME, "old_refcount > 0",
749 __FILE__, __LINE__);
750 return;
751 }
752#endif
753
754 _dbus_server_trace_ref (server, old_refcount, old_refcount - 1, "unref");
755
756 if (old_refcount == 1)
757 {
758 /* lock not held! */
759 _dbus_assert (server->disconnected);
760
761 _dbus_assert (server->vtable->finalize != NULL);
762
763 (* server->vtable->finalize) (server);
764 }
765}
766
775void
777{
778 _dbus_return_if_fail (server != NULL);
779
780 dbus_server_ref (server);
781 SERVER_LOCK (server);
782
783 _dbus_assert (server->vtable->disconnect != NULL);
784
785 if (!server->disconnected)
786 {
787 /* this has to be first so recursive calls to disconnect don't happen */
788 server->disconnected = TRUE;
789
790 (* server->vtable->disconnect) (server);
791 }
792
793 SERVER_UNLOCK (server);
794 dbus_server_unref (server);
795}
796
804{
805 dbus_bool_t retval;
806
807 _dbus_return_val_if_fail (server != NULL, FALSE);
808
809 SERVER_LOCK (server);
810 retval = !server->disconnected;
811 SERVER_UNLOCK (server);
812
813 return retval;
814}
815
823char*
825{
826 char *retval;
827
828 _dbus_return_val_if_fail (server != NULL, NULL);
829
830 SERVER_LOCK (server);
831 retval = _dbus_strdup (server->address);
832 SERVER_UNLOCK (server);
833
834 return retval;
835}
836
859char*
861{
862 char *retval;
863
864 _dbus_return_val_if_fail (server != NULL, NULL);
865
866 SERVER_LOCK (server);
867 retval = NULL;
868 _dbus_string_copy_data (&server->guid_hex, &retval);
869 SERVER_UNLOCK (server);
870
871 return retval;
872}
873
894void
897 void *data,
898 DBusFreeFunction free_data_function)
899{
900 DBusFreeFunction old_free_function;
901 void *old_data;
902
903 _dbus_return_if_fail (server != NULL);
904
905 SERVER_LOCK (server);
906 old_free_function = server->new_connection_free_data_function;
907 old_data = server->new_connection_data;
908
909 server->new_connection_function = function;
910 server->new_connection_data = data;
911 server->new_connection_free_data_function = free_data_function;
912 SERVER_UNLOCK (server);
913
914 if (old_free_function != NULL)
915 (* old_free_function) (old_data);
916}
917
936 DBusAddWatchFunction add_function,
937 DBusRemoveWatchFunction remove_function,
938 DBusWatchToggledFunction toggled_function,
939 void *data,
940 DBusFreeFunction free_data_function)
941{
942 dbus_bool_t result;
943 DBusWatchList *watches;
944
945 _dbus_return_val_if_fail (server != NULL, FALSE);
946
947 SERVER_LOCK (server);
948 watches = server->watches;
949 server->watches = NULL;
950 if (watches)
951 {
952 SERVER_UNLOCK (server);
953 result = _dbus_watch_list_set_functions (watches,
954 add_function,
955 remove_function,
956 toggled_function,
957 data,
958 free_data_function);
959 SERVER_LOCK (server);
960 }
961 else
962 {
963 _dbus_warn_check_failed ("Re-entrant call to %s", _DBUS_FUNCTION_NAME);
964 result = FALSE;
965 }
966 server->watches = watches;
967 SERVER_UNLOCK (server);
968
969 return result;
970}
971
989 DBusAddTimeoutFunction add_function,
990 DBusRemoveTimeoutFunction remove_function,
991 DBusTimeoutToggledFunction toggled_function,
992 void *data,
993 DBusFreeFunction free_data_function)
994{
995 dbus_bool_t result;
996 DBusTimeoutList *timeouts;
997
998 _dbus_return_val_if_fail (server != NULL, FALSE);
999
1000 SERVER_LOCK (server);
1001 timeouts = server->timeouts;
1002 server->timeouts = NULL;
1003 if (timeouts)
1004 {
1005 SERVER_UNLOCK (server);
1006 result = _dbus_timeout_list_set_functions (timeouts,
1007 add_function,
1008 remove_function,
1009 toggled_function,
1010 data,
1011 free_data_function);
1012 SERVER_LOCK (server);
1013 }
1014 else
1015 {
1016 _dbus_warn_check_failed ("Re-entrant call to %s", _DBUS_FUNCTION_NAME);
1017 result = FALSE;
1018 }
1019 server->timeouts = timeouts;
1020 SERVER_UNLOCK (server);
1021
1022 return result;
1023}
1024
1040 const char **mechanisms)
1041{
1042 char **copy;
1043
1044 _dbus_return_val_if_fail (server != NULL, FALSE);
1045
1046 SERVER_LOCK (server);
1047
1048 if (mechanisms != NULL)
1049 {
1050 copy = _dbus_dup_string_array (mechanisms);
1051 if (copy == NULL)
1052 {
1053 SERVER_UNLOCK (server);
1054 return FALSE;
1055 }
1056 }
1057 else
1058 copy = NULL;
1059
1061 server->auth_mechanisms = copy;
1062
1063 SERVER_UNLOCK (server);
1064
1065 return TRUE;
1066}
1067
1068static DBusDataSlotAllocator slot_allocator =
1069 _DBUS_DATA_SLOT_ALLOCATOR_INIT (_DBUS_LOCK_NAME (server_slots));
1070
1087{
1088 return _dbus_data_slot_allocator_alloc (&slot_allocator,
1089 slot_p);
1090}
1091
1103void
1105{
1106 _dbus_return_if_fail (*slot_p >= 0);
1107
1108 _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
1109}
1110
1126 int slot,
1127 void *data,
1128 DBusFreeFunction free_data_func)
1129{
1130 DBusFreeFunction old_free_func;
1131 void *old_data;
1132 dbus_bool_t retval;
1133
1134 _dbus_return_val_if_fail (server != NULL, FALSE);
1135
1136 SERVER_LOCK (server);
1137
1138 retval = _dbus_data_slot_list_set (&slot_allocator,
1139 &server->slot_list,
1140 slot, data, free_data_func,
1141 &old_free_func, &old_data);
1142
1143
1144 SERVER_UNLOCK (server);
1145
1146 if (retval)
1147 {
1148 /* Do the actual free outside the server lock */
1149 if (old_free_func)
1150 (* old_free_func) (old_data);
1151 }
1152
1153 return retval;
1154}
1155
1164void*
1166 int slot)
1167{
1168 void *res;
1169
1170 _dbus_return_val_if_fail (server != NULL, NULL);
1171
1172 SERVER_LOCK (server);
1173
1174 res = _dbus_data_slot_list_get (&slot_allocator,
1175 &server->slot_list,
1176 slot);
1177
1178 SERVER_UNLOCK (server);
1179
1180 return res;
1181}
1182
1185#ifdef DBUS_ENABLE_EMBEDDED_TESTS
1186#include "dbus-test.h"
1187#include <string.h>
1188
1190_dbus_server_test (void)
1191{
1192 const char *valid_addresses[] = {
1193 "tcp:port=1234",
1194 "tcp:host=localhost,port=1234",
1195 "tcp:host=localhost,port=1234;tcp:port=5678",
1196#ifdef DBUS_UNIX
1197 "unix:path=./boogie",
1198 "tcp:port=1234;unix:path=./boogie",
1199#endif
1200 };
1201
1202 DBusServer *server;
1203 int i;
1204
1205 for (i = 0; i < _DBUS_N_ELEMENTS (valid_addresses); i++)
1206 {
1207 DBusError error = DBUS_ERROR_INIT;
1208 char *address;
1209 char *id;
1210
1211 server = dbus_server_listen (valid_addresses[i], &error);
1212 if (server == NULL)
1213 {
1214 _dbus_warn ("server listen error: %s: %s", error.name, error.message);
1215 dbus_error_free (&error);
1216 _dbus_assert_not_reached ("Failed to listen for valid address.");
1217 }
1218
1219 id = dbus_server_get_id (server);
1220 _dbus_assert (id != NULL);
1221 address = dbus_server_get_address (server);
1222 _dbus_assert (address != NULL);
1223
1224 if (strstr (address, id) == NULL)
1225 {
1226 _dbus_warn ("server id '%s' is not in the server address '%s'",
1227 id, address);
1228 _dbus_assert_not_reached ("bad server id or address");
1229 }
1230
1231 dbus_free (id);
1232 dbus_free (address);
1233
1234 dbus_server_disconnect (server);
1235 dbus_server_unref (server);
1236 }
1237
1238 return TRUE;
1239}
1240
1241#endif /* DBUS_ENABLE_EMBEDDED_TESTS */
void dbus_address_entries_free(DBusAddressEntry **entries)
Frees a NULL-terminated array of address entries.
dbus_bool_t dbus_parse_address(const char *address, DBusAddressEntry ***entry_result, int *array_len, DBusError *error)
Parses an address string of the form:
const char * dbus_address_entry_get_method(DBusAddressEntry *entry)
Returns the method string of an address entry.
void(* DBusWatchToggledFunction)(DBusWatch *watch, void *data)
Called when dbus_watch_get_enabled() may return a different value than it did before.
dbus_bool_t(* DBusAddWatchFunction)(DBusWatch *watch, void *data)
Called when libdbus needs a new watch to be monitored by the main loop.
void(* DBusTimeoutToggledFunction)(DBusTimeout *timeout, void *data)
Called when dbus_timeout_get_enabled() may return a different value than it did before.
dbus_bool_t(* DBusAddTimeoutFunction)(DBusTimeout *timeout, void *data)
Called when libdbus needs a new timeout to be monitored by the main loop.
void(* DBusRemoveWatchFunction)(DBusWatch *watch, void *data)
Called when libdbus no longer needs a watch to be monitored by the main loop.
void(* DBusRemoveTimeoutFunction)(DBusTimeout *timeout, void *data)
Called when libdbus no longer needs a timeout to be monitored by the main loop.
void _dbus_data_slot_allocator_free(DBusDataSlotAllocator *allocator, dbus_int32_t *slot_id_p)
Deallocates an ID previously allocated with _dbus_data_slot_allocator_alloc().
void _dbus_data_slot_list_init(DBusDataSlotList *list)
Initializes a slot list.
void _dbus_data_slot_list_free(DBusDataSlotList *list)
Frees the data slot list and all data slots contained in it, calling application-provided free functi...
void * _dbus_data_slot_list_get(DBusDataSlotAllocator *allocator, DBusDataSlotList *list, int slot)
Retrieves data previously set with _dbus_data_slot_list_set_data().
dbus_bool_t _dbus_data_slot_list_set(DBusDataSlotAllocator *allocator, DBusDataSlotList *list, int slot, void *data, DBusFreeFunction free_data_func, DBusFreeFunction *old_free_func, void **old_data)
Stores a pointer in the data slot list, along with an optional function to be used for freeing the da...
dbus_bool_t _dbus_data_slot_allocator_alloc(DBusDataSlotAllocator *allocator, dbus_int32_t *slot_id_p)
Allocates an integer ID to be used for storing data in a DBusDataSlotList.
#define DBUS_ERROR_INIT
Expands to a suitable initializer for a DBusError on the stack.
Definition dbus-errors.h:62
void dbus_move_error(DBusError *src, DBusError *dest)
Moves an error src into dest, freeing src and overwriting dest.
void dbus_set_error(DBusError *error, const char *name, const char *format,...)
Assigns an error name and message to a DBusError.
void dbus_error_free(DBusError *error)
Frees an error that's been set (or just initialized), then reinitializes the error as in dbus_error_i...
dbus_bool_t dbus_error_is_set(const DBusError *error)
Checks whether an error occurred (the error is set).
#define _dbus_assert_not_reached(explanation)
Aborts with an error message if called.
#define _dbus_assert(condition)
Aborts with an error message if the condition is false.
dbus_bool_t _dbus_generate_uuid(DBusGUID *uuid, DBusError *error)
Generates a new UUID.
void _dbus_warn_check_failed(const char *format,...)
Prints a "critical" warning to stderr when an assertion fails; differs from _dbus_warn primarily in t...
char * _dbus_strdup(const char *str)
Duplicates a string.
void _dbus_warn(const char *format,...)
Prints a warning message to stderr.
#define _DBUS_N_ELEMENTS(array)
Computes the number of elements in a fixed-size array using sizeof().
#define _DBUS_LOCK_NAME(name)
Expands to name of a global lock variable.
dbus_bool_t _dbus_uuid_encode(const DBusGUID *uuid, DBusString *encoded)
Hex-encode a UUID.
char ** _dbus_dup_string_array(const char **array)
Duplicates a string array.
#define NULL
A null pointer, defined appropriately for C or C++.
Definition dbus-macros.h:49
#define TRUE
Expands to "1".
Definition dbus-macros.h:39
#define FALSE
Expands to "0".
Definition dbus-macros.h:42
void dbus_free(void *memory)
Frees a block of memory previously allocated by dbus_malloc() or dbus_malloc0().
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition dbus-memory.h:64
void dbus_free_string_array(char **str_array)
Frees a NULL-terminated array of strings.
#define DBUS_ERROR_ADDRESS_IN_USE
Can't bind a socket since its address is in use (i.e.
#define DBUS_ERROR_BAD_ADDRESS
A D-Bus bus address was malformed.
dbus_bool_t _dbus_server_add_watch(DBusServer *server, DBusWatch *watch)
Adds a watch for this server, chaining out to application-provided watch handlers.
void(* DBusWatchRemoveFunction)(DBusWatchList *list, DBusWatch *watch)
Function to be called in protected_change_watch() with refcount held.
void _dbus_server_remove_watch(DBusServer *server, DBusWatch *watch)
Removes a watch previously added with _dbus_server_remove_watch().
void _dbus_server_remove_timeout(DBusServer *server, DBusTimeout *timeout)
Removes a timeout previously added with _dbus_server_add_timeout().
void _dbus_server_unref_unlocked(DBusServer *server)
Like dbus_server_unref() but does not acquire the lock (must already be held)
void _dbus_server_toggle_timeout(DBusServer *server, DBusTimeout *timeout, dbus_bool_t enabled)
Toggles a timeout and notifies app via server's DBusTimeoutToggledFunction if available.
void(* DBusTimeoutToggleFunction)(DBusTimeoutList *list, DBusTimeout *timeout, dbus_bool_t enabled)
Function to be called in protected_change_timeout() with refcount held.
void(* DBusTimeoutRemoveFunction)(DBusTimeoutList *list, DBusTimeout *timeout)
Function to be called in protected_change_timeout() with refcount held.
dbus_bool_t _dbus_server_add_timeout(DBusServer *server, DBusTimeout *timeout)
Adds a timeout for this server, chaining out to application-provided timeout handlers.
dbus_bool_t _dbus_server_init_base(DBusServer *server, const DBusServerVTable *vtable, const DBusString *address, DBusError *error)
Initializes the members of the DBusServer base class.
void _dbus_server_finalize_base(DBusServer *server)
Finalizes the members of the DBusServer base class.
void _dbus_server_ref_unlocked(DBusServer *server)
Like dbus_server_ref() but does not acquire the lock (must already be held)
dbus_bool_t(* DBusTimeoutAddFunction)(DBusTimeoutList *list, DBusTimeout *timeout)
Function to be called in protected_change_timeout() with refcount held.
void(* DBusWatchToggleFunction)(DBusWatchList *list, DBusWatch *watch, dbus_bool_t enabled)
Function to be called in protected_change_watch() with refcount held.
void _dbus_server_toggle_all_watches(DBusServer *server, dbus_bool_t enabled)
Toggles all watch and notifies app via server's DBusWatchToggledFunction if available.
dbus_bool_t(* DBusWatchAddFunction)(DBusWatchList *list, DBusWatch *watch)
Function to be called in protected_change_watch() with refcount held.
DBusServerListenResult _dbus_server_listen_socket(DBusAddressEntry *entry, DBusServer **server_p, DBusError *error)
Tries to interpret the address entry for various socket-related addresses (well, currently only tcp a...
DBusServerListenResult _dbus_server_listen_platform_specific(DBusAddressEntry *entry, DBusServer **server_p, DBusError *error)
Tries to interpret the address entry in a platform-specific way, creating a platform-specific server ...
dbus_bool_t dbus_server_allocate_data_slot(dbus_int32_t *slot_p)
Allocates an integer ID to be used for storing application-specific data on any DBusServer.
void dbus_server_disconnect(DBusServer *server)
Releases the server's address and stops listening for new clients.
dbus_bool_t dbus_server_set_auth_mechanisms(DBusServer *server, const char **mechanisms)
Sets the authentication mechanisms that this server offers to clients, as a NULL-terminated array of ...
char * dbus_server_get_id(DBusServer *server)
Returns the unique ID of the server, as a newly-allocated string which must be freed by the caller.
DBusServer * dbus_server_listen(const char *address, DBusError *error)
Listens for new connections on the given address.
char * dbus_server_get_address(DBusServer *server)
Returns the address of the server, as a newly-allocated string which must be freed by the caller.
dbus_bool_t dbus_server_get_is_connected(DBusServer *server)
Returns TRUE if the server is still listening for new connections.
void dbus_server_unref(DBusServer *server)
Decrements the reference count of a DBusServer.
void dbus_server_set_new_connection_function(DBusServer *server, DBusNewConnectionFunction function, void *data, DBusFreeFunction free_data_function)
Sets a function to be used for handling new connections.
dbus_bool_t dbus_server_set_watch_functions(DBusServer *server, DBusAddWatchFunction add_function, DBusRemoveWatchFunction remove_function, DBusWatchToggledFunction toggled_function, void *data, DBusFreeFunction free_data_function)
Sets the watch functions for the server.
dbus_bool_t dbus_server_set_data(DBusServer *server, int slot, void *data, DBusFreeFunction free_data_func)
Stores a pointer on a DBusServer, along with an optional function to be used for freeing the data whe...
DBusServer * dbus_server_ref(DBusServer *server)
Increments the reference count of a DBusServer.
void * dbus_server_get_data(DBusServer *server, int slot)
Retrieves data previously set with dbus_server_set_data().
void dbus_server_free_data_slot(dbus_int32_t *slot_p)
Deallocates a global ID for server data slots.
dbus_bool_t dbus_server_set_timeout_functions(DBusServer *server, DBusAddTimeoutFunction add_function, DBusRemoveTimeoutFunction remove_function, DBusTimeoutToggledFunction toggled_function, void *data, DBusFreeFunction free_data_function)
Sets the timeout functions for the server.
void(* DBusNewConnectionFunction)(DBusServer *server, DBusConnection *new_connection, void *data)
Called when a new connection to the server is available.
Definition dbus-server.h:48
dbus_bool_t _dbus_string_append(DBusString *str, const char *buffer)
Appends a nul-terminated C-style string to a DBusString.
dbus_bool_t _dbus_string_init(DBusString *str)
Initializes a string.
dbus_bool_t _dbus_string_copy(const DBusString *source, int start, DBusString *dest, int insert_at)
Like _dbus_string_move(), but does not delete the section of the source string that's copied to the d...
dbus_bool_t _dbus_string_steal_data(DBusString *str, char **data_return)
Like _dbus_string_get_data(), but removes the gotten data from the original string.
void _dbus_string_free(DBusString *str)
Frees a string created by _dbus_string_init().
dbus_bool_t _dbus_string_copy_data(const DBusString *str, char **data_return)
Copies the data from the string into a char*.
dbus_int32_t _dbus_atomic_dec(DBusAtomic *atomic)
Atomically decrement an integer.
dbus_int32_t _dbus_atomic_inc(DBusAtomic *atomic)
Atomically increments an integer.
void _dbus_rmutex_new_at_location(DBusRMutex **location_p)
Creates a new mutex or creates a no-op mutex if threads are not initialized.
void _dbus_rmutex_free_at_location(DBusRMutex **location_p)
Frees a DBusRMutex; does nothing if passed a NULL pointer.
dbus_bool_t _dbus_timeout_list_add_timeout(DBusTimeoutList *timeout_list, DBusTimeout *timeout)
Adds a new timeout to the timeout list, invoking the application DBusAddTimeoutFunction if appropriat...
void _dbus_timeout_list_free(DBusTimeoutList *timeout_list)
Frees a DBusTimeoutList.
void _dbus_timeout_list_toggle_timeout(DBusTimeoutList *timeout_list, DBusTimeout *timeout, dbus_bool_t enabled)
Sets a timeout to the given enabled state, invoking the application's DBusTimeoutToggledFunction if a...
DBusTimeoutList * _dbus_timeout_list_new(void)
Creates a new timeout list.
dbus_bool_t _dbus_timeout_list_set_functions(DBusTimeoutList *timeout_list, DBusAddTimeoutFunction add_function, DBusRemoveTimeoutFunction remove_function, DBusTimeoutToggledFunction toggled_function, void *data, DBusFreeFunction free_data_function)
Sets the timeout functions.
void _dbus_timeout_list_remove_timeout(DBusTimeoutList *timeout_list, DBusTimeout *timeout)
Removes a timeout from the timeout list, invoking the application's DBusRemoveTimeoutFunction if appr...
int dbus_int32_t
A 32-bit signed integer on all platforms.
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition dbus-types.h:35
dbus_bool_t _dbus_watch_list_add_watch(DBusWatchList *watch_list, DBusWatch *watch)
Adds a new watch to the watch list, invoking the application DBusAddWatchFunction if appropriate.
Definition dbus-watch.c:382
DBusWatchList * _dbus_watch_list_new(void)
Creates a new watch list.
Definition dbus-watch.c:232
void _dbus_watch_list_free(DBusWatchList *watch_list)
Frees a DBusWatchList.
Definition dbus-watch.c:249
dbus_bool_t _dbus_watch_list_set_functions(DBusWatchList *watch_list, DBusAddWatchFunction add_function, DBusRemoveWatchFunction remove_function, DBusWatchToggledFunction toggled_function, void *data, DBusFreeFunction free_data_function)
Sets the watch functions.
Definition dbus-watch.c:296
void _dbus_watch_list_toggle_all_watches(DBusWatchList *watch_list, dbus_bool_t enabled)
Sets all watches to the given enabled state, invoking the application's DBusWatchToggledFunction if a...
Definition dbus-watch.c:473
void _dbus_watch_list_remove_watch(DBusWatchList *watch_list, DBusWatch *watch)
Removes a watch from the watch list, invoking the application's DBusRemoveWatchFunction if appropriat...
Definition dbus-watch.c:415
Internals of DBusAddressEntry.
An allocator that tracks a set of slot IDs.
Object representing an exception.
Definition dbus-errors.h:49
const char * name
public error name field
Definition dbus-errors.h:50
const char * message
public error message field
Definition dbus-errors.h:51
Virtual table to be implemented by all server "subclasses".
void(* disconnect)(DBusServer *server)
Disconnect this server.
void(* finalize)(DBusServer *server)
The finalize method must free the server.
Internals of DBusServer object.
dbus_bool_t published_address
flag which indicates that server has published its bus address.
DBusDataSlotList slot_list
Data stored by allocated integer ID.
char * address
Address this server is listening on.
DBusFreeFunction new_connection_free_data_function
Callback to invoke to free new_connection_data when server is finalized or data is replaced.
DBusAtomic refcount
Reference count.
DBusWatchList * watches
Our watches.
DBusGUID guid
Globally unique ID of server.
DBusString guid_hex
Hex-encoded version of GUID.
unsigned int disconnected
TRUE if we are disconnected.
DBusRMutex * mutex
Lock on the server object.
DBusNewConnectionFunction new_connection_function
Callback to invoke when a new connection is created.
const DBusServerVTable * vtable
Virtual methods for this instance.
void * new_connection_data
Data for new connection callback.
unsigned int have_server_lock
Does someone have the server mutex locked.
char ** auth_mechanisms
Array of allowed authentication mechanisms.
DBusTimeoutList * timeouts
Our timeouts.
DBusTimeoutList implementation details.
Internals of DBusTimeout.
DBusWatchList implementation details.
Definition dbus-watch.c:215
Implementation of DBusWatch.
Definition dbus-watch.c:41