\inmodule QtDBus More...

#include <qdbusconnection.h>

Collaboration diagram for QDBusConnection:

Public Types
enum	BusType { SessionBus , SystemBus , ActivationBus }
	Specifies the type of the bus connection. More...

enum	RegisterOption { ExportAdaptors = 0x01 , ExportScriptableSlots = 0x10 , ExportScriptableSignals = 0x20 , ExportScriptableProperties = 0x40 , ExportScriptableInvokables = 0x80 , ExportScriptableContents = 0xf0 , ExportNonScriptableSlots = 0x100 , ExportNonScriptableSignals = 0x200 , ExportNonScriptableProperties = 0x400 , ExportNonScriptableInvokables = 0x800 , ExportNonScriptableContents = 0xf00 , ExportAllSlots = ExportScriptableSlots\|ExportNonScriptableSlots , ExportAllSignals = ExportScriptableSignals\|ExportNonScriptableSignals , ExportAllProperties = ExportScriptableProperties\|ExportNonScriptableProperties , ExportAllInvokables = ExportScriptableInvokables\|ExportNonScriptableInvokables , ExportAllContents = ExportScriptableContents\|ExportNonScriptableContents , ExportAllSignal = ExportAllSignals , ExportChildObjects = 0x1000 }
	Specifies the options for registering objects with the connection. More...

enum	UnregisterMode { UnregisterNode , UnregisterTree }
	The mode for unregistering an object path: More...

enum	VirtualObjectRegisterOption { SingleNode = 0x0 , SubPath = 0x1 }

enum	ConnectionCapability { UnixFileDescriptorPassing = 0x0001 }

Public Member Functions
	QDBusConnection (const QString &name)
	Creates a QDBusConnection object attached to the connection with name name.

	QDBusConnection (const QDBusConnection &other)
	Creates a copy of the other connection.

	QDBusConnection (QDBusConnection &&other) noexcept

QDBusConnection &	operator= (QDBusConnection &&other) noexcept

QDBusConnection &	operator= (const QDBusConnection &other)
	Creates a copy of the connection other in this object.

	~QDBusConnection ()
	Disposes of this object.

void	swap (QDBusConnection &other) noexcept
	Swaps this QDBusConnection instance with other.

bool	isConnected () const
	Returns `true` if this QDBusConnection object is connected.

QString	baseService () const
	Returns the unique connection name for this connection, if this QDBusConnection object is connected, or an empty QString otherwise.

QDBusError	lastError () const
	Returns the last error that happened in this connection.

QString	name () const

ConnectionCapabilities	connectionCapabilities () const

bool	send (const QDBusMessage &message) const
	Sends the message over this connection, without waiting for a reply.

bool	callWithCallback (const QDBusMessage &message, QObject receiver, const char returnMethod, const char *errorMethod, int timeout=-1) const
	Sends the message over this connection and returns immediately.

bool	callWithCallback (const QDBusMessage &message, QObject receiver, const char slot, int timeout=-1) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QDBusMessage	call (const QDBusMessage &message, QDBus::CallMode mode=QDBus::Block, int timeout=-1) const
	Sends the message over this connection and blocks, waiting for a reply, for at most timeout milliseconds.

QDBusPendingCall	asyncCall (const QDBusMessage &message, int timeout=-1) const

bool	connect (const QString &service, const QString &path, const QString &interface, const QString &name, QObject receiver, const char slot)
	Connects the signal specified by the service, path, interface and name parameters to the slot slot in object receiver.

bool	connect (const QString &service, const QString &path, const QString &interface, const QString &name, const QString &signature, QObject receiver, const char slot)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Connects the signal to the slot slot in object receiver.

bool	connect (const QString &service, const QString &path, const QString &interface, const QString &name, const QStringList &argumentMatch, const QString &signature, QObject receiver, const char slot)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool	disconnect (const QString &service, const QString &path, const QString &interface, const QString &name, QObject receiver, const char slot)
	Disconnects the signal specified by the service, path, interface and name parameters from the slot slot in object receiver.

bool	disconnect (const QString &service, const QString &path, const QString &interface, const QString &name, const QString &signature, QObject receiver, const char slot)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Disconnects the signal specified by the service, path, interface, name, and signature parameters from the slot slot in object receiver.

bool	disconnect (const QString &service, const QString &path, const QString &interface, const QString &name, const QStringList &argumentMatch, const QString &signature, QObject receiver, const char slot)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool	registerObject (const QString &path, QObject *object, RegisterOptions options=ExportAdaptors)
	Registers the object object at path path and returns `true` if the registration was successful.

bool	registerObject (const QString &path, const QString &interface, QObject *object, RegisterOptions options=ExportAdaptors)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	unregisterObject (const QString &path, UnregisterMode mode=UnregisterNode)
	Unregisters an object that was registered with the registerObject() at the object path given by path and, if mode is QDBusConnection::UnregisterTree, all of its sub-objects too.

