Qt Signal Slot Cross Thread
Posted By admin On 04/04/22The QThread::run method only spins (exec in Qt parlance) an event loop (of course it won't do it anymore if your reimplementation doesn't). An event loop waits for events to arrive in the queue, and then notifies the target QObjects of their reception. The cross-thread (queued) signal-slot connections are implemented by leveraging events. Connecting in Qt 5. There are several ways to connect a signal in Qt 5. Qt 5 continues to support the old string-based syntax for connecting signals and slots defined in a QObject or any class that inherits from QObject (including QWidget). Connect( sender, SIGNAL( valueChanged( QString, QString ) ), receiver, SLOT( updateValue( QString ) ) ).
how in BOOST send a signal in a thread and have the corresponding slot executed in another thread?
boost::signals2::signal
boost signal handler
boost signal multi-threaded
boost multithreading
In Qt for instance if you emit a signal in a thread other that the GUI thread, the signal is enqueued and executed later in the GUI thread, is there a way to do that with boost?
thanks
For an event loop use boost::asio::io_service. You can post tasks inside this object and have another thread execute them, in a thread safe way:
Messaging and Signaling in C++, But as this blog post is more on signaling then system events. Qt signal/slot implementation is thread safe, so that you can use it to send messages important, as anything UI related should run in the main thread of Qt, anything that I use this in a different program to have one widget for editing flag like Almost all classes provided by Boost.Signals2 are thread safe and can be used in multithreaded applications. For example, objects of type boost::signals2::signal and boost::signals2::connection can be accessed from different threads. On the other hand, boost::signals2::shared_connection_block is not thread safe.
Not directly, because boost does not provide an event loop.
To have a signal handled in another thread, that another thread needs to be checking the queue of handlers it should run and execute them (which usually means some kind of event-loop). Boost does not provide one, so you'll need to get it from elsewhere or write it.
If you have an event-loop, that does not provide signals, (or implement some simple solution with queues) you should be able to (ab)use boost.signals2 (not boost.signals, because that version is not thread-safe) by overriding the operator+=
to wrap each handler in something, that will queue it for execution in the other thread. You might even be able to implement it for signals with return values (which is not supported by Qt, but is supported by boost), but you'll have to be careful to avoid dead-lock.
[PDF] Boost.Signals2, Signals2 library is an implementation of a managed signals and slots system. This documentation describes a thread-safe variant of the original Boost. so we put 'Hello' into a group that must be executed before the group possible to set up tracking in a post-constructor which is called after the object has been created To have a signal handled in another thread, that another thread needs to be checking the queue of handlers it should run and execute them (which usually means some kind of event-loop). Boost does not provide one, so you'll need to get it from elsewhere or write it.
Signals & Slots, Signals and slots are made possible by Qt's meta-object system. to one signal, the slots will be executed one after the other, in the order they have valueChanged() , and it has a slot which other objects can send signals to. The context object provides information about in which thread the receiver should be executed. Special behavior for C++: If a thread is sent a signal using pthread_kill() and that thread does not handle the signal, then destructors for local objects may not be executed. Usage notes. The SIGTHSTOP and SIGTHCONT signals can be issued by this function. pthread_kill() is the only function that can issue SIGTHSTOP or SIGTHCONT. Returned value
Chila's answer is correct, but it's missing one important thing:A boost::thread
object will only call the function its passed once. Since the boost::io_service
has no work to do until the signal is emitted, the thread will finish immediately. To counter this there is a boost::asio::io_service::work
class.Before you call the run()
method of the io_service
you should create a work object and pass it the io_service
:
Note: At the time of writing (boost 1.67) this method is already deprecated and you are supposed to use io_context::executor_work_guard
(basically same functionality as io_service::work
). I was not able to compile when using the new method though, and the work solution is still working in boost 1.67.
Slots, It also implements a few conditional (event) related classes. Qt - SigSlot - Boost Libraries Qt was the original signal/slots implementation, but it Sigslot and Boost on the other hand are pure ISO C++, but both have some disadvantages. None of these are thread-safe and it can be somewhat inconvenient manually Qt documentation states that signals and slots can be direct, queued and auto. It also stated that if object that owns slot 'lives' in a thread different from object that owns signal, emitting such signal will be like posting message - signal emit will return instantly and slot method will be called in target thread's event loop.
For some reason, the assignment operator of boost::asio::executor_work_guard<boost::asio::io_context::executor_type>
is deleted, but you still can construct it.
Here's my version of the code that posts some movable Event
object and processes it on the thread running io_context::run()
:
It requires C++14 and was tested with VS2017 and GCC 6.4 with thread & memory sanitizers.
Observer pattern with Stl, boost and qt, A comparison between the Qt signal and slot mechanism and some Each slot is a potential callback ○ Adds more run-time introspection, The Synapse library ○ Another signals/slot like library ○ Submitted to Very similar to boost::signals2 ○ Have the ability to transfer control between threads 29; 30. So, when the thread is created from the create_thread method it will call the io_service::run method and it passes the io_service object as an argument. Typically one io_service object can be used with multiple socket objects.
QThreads: Are You Using Them Wrong?, Show related SlideShares at end The Basics of QThread QThread manages one thread of execution ○ The Signal Slot Connections and Threads ○ Qt::DirectConnection have same thread affinity: Direct ○ If objects have different thread It implies you want to send cross-thread signals to yourself. Direct Connection The slot is invoked immediately, when the signal is emitted. The slot is executed in the emitter's thread, which is not necessarily the receiver's thread. Queued Connection The slot is invoked when control returns to the event loop of the receiver's thread. The slot is executed in the receiver's thread.
What do I do if a slot is not invoked?, A practical checklist to debug your signal/slot connections that an event loop is running in the thread the receiver has affinity with;; that all the arguments Using this signal is very easy – it just acts like a flag, but you can wait for it as well as read it. The following unit test (also in GitHub) shows how the signal makes it easy for threads to set gates on each other. Note that the final signal in this example could have been done with thread.join(), but wasn’t for the purposes of the test.
[Boost-users] Signals2 benchmark, I want to test it against boost::signals2 to get an idea of how well it performs. Suppose one thread disconnects a slot while another fires a signal Each Signal-type has its own corresponding vector of slots defined within the Emitter. the copy being made instead of every slot being called and executed. POSIX requires that signal is thread-safe, and specifies a list of async-signal-safe library functions that may be called from any signal handler. Signal handlers are expected to have C linkage and, in general, only use the features from the common subset of C and C++. It is implementation-defined if a function with C++ linkage can be used as a
Comments
- THX for this very helpfull sample ! Since boost::signal is deprecated I have to use boost::signals2::signal<>.
Hot Questions
Signals and slots are used for communication between objects. The signals and slots mechanism is a central feature of Qt and probably the part that differs most from the features provided by other frameworks. Signals and slots are made possible by Qt's meta-object system.
Introduction
In GUI programming, when we change one widget, we often want another widget to be notified. More generally, we want objects of any kind to be able to communicate with one another. For example, if a user clicks a Close button, we probably want the window's close() function to be called.
Other toolkits achieve this kind of communication using callbacks. A callback is a pointer to a function, so if you want a processing function to notify you about some event you pass a pointer to another function (the callback) to the processing function. The processing function then calls the callback when appropriate. While successful frameworks using this method do exist, callbacks can be unintuitive and may suffer from problems in ensuring the type-correctness of callback arguments.
Signals and Slots
In Qt, we have an alternative to the callback technique: We use signals and slots. A signal is emitted when a particular event occurs. Qt's widgets have many predefined signals, but we can always subclass widgets to add our own signals to them. A slot is a function that is called in response to a particular signal. Qt's widgets have many pre-defined slots, but it is common practice to subclass widgets and add your own slots so that you can handle the signals that you are interested in.
The signals and slots mechanism is type safe: The signature of a signal must match the signature of the receiving slot. (In fact a slot may have a shorter signature than the signal it receives because it can ignore extra arguments.) Since the signatures are compatible, the compiler can help us detect type mismatches when using the function pointer-based syntax. The string-based SIGNAL and SLOT syntax will detect type mismatches at runtime. Signals and slots are loosely coupled: A class which emits a signal neither knows nor cares which slots receive the signal. Qt's signals and slots mechanism ensures that if you connect a signal to a slot, the slot will be called with the signal's parameters at the right time. Signals and slots can take any number of arguments of any type. They are completely type safe.
All classes that inherit from QObject or one of its subclasses (e.g., QWidget) can contain signals and slots. Signals are emitted by objects when they change their state in a way that may be interesting to other objects. This is all the object does to communicate. It does not know or care whether anything is receiving the signals it emits. This is true information encapsulation, and ensures that the object can be used as a software component.
Slots can be used for receiving signals, but they are also normal member functions. Just as an object does not know if anything receives its signals, a slot does not know if it has any signals connected to it. This ensures that truly independent components can be created with Qt.
You can connect as many signals as you want to a single slot, and a signal can be connected to as many slots as you need. It is even possible to connect a signal directly to another signal. (This will emit the second signal immediately whenever the first is emitted.)
Together, signals and slots make up a powerful component programming mechanism.
Signals
Signals are emitted by an object when its internal state has changed in some way that might be interesting to the object's client or owner. Signals are public access functions and can be emitted from anywhere, but we recommend to only emit them from the class that defines the signal and its subclasses.
When a signal is emitted, the slots connected to it are usually executed immediately, just like a normal function call. When this happens, the signals and slots mechanism is totally independent of any GUI event loop. Execution of the code following the emit
statement will occur once all slots have returned. The situation is slightly different when using queued connections; in such a case, the code following the emit
keyword will continue immediately, and the slots will be executed later.
If several slots are connected to one signal, the slots will be executed one after the other, in the order they have been connected, when the signal is emitted.
Signals are automatically generated by the moc and must not be implemented in the .cpp
file. They can never have return types (i.e. use void
).
A note about arguments: Our experience shows that signals and slots are more reusable if they do not use special types. If QScrollBar::valueChanged() were to use a special type such as the hypothetical QScrollBar::Range, it could only be connected to slots designed specifically for QScrollBar. Connecting different input widgets together would be impossible.
Slots
A slot is called when a signal connected to it is emitted. Slots are normal C++ functions and can be called normally; their only special feature is that signals can be connected to them.
Since slots are normal member functions, they follow the normal C++ rules when called directly. However, as slots, they can be invoked by any component, regardless of its access level, via a signal-slot connection. This means that a signal emitted from an instance of an arbitrary class can cause a private slot to be invoked in an instance of an unrelated class.
You can also define slots to be virtual, which we have found quite useful in practice.
Compared to callbacks, signals and slots are slightly slower because of the increased flexibility they provide, although the difference for real applications is insignificant. In general, emitting a signal that is connected to some slots, is approximately ten times slower than calling the receivers directly, with non-virtual function calls. This is the overhead required to locate the connection object, to safely iterate over all connections (i.e. checking that subsequent receivers have not been destroyed during the emission), and to marshall any parameters in a generic fashion. While ten non-virtual function calls may sound like a lot, it's much less overhead than any new
or delete
operation, for example. As soon as you perform a string, vector or list operation that behind the scene requires new
or delete
, the signals and slots overhead is only responsible for a very small proportion of the complete function call costs. The same is true whenever you do a system call in a slot; or indirectly call more than ten functions. The simplicity and flexibility of the signals and slots mechanism is well worth the overhead, which your users won't even notice.
Note that other libraries that define variables called signals
or slots
may cause compiler warnings and errors when compiled alongside a Qt-based application. To solve this problem, #undef
the offending preprocessor symbol.
A Small Example
A minimal C++ class declaration might read:
A small QObject-based class might read:
The QObject-based version has the same internal state, and provides public methods to access the state, but in addition it has support for component programming using signals and slots. This class can tell the outside world that its state has changed by emitting a signal, valueChanged()
, and it has a slot which other objects can send signals to.
All classes that contain signals or slots must mention Q_OBJECT at the top of their declaration. They must also derive (directly or indirectly) from QObject.
Slots are implemented by the application programmer. Here is a possible implementation of the Counter::setValue()
slot:
The emit
line emits the signal valueChanged()
from the object, with the new value as argument.
In the following code snippet, we create two Counter
objects and connect the first object's valueChanged()
signal to the second object's setValue()
slot using QObject::connect():
Calling a.setValue(12)
makes a
emit a valueChanged(12)
signal, which b
will receive in its setValue()
slot, i.e. b.setValue(12)
is called. Then b
emits the same valueChanged()
signal, but since no slot has been connected to b
's valueChanged()
signal, the signal is ignored.
Note that the setValue()
function sets the value and emits the signal only if value != m_value
. This prevents infinite looping in the case of cyclic connections (e.g., if b.valueChanged()
were connected to a.setValue()
).
By default, for every connection you make, a signal is emitted; two signals are emitted for duplicate connections. You can break all of these connections with a single disconnect() call. If you pass the Qt::UniqueConnectiontype, the connection will only be made if it is not a duplicate. If there is already a duplicate (exact same signal to the exact same slot on the same objects), the connection will fail and connect will return false
.
This example illustrates that objects can work together without needing to know any information about each other. To enable this, the objects only need to be connected together, and this can be achieved with some simple QObject::connect() function calls, or with uic's automatic connections feature.
A Real Example
The following is an example of the header of a simple widget class without member functions. The purpose is to show how you can utilize signals and slots in your own applications.
LcdNumber
inherits QObject, which has most of the signal-slot knowledge, via QFrame and QWidget. It is somewhat similar to the built-in QLCDNumber widget.
The Q_OBJECT macro is expanded by the preprocessor to declare several member functions that are implemented by the moc
; if you get compiler errors along the lines of 'undefined reference to vtable for LcdNumber
', you have probably forgotten to run the moc or to include the moc output in the link command.
Qt Signal Slot Performance
After the class constructor and public
members, we declare the class signals
. The LcdNumber
class emits a signal, overflow()
, when it is asked to show an impossible value.
If you don't care about overflow, or you know that overflow cannot occur, you can ignore the overflow()
signal, i.e. don't connect it to any slot.
If on the other hand you want to call two different error functions when the number overflows, simply connect the signal to two different slots. Qt will call both (in the order they were connected).
A slot is a receiving function used to get information about state changes in other widgets. LcdNumber
uses it, as the code above indicates, to set the displayed number. Since display()
is part of the class's interface with the rest of the program, the slot is public.
Several of the example programs connect the valueChanged() signal of a QScrollBar to the display()
slot, so the LCD number continuously shows the value of the scroll bar.
Note that display()
is overloaded; Qt will select the appropriate version when you connect a signal to the slot. With callbacks, you'd have to find five different names and keep track of the types yourself.
Signals And Slots With Default Arguments
The signatures of signals and slots may contain arguments, and the arguments can have default values. Consider QObject::destroyed():
When a QObject is deleted, it emits this QObject::destroyed() signal. We want to catch this signal, wherever we might have a dangling reference to the deleted QObject, so we can clean it up. A suitable slot signature might be:
To connect the signal to the slot, we use QObject::connect(). There are several ways to connect signal and slots. The first is to use function pointers:
There are several advantages to using QObject::connect() with function pointers. First, it allows the compiler to check that the signal's arguments are compatible with the slot's arguments. Arguments can also be implicitly converted by the compiler, if needed.
You can also connect to functors or C++11 lambdas:
In both these cases, we provide this as context in the call to connect(). The context object provides information about in which thread the receiver should be executed. This is important, as providing the context ensures that the receiver is executed in the context thread.
The lambda will be disconnected when the sender or context is destroyed. You should take care that any objects used inside the functor are still alive when the signal is emitted.
The other way to connect a signal to a slot is to use QObject::connect() and the SIGNAL
and SLOT
macros. The rule about whether to include arguments or not in the SIGNAL()
and SLOT()
macros, if the arguments have default values, is that the signature passed to the SIGNAL()
macro must not have fewer arguments than the signature passed to the SLOT()
macro.
All of these would work:
But this one won't work:
...because the slot will be expecting a QObject that the signal will not send. This connection will report a runtime error.
Note that signal and slot arguments are not checked by the compiler when using this QObject::connect() overload.
Advanced Signals and Slots Usage
For cases where you may require information on the sender of the signal, Qt provides the QObject::sender() function, which returns a pointer to the object that sent the signal.
Lambda expressions are a convenient way to pass custom arguments to a slot:
Using Qt with 3rd Party Signals and Slots
It is possible to use Qt with a 3rd party signal/slot mechanism. You can even use both mechanisms in the same project. Just add the following line to your qmake project (.pro) file.
It tells Qt not to define the moc keywords signals
, slots
, and emit
, because these names will be used by a 3rd party library, e.g. Boost. Then to continue using Qt signals and slots with the no_keywords
flag, simply replace all uses of the Qt moc keywords in your sources with the corresponding Qt macros Q_SIGNALS (or Q_SIGNAL), Q_SLOTS (or Q_SLOT), and Q_EMIT.
Qt Signal Slot Cross Threads
See also QLCDNumber, QObject::connect(), Digital Clock Example, Tetrix Example, Meta-Object System, and Qt's Property System.
Qt Connect Signal Slot
© 2020 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.