The Qt D-Bus Type System | Qt D-Bus

Qt 5.6 | Qt D-Bus | The Qt D-Bus Type System

Qt 5.6.2 Reference Documentation

Declaring Signals in D-Bus Adaptors ◦ D-Bus Adaptor Example

# The Qt D-Bus Type System

D-Bus has an extensible type system based on a few primitives and composition of the primitives in arrays and structures. Qt D-Bus implements the interface to that type system through the QDBusArgument class, allowing user programs to send and receive practically every C++ type over the bus.

## Primitive Types

The primitive types are supported natively by QDBusArgument and need no special customization to be sent or received. They are listed below, along with the C++ class they relate to:

Qt type | D-Bus equivalent type
--- | ---
uchar | BYTE
bool | BOOLEAN
short | INT16
ushort | UINT16
int | INT32
uint | UINT32
qlonglong | INT64
qulonglong | UINT64
double | DOUBLE
QString | STRING
QDBusVariant | VARIANT
QDBusObjectPath | OBJECT_PATH
QDBusSignature | SIGNATURE

Aside from the primitive types, QDBusArgument also supports two non-primitive types natively, due to their widespread use in Qt applications: QStringList and QByteArray.

## Compound Types

D-Bus specifies three types of aggregations of primitive types that allow one to create compound types. They are `ARRAY`, `STRUCT` and maps/dictionaries.

Arrays are sets of zero or more elements of the same type, while structures are a set of a fixed number of elements, each of any type. Maps or dictionaries are implemented as arrays of a pair of elements, so there can be zero or more elements in one map.

## Extending the Type System

In order to use one's own type with Qt D-Bus, the type has to be declared as a Qt meta-type with the Q_DECLARE_METATYPE() macro and registered with the qDBusRegisterMetaType() function. The streaming operators `operator>>` and `operator<<` will be automatically found by the registration system.

Qt D-Bus provides template specializations for arrays and maps for use with Qt's container classes, such as QMap and QList, so it is not necessary to write the streaming operator functions for those. For other types, and specially for types implementing structures, the operators have to be explicitly implemented.

See the documentation for QDBusArgument for examples for structures, arrays and maps.

## The Type System in Use

All of the Qt D-Bus types (primitives and user-defined alike) can be used to send and receive messages of all types over the bus.

Warning: You may not use any type that is not on the list above, including typedefs to the types listed. This also includes QList<QVariant> and QMap<QString,QVariant>.

Declaring Signals in D-Bus Adaptors ◦ D-Bus Adaptor Example