The QDBusMessage class represents one message sent or received over the D-Bus bus. More...

#include <qdbusmessage.h>

Public Types
enum	MessageType { InvalidMessage , MethodCallMessage , ReplyMessage , ErrorMessage , SignalMessage }

Public Member Functions
	QDBusMessage ()

	QDBusMessage (const QDBusMessage &other)

QDBusMessage &	operator= (QDBusMessage &&other) noexcept

QDBusMessage &	operator= (const QDBusMessage &other)

	~QDBusMessage ()

void	swap (QDBusMessage &other) noexcept

QDBusMessage	createReply (const QList< QVariant > &arguments=QList< QVariant >()) const

QDBusMessage	createReply (const QVariant &argument) const

QDBusMessage	createErrorReply (const QString &name, const QString &msg) const

QDBusMessage	createErrorReply (const QDBusError &err) const

QDBusMessage	createErrorReply (QDBusError::ErrorType type, const QString &msg) const

QString	service () const

QString	path () const

QString	interface () const

QString	member () const

QString	errorName () const

QString	errorMessage () const

MessageType	type () const

QString	signature () const

bool	isReplyRequired () const

void	setDelayedReply (bool enable) const

bool	isDelayedReply () const

void	setAutoStartService (bool enable)

bool	autoStartService () const

void	setInteractiveAuthorizationAllowed (bool enable)

bool	isInteractiveAuthorizationAllowed () const

void	setArguments (const QList< QVariant > &arguments)

QList< QVariant >	arguments () const

QDBusMessage &	operator<< (const QVariant &arg)

Static Public Member Functions
static QDBusMessage	createSignal (const QString &path, const QString &interface, const QString &name)

static QDBusMessage	createTargetedSignal (const QString &service, const QString &path, const QString &interface, const QString &name)

static QDBusMessage	createMethodCall (const QString &destination, const QString &path, const QString &interface, const QString &method)

static QDBusMessage	createError (const QString &name, const QString &msg)

static QDBusMessage	createError (const QDBusError &err)

static QDBusMessage	createError (QDBusError::ErrorType type, const QString &msg)

Friends
class	QDBusMessagePrivate

Detailed Description

The QDBusMessage class represents one message sent or received over the D-Bus bus.

\inmodule QtDBus

Since: 4.2

This object can represent any of the four different types of messages (MessageType) that can occur on the bus:

\list

Method calls
Method return values
Signal emissions
Error codes \endlist

Objects of this type are created with the static createError(), createMethodCall() and createSignal() functions. Use the QDBusConnection::send() function to send the messages.

Definition at line 57 of file qdbusmessage.h.

Member Enumeration Documentation

◆ MessageType

enum QDBusMessage::MessageType

The possible message types:

\value MethodCallMessage a message representing an outgoing or incoming method call \value SignalMessage a message representing an outgoing or incoming signal emission \value ReplyMessage a message representing the return values of a method call \value ErrorMessage a message representing an error condition in response to a method call \value InvalidMessage an invalid message: this is never set on messages received from D-Bus

Enumerator
InvalidMessage
MethodCallMessage
ReplyMessage
ErrorMessage
SignalMessage

Definition at line 60 of file qdbusmessage.h.

Constructor & Destructor Documentation

◆ QDBusMessage() [1/2]

QDBusMessage::QDBusMessage ( )

Constructs an empty, invalid QDBusMessage object.

See also: createError(), createMethodCall(), createSignal()

Definition at line 551 of file qdbusmessage.cpp.

Here is the caller graph for this function:

◆ QDBusMessage() [2/2]

QDBusMessage::QDBusMessage ( const QDBusMessage & other )

Constructs a copy of the object given by other.

Note: QDBusMessage objects are shared. Modifications made to the copy will affect the original one as well. See setDelayedReply() for more information.

Definition at line 563 of file qdbusmessage.cpp.

Here is the call graph for this function:

◆ ~QDBusMessage()

QDBusMessage::~QDBusMessage ( )

