feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Add some more comments

Browse Source 
Add some developer comments explaining which method
is designed to be called from a certain thread.
Add also some comments about in which thread
certain QObjects live in.

Change-Id: I38b10216cc29f8a86fd784e588e913407f0fb776
Reviewed-by: hjk <hjk@qt.io>
This commit is contained in:
Jarek Kobus
2021-08-18 10:45:57 +02:00
parent fd6ab7ddab
commit a7e8ddd725
4 changed files with 44 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src/libs/utils/launchersocket.cpp
View File

@@ -39,9 +39,10 @@ class CallerHandle : public QObject
{
Q_OBJECT
public:
// Called from caller's thread exclusively, lives in caller's thread.
CallerHandle() : QObject() {}
// Always called in caller's thread. Returns the list of flushed signals.
// Called from caller's thread exclusively. Returns the list of flushed signals.
QList<LauncherHandle::SignalType> flush()
{
QList<LauncherHandle::SignalType> oldSignals;
@@ -70,17 +71,7 @@ public:
}
return oldSignals;
}
void appendSignal(LauncherHandle::SignalType signalType)
{
if (signalType == LauncherHandle::SignalType::NoSignal)
return;
QMutexLocker locker(&m_mutex);
if (m_signals.contains(signalType))
return;
m_signals.append(signalType);
}
// Called from caller's thread exclusively.
bool shouldFlushFor(LauncherHandle::SignalType signalType)
{
// TODO: Should we always flush when the list isn't empty?
@@ -93,7 +84,20 @@ public:
return true;
return false;
}
// Called from launcher's thread exclusively.
void appendSignal(LauncherHandle::SignalType signalType)
{
if (signalType == LauncherHandle::SignalType::NoSignal)
return;
QMutexLocker locker(&m_mutex);
if (m_signals.contains(signalType))
return;
m_signals.append(signalType);
}
signals:
// Emitted from caller's thread exclusively.
void errorOccurred();
void started();
void readyRead();
@@ -485,7 +489,7 @@ void LauncherSocket::sendData(const QByteArray &data)
return m_requests.size() == 1; // Returns true if requests handling should be triggered.
};
if (storeRequest(data))
if (storeRequest(data)) // Call handleRequests() in launcher's thread.
QMetaObject::invokeMethod(this, &LauncherSocket::handleRequests);
}