From d3204dc446d96876baab9859de132a5a4da675d4 Mon Sep 17 00:00:00 2001 From: Havoc Pennington Date: Wed, 15 Nov 2006 03:07:59 +0000 Subject: 2006-11-14 Havoc Pennington * dbus/dbus-misc.c, dbus/dbus-misc.h: Move dbus_get_local_machine_id() to its own file, no substantive changes. There are a couple other things we might want to add that are "misc" so moving out of dbus-connection.[hc] which is big enough already. --- ChangeLog | 8 ++++ dbus/Makefile.am | 2 + dbus/dbus-connection.c | 57 ------------------------- dbus/dbus-connection.h | 2 - dbus/dbus-misc.c | 113 +++++++++++++++++++++++++++++++++++++++++++++++++ dbus/dbus-misc.h | 47 ++++++++++++++++++++ dbus/dbus-test.c | 2 + dbus/dbus-test.h | 1 + dbus/dbus.h | 1 + 9 files changed, 174 insertions(+), 59 deletions(-) create mode 100644 dbus/dbus-misc.c create mode 100644 dbus/dbus-misc.h diff --git a/ChangeLog b/ChangeLog index c189e7ae..9f4d60f4 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2006-11-14 Havoc Pennington + + * dbus/dbus-misc.c, dbus/dbus-misc.h: Move + dbus_get_local_machine_id() to its own file, no substantive + changes. There are a couple other things we might want to add that + are "misc" so moving out of dbus-connection.[hc] which is big + enough already. + 2006-11-14 Havoc Pennington * dbus/dbus-internals.c (_dbus_generate_uuid): The spec said the diff --git a/dbus/Makefile.am b/dbus/Makefile.am index c6fb4755..70d5b371 100644 --- a/dbus/Makefile.am +++ b/dbus/Makefile.am @@ -17,6 +17,7 @@ dbusinclude_HEADERS= \ dbus-macros.h \ dbus-memory.h \ dbus-message.h \ + dbus-misc.h \ dbus-pending-call.h \ dbus-protocol.h \ dbus-server.h \ @@ -54,6 +55,7 @@ DBUS_LIB_SOURCES= \ dbus-message.c \ dbus-message-internal.h \ dbus-message-private.h \ + dbus-misc.c \ dbus-object-tree.c \ dbus-object-tree.h \ dbus-pending-call.c \ diff --git a/dbus/dbus-connection.c b/dbus/dbus-connection.c index 268a97d6..5dc463a4 100644 --- a/dbus/dbus-connection.c +++ b/dbus/dbus-connection.c @@ -5482,61 +5482,4 @@ dbus_connection_get_outgoing_size (DBusConnection *connection) return res; } -/** - * Obtains the machine UUID of the machine this process is running on. - * - * The returned string must be freed with dbus_free(). - * - * This UUID is guaranteed to remain the same until the next reboot - * (unless the sysadmin foolishly changes it and screws themselves). - * It will usually remain the same across reboots also, but hardware - * configuration changes or rebuilding the machine could break that. - * - * The idea is that two processes with the same machine ID should be - * able to use shared memory, UNIX domain sockets, process IDs, and other - * features of the OS that require both processes to be running - * on the same OS kernel instance. - * - * The machine ID can also be used to create unique per-machine - * instances. For example, you could use it in bus names or - * X selection names. - * - * The machine ID is preferred over the machine hostname, because - * the hostname is frequently set to "localhost.localdomain" and - * may also change at runtime. - * - * You can get the machine ID of a remote application by invoking the - * method GetMachineId from interface org.freedesktop.DBus.Peer. - * - * If the remote application has the same machine ID as the one - * returned by this function, then the remote application is on the - * same machine as your application. - * - * The UUID is not a UUID in the sense of RFC4122; the details - * are explained in the D-Bus specification. - * - * @returns a 32-byte-long hex-encoded UUID string, or #NULL if insufficient memory - */ -char* -dbus_get_local_machine_id (void) -{ - DBusString uuid; - char *s; - - s = NULL; - _dbus_string_init (&uuid); - if (!_dbus_get_local_machine_uuid_encoded (&uuid) || - !_dbus_string_steal_data (&uuid, &s)) - { - _dbus_string_free (&uuid); - return FALSE; - } - else - { - _dbus_string_free (&uuid); - return s; - } - -} - /** @} */ diff --git a/dbus/dbus-connection.h b/dbus/dbus-connection.h index 02d433d2..819e96c8 100644 --- a/dbus/dbus-connection.h +++ b/dbus/dbus-connection.h @@ -321,8 +321,6 @@ dbus_bool_t dbus_connection_get_unix_fd (DBusConnection dbus_bool_t dbus_connection_get_socket (DBusConnection *connection, int *fd); -char* dbus_get_local_machine_id (void); - /** @} */ diff --git a/dbus/dbus-misc.c b/dbus/dbus-misc.c new file mode 100644 index 00000000..fbefe9ba --- /dev/null +++ b/dbus/dbus-misc.c @@ -0,0 +1,113 @@ +/* -*- mode: C; c-file-style: "gnu" -*- */ +/* dbus-misc.c A few assorted public functions that don't fit elsewhere + * + * Copyright (C) 2006 Red Hat, Inc. + * + * Licensed under the Academic Free License version 2.1 + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + */ + +#include +#include "dbus-misc.h" +#include "dbus-internals.h" +#include "dbus-string.h" + +/** + * @defgroup DBusMisc Miscellaneous + * @ingroup DBus + * @brief Miscellaneous API that doesn't cleanly fit anywhere else + * + * @{ + */ + +/** + * Obtains the machine UUID of the machine this process is running on. + * + * The returned string must be freed with dbus_free(). + * + * This UUID is guaranteed to remain the same until the next reboot + * (unless the sysadmin foolishly changes it and screws themselves). + * It will usually remain the same across reboots also, but hardware + * configuration changes or rebuilding the machine could break that. + * + * The idea is that two processes with the same machine ID should be + * able to use shared memory, UNIX domain sockets, process IDs, and other + * features of the OS that require both processes to be running + * on the same OS kernel instance. + * + * The machine ID can also be used to create unique per-machine + * instances. For example, you could use it in bus names or + * X selection names. + * + * The machine ID is preferred over the machine hostname, because + * the hostname is frequently set to "localhost.localdomain" and + * may also change at runtime. + * + * You can get the machine ID of a remote application by invoking the + * method GetMachineId from interface org.freedesktop.DBus.Peer. + * + * If the remote application has the same machine ID as the one + * returned by this function, then the remote application is on the + * same machine as your application. + * + * The UUID is not a UUID in the sense of RFC4122; the details + * are explained in the D-Bus specification. + * + * @returns a 32-byte-long hex-encoded UUID string, or #NULL if insufficient memory + */ +char* +dbus_get_local_machine_id (void) +{ + DBusString uuid; + char *s; + + s = NULL; + _dbus_string_init (&uuid); + if (!_dbus_get_local_machine_uuid_encoded (&uuid) || + !_dbus_string_steal_data (&uuid, &s)) + { + _dbus_string_free (&uuid); + return FALSE; + } + else + { + _dbus_string_free (&uuid); + return s; + } + +} + +/** @} */ /* End of public API */ + +#ifdef DBUS_BUILD_TESTS + +#ifndef DOXYGEN_SHOULD_SKIP_THIS + +#include "dbus-test.h" +#include + + +dbus_bool_t +_dbus_misc_test (void) +{ + + return TRUE; +} + +#endif /* !DOXYGEN_SHOULD_SKIP_THIS */ + +#endif diff --git a/dbus/dbus-misc.h b/dbus/dbus-misc.h new file mode 100644 index 00000000..590ee870 --- /dev/null +++ b/dbus/dbus-misc.h @@ -0,0 +1,47 @@ +/* -*- mode: C; c-file-style: "gnu" -*- */ +/* dbus-misc.h A few assorted public functions that don't fit elsewhere + * + * Copyright (C) 2006 Red Hat, Inc. + * + * Licensed under the Academic Free License version 2.1 + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + */ +#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION) +#error "Only can be included directly, this file may disappear or change contents." +#endif + +#ifndef DBUS_MISC_H +#define DBUS_MISC_H + +#include +#include + +DBUS_BEGIN_DECLS + +/** + * @addtogroup DBusMisc + * @{ + */ + +char* dbus_get_local_machine_id (void); + +/** @} */ + +DBUS_END_DECLS + +#endif /* DBUS_MISC_H */ + diff --git a/dbus/dbus-test.c b/dbus/dbus-test.c index 603a5092..9f931783 100644 --- a/dbus/dbus-test.c +++ b/dbus/dbus-test.c @@ -115,6 +115,8 @@ dbus_internal_do_not_use_run_tests (const char *test_data_dir, const char *speci run_test ("sysdeps", specific_test, _dbus_sysdeps_test); run_test ("data-slot", specific_test, _dbus_data_slot_test); + + run_test ("misc", specific_test, _dbus_misc_test); run_test ("address", specific_test, _dbus_address_test); diff --git a/dbus/dbus-test.h b/dbus/dbus-test.h index 9e37fe74..e7c55d92 100644 --- a/dbus/dbus-test.h +++ b/dbus/dbus-test.h @@ -36,6 +36,7 @@ dbus_bool_t _dbus_marshal_recursive_test (void); dbus_bool_t _dbus_marshal_byteswap_test (void); dbus_bool_t _dbus_marshal_header_test (void); dbus_bool_t _dbus_marshal_validate_test (void); +dbus_bool_t _dbus_misc_test (void); dbus_bool_t _dbus_signature_test (void); dbus_bool_t _dbus_mem_pool_test (void); dbus_bool_t _dbus_string_test (void); diff --git a/dbus/dbus.h b/dbus/dbus.h index c15ebac6..b30b9359 100644 --- a/dbus/dbus.h +++ b/dbus/dbus.h @@ -33,6 +33,7 @@ #include #include #include +#include #include #include #include -- cgit