VirtualBox

source: vbox/trunk/src/VBox/Main/include/vbox-dbus.h@ 15834

Last change on this file since 15834 was 15468, checked in by vboxsync, 16 years ago

Main/USB: code documentation

  • Property svn:eol-style set to native
File size: 5.7 KB
Line 
1/** @file
2 *
3 * Module to dynamically load libdbus and load all symbols
4 * which are needed by VirtualBox.
5 */
6
7/*
8 * Copyright (C) 2008 Sun Microsystems, Inc.
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License (GPL) as published by the Free Software
14 * Foundation, in version 2 as it comes in the "COPYING" file of the
15 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17 *
18 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
19 * Clara, CA 95054 USA or visit http://www.sun.com if you need
20 * additional information or have any questions.
21 */
22
23#ifndef ____H_VBOX_DBUS
24#define ____H_VBOX_DBUS
25
26#include <stdint.h>
27
28#define LIB_DBUS_1_2 "libdbus-1.so.2" /* This should be compatible */
29#define LIB_DBUS_1_3 "libdbus-1.so.3"
30
31/** Types and defines from the dbus header files which we need. These are
32 * taken more or less verbatim from the DBus public interface header files. */
33struct DBusError
34{
35 const char *name;
36 const char *message;
37 unsigned int dummy1 : 1;
38 unsigned int dummy2 : 1;
39 unsigned int dummy3 : 1;
40 unsigned int dummy4 : 1;
41 unsigned int dummy5 : 1;
42 void *padding1;
43};
44struct DBusConnection;
45typedef struct DBusConnection DBusConnection;
46typedef uint32_t dbus_bool_t;
47typedef uint32_t dbus_uint32_t;
48typedef enum { DBUS_BUS_SESSON, DBUS_BUS_SYSTEM, DBUS_BUS_STARTER } DBusBusType;
49struct DBusMessage;
50typedef struct DBusMessage DBusMessage;
51struct DBusMessageIter
52{
53 void *dummy1;
54 void *dummy2;
55 dbus_uint32_t dummy3;
56 int dummy4;
57 int dummy5;
58 int dummy6;
59 int dummy7;
60 int dummy8;
61 int dummy9;
62 int dummy10;
63 int dummy11;
64 int pad1;
65 int pad2;
66 void *pad3;
67};
68typedef struct DBusMessageIter DBusMessageIter;
69
70#define DBUS_ERROR_NO_MEMORY "org.freedesktop.DBus.Error.NoMemory"
71#define DBUS_TYPE_STRING ((int) 's')
72#define DBUS_TYPE_ARRAY ((int) 'a')
73#define DBUS_TYPE_DICT_ENTRY ((int) 'e')
74
75typedef enum
76{
77 DBUS_HANDLER_RESULT_HANDLED,
78 DBUS_HANDLER_RESULT_NOT_YET_HANDLED,
79 DBUS_HANDLER_RESULT_NEED_MEMORY
80} DBusHandlerResult;
81
82typedef DBusHandlerResult (*DBusHandleMessageFunction) (DBusConnection *,
83 DBusMessage *, void *);
84typedef void (*DBusFreeFunction) (void *);
85
86/** The following are the symbols which we need from libdbus-1. */
87extern void (*dbus_error_init)(DBusError *);
88extern DBusConnection *(*dbus_bus_get)(DBusBusType, DBusError *);
89extern DBusConnection *(*dbus_bus_get_private)(DBusBusType, DBusError *);
90extern void (*dbus_error_free)(DBusError *);
91extern void (*dbus_connection_unref)(DBusConnection *);
92extern void (*dbus_connection_close)(DBusConnection *);
93extern void (*dbus_connection_set_exit_on_disconnect)(DBusConnection *, dbus_bool_t);
94extern dbus_bool_t (*dbus_bus_name_has_owner)(DBusConnection *, const char *,
95 DBusError *);
96extern void (*dbus_bus_add_match)(DBusConnection *, const char *, DBusError *);
97extern void (*dbus_bus_remove_match)(DBusConnection *, const char *, DBusError *);
98extern void (*dbus_message_unref)(DBusMessage *);
99extern DBusMessage* (*dbus_message_new_method_call)(const char *, const char *,
100 const char *, const char *);
101extern void (*dbus_message_iter_init_append)(DBusMessage *, DBusMessageIter *);
102extern dbus_bool_t (*dbus_message_iter_append_basic)(DBusMessageIter *, int,
103 const void *);
104extern DBusMessage * (*dbus_connection_send_with_reply_and_block)(DBusConnection *,
105 DBusMessage *, int,
106 DBusError *error);
107extern dbus_bool_t (*dbus_message_iter_init) (DBusMessage *, DBusMessageIter *);
108extern int (*dbus_message_iter_get_arg_type) (DBusMessageIter *);
109extern int (*dbus_message_iter_get_element_type) (DBusMessageIter *);
110extern void (*dbus_message_iter_recurse) (DBusMessageIter *, DBusMessageIter *);
111extern void (*dbus_message_iter_get_basic) (DBusMessageIter *, void *);
112extern dbus_bool_t (*dbus_message_iter_next) (DBusMessageIter *);
113extern dbus_bool_t (*dbus_connection_add_filter) (DBusConnection *, DBusHandleMessageFunction,
114 void *, DBusFreeFunction);
115extern void (*dbus_connection_remove_filter) (DBusConnection *, DBusHandleMessageFunction,
116 void *);
117extern dbus_bool_t (*dbus_connection_read_write_dispatch) (DBusConnection *, int);
118extern dbus_bool_t (*dbus_message_is_signal) (DBusMessage *, const char *, const char *);
119extern DBusMessage *(*dbus_connection_pop_message)(DBusConnection *);
120
121/**
122 * Checks whether libdbus is present and if so loads all symbols we need. This
123 * should be called before making any calls to libdbus if that library is being
124 * loaded at runtime.
125 * @returns true if libdbus was found, false otherwise.
126 */
127extern bool VBoxDBusCheckPresence(void);
128/** Wrapper around dbus_connection_unref. We need this to use it as a free
129 * function in auto pointers, as a function pointer won't wash here. */
130extern void VBoxDBusConnectionUnref(DBusConnection *pConnection);
131/** Wrapper around dbus_message_unref. We need this to use it as a free
132 * function in auto pointers, as a function pointer won't wash here. */
133extern void VBoxDBusMessageUnref(DBusMessage *pMessage);
134
135#endif /* ____H_VBOX_DBUS not defined */
136/* vi: set tabstop=4 shiftwidth=4 expandtab: */
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette