Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
qtdbus-index.qdoc
Go to the documentation of this file.
1// Copyright (C) 2020 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
3
4/*!
5 \page qtdbus-index.html
6 \title Qt D-Bus
7 \brief An introduction to Inter-Process Communication and Remote Procedure Calling with D-Bus.
8
9 \keyword QtDBus
10
11 D-Bus is an Inter-Process Communication (IPC) and Remote Procedure
12 Calling (RPC) mechanism originally developed for Linux to replace
13 existing and competing IPC solutions with one unified protocol. It
14 was also designed to allow communication between system-level
15 processes (such as printer and hardware driver services) and
16 normal user processes.
17
18 It uses a fast, binary message-passing protocol, which is suitable
19 for same-machine communication due to its low latency and low
20 overhead. Its specification is currently defined by the
21 \tt{freedesktop.org} project and is available to all parties.
22
23 Communication, in general, happens through a central server
24 application called the "bus" (hence the name), but direct
25 application-to-application communication is also possible. When
26 communicating on a bus, applications can query which other
27 applications and services are available, as well as activate one
28 on demand.
29
30 \section1 Using the Module
31
32 \include {module-use.qdocinc} {using the c++ api}
33
34 \include {module-use.qdocinc} {building with cmake} {DBus}
35
36 \section1 Articles and Guides
37
38 The following documents contain information about Qt's D-Bus integration
39 features and provide details about the mechanisms used to send and receive
40 type information over the bus:
41
42 \list
43 \li \l {Qt D-Bus Overview}
44 \li \l {Using Qt D-Bus Adaptors}
45 \li \l {The Qt D-Bus Type System}
46 \li \l {Qt D-Bus XML compiler (qdbusxml2cpp)}
47 \li \l{D-Bus Viewer}
48 \endlist
49
50 \section1 Examples
51
52 \list
53 \li \l{Qt D-Bus Examples}
54 \endlist
55
56 \section1 Reference
57
58 \list
59 \li \l{Qt D-Bus C++ Classes}
60 \li \l{CMake Commands in Qt6 DBus}
61 \endlist
62
63 \section1 Module Evolution
64
65 \l{Changes to Qt D-Bus} lists important changes in the module API
66 and functionality that were made for the Qt 6 series of Qt.
67
68 \section1 Licenses and Attributions
69
70 The Qt D-Bus module is available under commercial licenses from \l{The Qt Company}.
71 In addition, it is available under free software licenses:
72 The \l{GNU Lesser General Public License, version 3}, or
73 the \l{GNU General Public License, version 2}.
74 See \l{Qt Licensing} for further details.
75
76 Furthermore, Qt D-Bus in Qt \QtVersion may contain third party
77 modules under the following permissive licenses:
78
79 \generatelist{groupsbymodule attributions-qtdbus}
80*/
81
82/*!
83 \page qdbusviewer.html
84 \title D-Bus Viewer
85 \keyword qdbusviewer
86
87 The Qt D-Bus Viewer is a tool that lets you introspect D-Bus objects and messages. You can
88 choose between the system bus and the session bus. Click on any service on the list
89 on the left side to see all the exported objects.
90
91 You can invoke methods by double-clicking on them. If a method takes one or more IN parameters,
92 a property editor opens.
93
94 Right-click on a signal to connect to it. All emitted signals including their parameters
95 are output in the message view on the lower side of the window.
96*/