D-Bus 1.14.10
Macros | Enumerations

Shared header included by both libdbus and C/C++ bindings such as the GLib bindings. More...

Macros

#define DBUS_SERVICE_DBUS   "org.freedesktop.DBus"
 The bus name used to talk to the bus itself. More...
 
#define DBUS_PATH_DBUS   "/org/freedesktop/DBus"
 The object path used to talk to the bus itself. More...
 
#define DBUS_PATH_LOCAL   "/org/freedesktop/DBus/Local"
 The object path used in local/in-process-generated messages. More...
 
#define DBUS_INTERFACE_DBUS   "org.freedesktop.DBus"
 The interface exported by the object with DBUS_SERVICE_DBUS and DBUS_PATH_DBUS. More...
 
#define DBUS_INTERFACE_MONITORING   "org.freedesktop.DBus.Monitoring"
 The monitoring interface exported by the dbus-daemon. More...
 
#define DBUS_INTERFACE_VERBOSE   "org.freedesktop.DBus.Verbose"
 The verbose interface exported by the dbus-daemon. More...
 
#define DBUS_INTERFACE_INTROSPECTABLE   "org.freedesktop.DBus.Introspectable"
 The interface supported by introspectable objects. More...
 
#define DBUS_INTERFACE_PROPERTIES   "org.freedesktop.DBus.Properties"
 The interface supported by objects with properties. More...
 
#define DBUS_INTERFACE_PEER   "org.freedesktop.DBus.Peer"
 The interface supported by most dbus peers. More...
 