Disposes of the object and frees any resources that were being held.

Definition at line 572 of file qdbusmessage.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ arguments()

QList< QVariant > QDBusMessage::arguments ( ) const

Returns the list of arguments that are going to be sent or were received from D-Bus.

Definition at line 784 of file qdbusmessage.cpp.

Here is the caller graph for this function:

◆ autoStartService()

bool QDBusMessage::autoStartService ( ) const

Returns the auto start flag, as set by setAutoStartService(). By default, this flag is true, which means Qt D-Bus will auto start a service, if it is not running already.

See also: setAutoStartService()

Since: 4.7

Definition at line 726 of file qdbusmessage.cpp.

◆ createError() [1/3]

QDBusMessage QDBusMessage::createError ( const QDBusError & error )

inlinestatic

Constructs a new DBus message representing the given error.

Definition at line 83 of file qdbusmessage.h.

Here is the call graph for this function:

◆ createError() [2/3]

QDBusMessage QDBusMessage::createError	(	const QString &	name,
		const QString &	msg
	)

static

Constructs a new DBus message representing an error, with the given name and msg.

Definition at line 451 of file qdbusmessage.cpp.

Here is the caller graph for this function:

◆ createError() [3/3]

QDBusMessage QDBusMessage::createError	(	QDBusError::ErrorType	type,
		const QString &	msg
	)

inlinestatic

Constructs a new DBus message for the error type type using the message msg. Returns the DBus message.

Definition at line 85 of file qdbusmessage.h.

Here is the call graph for this function:

◆ createErrorReply() [1/3]

QDBusMessage QDBusMessage::createErrorReply ( const QDBusError & error ) const

inline

Constructs a new DBus message representing an error reply message, from the given error object.

Definition at line 92 of file qdbusmessage.h.

Here is the call graph for this function:

◆ createErrorReply() [2/3]

QDBusMessage QDBusMessage::createErrorReply	(	const QString &	name,
		const QString &	msg
	)		const

Constructs a new DBus message representing an error reply message, with the given name and msg.

Definition at line 501 of file qdbusmessage.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createErrorReply() [3/3]

QDBusMessage QDBusMessage::createErrorReply	(	QDBusError::ErrorType	type,
		const QString &	msg
	)		const

Constructs a new DBus reply message for the error type type using the message msg. Returns the DBus message.

Definition at line 538 of file qdbusmessage.cpp.

Here is the call graph for this function:

◆ createMethodCall()

QDBusMessage QDBusMessage::createMethodCall	(	const QString &	service,
		const QString &	path,
		const QString &	interface,
		const QString &	method
	)

static

Constructs a new DBus message representing a method call. A method call always informs its destination address (service, path, interface and method).

The DBus bus allows calling a method on a given remote object without specifying the destination interface, if the method name is unique. However, if two interfaces on the remote object export the same method name, the result is undefined (one of the two may be called or an error may be returned).

When using DBus in a peer-to-peer context (i.e., not on a bus), the service parameter is optional.

The QDBusInterface class provides a simpler abstraction to synchronous method calling.

This function returns a QDBusMessage object that can be sent with QDBusConnection::call().

Definition at line 434 of file qdbusmessage.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createReply() [1/2]

QDBusMessage QDBusMessage::createReply ( const QList< QVariant > & arguments = QList<QVariant>() ) const

Constructs a new DBus message representing a reply, with the given arguments.

Definition at line 480 of file qdbusmessage.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createReply() [2/2]

QDBusMessage QDBusMessage::createReply ( const QVariant & argument ) const

Constructs a new DBus message representing a reply, with the given argument.

Definition at line 520 of file qdbusmessage.cpp.

Here is the call graph for this function:

◆ createSignal()

QDBusMessage QDBusMessage::createSignal	(	const QString &	path,
		const QString &	interface,
		const QString &	name
	)

static

Constructs a new DBus message with the given path, interface and name, representing a signal emission.

A DBus signal is emitted from one application and is received by all applications that are listening for that signal from that interface.

