Contents

• Public Types
• Properties
• Public Slots
• Signals
• Detailed Description

Detailed Description

TheQDBusConnectionInterface class provides access to the D-Bus bus daemon service.

The D-Bus bus server daemon provides one special interfaceorg.freedesktop.DBus that allows clients to access certain properties of the bus, such as the current list of clients connected. TheQDBusConnectionInterface class provides access to that interface.

The most common uses of this class are to register and unregister service names on the bus using theregisterService() andunregisterService() functions, query about existing names using theisServiceRegistered(),registeredServiceNames() andserviceOwner() functions, and to receive notification that a client has registered or de-registered through theserviceRegistered(),serviceUnregistered() andserviceOwnerChanged() signals.

Member Type Documentation

enum QDBusConnectionInterface::RegisterServiceReply

The possible return values fromregisterService():

TheserviceRegistered() signal will be emitted when the service is acquired by this application.

enum QDBusConnectionInterface::ServiceQueueOptions

Flags for determining how a service registration should behave, in case the service name is already registered.

See alsoServiceReplacementOptions.

enum QDBusConnectionInterface::ServiceReplacementOptions

Flags for determining if the D-Bus server should allow another application to replace a name that this application has registered with theReplaceExistingService option.

The possible values are:

See alsoServiceQueueOptions.

Property Documentation

registeredServiceNames : constQDBusReply<QStringList>

This property holds the registered service names.

Lists all names currently registered on the bus.

Access functions:

Member Function Documentation

[signal]void QDBusConnectionInterface::callWithCallbackFailed(constQDBusError & error, constQDBusMessage & call)

This signal is emitted when there is an error during aQDBusConnection::callWithCallback().error specifies the error.call is the message that couldn't be delivered.

See alsoQDBusConnection::callWithCallback().

[slot]QDBusReply<bool> QDBusConnectionInterface::isServiceRegistered(constQString & serviceName) const

Returns true if the service nameserviceName has is currently registered.

[slot]QDBusReply<QDBusConnectionInterface::RegisterServiceReply> QDBusConnectionInterface::registerService(constQString & serviceName,ServiceQueueOptions qoption = DontQueueService,ServiceReplacementOptions roption = DontAllowReplacement)

Requests to register the service nameserviceName on the bus. Theqoption flag specifies how the D-Bus server should behave ifserviceName is already registered. Theroption flag specifies if the server should allow another application to replace our registered name.

If the service registration succeeds, theserviceRegistered() signal will be emitted. If we are placed in queue, the signal will be emitted when we obtain the name. Ifroption isAllowReplacement, theserviceUnregistered() signal will be emitted if another application replaces this one.

See alsounregisterService().

[slot]QDBusReply<QString> QDBusConnectionInterface::serviceOwner(constQString & name) const

Returns the unique connection name of the primary owner of the namename. If the requested name doesn't have an owner, returns aorg.freedesktop.DBus.Error.NameHasNoOwner error.

[signal]void QDBusConnectionInterface::serviceOwnerChanged(constQString & name, constQString & oldOwner, constQString & newOwner)

This signal is emitted by the D-Bus server whenever a service ownership change happens in the bus, including apparition and disparition of names.

This signal means the applicationoldOwner lost ownership of bus namename to applicationnewOwner. IfoldOwner is an empty string, it means the namename has just been created; ifnewOwner is empty, the namename has no current owner and is no longer available.

Note:connecting to this signal will make the application listen for and receive every single service ownership change on the bus. Depending on how many services are running, this make the application be activated to receive more signals than it needs. To avoid this problem, use theQDBusServiceWatcher class, which can listen for specific changes.

[slot]QDBusReply<uint> QDBusConnectionInterface::servicePid(constQString & serviceName) const

Returns the Unix Process ID (PID) for the process currently holding the bus serviceserviceName.

[signal]void QDBusConnectionInterface::serviceRegistered(constQString & serviceName)

This signal is emitted by the D-Bus server when the bus service name (unique connection name or well-known service name) given byserviceName is acquired by this application.

Acquisition happens after this application has requested a name usingregisterService().

[slot]QDBusReply<uint> QDBusConnectionInterface::serviceUid(constQString & serviceName) const

Returns the Unix User ID (UID) for the process currently holding the bus serviceserviceName.

[signal]void QDBusConnectionInterface::serviceUnregistered(constQString & serviceName)

This signal is emitted by the D-Bus server when this application loses ownership of the bus service name given byserviceName.

[slot]QDBusReply<void> QDBusConnectionInterface::startService(constQString & name)

Requests that the bus start the service given by the namename.

[slot]QDBusReply<bool> QDBusConnectionInterface::unregisterService(constQString & serviceName)

Releases the claim on the bus service nameserviceName, that had been previously registered withregisterService(). If this application had ownership of the name, it will be released for other applications to claim. If it only had the name queued, it gives up its position in the queue.