D-Bus: dbus-bus.h Source File

D-Bus 1.10.22

dbus-bus.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-bus.h Convenience functions for communicating with the bus.
3 *
4 * Copyright (C) 2003 CodeFactory AB
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 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
24 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
25 #endif
26
27 #ifndef DBUS_BUS_H
28 #define DBUS_BUS_H
29
30 #include <dbus/dbus-connection.h>
31
32 DBUS_BEGIN_DECLS
33
39 DBUS_EXPORT
40 DBusConnection *dbus_bus_get (DBusBusType type,
41 DBusError *error);
42 DBUS_EXPORT
43 DBusConnection *dbus_bus_get_private (DBusBusType type,
44 DBusError *error);
45
46 DBUS_EXPORT
47 dbus_bool_t dbus_bus_register (DBusConnection *connection,
48 DBusError *error);
49 DBUS_EXPORT
50 dbus_bool_t dbus_bus_set_unique_name (DBusConnection *connection,
51 const char *unique_name);
52 DBUS_EXPORT
53 const char* dbus_bus_get_unique_name (DBusConnection *connection);
54 DBUS_EXPORT
55 unsigned long dbus_bus_get_unix_user (DBusConnection *connection,
56 const char *name,
57 DBusError *error);
58 DBUS_EXPORT
59 char* dbus_bus_get_id (DBusConnection *connection,
60 DBusError *error);
61 DBUS_EXPORT
62 int dbus_bus_request_name (DBusConnection *connection,
63 const char *name,
64 unsigned int flags,
65 DBusError *error);
66 DBUS_EXPORT
67 int dbus_bus_release_name (DBusConnection *connection,
68 const char *name,
69 DBusError *error);
70 DBUS_EXPORT
71 dbus_bool_t dbus_bus_name_has_owner (DBusConnection *connection,
72 const char *name,
73 DBusError *error);
74
75 DBUS_EXPORT
76 dbus_bool_t dbus_bus_start_service_by_name (DBusConnection *connection,
77 const char *name,
78 dbus_uint32_t flags,
79 dbus_uint32_t *reply,
80 DBusError *error);
81
82 DBUS_EXPORT
83 void dbus_bus_add_match (DBusConnection *connection,
84 const char *rule,
85 DBusError *error);
86 DBUS_EXPORT
87 void dbus_bus_remove_match (DBusConnection *connection,
88 const char *rule,
89 DBusError *error);
90
93 DBUS_END_DECLS
94
95 #endif /* DBUS_BUS_H */
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
dbus_bus_release_name
int dbus_bus_release_name(DBusConnection *connection, const char *name, DBusError *error)
Asks the bus to unassign the given name from this connection by invoking the ReleaseName method on th...
Definition: dbus-bus.c:1198
DBusConnection
Implementation details of DBusConnection.
Definition: dbus-connection.c:256
dbus_bus_request_name
int dbus_bus_request_name(DBusConnection *connection, const char *name, unsigned int flags, DBusError *error)
Asks the bus to assign the given name to this connection by invoking the RequestName method on the bu...
Definition: dbus-bus.c:1112
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
dbus_bus_get
DBusConnection * dbus_bus_get(DBusBusType type, DBusError *error)
Connects to a bus daemon and registers the client with it.
Definition: dbus-bus.c:558
dbus_bus_set_unique_name
dbus_bool_t dbus_bus_set_unique_name(DBusConnection *connection, const char *unique_name)
Sets the unique name of the connection, as assigned by the message bus.
Definition: dbus-bus.c:766
dbus_bus_remove_match
void dbus_bus_remove_match(DBusConnection *connection, const char *rule, DBusError *error)
Removes a previously-added match rule "by value" (the most recently-added identical rule gets removed...
Definition: dbus-bus.c:1576
DBusError
Object representing an exception.
Definition: dbus-errors.h:48
dbus_bus_register
dbus_bool_t dbus_bus_register(DBusConnection *connection, DBusError *error)
Registers a connection with the bus.
Definition: dbus-bus.c:646
dbus_bus_start_service_by_name
dbus_bool_t dbus_bus_start_service_by_name(DBusConnection *connection, const char *name, dbus_uint32_t flags, dbus_uint32_t *result, DBusError *error)
Starts a service that will request ownership of the given name.
Definition: dbus-bus.c:1356
dbus_bus_get_unix_user
unsigned long dbus_bus_get_unix_user(DBusConnection *connection, const char *name, DBusError *error)
Asks the bus to return the UID the named connection authenticated as, if any.
Definition: dbus-bus.c:865
dbus_bus_add_match
void dbus_bus_add_match(DBusConnection *connection, const char *rule, DBusError *error)
Adds a match rule to match messages going through the message bus.
Definition: dbus-bus.c:1526
dbus_bus_get_unique_name
const char * dbus_bus_get_unique_name(DBusConnection *connection)
Gets the unique name of the connection as assigned by the message bus.
Definition: dbus-bus.c:815
dbus_bus_get_id
char * dbus_bus_get_id(DBusConnection *connection, DBusError *error)
Asks the bus to return its globally unique ID, as described in the D-Bus specification.
Definition: dbus-bus.c:948
DBusBusType
DBusBusType
Well-known bus types.
Definition: dbus-shared.h:56
dbus_bus_get_private
DBusConnection * dbus_bus_get_private(DBusBusType type, DBusError *error)
Connects to a bus daemon and registers the client with it as with dbus_bus_register().
Definition: dbus-bus.c:590
dbus_bus_name_has_owner
dbus_bool_t dbus_bus_name_has_owner(DBusConnection *connection, const char *name, DBusError *error)
Asks the bus whether a certain name has an owner.
Definition: dbus-bus.c:1280
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.