The QDBusMessage object that is returned can be sent using the QDBusConnection::send() function.

Definition at line 378 of file qdbusmessage.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createTargetedSignal()

QDBusMessage QDBusMessage::createTargetedSignal	(	const QString &	service,
		const QString &	path,
		const QString &	interface,
		const QString &	name
	)

static

Since: 5.6

Constructs a new DBus message with the given path, interface and name, representing a signal emission to a specific destination.

A DBus signal is emitted from one application and is received only by the application owning the destination service name.

The QDBusMessage object that is returned can be sent using the QDBusConnection::send() function.

Definition at line 402 of file qdbusmessage.cpp.

Here is the call graph for this function:

◆ errorMessage()

QString QDBusMessage::errorMessage ( ) const

Since: 4.3 Returns the human-readable message associated with the error that was received.

Definition at line 93 of file qdbusmessage.cpp.

Here is the call graph for this function:

◆ errorName()

QString QDBusMessage::errorName ( ) const

Returns the name of the error that was received.

Definition at line 630 of file qdbusmessage.cpp.

◆ interface()

QString QDBusMessage::interface ( ) const

Returns the interface of the method being called (in the case of a method call) or of the signal being received from.

Definition at line 612 of file qdbusmessage.cpp.

Here is the caller graph for this function:

◆ isDelayedReply()

bool QDBusMessage::isDelayedReply ( ) const

Returns the delayed reply flag, as set by setDelayedReply(). By default, this flag is false, which means Qt D-Bus will generate automatic replies when necessary.

Definition at line 687 of file qdbusmessage.cpp.

Here is the caller graph for this function:

◆ isInteractiveAuthorizationAllowed()

bool QDBusMessage::isInteractiveAuthorizationAllowed ( ) const

Returns the interactive authorization allowed flag, as set by setInteractiveAuthorizationAllowed(). By default this flag is false and the other end is expected to make any authorization decisions non-interactively and promptly.

See also: setInteractiveAuthorizationAllowed()

Since: 5.12

Definition at line 764 of file qdbusmessage.cpp.

◆ isReplyRequired()

bool QDBusMessage::isReplyRequired ( ) const

Returns the flag that indicates if this message should see a reply or not. This is only meaningful for \l {MethodCallMessage}{method call messages}: any other kind of message cannot have replies and this function will always return false for them.

Definition at line 652 of file qdbusmessage.cpp.

◆ member()

QString QDBusMessage::member ( ) const

Returns the name of the signal that was emitted or the name of the method that was called.

Definition at line 620 of file qdbusmessage.cpp.

◆ operator<<()

QDBusMessage & QDBusMessage::operator<< ( const QVariant & arg )

Appends the argument arg to the list of arguments to be sent over D-Bus in a method call or signal emission.

Definition at line 794 of file qdbusmessage.cpp.

Here is the call graph for this function:

◆ operator=() [1/2]

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

Copies the contents of the object given by other.

Note: QDBusMessage objects are shared. Modifications made to the copy will affect the original one as well. See setDelayedReply() for more information.

Definition at line 585 of file qdbusmessage.cpp.

Here is the call graph for this function:

◆ operator=() [2/2]

QDBusMessage& QDBusMessage::operator= ( QDBusMessage && other )

inlinenoexcept

Definition at line 70 of file qdbusmessage.h.

Here is the call graph for this function:

◆ path()

QString QDBusMessage::path ( ) const

Returns the path of the object that this message is being sent to (in the case of a method call) or being received from (for a signal).

Definition at line 603 of file qdbusmessage.cpp.

Here is the caller graph for this function:

◆ service()

QString QDBusMessage::service ( ) const

Returns the name of the service or the bus address of the remote method call.

Definition at line 594 of file qdbusmessage.cpp.

Here is the caller graph for this function:

◆ setArguments()

void QDBusMessage::setArguments ( const QList< QVariant > & arguments )

Sets the arguments that are going to be sent over D-Bus to arguments. Those will be the arguments to a method call or the parameters in the signal.