QObject *	objectRegisteredAt (const QString &path) const
	Return the object that was registered with the registerObject() at the object path given by path.

bool	registerVirtualObject (const QString &path, QDBusVirtualObject *object, VirtualObjectRegisterOption options=SingleNode)

bool	registerService (const QString &serviceName)
	Attempts to register the serviceName on the D-Bus server and returns `true` if the registration succeeded.

bool	unregisterService (const QString &serviceName)
	Unregisters the service serviceName that was previously registered with registerService() and returns `true` if it succeeded.

QDBusConnectionInterface *	interface () const
	Returns a QDBusConnectionInterface object that represents the D-Bus server interface on this connection.

void *	internalPointer () const

Static Public Member Functions
static QDBusConnection	connectToBus (BusType type, const QString &name)
	Opens a connection of type type to one of the known buses and associate with it the connection name name.

static QDBusConnection	connectToBus (const QString &address, const QString &name)
	Opens a connection to a private bus on address address and associate with it the connection name name.

static QDBusConnection	connectToPeer (const QString &address, const QString &name)

static void	disconnectFromBus (const QString &name)
	Closes the bus connection of name name.

static void	disconnectFromPeer (const QString &name)

static QByteArray	localMachineId ()

static QDBusConnection	sessionBus ()
	Returns a QDBusConnection object opened with the session bus.

static QDBusConnection	systemBus ()
	Returns a QDBusConnection object opened with the system bus.

Protected Member Functions
	QDBusConnection (QDBusConnectionPrivate *dd)

Friends
class	QDBusConnectionPrivate

Detailed Description

\inmodule QtDBus

Since: 4.2

The QDBusConnection class represents a connection to the D-Bus bus daemon.

This class is the initial point in a D-Bus session. Using it, you can get access to remote objects, interfaces; connect remote signals to your object's slots; register objects, etc.

D-Bus connections are created using the connectToBus() function, which opens a connection to the server daemon and does the initial handshaking, associating that connection with a name. Further attempts to connect using the same name will return the same connection.

The connection is then torn down using the disconnectFromBus() function.

Once disconnected, calling connectToBus() will not reestablish a connection, you must create a new QDBusConnection instance.

As a convenience for the two most common connection types, the sessionBus() and systemBus() functions return open connections to the session server daemon and the system server daemon, respectively. Those connections are opened when first used and are closed when the QCoreApplication destructor is run.

D-Bus also supports peer-to-peer connections, without the need for a bus server daemon. Using this facility, two applications can talk to each other and exchange messages. This can be achieved by passing an address to connectToBus() function, which was opened by another D-Bus application using QDBusServer.

Definition at line 41 of file qdbusconnection.h.

Member Enumeration Documentation

◆ BusType

enum QDBusConnection::BusType

Specifies the type of the bus connection.

The valid bus types are:

\value SessionBus the session bus, associated with the running desktop session \value SystemBus the system bus, used to communicate with system-wide processes \value ActivationBus the activation bus, the "alias" for the bus that started the service

On the Session Bus, one can find other applications by the same user that are sharing the same desktop session (hence the name). On the System Bus, however, processes shared for the whole system are usually found.

Enumerator
SessionBus
SystemBus
ActivationBus

Definition at line 47 of file qdbusconnection.h.

◆ ConnectionCapability

enum QDBusConnection::ConnectionCapability

Since: 4.8

This enum describes the available capabilities for a D-Bus connection.

\value UnixFileDescriptorPassing enables passing of Unix file descriptors to other processes (see QDBusUnixFileDescriptor)

See also: connectionCapabilities()

Enumerator
UnixFileDescriptorPassing

Definition at line 93 of file qdbusconnection.h.

◆ RegisterOption

enum QDBusConnection::RegisterOption

Specifies the options for registering objects with the connection.

The possible values are:

\value ExportAdaptors export the contents of adaptors found in this object

\value ExportScriptableSlots export this object's scriptable slots \value ExportScriptableSignals export this object's scriptable signals \value ExportScriptableProperties export this object's scriptable properties \value ExportScriptableInvokables export this object's scriptable invokables \value ExportScriptableContents shorthand form for ExportScriptableSlots | ExportScriptableSignals | ExportScriptableProperties

\value ExportNonScriptableSlots export this object's non-scriptable slots \value ExportNonScriptableSignals export this object's non-scriptable signals \value ExportNonScriptableProperties export this object's non-scriptable properties \value ExportNonScriptableInvokables export this object's non-scriptable invokables \value ExportNonScriptableContents shorthand form for ExportNonScriptableSlots | ExportNonScriptableSignals | ExportNonScriptableProperties

\value ExportAllSlots export all of this object's slots \value ExportAllSignals export all of this object's signals \value ExportAllProperties export all of this object's properties \value ExportAllInvokables export all of this object's invokables \value ExportAllContents export all of this object's contents \value ExportChildObjects export this object's child objects

See also: registerObject(), QDBusAbstractAdaptor, {usingadaptors.html}{Using adaptors}

