kouta::base::callback::DirectCallback< TArgs > Class Template Reference

Direct Callback implementation. More...

#include <direct-callback.hpp>

Inheritance diagram for kouta::base::callback::DirectCallback< TArgs >:

Collaboration diagram for kouta::base::callback::DirectCallback< TArgs >:

Public Types
using	Callable = typename BaseCallback< TArgs... >::Callable
	The type of the callable the Callback points to.
Public Types inherited from kouta::base::callback::BaseCallback< TArgs... >
using	Callable = std::function< void(TArgs...)>
	The type of the callable the Callback points to.

Public Member Functions
	DirectCallback (const DirectCallback &)=default
DirectCallback &	operator= (const DirectCallback &)=default
	DirectCallback (DirectCallback &&)=default
DirectCallback &	operator= (DirectCallback &&)=default
	~DirectCallback () override=default
template<class TClass >
	DirectCallback (TClass *object, void(TClass::*method)(TArgs...))
	Callback constructor from a bound method.
	DirectCallback (const DirectCallback::Callable &callable)
	Callback constructor from a callable.
	DirectCallback (DirectCallback::Callable &&callable)
	Callback constructor from a callable.
Public Member Functions inherited from kouta::base::callback::BaseCallback< TArgs... >
	BaseCallback ()=default
	Default constructor.
	BaseCallback (const BaseCallback &)=default
	BaseCallback (BaseCallback &&)=default
BaseCallback &	operator= (const BaseCallback &)=default
BaseCallback &	operator= (BaseCallback &&)=default
virtual	~BaseCallback ()=default
void	operator() (TArgs... args) const
	Invoke the underlying callable.

Additional Inherited Members
Protected Member Functions inherited from kouta::base::callback::BaseCallback< TArgs... >
void	set_callable (const Callable &callable)
	Set the callable.
void	set_callable (Callable &&callable)
	Set the callable.

Detailed Description

template<class... TArgs>
class kouta::base::callback::DirectCallback< TArgs >

Direct Callback implementation.

A direct Callback wraps a callable that is invoked within the caller's thread, making it no different to a direct invokation of a specific function or method.

The lifetime of the object the Callback points to must be guaranteed to surpass that of the Callback itself.

Template Parameters

TArgs

Callable arguments.

Member Typedef Documentation

Callable

template<class... TArgs>

using kouta::base::callback::DirectCallback< TArgs >::Callable = typename BaseCallback<TArgs...>::Callable

The type of the callable the Callback points to.

Constructor & Destructor Documentation

DirectCallback() [1/5]

template<class... TArgs>

kouta::base::callback::DirectCallback< TArgs >::DirectCallback ( const DirectCallback< TArgs > &  )

default

DirectCallback() [2/5]

template<class... TArgs>

kouta::base::callback::DirectCallback< TArgs >::DirectCallback ( DirectCallback< TArgs > &&  )

default

~DirectCallback()

template<class... TArgs>

kouta::base::callback::DirectCallback< TArgs >::~DirectCallback ( )

overridedefault

DirectCallback() [3/5]

template<class... TArgs>

template<class TClass >

kouta::base::callback::DirectCallback< TArgs >::DirectCallback ( TClass *  object, void(TClass::*)(TArgs...)  method  )

inline

Callback constructor from a bound method.

This constructor initializes the internal callable with a pointer to the specified bound method. The developer must guarantee the lifetime of the object to prevent invalid memory access.

Template Parameters

TClass

Object type.

Parameters

[in]	object	Pointer to the object whose method is going to be called.
[in]	method	Pointer to the method that is going to be called. The arguments of the Callback must match those of this method.

DirectCallback() [4/5]

template<class... TArgs>

kouta::base::callback::DirectCallback< TArgs >::DirectCallback ( const DirectCallback< TArgs >::Callable &  callable )

inlineexplicit

Callback constructor from a callable.

This constructor initializes the internal callable to the one specified in callable , so that it is invoked from within the current context (i.e. as a regular function).

Parameters

[in]

callable

Callable to store. For instance, this could be a lambda or anything convertible to std::function.

DirectCallback() [5/5]

template<class... TArgs>

kouta::base::callback::DirectCallback< TArgs >::DirectCallback ( DirectCallback< TArgs >::Callable &&  callable )

inlineexplicit

Callback constructor from a callable.

This constructor initializes the internal callable to the one specified in callable , so that it is invoked from within the current context (i.e. as a regular function).

Parameters

[in]

callable

Callable to store. For instance, this could be a lambda or anything convertible to std::function.

Member Function Documentation

operator=() [1/2]

template<class... TArgs>

DirectCallback & kouta::base::callback::DirectCallback< TArgs >::operator= ( const DirectCallback< TArgs > &  )

default

operator=() [2/2]

template<class... TArgs>

DirectCallback & kouta::base::callback::DirectCallback< TArgs >::operator= ( DirectCallback< TArgs > &&  )

default

---

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

• include/kouta/base/callback/direct-callback.hpp