EnTT 3.13.2
|
Sink class. More...
#include <sigh.hpp>
Public Member Functions | |
sink (sigh< Ret(Args...), Allocator > &ref) noexcept | |
Constructs a sink that is allowed to modify a given signal. | |
bool | empty () const noexcept |
Returns false if at least a listener is connected to the sink. | |
template<auto Candidate, typename... Type> | |
connection | connect (Type &&...value_or_instance) |
Connects a free function (with or without payload), a bound or an unbound member to a signal. | |
template<auto Candidate, typename... Type> | |
void | disconnect (Type &&...value_or_instance) |
Disconnects a free function (with or without payload), a bound or an unbound member from a signal. | |
void | disconnect (const void *value_or_instance) |
Disconnects free functions with payload or bound members from a signal. | |
void | disconnect () |
Disconnects all the listeners from a signal. | |
Sink class.
A sink is used to connect listeners to signals and to disconnect them.
The function type for a listener is the one of the signal to which it belongs.
The clear separation between a signal and a sink permits to store the former as private data member without exposing the publish functionality to the users of the class.
Ret | Return type of a function type. |
Args | Types of arguments of a function type. |
Allocator | Type of allocator used to manage memory and elements. |
|
inlinenoexcept |
|
inline |
Connects a free function (with or without payload), a bound or an unbound member to a signal.
Candidate | Function or member to connect to the signal. |
Type | Type of class or type of payload, if any. |
value_or_instance | A valid object that fits the purpose, if any. |
|
inline |
|
inline |
Disconnects a free function (with or without payload), a bound or an unbound member from a signal.
Candidate | Function or member to disconnect from the signal. |
Type | Type of class or type of payload, if any. |
value_or_instance | A valid object that fits the purpose, if any. |
|
inlinenoexcept |