D-Bus  1.13.7
dbus-object-tree.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-object-tree.h DBusObjectTree (internals of DBusConnection)
3  *
4  * Copyright (C) 2003 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 #ifndef DBUS_OBJECT_TREE_H
24 #define DBUS_OBJECT_TREE_H
25 
26 #include <dbus/dbus-connection.h>
27 
29 
30 typedef struct DBusObjectTree DBusObjectTree;
31 
35 
37  dbus_bool_t fallback,
38  const char **path,
39  const DBusObjectPathVTable *vtable,
40  void *user_data,
41  DBusError *error);
43  const char **path);
45  DBusMessage *message,
46  dbus_bool_t *found_object);
48  const char **path);
50 
51 
53  const char **parent_path,
54  char ***child_entries);
55 
56 dbus_bool_t _dbus_decompose_path (const char *data,
57  int len,
58  char ***path,
59  int *path_len);
60 
62 
63 #endif /* DBUS_OBJECT_TREE_H */
DBusHandlerResult _dbus_object_tree_dispatch_and_unlock(DBusObjectTree *tree, DBusMessage *message, dbus_bool_t *found_object)
Tries to dispatch a message by directing it to handler for the object path listed in the message head...
void _dbus_object_tree_free_all_unlocked(DBusObjectTree *tree)
Free all the handlers in the tree.
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBusConnection * connection
Connection this tree belongs to.
void _dbus_object_tree_unregister_and_unlock(DBusObjectTree *tree, const char **path)
Unregisters an object subtree that was registered with the same path.
Implementation details of DBusConnection.
DBusHandlerResult
Results that a message handler can return.
Definition: dbus-shared.h:66
Virtual table that must be implemented to handle a portion of the object path hierarchy.
Internals of DBusMessage.
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
dbus_bool_t _dbus_object_tree_list_registered_and_unlock(DBusObjectTree *tree, const char **parent_path, char ***child_entries)
Lists the registered fallback handlers and object path handlers at the given parent_path.
Internals of DBusObjectTree.
DBusObjectTree * _dbus_object_tree_ref(DBusObjectTree *tree)
Increment the reference count.
dbus_bool_t _dbus_decompose_path(const char *data, int len, char ***path, int *path_len)
Decompose an object path.
Object representing an exception.
Definition: dbus-errors.h:48
void * _dbus_object_tree_get_user_data_unlocked(DBusObjectTree *tree, const char **path)
Looks up the data passed to _dbus_object_tree_register() for a handler at the given path...
dbus_bool_t _dbus_object_tree_register(DBusObjectTree *tree, dbus_bool_t fallback, const char **path, const DBusObjectPathVTable *vtable, void *user_data, DBusError *error)
Registers a new subtree in the global object tree.
DBusObjectTree * _dbus_object_tree_new(DBusConnection *connection)
Creates a new object tree, representing a mapping from paths to handler vtables.
void _dbus_object_tree_unref(DBusObjectTree *tree)
Decrement the reference count.
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.