Class to manage a map of key and its associative signal. More...

Public Member Functions
bool	connectTrackableSlot (ConnectionSharedPtr const &trackable, Key const &key, std::function< void(Args...)> slot)
	Connect a slot to the signal, the slot will be called when the signal is emitted and trackable is still alive.

bool	disconnect (ConnectionPtr trackablePtr, Key const &key)
	Disconnect a slot from the key's associative signal.

void	emit (Key const &key, Args const &... args)
	Emit the signal with the given key and arguments.

Detailed Description

template<Hashable Key, typename Session, typename... Args>
class feed::impl::TrackableSignalMap< Key, Session, Args >

Class to manage a map of key and its associative signal.

Parameters

Key	The type of the key.
Session	The type of the object that will be tracked, when the object is destroyed, the connection will be removed lazily.
Args	The types of the arguments that will be passed to the slot

Member Function Documentation

template<Hashable Key, typename Session , typename... Args>

bool feed::impl::TrackableSignalMap< Key, Session, Args >::connectTrackableSlot	(	ConnectionSharedPtr const &	trackable,
		Key const &	key,
		std::function< void(Args...)>	slot )

inline

Connect a slot to the signal, the slot will be called when the signal is emitted and trackable is still alive.

Parameters

trackable	Track this object's lifttime, if the object is destroyed, the connection will be removed lazily. When the slot is being called, the object is guaranteed to be alive.
key	The key to the signal.
slot	The slot connecting to the signal, the slot will be called when the assocaiative signal is emitted.

Returns: true if the connection is successfully added, false if the connection already exists for the key.

template<Hashable Key, typename Session , typename... Args>

bool feed::impl::TrackableSignalMap< Key, Session, Args >::disconnect	(	ConnectionPtr	trackablePtr,
		Key const &	key )

inline

Disconnect a slot from the key's associative signal.

Parameters

trackablePtr	The pointer to the object that is being tracked.
key	The key to the signal.

Returns: true if the connection is successfully removed, false if the connection does not exist.

template<Hashable Key, typename Session , typename... Args>

void feed::impl::TrackableSignalMap< Key, Session, Args >::emit	(	Key const &	key,
		Args const &...	args )

inline

Emit the signal with the given key and arguments.

Parameters

key	The key to the signal.
args	The arguments to be passed to the slot.

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