Signal::Signal< SignalSignature, Collector > Struct Template Reference

Signal is a template type providing an interface for arbitrary callback lists. A signal type needs to be declared with the function signature of its callbacks, and optionally a return result collector class type. Signal callbacks can be added with operator+= to a signal and removed with operator-=, using a callback connection ID return by operator+= as argument. The callbacks of a signal are invoked with the emit() method and arguments according to the signature. The result returned by emit() depends on the signal collector class. By default, the result of the last callback is returned from emit(). Collectors can be implemented to accumulate callback results or to halt a running emissions in correspondance to callback results. The signal implementation is safe against recursion, so callbacks may be removed and added during a signal emission and recursive emit() calls are also safe. The overhead of an unused signal is intentionally kept very low, around the size of a single pointer. Note that the Signal template types is non-copyable. More...

#include <Signal.hxx>

Inheritance diagram for Signal::Signal< SignalSignature, Collector >:

Collaboration diagram for Signal::Signal< SignalSignature, Collector >:

Public Types
using	ProtoSignal = Lib::ProtoSignal< SignalSignature, Collector >
using	CbFunction = typename ProtoSignal::CbFunction

Public Member Functions
	Signal (const CbFunction &method=CbFunction())
	Signal constructor, supports a default callback as argument. More...

Detailed Description

template<typename SignalSignature, class Collector = Lib::CollectorDefault<typename std::function<SignalSignature>::result_type>>
struct Signal::Signal< SignalSignature, Collector >

Signal is a template type providing an interface for arbitrary callback lists. A signal type needs to be declared with the function signature of its callbacks, and optionally a return result collector class type. Signal callbacks can be added with operator+= to a signal and removed with operator-=, using a callback connection ID return by operator+= as argument. The callbacks of a signal are invoked with the emit() method and arguments according to the signature. The result returned by emit() depends on the signal collector class. By default, the result of the last callback is returned from emit(). Collectors can be implemented to accumulate callback results or to halt a running emissions in correspondance to callback results. The signal implementation is safe against recursion, so callbacks may be removed and added during a signal emission and recursive emit() calls are also safe. The overhead of an unused signal is intentionally kept very low, around the size of a single pointer. Note that the Signal template types is non-copyable.

Definition at line 157 of file Signal.hxx.

Member Typedef Documentation

CbFunction

template<typename SignalSignature , class Collector = Lib::CollectorDefault<typename std::function<SignalSignature>::result_type>>

using Signal::Signal< SignalSignature, Collector >::CbFunction = typename ProtoSignal::CbFunction

Definition at line 160 of file Signal.hxx.

ProtoSignal

template<typename SignalSignature , class Collector = Lib::CollectorDefault<typename std::function<SignalSignature>::result_type>>

using Signal::Signal< SignalSignature, Collector >::ProtoSignal = Lib::ProtoSignal<SignalSignature, Collector>

Definition at line 159 of file Signal.hxx.

Constructor & Destructor Documentation

Signal()

template<typename SignalSignature , class Collector = Lib::CollectorDefault<typename std::function<SignalSignature>::result_type>>

Signal::Signal< SignalSignature, Collector >::Signal ( const CbFunction &  method = CbFunction() )

inline

Signal constructor, supports a default callback as argument.

Definition at line 162 of file Signal.hxx.

: ProtoSignal(method) {}

---

The documentation for this struct was generated from the following file:

• src/util/Signal.hxx