Enumerator
ExportAdaptors
ExportScriptableSlots
ExportScriptableSignals
ExportScriptableProperties
ExportScriptableInvokables
ExportScriptableContents
ExportNonScriptableSlots
ExportNonScriptableSignals
ExportNonScriptableProperties
ExportNonScriptableInvokables
ExportNonScriptableContents
ExportAllSlots
ExportAllSignals
ExportAllProperties
ExportAllInvokables
ExportAllContents
ExportAllSignal
ExportChildObjects

Definition at line 49 of file qdbusconnection.h.

◆ UnregisterMode

enum QDBusConnection::UnregisterMode

The mode for unregistering an object path:

\value UnregisterNode unregister this node only: do not unregister child objects \value UnregisterTree unregister this node and all its sub-tree

Note, however, if this object was registered with the ExportChildObjects option, UnregisterNode will unregister the child objects too.

Enumerator
UnregisterNode
UnregisterTree

Definition at line 80 of file qdbusconnection.h.

◆ VirtualObjectRegisterOption

enum QDBusConnection::VirtualObjectRegisterOption

Since: 4.8

Specifies the options for registering virtual objects with the connection. The possible values are:

\value SingleNode register a virtual object to handle one path only \value SubPath register a virtual object so that it handles all sub paths

See also: registerVirtualObject(), QDBusVirtualObject

Enumerator
SingleNode
SubPath

Definition at line 86 of file qdbusconnection.h.

Constructor & Destructor Documentation

◆ QDBusConnection() [1/4]

QDBusConnection::QDBusConnection ( const QString & name )

explicit

Creates a QDBusConnection object attached to the connection with name name.

This does not open the connection. You have to call connectToBus() to open it.

Definition at line 366 of file qdbusconnection.cpp.

References d, and mutex.

◆ QDBusConnection() [2/4]

QDBusConnection::QDBusConnection ( const QDBusConnection & other )

Creates a copy of the other connection.

Definition at line 381 of file qdbusconnection.cpp.

References d, and other().

Here is the call graph for this function:

◆ QDBusConnection() [3/4]

QDBusConnection::QDBusConnection ( QDBusConnection && other )

inlinenoexcept

Definition at line 100 of file qdbusconnection.h.

References other().

Here is the call graph for this function:

◆ ~QDBusConnection()

QDBusConnection::~QDBusConnection ( )

Disposes of this object.

This does not close the connection: you have to call disconnectFromBus() to do that.

Definition at line 403 of file qdbusconnection.cpp.

References d.

◆ QDBusConnection() [4/4]

QDBusConnection::QDBusConnection ( QDBusConnectionPrivate * dd )

explicitprotected

Creates a connection object with the given dd as private object.

Definition at line 392 of file qdbusconnection.cpp.

References d.

Member Function Documentation

◆ asyncCall()

QDBusPendingCall QDBusConnection::asyncCall	(	const QDBusMessage &	message,
		int	timeout = `-1`
	)		const

Since: 4.5 Sends the message over this connection and returns immediately. This function is suitable for method calls only. It returns an object of type QDBusPendingCall which can be used to track the status of the reply.

If no reply is received within timeout milliseconds, an automatic error will be delivered indicating the expiration of the call. The default timeout is -1, which will be replaced with an implementation-defined value that is suitable for inter-process communications (generally, 25 seconds). This timeout is also the upper limit for waiting in QDBusPendingCall::waitForFinished().

See the QDBusInterface::asyncCall() function for a more friendly way of placing calls.

Definition at line 644 of file qdbusconnection.cpp.

References d, and priv().

Referenced by QXdgDesktopPortalTheme::QXdgDesktopPortalTheme(), and QIBusProxy::GetProperty().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ baseService()

QString QDBusConnection::baseService ( ) const

Returns the unique connection name for this connection, if this QDBusConnection object is connected, or an empty QString otherwise.

A Unique Connection Name is a string in the form ":x.xxx" (where x are decimal digits) that is assigned by the D-Bus server daemon upon connection. It uniquely identifies this client in the bus.

This function returns an empty QString for peer-to-peer connections.

Definition at line 1046 of file qdbusconnection.cpp.

References d.

Referenced by QDBusMenuConnection::registerTrayIconWithWatcher().

Here is the caller graph for this function:

◆ call()

QDBusMessage QDBusConnection::call	(	const QDBusMessage &	message,
		QDBus::CallMode	mode = `QDBus::Block`,
		int	timeout = `-1`
	)		const

Sends the message over this connection and blocks, waiting for a reply, for at most timeout milliseconds.

This function is suitable for method calls only. It returns the reply message as its return value, which will be either of type QDBusMessage::ReplyMessage or QDBusMessage::ErrorMessage.

If no reply is received within timeout milliseconds, an automatic error will be delivered indicating the expiration of the call. The default timeout is -1, which will be replaced with an implementation-defined value that is suitable for inter-process communications (generally, 25 seconds).

