qt5base-lts/tests/auto/dbus/qdbusconnection_delayed/tst_qdbusconnection_delayed.cpp

86 lines
2.7 KiB
C++
Raw Normal View History

// Copyright (C) 2016 Intel Corporation.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
Suspend processing of some messages in the default busses by default To retain a bit compatibility with applications developed in the last 9 years that expect that QDBusConnections won't process their events until the event loop runs, we now suspend the handling of incoming messages in the two default buses (and only in them) and resume when the event loop starts. This is required because the new threaded QtDBus would otherwise process incoming messages that the application didn't expect it to. For example, if the application first acquires names on the bus and only after that registers objects with QtDBus, there's a small window in which the name is acquired and visible to other applications, but no objects are registered yet. Calls to those objects may be received, would then be processed in the QDBusConnectionManager thread and fail. The work around is to disable the actual handling of method calls and signals in QDBusConnectionPrivate::handleMessage. Instead, those messages are queued until later. Due to the way that libdbus-1 works, outgoing method calls that are waiting for replies are not affected, since their processing does not happen in handleMessage(). [ChangeLog][Important Behavior Changes] QtDBus now uses threads to implement processing of incoming and outgoing messages. This solves a number of thread safety issues and fixes an architectural problem that would cause all processing to stop if a particular thread (usually the main thread) were blocked in any operation. On the flip side, application developers need to know that modifications to a QDBusConnection may be visible immediately on the connection, so they should be done in an order that won't allow for incomplete states to be observed (for example, first register all objects, then acquire service names). Change-Id: I39cc61d0d59846ab8c23ffff1423c6d555f6ee0a Reviewed-by: David Faure <david.faure@kdab.com>
2015-12-27 13:15:24 +00:00
#include <QTest>
#include <QTestEventLoop>
#include <QDBusConnection>
#include <QDBusConnectionInterface>
Suspend processing of some messages in the default busses by default To retain a bit compatibility with applications developed in the last 9 years that expect that QDBusConnections won't process their events until the event loop runs, we now suspend the handling of incoming messages in the two default buses (and only in them) and resume when the event loop starts. This is required because the new threaded QtDBus would otherwise process incoming messages that the application didn't expect it to. For example, if the application first acquires names on the bus and only after that registers objects with QtDBus, there's a small window in which the name is acquired and visible to other applications, but no objects are registered yet. Calls to those objects may be received, would then be processed in the QDBusConnectionManager thread and fail. The work around is to disable the actual handling of method calls and signals in QDBusConnectionPrivate::handleMessage. Instead, those messages are queued until later. Due to the way that libdbus-1 works, outgoing method calls that are waiting for replies are not affected, since their processing does not happen in handleMessage(). [ChangeLog][Important Behavior Changes] QtDBus now uses threads to implement processing of incoming and outgoing messages. This solves a number of thread safety issues and fixes an architectural problem that would cause all processing to stop if a particular thread (usually the main thread) were blocked in any operation. On the flip side, application developers need to know that modifications to a QDBusConnection may be visible immediately on the connection, so they should be done in an order that won't allow for incomplete states to be observed (for example, first register all objects, then acquire service names). Change-Id: I39cc61d0d59846ab8c23ffff1423c6d555f6ee0a Reviewed-by: David Faure <david.faure@kdab.com>
2015-12-27 13:15:24 +00:00
#ifdef Q_OS_WIN
# include <process.h>
# define getpid _getpid
#else
# include <sys/types.h>
# include <unistd.h>
#endif
class tst_QDBusConnection_Delayed : public QObject
{
Q_OBJECT
private slots:
void delayedMessages();
};
class Foo : public QObject
{
Q_OBJECT
Q_CLASSINFO("D-Bus Interface", "org.qtproject.tst_qdbusconnection_delayed.Foo")
public slots:
int bar() { return 42; }
};
static bool executedOnce = false;
void tst_QDBusConnection_Delayed::delayedMessages()
{
if (executedOnce)
QSKIP("This test can only be executed once");
executedOnce = true;
int argc = 1;
char *argv[] = { const_cast<char *>("tst_qdbusconnection_delayed"), 0 };
QCoreApplication app(argc, argv);
QDBusConnection session = QDBusConnection::sessionBus();
QVERIFY(session.isConnected());
QVERIFY(!session.baseService().isEmpty());
QDBusConnection other = QDBusConnection::connectToBus(QDBusConnection::SessionBus, "other");
QVERIFY(other.isConnected());
QVERIFY(!other.baseService().isEmpty());
// make a method call: those should work even if delivery is disabled
QVERIFY(session.interface()->isServiceRegistered(other.baseService()));
// acquire a name in the main session bus connection: the effect is immediate
Suspend processing of some messages in the default busses by default To retain a bit compatibility with applications developed in the last 9 years that expect that QDBusConnections won't process their events until the event loop runs, we now suspend the handling of incoming messages in the two default buses (and only in them) and resume when the event loop starts. This is required because the new threaded QtDBus would otherwise process incoming messages that the application didn't expect it to. For example, if the application first acquires names on the bus and only after that registers objects with QtDBus, there's a small window in which the name is acquired and visible to other applications, but no objects are registered yet. Calls to those objects may be received, would then be processed in the QDBusConnectionManager thread and fail. The work around is to disable the actual handling of method calls and signals in QDBusConnectionPrivate::handleMessage. Instead, those messages are queued until later. Due to the way that libdbus-1 works, outgoing method calls that are waiting for replies are not affected, since their processing does not happen in handleMessage(). [ChangeLog][Important Behavior Changes] QtDBus now uses threads to implement processing of incoming and outgoing messages. This solves a number of thread safety issues and fixes an architectural problem that would cause all processing to stop if a particular thread (usually the main thread) were blocked in any operation. On the flip side, application developers need to know that modifications to a QDBusConnection may be visible immediately on the connection, so they should be done in an order that won't allow for incomplete states to be observed (for example, first register all objects, then acquire service names). Change-Id: I39cc61d0d59846ab8c23ffff1423c6d555f6ee0a Reviewed-by: David Faure <david.faure@kdab.com>
2015-12-27 13:15:24 +00:00
QString name = "org.qtproject.tst_qdbusconnection_delayed-" +
QString::number(getpid());
QVERIFY(session.registerService(name));
QVERIFY(other.interface()->isServiceRegistered(name));
// make an asynchronous call to a yet-unregistered object
QDBusPendingCallWatcher pending(other.asyncCall(QDBusMessage::createMethodCall(name, "/foo", QString(), "bar")));
// sleep the main thread without running the event loop;
// the call must not be delivered
QTest::qSleep(1000);
QVERIFY(!pending.isFinished());
// now register the object
Foo foo;
session.registerObject("/foo", &foo, QDBusConnection::ExportAllSlots);
connect(&pending, &QDBusPendingCallWatcher::finished,
&QTestEventLoop::instance(), &QTestEventLoop::exitLoop);
QTestEventLoop::instance().enterLoop(2);
QVERIFY(!QTestEventLoop::instance().timeout());
QVERIFY(pending.isFinished());
QVERIFY2(!pending.isError(), pending.error().name().toLatin1());
QVERIFY(!pending.reply().arguments().isEmpty());
QCOMPARE(pending.reply().arguments().at(0), QVariant(42));
}
QTEST_APPLESS_MAIN(tst_QDBusConnection_Delayed)
#include "tst_qdbusconnection_delayed.moc"