vanetza::Hook< Args > Class Template Reference

#include <hook.hpp>

Inheritance diagram for vanetza::Hook< Args >:

Public Types
typedef std::function< void(Args...)>	callback_type

Public Member Functions
void	operator= (callback_type &&cb)
void	operator= (const callback_type &cb)
void	operator() (Args... args)
void	reset ()
void	clear ()

Private Attributes
callback_type	m_function

Detailed Description

template<typename... Args>
class vanetza::Hook< Args >

Hook mechanism for realising extension points

Definition at line 14 of file hook.hpp.

Member Typedef Documentation

callback_type

template<typename... Args>

typedef std::function<void(Args...)> vanetza::Hook< Args >::callback_type

Definition at line 17 of file hook.hpp.

Member Function Documentation

clear()

template<typename... Args>

void vanetza::Hook< Args >::clear ( )

inline

Deprecated:

previous name of reset

Definition at line 57 of file hook.hpp.

operator()()

template<typename... Args>

void vanetza::Hook< Args >::operator() ( Args...  args )

inline

Execute hook callback if assigned

Parameters

Args...

various arguments passed to assigned callback

Definition at line 37 of file hook.hpp.

operator=() [1/2]

template<typename... Args>

void vanetza::Hook< Args >::operator= ( callback_type &&  cb )

inline

Assign a callback to hook, replaces previously assigned one

Parameters

cb	A callable used as hook callback, e.g. lambda

Definition at line 23 of file hook.hpp.

operator=() [2/2]

template<typename... Args>

void vanetza::Hook< Args >::operator= ( const callback_type &  cb )

inline

Definition at line 28 of file hook.hpp.

reset()

template<typename... Args>

void vanetza::Hook< Args >::reset ( )

inline

Reset previously assigned callback. No callback will be invoked when triggering hook after reset.

Definition at line 49 of file hook.hpp.

Member Data Documentation

m_function

template<typename... Args>

callback_type vanetza::Hook< Args >::m_function

private

Definition at line 60 of file hook.hpp.

---

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

• vanetza/common/hook.hpp