See the QDBusInterface::call() function for a more friendly way of placing calls.

Warning: If mode is QDBus::BlockWithGui, this function will reenter the Qt event loop in order to wait for the reply. During the wait, it may deliver signals and other method calls to your application. Therefore, it must be prepared to handle a reentrancy whenever a call is placed with call().

Definition at line 607 of file qdbusconnection.cpp.

References QDBusMessage::createError(), d, QDBusError::Disconnected, QDBusUtil::disconnectedErrorMessage(), and QDBus::NoBlock.

Referenced by QXdgDesktopPortalTheme::QXdgDesktopPortalTheme(), and QDBusAbstractInterfacePrivate::property().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ callWithCallback() [1/2]

bool QDBusConnection::callWithCallback	(	const QDBusMessage &	message,
		QObject *	receiver,
		const char *	returnMethod,
		const char *	errorMethod,
		int	timeout = `-1`
	)		const

Sends the message over this connection and returns immediately.

When the reply is received, the method returnMethod is called in the receiver object. If an error occurs, the method errorMethod will be called instead.

If no reply is received within timeout milliseconds, an automatic error will be delivered indicating the expiration of the call. The default timeout is -1, which will be replaced with an implementation-defined value that is suitable for inter-process communications (generally, 25 seconds).

This function is suitable for method calls only. It is guaranteed that the slot will be called exactly once with the reply, as long as the parameter types match and no error occurs.

Returns true if the message was sent, or false if the message could not be sent.

Definition at line 547 of file qdbusconnection.cpp.

References d, QDBusError::Disconnected, and QDBusUtil::disconnectedErrorMessage().

Referenced by callWithCallback(), and QDBusMenuConnection::registerTrayIconWithWatcher().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ callWithCallback() [2/2]