#define DBUS_INTERFACE_LOCAL   "org.freedesktop.DBus.Local"
 This is a special interface whose methods can only be invoked by the local implementation (messages from remote apps aren't allowed to specify this interface). More...
 
#define DBUS_NAME_FLAG_ALLOW_REPLACEMENT   0x1
 Allow another service to become the primary owner if requested. More...
 
#define DBUS_NAME_FLAG_REPLACE_EXISTING   0x2
 Request to replace the current primary owner. More...
 
#define DBUS_NAME_FLAG_DO_NOT_QUEUE   0x4
 If we can not become the primary owner do not place us in the queue. More...
 
#define DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER   1
 Service has become the primary owner of the requested name. More...
 
#define DBUS_REQUEST_NAME_REPLY_IN_QUEUE   2
 Service could not become the primary owner and has been placed in the queue. More...
 
#define DBUS_REQUEST_NAME_REPLY_EXISTS   3
 Service is already in the queue. More...
 
#define DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER   4
 Service is already the primary owner. More...
 
#define DBUS_RELEASE_NAME_REPLY_RELEASED   1
 Service was released from the given name. More...
 
#define DBUS_RELEASE_NAME_REPLY_NON_EXISTENT   2
 The given name does not exist on the bus. More...
 
#define DBUS_RELEASE_NAME_REPLY_NOT_OWNER   3
 Service is not an owner of the given name. More...
 
#define DBUS_START_REPLY_SUCCESS   1
 Service was auto started. More...
 
#define DBUS_START_REPLY_ALREADY_RUNNING   2
 Service was already running. More...
 

Enumerations

enum  DBusBusType { DBUS_BUS_SESSION , DBUS_BUS_SYSTEM , DBUS_BUS_STARTER }
 Well-known bus types. More...
 
enum  DBusHandlerResult { DBUS_HANDLER_RESULT_HANDLED , DBUS_HANDLER_RESULT_NOT_YET_HANDLED , DBUS_HANDLER_RESULT_NEED_MEMORY }
 Results that a message handler can return. More...
 

Detailed Description

Shared header included by both libdbus and C/C++ bindings such as the GLib bindings.

Usually a C/C++ binding such as the GLib or Qt binding won't want to include dbus.h in its public headers. However, a few constants and macros may be useful to include; those are found here and in dbus-protocol.h

Macro Definition Documentation

◆ DBUS_INTERFACE_DBUS

#define DBUS_INTERFACE_DBUS   "org.freedesktop.DBus"

The interface exported by the object with DBUS_SERVICE_DBUS and DBUS_PATH_DBUS.

Definition at line 88 of file dbus-shared.h.

◆ DBUS_INTERFACE_INTROSPECTABLE

#define DBUS_INTERFACE_INTROSPECTABLE   "org.freedesktop.DBus.Introspectable"

The interface supported by introspectable objects.

Definition at line 95 of file dbus-shared.h.

◆ DBUS_INTERFACE_LOCAL

#define DBUS_INTERFACE_LOCAL   "org.freedesktop.DBus.Local"

This is a special interface whose methods can only be invoked by the local implementation (messages from remote apps aren't allowed to specify this interface).

Definition at line 105 of file dbus-shared.h.

◆ DBUS_INTERFACE_MONITORING

#define DBUS_INTERFACE_MONITORING   "org.freedesktop.DBus.Monitoring"

The monitoring interface exported by the dbus-daemon.

Definition at line 90 of file dbus-shared.h.

◆ DBUS_INTERFACE_PEER

#define DBUS_INTERFACE_PEER   "org.freedesktop.DBus.Peer"

The interface supported by most dbus peers.

Definition at line 99 of file dbus-shared.h.

◆ DBUS_INTERFACE_PROPERTIES

#define DBUS_INTERFACE_PROPERTIES   "org.freedesktop.DBus.Properties"

The interface supported by objects with properties.

Definition at line 97 of file dbus-shared.h.

◆ DBUS_INTERFACE_VERBOSE

#define DBUS_INTERFACE_VERBOSE   "org.freedesktop.DBus.Verbose"

The verbose interface exported by the dbus-daemon.

Definition at line 93 of file dbus-shared.h.

◆ DBUS_NAME_FLAG_ALLOW_REPLACEMENT

#define DBUS_NAME_FLAG_ALLOW_REPLACEMENT   0x1

Allow another service to become the primary owner if requested.

Definition at line 108 of file dbus-shared.h.

◆ DBUS_NAME_FLAG_DO_NOT_QUEUE

#define DBUS_NAME_FLAG_DO_NOT_QUEUE   0x4

If we can not become the primary owner do not place us in the queue.

Definition at line 110 of file dbus-shared.h.

◆ DBUS_NAME_FLAG_REPLACE_EXISTING

#define DBUS_NAME_FLAG_REPLACE_EXISTING   0x2

Request to replace the current primary owner.

Definition at line 109 of file dbus-shared.h.

◆ DBUS_PATH_DBUS

#define DBUS_PATH_DBUS   "/org/freedesktop/DBus"

The object path used to talk to the bus itself.

Definition at line 80 of file dbus-shared.h.

◆ DBUS_PATH_LOCAL

#define DBUS_PATH_LOCAL   "/org/freedesktop/DBus/Local"

The object path used in local/in-process-generated messages.

Definition at line 82 of file dbus-shared.h.

◆ DBUS_RELEASE_NAME_REPLY_NON_EXISTENT

#define DBUS_RELEASE_NAME_REPLY_NON_EXISTENT   2

The given name does not exist on the bus.

Definition at line 120 of file dbus-shared.h.

◆ DBUS_RELEASE_NAME_REPLY_NOT_OWNER

#define DBUS_RELEASE_NAME_REPLY_NOT_OWNER   3

Service is not an owner of the given name.

Definition at line 121 of file dbus-shared.h.

◆ DBUS_RELEASE_NAME_REPLY_RELEASED

#define DBUS_RELEASE_NAME_REPLY_RELEASED   1

Service was released from the given name.

Definition at line 119 of file dbus-shared.h.

◆ DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER

#define DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER   4

Service is already the primary owner.

Definition at line 116 of file dbus-shared.h.

◆ DBUS_REQUEST_NAME_REPLY_EXISTS

#define DBUS_REQUEST_NAME_REPLY_EXISTS   3

Service is already in the queue.

Definition at line 115 of file dbus-shared.h.

◆ DBUS_REQUEST_NAME_REPLY_IN_QUEUE

#define DBUS_REQUEST_NAME_REPLY_IN_QUEUE   2

Service could not become the primary owner and has been placed in the queue.

Definition at line 114 of file dbus-shared.h.

◆ DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER

#define DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER   1

Service has become the primary owner of the requested name.

Definition at line 113 of file dbus-shared.h.

◆ DBUS_SERVICE_DBUS

#define DBUS_SERVICE_DBUS   "org.freedesktop.DBus"

The bus name used to talk to the bus itself.

Definition at line 76 of file dbus-shared.h.

◆ DBUS_START_REPLY_ALREADY_RUNNING

#define DBUS_START_REPLY_ALREADY_RUNNING   2

Service was already running.

Definition at line 125 of file dbus-shared.h.

◆ DBUS_START_REPLY_SUCCESS

#define DBUS_START_REPLY_SUCCESS   1

Service was auto started.

Definition at line 124 of file dbus-shared.h.

Enumeration Type Documentation

◆ DBusBusType

Well-known bus types.

See dbus_bus_get().

Enumerator
DBUS_BUS_SESSION 

The login session bus.

DBUS_BUS_SYSTEM 

The systemwide bus.

DBUS_BUS_STARTER 

The bus that started us, if any.

Definition at line 56 of file dbus-shared.h.

◆ DBusHandlerResult

Results that a message handler can return.

Enumerator
DBUS_HANDLER_RESULT_HANDLED 

Message has had its effect - no need to run more handlers.

DBUS_HANDLER_RESULT_NOT_YET_HANDLED 

Message has not had any effect - see if other handlers want it.

DBUS_HANDLER_RESULT_NEED_MEMORY 

Need more memory in order to return DBUS_HANDLER_RESULT_HANDLED or DBUS_HANDLER_RESULT_NOT_YET_HANDLED.

Please try again later with more memory.

Definition at line 66 of file dbus-shared.h.