See also: arguments()

Definition at line 775 of file qdbusmessage.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAutoStartService()

void QDBusMessage::setAutoStartService ( bool enable )

Sets the auto start flag to enable. This flag only makes sense for method call messages, where it tells the D-Bus server to either auto start the service responsible for the service name, or not to auto start it.

By default this flag is true, i.e. a service is autostarted. This means:

When the service that this method call is sent to is already running, the method call is sent to it. If the service is not running yet, the D-Bus daemon is requested to autostart the service that is assigned to this service name. This is handled by .service files that are placed in a directory known to the D-Bus server. These files then each contain a service name and the path to a program that should be executed when this service name is requested.

Since: 4.7

Definition at line 712 of file qdbusmessage.cpp.

◆ setDelayedReply()

void QDBusMessage::setDelayedReply ( bool enable ) const

Sets whether the message will be replied later (if enable is true) or if an automatic reply should be generated by Qt D-Bus (if enable is false).

In D-Bus, all method calls must generate a reply to the caller, unless the caller explicitly indicates otherwise (see isReplyRequired()). QtDBus automatically generates such replies for any slots being called, but it also allows slots to indicate whether they will take responsibility of sending the reply at a later time, after the function has finished processing.

See also: {Delayed Replies}

Definition at line 677 of file qdbusmessage.cpp.

Here is the caller graph for this function:

◆ setInteractiveAuthorizationAllowed()

void QDBusMessage::setInteractiveAuthorizationAllowed ( bool enable )

Sets the interactive authorization flag to enable. This flag only makes sense for method call messages, where it tells the D-Bus server that the caller of the method is prepared to wait for interactive authorization to take place (for instance via Polkit) before the actual method is processed.

By default this flag is false and the other end is expected to make any authorization decisions non-interactively and promptly.

The org.freedesktop.DBus.Error.InteractiveAuthorizationRequired error indicates that authorization failed, but could have succeeded if this flag had been set.

See also: isInteractiveAuthorizationAllowed()

Since: 5.12

Definition at line 749 of file qdbusmessage.cpp.

◆ signature()

QString QDBusMessage::signature ( ) const

Returns the signature of the signal that was received or for the output arguments of a method call.

Definition at line 641 of file qdbusmessage.cpp.

Here is the caller graph for this function:

◆ swap()

void QDBusMessage::swap ( QDBusMessage & other )

inlinenoexcept

Swaps this QDBusMessage instance with other.

Definition at line 74 of file qdbusmessage.h.

Here is the call graph for this function:

◆ type()

QDBusMessage::MessageType QDBusMessage::type ( ) const

Returns the message type.

Definition at line 803 of file qdbusmessage.cpp.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ QDBusMessagePrivate

friend class QDBusMessagePrivate

friend

Definition at line 123 of file qdbusmessage.h.

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

src/dbus/qdbusmessage.h
src/dbus/qdbusmessage.cpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ MessageType

Constructor & Destructor Documentation

◆ QDBusMessage() [1/2]

◆ QDBusMessage() [2/2]

◆ ~QDBusMessage()

Member Function Documentation

◆ arguments()

◆ autoStartService()

◆ createError() [1/3]

◆ createError() [2/3]

◆ createError() [3/3]

◆ createErrorReply() [1/3]

◆ createErrorReply() [2/3]

◆ createErrorReply() [3/3]

◆ createMethodCall()

◆ createReply() [1/2]

◆ createReply() [2/2]

◆ createSignal()

◆ createTargetedSignal()

◆ errorMessage()

◆ errorName()

◆ interface()

◆ isDelayedReply()

◆ isInteractiveAuthorizationAllowed()

◆ isReplyRequired()

◆ member()

◆ operator<<()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ path()

◆ service()

◆ setArguments()

◆ setAutoStartService()

◆ setDelayedReply()

◆ setInteractiveAuthorizationAllowed()

◆ signature()

◆ swap()

◆ type()

Friends And Related Function Documentation

◆ QDBusMessagePrivate