bool QDBusConnection::callWithCallback	(	const QDBusMessage &	message,
		QObject *	receiver,
		const char *	returnMethod,
		int	timeout = `-1`
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Deprecated:: Sends the message over this connection and returns immediately. When the reply is received, the method returnMethod is called in the receiver object.

This function is suitable for method calls only. It is guaranteed that the slot will be called exactly once with the reply, as long as the parameter types match and no error occurs.

This function is dangerous because it cannot report errors, including the expiration of the timeout.

Returns true if the message was sent, or false if the message could not be sent.

Definition at line 578 of file qdbusconnection.cpp.

References callWithCallback().

Here is the call graph for this function:

◆ connect() [1/3]

bool QDBusConnection::connect	(	const QString &	service,
		const QString &	path,
		const QString &	interface,
		const QString &	name,
		const QString &	signature,
		QObject *	receiver,
		const char *	slot
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Connects the signal to the slot slot in object receiver.

Unlike the previous connect() overload, this function allows one to specify the parameter signature to be connected using the signature variable. The function will then verify that this signature can be delivered to the slot specified by slot and return false otherwise.

Returns true if the connection was successful.

Note: This function verifies that the signal signature matches the slot's parameters, but it does not verify that the actual signal exists with the given signature in the remote service.

Definition at line 688 of file qdbusconnection.cpp.

References connect(), and interface().

Here is the call graph for this function:

◆ connect() [2/3]

bool QDBusConnection::connect	(	const QString &	service,
		const QString &	path,
		const QString &	interface,
		const QString &	name,
		const QStringList &	argumentMatch,
		const QString &	signature,
		QObject *	receiver,
		const char *	slot
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since: 4.6

Connects the signal to the slot slot in object receiver. Unlike the previous connect() overload, this function allows one to specify the parameter signature to be connected using the signature variable. The function will then verify that this signature can be delivered to the slot specified by slot and return false otherwise.

The argumentMatch parameter lists the string parameters to be matched, in sequential order. Note that, to match an empty string, you need to pass a QString that is empty but not null (i.e., QString("")). A null QString skips matching at that position.

Returns true if the connection was successful.

Note: This function verifies that the signal signature matches the slot's parameters, but it does not verify that the actual signal exists with the given signature in the remote service.

Definition at line 718 of file qdbusconnection.cpp.

References d, interface(), QDBusUtil::isValidBusName(), QDBusUtil::isValidInterfaceName(), QDBusUtil::isValidObjectPath(), and qWarning.

Here is the call graph for this function:

◆ connect() [3/3]

bool QDBusConnection::connect	(	const QString &	service,
		const QString &	path,
		const QString &	interface,
		const QString &	name,
		QObject *	receiver,
		const char *	slot
	)

Connects the signal specified by the service, path, interface and name parameters to the slot slot in object receiver.

The arguments service and path can be empty, denoting a connection to any signal of the (interface, name) pair, from any remote application.

Returns true if the connection was successful.

Warning: The signal will only be delivered to the slot if the parameters match. This verification can be done only when the signal is received, not at connection time.

Definition at line 665 of file qdbusconnection.cpp.

References connect(), and interface().

Referenced by QIBusProxy::QIBusProxy(), QNetworkManagerInterface::QNetworkManagerInterface(), connect(), and connect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ connectionCapabilities()

QDBusConnection::ConnectionCapabilities QDBusConnection::connectionCapabilities ( ) const

Since: 4.8

Returns the capabilities of this connection as negotiated with the bus server or peer. If this QDBusConnection is not connected, this function returns no capabilities.

Definition at line 1080 of file qdbusconnection.cpp.

References d.

◆ connectToBus() [1/2]

QDBusConnection QDBusConnection::connectToBus	(	BusType	type,
		const QString &	name
	)

static

Opens a connection of type type to one of the known buses and associate with it the connection name name.

Returns a QDBusConnection object associated with that connection.

Definition at line 431 of file qdbusconnection.cpp.

References connectToBus(), d, and qdbus_loadLibDBus().

Referenced by connectToBus(), connectToBus(), and QIBusPlatformInputContextPrivate::createConnection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ connectToBus() [2/2]

QDBusConnection QDBusConnection::connectToBus	(	const QString &	address,
		const QString &	name
	)

static

Opens a connection to a private bus on address address and associate with it the connection name name.

Returns a QDBusConnection object associated with that connection.

Definition at line 444 of file qdbusconnection.cpp.

References connectToBus(), d, and qdbus_loadLibDBus().

Here is the call graph for this function:

◆ connectToPeer()

QDBusConnection QDBusConnection::connectToPeer	(	const QString &	address,
		const QString &	name
	)

static

Since: 4.8

Opens a peer-to-peer connection on address address and associate with it the connection name name. Returns a QDBusConnection object associated with that connection.

Definition at line 459 of file qdbusconnection.cpp.

References connectToPeer(), d, and qdbus_loadLibDBus().

Referenced by connectToPeer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ disconnect() [1/3]

bool QDBusConnection::disconnect	(	const QString &	service,
		const QString &	path,
		const QString &	interface,
		const QString &	name,
		const QString &	signature,
		QObject *	receiver,
		const char *	slot
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Disconnects the signal specified by the service, path, interface, name, and signature parameters from the slot slot in object receiver.

The arguments must be the same as passed to the connect() function.

Returns true if the disconnection was successful.

Definition at line 772 of file qdbusconnection.cpp.

References disconnect(), and interface().

Here is the call graph for this function:

◆ disconnect() [2/3]

bool QDBusConnection::disconnect	(	const QString &	service,
		const QString &	path,
		const QString &	interface,
		const QString &	name,
		const QStringList &	argumentMatch,
		const QString &	signature,
		QObject *	receiver,
		const char *	slot
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since: 4.6

Disconnects the signal specified by the service, path, interface, name, argumentMatch, and signature parameters from the slot slot in object receiver. The arguments must be the same as passed to the connect() function.

Returns true if the disconnection was successful.

Definition at line 790 of file qdbusconnection.cpp.

References d, interface(), and QDBusUtil::isValidInterfaceName().

Here is the call graph for this function:

◆ disconnect() [3/3]

bool QDBusConnection::disconnect	(	const QString &	service,
		const QString &	path,
		const QString &	interface,
		const QString &	name,
		QObject *	receiver,
		const char *	slot
	)

Disconnects the signal specified by the service, path, interface and name parameters from the slot slot in object receiver.

The arguments must be the same as passed to the connect() function.

Returns true if the disconnection was successful.

Definition at line 756 of file qdbusconnection.cpp.

References disconnect(), and interface().

Referenced by QNetworkManagerInterface::~QNetworkManagerInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ disconnectFromBus()

void QDBusConnection::disconnectFromBus ( const QString & name )

static

Closes the bus connection of name name.

Note that if there are still QDBusConnection objects associated with the same connection, the connection will not be closed until all references are dropped. However, no further references can be created using the QDBusConnection constructor.

Definition at line 477 of file qdbusconnection.cpp.

References QDBusConnectionPrivate::ClientMode, d, and mutex.

Referenced by QDBusMenuConnection::~QDBusMenuConnection(), QIBusPlatformInputContextPrivate::~QIBusPlatformInputContextPrivate(), and QIBusPlatformInputContext::socketChanged().

Here is the caller graph for this function:

◆ disconnectFromPeer()

void QDBusConnection::disconnectFromPeer ( const QString & name )

static

Since: 4.8

Closes the peer connection of name name.

Note that if there are still QDBusConnection objects associated with the same connection, the connection will not be closed until all references are dropped. However, no further references can be created using the QDBusConnection constructor.

Definition at line 498 of file qdbusconnection.cpp.

References d, mutex, and QDBusConnectionPrivate::PeerMode.

◆ interface()

QDBusConnectionInterface * QDBusConnection::interface ( ) const

Returns a QDBusConnectionInterface object that represents the D-Bus server interface on this connection.

Definition at line 992 of file qdbusconnection.cpp.

References QDBusConnectionPrivate::ClientMode, and d.

Referenced by bluetoothdVersion(), connect(), connect(), connect(), disconnect(), disconnect(), disconnect(), registerObject(), registerService(), and unregisterService().

Here is the caller graph for this function:

◆ internalPointer()

void * QDBusConnection::internalPointer ( ) const

Since: 4.8

Returns the internal, implementation-defined pointer for this connection. Currently, this returns a DBusConnection* pointer, without changing the reference count. It is the responsibility of the caller to call dbus_connection_ref if it wants to store the pointer.

Definition at line 1009 of file qdbusconnection.cpp.

References d.

◆ isConnected()

bool QDBusConnection::isConnected ( ) const

Returns true if this QDBusConnection object is connected.

Definition at line 1017 of file qdbusconnection.cpp.

References d.

Referenced by QDBusAbstractInterfacePrivate::QDBusAbstractInterfacePrivate(), QDBusInterfacePrivate::QDBusInterfacePrivate(), QDBusMenuConnection::~QDBusMenuConnection(), and QDBusAbstractInterfacePrivate::initOwnerTracking().

Here is the caller graph for this function:

◆ lastError()

QDBusError QDBusConnection::lastError ( ) const

Returns the last error that happened in this connection.

This function is provided for low-level code. If you're using QDBusInterface::call(), error codes are reported by its return value.

See also: QDBusInterface, QDBusMessage

Definition at line 1031 of file qdbusconnection.cpp.

References d, QDBusError::Disconnected, and QDBusUtil::disconnectedErrorMessage().

Here is the call graph for this function:

◆ localMachineId()

QByteArray QDBusConnection::localMachineId ( )

static

Since: 4.8 Returns the local machine ID as known to the D-Bus system. Each node or host that runs D-Bus has a unique identifier that can be used to distinguish it from other hosts if they are sharing resources like the filesystem.

Note that the local machine ID is not guaranteed to be persistent across boots of the system, so this identifier should not be stored in persistent storage (like the filesystem). It is guaranteed to remain constant only during the lifetime of this boot session.

Definition at line 1174 of file qdbusconnection.cpp.

Referenced by QIBusPlatformInputContextPrivate::getSocketPath().

Here is the caller graph for this function:

◆ name()

QString QDBusConnection::name ( ) const

Since: 4.5

Returns the connection name for this connection, as given as the name parameter to connectToBus().

The connection name can be used to uniquely identify actual underlying connections to buses. Copies made from a single connection will always implicitly share the underlying connection, and hence will have the same connection name.

Inversely, two connections having different connection names will always either be connected to different buses, or have a different unique name (as returned by baseService()) on that bus.

See also: connectToBus(), disconnectFromBus()

Definition at line 1068 of file qdbusconnection.cpp.

References d.

Referenced by QDBusServiceWatcher::setConnection().

Here is the caller graph for this function:

◆ objectRegisteredAt()

QObject * QDBusConnection::objectRegisteredAt ( const QString & path ) const

Return the object that was registered with the registerObject() at the object path given by path.

Definition at line 953 of file qdbusconnection.cpp.

References QDBusConnectionPrivate::ObjectTreeNode::children, QList< T >::constBegin(), QList< T >::constEnd(), d, QDBusConnectionPrivate::ObjectTreeNode::flags, i, QDBusUtil::isValidObjectPath(), it, lock, QDBusConnectionPrivate::ObjectTreeNode::obj, ObjectRegisteredAtAction, Q_ASSERT_X, QList< T >::removeLast(), QStringView::split(), SubPath, and QDBusConnectionPrivate::VirtualObject.

Here is the call graph for this function:

◆ operator=() [1/2]

QDBusConnection & QDBusConnection::operator= ( const QDBusConnection & other )

Creates a copy of the connection other in this object.

Note that the connection this object referenced before the copy, is not spontaneously disconnected.

See also: disconnectFromBus()

Definition at line 416 of file qdbusconnection.cpp.

References d, and other().

Here is the call graph for this function:

◆ operator=() [2/2]

QDBusConnection & QDBusConnection::operator= ( QDBusConnection && other )

inlinenoexcept

Definition at line 101 of file qdbusconnection.h.

References other(), and swap().

Here is the call graph for this function:

◆ registerObject() [1/2]

bool QDBusConnection::registerObject	(	const QString &	path,
		const QString &	interface,
		QObject *	object,
		RegisterOptions	options = `ExportAdaptors`
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since: 5.5

Registers the object object at path path with interface name interface and returns true if the registration was successful. The options parameter specifies how much of the object object will be exposed through D-Bus.

This function does not replace existing objects: if there is already an object registered at path path, this function will return false. Use unregisterObject() to unregister it first.

The ExportChildObjects flag exports child objects on D-Bus based on the path of the registered objects and the QObject::objectName of the child. Therefore, it is important for the child object to have an object name.

You cannot register an object as a child object of an object that was registered with ExportChildObjects.

Definition at line 844 of file qdbusconnection.cpp.

References QList< T >::begin(), QDBusConnectionPrivate::ObjectTreeNode::children, d, QList< T >::end(), ExportChildObjects, QDBusConnectionPrivate::ObjectTreeNode::flags, i, QList< T >::insert(), interface(), QDBusConnectionPrivate::ObjectTreeNode::interfaceName, QList< T >::isEmpty(), QDBusUtil::isValidObjectPath(), it, QDBusConnectionPrivate::ObjectTreeNode::obj, Q_ASSERT_X, RegisterObjectAction, QList< T >::removeLast(), QStringView::split(), SubPath, and QDBusConnectionPrivate::VirtualObject.

Here is the call graph for this function:

◆ registerObject() [2/2]

bool QDBusConnection::registerObject	(	const QString &	path,
		QObject *	object,
		RegisterOptions	options = `ExportAdaptors`
	)

Registers the object object at path path and returns true if the registration was successful.

The options parameter specifies how much of the object object will be exposed through D-Bus.

This function does not replace existing objects: if there is already an object registered at path path, this function will return false. Use unregisterObject() to unregister it first.

The ExportChildObjects flag exports child objects on D-Bus based on the path of the registered objects and the QObject::objectName of the child. Therefore, it is important for the child object to have an object name.

You cannot register an object as a child object of an object that was registered with ExportChildObjects.

Definition at line 820 of file qdbusconnection.cpp.

References registerObject().

Referenced by QBluetoothSocketPrivateBluezDBus::connectToServiceHelper(), registerObject(), QDBusMenuConnection::registerTrayIcon(), QDBusMenuConnection::registerTrayIconMenu(), and registerVirtualObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerService()

bool QDBusConnection::registerService ( const QString & serviceName )

Attempts to register the serviceName on the D-Bus server and returns true if the registration succeeded.

The registration will fail if the name is already registered by another application.

See also: unregisterService(), QDBusConnectionInterface::registerService()

Definition at line 1092 of file qdbusconnection.cpp.

References d, interface(), and registerService().

Referenced by registerService().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ registerVirtualObject()

bool QDBusConnection::registerVirtualObject	(	const QString &	path,
		QDBusVirtualObject *	treeNode,
		VirtualObjectRegisterOption	options = `SingleNode`
	)

Since: 4.8 Registers a QDBusTreeNode for a path. It can handle a path including all child paths, thus handling multiple DBus nodes.

To unregister a QDBusTreeNode use the unregisterObject() function with its path.

Definition at line 927 of file qdbusconnection.cpp.

References registerObject(), and QDBusConnectionPrivate::VirtualObject.

Here is the call graph for this function:

◆ send()

bool QDBusConnection::send ( const QDBusMessage & message ) const

Sends the message over this connection, without waiting for a reply.

This is suitable for errors, signals, and return values as well as calls whose return values are not necessary.

Returns true if the message was queued successfully, false otherwise.

Definition at line 516 of file qdbusconnection.cpp.

References d, QDBusError::Disconnected, and QDBusUtil::disconnectedErrorMessage().

Referenced by OrgBluezGattCharacteristic1Adaptor::ReadValue(), OrgBluezGattDescriptor1Adaptor::ReadValue(), QDBusContext::sendErrorReply(), QDBusContext::sendErrorReply(), sendReply(), QGenericUnixServices::setApplicationBadge(), OrgBluezGattCharacteristic1Adaptor::WriteValue(), and OrgBluezGattDescriptor1Adaptor::WriteValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sessionBus()

QDBusConnection QDBusConnection::sessionBus ( )

static

Returns a QDBusConnection object opened with the session bus.

The object reference returned by this function is valid until the application terminates, at which point the connection will be closed and the object deleted.

Definition at line 1124 of file qdbusconnection.cpp.

References SessionBus.

Referenced by DBusConnection::DBusConnection(), QXdgDesktopPortalTheme::QXdgDesktopPortalTheme(), checkDBusGlobalMenuAvailable(), sendReply(), and QGenericUnixServices::setApplicationBadge().

Here is the caller graph for this function:

◆ swap()

void QDBusConnection::swap ( QDBusConnection & other )

inlinenoexcept

Swaps this QDBusConnection instance with other.

Definition at line 105 of file qdbusconnection.h.

References d, other(), and qt_ptr_swap().

Here is the call graph for this function:

◆ systemBus()

QDBusConnection QDBusConnection::systemBus ( )

static

Returns a QDBusConnection object opened with the system bus.

The object reference returned by this function is valid until the QCoreApplication's destructor is run, when the connection will be closed and the object, deleted.

Definition at line 1138 of file qdbusconnection.cpp.

References SystemBus.

Referenced by QBluetoothSocketPrivateBluezDBus::QBluetoothSocketPrivateBluezDBus(), QNetworkManagerInterface::QNetworkManagerInterface(), QtBluezDiscoveryManager::QtBluezDiscoveryManager(), QtBluezPeripheralApplication::QtBluezPeripheralApplication(), QNetworkManagerInterface::~QNetworkManagerInterface(), QtBluezDiscoveryManager::~QtBluezDiscoveryManager(), adapterWithDBusPeripheralInterface(), bluetoothdVersion(), QBluetoothSocketPrivateBluezDBus::connectToServiceHelper(), QtBluezPeripheralConnectionManager::disconnectDevices(), QLowEnergyControllerPrivateBluezDBus::discoverServiceDetails(), QLowEnergyControllerPrivateBluezDBus::discoverServices(), findAdapterForAddress(), findRemoteDevicePath(), getPrimaryDevice(), QBluetoothSocketPrivateBluezDBus::localAddress(), QBluetoothSocketPrivateBluezDBus::localName(), nameOfRemoteCentral(), QBluetoothSocketPrivateBluezDBus::peerAddress(), QBluetoothSocketPrivateBluez::peerName(), QBluetoothSocketPrivateBluezDBus::peerName(), Q_GLOBAL_STATIC_WITH_ARGS(), OrgBluezGattCharacteristic1Adaptor::ReadValue(), OrgBluezGattDescriptor1Adaptor::ReadValue(), QtBluezPeripheralApplication::registerApplication(), QtBluezDiscoveryManager::registerDiscoveryInterest(), QtBluezPeripheralGattObject::registerObject(), QLeDBusAdvertiser::Release(), QtBluezPeripheralConnectionManager::remoteDeviceAccessEvent(), QBluetoothLocalDevicePrivate::requestPairing(), QLeDBusAdvertiser::startAdvertising(), QLeDBusAdvertiser::stopAdvertising(), QtBluezPeripheralApplication::unregisterApplication(), QtBluezDiscoveryManager::unregisterDiscoveryInterest(), QtBluezPeripheralGattObject::unregisterObject(), OrgBluezGattCharacteristic1Adaptor::WriteValue(), and OrgBluezGattDescriptor1Adaptor::WriteValue().

Here is the caller graph for this function:

◆ unregisterObject()

void QDBusConnection::unregisterObject	(	const QString &	path,
		UnregisterMode	mode = `UnregisterNode`
	)

Unregisters an object that was registered with the registerObject() at the object path given by path and, if mode is QDBusConnection::UnregisterTree, all of its sub-objects too.

Note that you cannot unregister objects that were not registered with registerObject().

Definition at line 940 of file qdbusconnection.cpp.

References d, QDBusUtil::isValidObjectPath(), and UnregisterObjectAction.

Referenced by QBluetoothSocketPrivateBluezDBus::connectToServiceHelper(), QLeDBusAdvertiser::Release(), QLeDBusAdvertiser::stopAdvertising(), QtBluezPeripheralApplication::unregisterApplication(), QtBluezPeripheralGattObject::unregisterObject(), QDBusMenuConnection::unregisterTrayIcon(), and QDBusMenuConnection::unregisterTrayIconMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unregisterService()

bool QDBusConnection::unregisterService ( const QString & serviceName )

Unregisters the service serviceName that was previously registered with registerService() and returns true if it succeeded.

See also: registerService(), QDBusConnectionInterface::unregisterService()

Definition at line 1108 of file qdbusconnection.cpp.

References d, interface(), and unregisterService().

Referenced by unregisterService().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QDBusConnectionPrivate

friend class QDBusConnectionPrivate

friend

Definition at line 173 of file qdbusconnection.h.

The documentation for this class was generated from the following files:

qtbase/src/dbus/qdbusconnection.h
qtbase/src/dbus/qdbusconnection.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ BusType

◆ ConnectionCapability

◆ RegisterOption

◆ UnregisterMode

◆ VirtualObjectRegisterOption

Constructor & Destructor Documentation

◆ QDBusConnection() [1/4]

◆ QDBusConnection() [2/4]

◆ QDBusConnection() [3/4]

◆ ~QDBusConnection()

◆ QDBusConnection() [4/4]

Member Function Documentation

◆ asyncCall()

◆ baseService()

◆ call()

◆ callWithCallback() [1/2]

◆ callWithCallback() [2/2]

◆ connect() [1/3]

◆ connect() [2/3]

◆ connect() [3/3]

◆ connectionCapabilities()

◆ connectToBus() [1/2]

◆ connectToBus() [2/2]

◆ connectToPeer()

◆ disconnect() [1/3]

◆ disconnect() [2/3]

◆ disconnect() [3/3]

◆ disconnectFromBus()

◆ disconnectFromPeer()

◆ interface()

◆ internalPointer()

◆ isConnected()

◆ lastError()

◆ localMachineId()

◆ name()

◆ objectRegisteredAt()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ registerObject() [1/2]

◆ registerObject() [2/2]

◆ registerService()

◆ registerVirtualObject()

◆ send()

◆ sessionBus()

◆ swap()

◆ systemBus()

◆ unregisterObject()

◆ unregisterService()

Friends And Related Symbol Documentation

◆ QDBusConnectionPrivate