Template Class Signal< void, Capacity >
Defined in File signal.hpp
Class Documentation
-
template<unsigned int Capacity>
class Signal<void, Capacity> Specialisation of the signal for data-less sigslots.
Specialises the signal class for use with void callbacks. In this situation, it is purely a signaller, nothing else.
- Template Parameters:
Capacity – : the number of slot connections to reserve.
Public Functions
-
inline Signal()
Initialise the storage.
-
inline sigslots::Error connect(sigslots::SlotBase<void> &slot)
Connect the signal to the specified slot.
This will attach the slot (note that it is a permanent attachment) so long as the reserved capacity isn’t already fully utilised.
Valid return values:
NoError
OutOfResourcesError
- Parameters:
slot – : the slot to connect.
- Returns:
Error : the sigslots error
-
inline unsigned int capacity() const
The reserved capacity for this signaller.
- Returns:
unsigned int : the capacity.
-
inline unsigned int stored() const
The current number of connections stored.
- Returns:
unsigned int : no. of connections.