Ikarus::Broadcaster< void(Args...)> Class Template Reference

Implements a Broadcaster for a specific function signature with return type void. More...

#include <ikarus/utils/broadcaster/broadcaster.hh>

Public Types
using	Token = std::shared_ptr< F >

Public Member Functions
Token	registerListener (F f)
	This method is used to register a Listener function. More...
void	unregisterListener (Token &&t)
void	notify (Args... args)
	This calls all the registered functions. More...

Detailed Description

template<typename... Args>
class Ikarus::Broadcaster< void(Args...)>

Template Parameters

Args	the arguments of the signature the Broadcaster can emit.

Member Typedef Documentation

Token

template<typename... Args>

using Ikarus::Broadcaster< void(Args...)>::Token = std::shared_ptr<F>

Member Function Documentation

notify()

template<typename... Args>

void Ikarus::Broadcaster< void(Args...)>::notify ( Args...  args )

inline

registerListener()

template<typename... Args>

Token Ikarus::Broadcaster< void(Args...)>::registerListener ( F  f )

inline

The function that is passed in is first stored in a shared_ptr. After this, the shared_ptr is added to the vector of listener functions, which leads to a implicit conversion to a weak_ptr. The shared_ptr is then returned to the Listener that has called this function to be stored in a vector of shared_ptr<void> listener.hh.

Parameters

target

Returns

Token

unregisterListener()

template<typename... Args>

void Ikarus::Broadcaster< void(Args...)>::unregisterListener ( Token &&  t )

inline

---

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

• broadcaster.hh