forked
Callback< R()> Class Template Reference
[Platform]
Callback class based on template specialization. More...
#include <Callback.h>
Inherited by FunctionPointerArg1< R, void >.
Public Member Functions | |
Callback (R(*func)()=0) | |
Create a Callback with a static function. | |
Callback (const Callback< R()> &func) | |
Attach a Callback. | |
template<typename T , typename U > | |
Callback (U *obj, R(T::*method)()) | |
Create a Callback with a member function. | |
template<typename T , typename U > | |
Callback (const U *obj, R(T::*method)() const) | |
Create a Callback with a member function. | |
template<typename T , typename U > | |
Callback (volatile U *obj, R(T::*method)() volatile) | |
Create a Callback with a member function. | |
template<typename T , typename U > | |
Callback (const volatile U *obj, R(T::*method)() const volatile) | |
Create a Callback with a member function. | |
template<typename T , typename U > | |
Callback (R(*func)(T *), U *arg) | |
Create a Callback with a static function and bound pointer. | |
template<typename T , typename U > | |
Callback (R(*func)(const T *), const U *arg) | |
Create a Callback with a static function and bound pointer. | |
template<typename T , typename U > | |
Callback (R(*func)(volatile T *), volatile U *arg) | |
Create a Callback with a static function and bound pointer. | |
template<typename T , typename U > | |
Callback (R(*func)(const volatile T *), const volatile U *arg) | |
Create a Callback with a static function and bound pointer. | |
template<typename F > | |
Callback (F f, MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)())) | |
Create a Callback with a function object. | |
template<typename F > | |
Callback (const F f, MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)() const)) | |
Create a Callback with a function object. | |
template<typename F > | |
Callback (volatile F f, MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)() volatile)) | |
Create a Callback with a function object. | |
template<typename F > | |
Callback (const volatile F f, MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)() const volatile)) | |
Create a Callback with a function object. | |
template<typename T , typename U > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to Callback(func, arg)") Callback(U *obj | |
Create a Callback with a static function and bound pointer. | |
template<typename T , typename U > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to Callback(func, arg)") Callback(const U *obj | |
Create a Callback with a static function and bound pointer. | |
template<typename T , typename U > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to Callback(func, arg)") Callback(volatile U *obj | |
Create a Callback with a static function and bound pointer. | |
template<typename T , typename U > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to Callback(func, arg)") Callback(const volatile U *obj | |
Create a Callback with a static function and bound pointer. | |
~Callback () | |
Destroy a callback. | |
MBED_DEPRECATED_SINCE ("mbed-os-5.4","Replaced by simple assignment 'Callback cb = func") void attach(R(*func)()) | |
Attach a static function. | |
MBED_DEPRECATED_SINCE ("mbed-os-5.4","Replaced by simple assignment 'Callback cb = func") void attach(const Callback< R()> &func) | |
Attach a Callback. | |
template<typename T , typename U > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.4","Replaced by simple assignment 'Callback cb = func") void attach(U *obj | |
Attach a member function. | |
template<typename T , typename U > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.4","Replaced by simple assignment 'Callback cb = func") void attach(const U *obj | |
Attach a member function. | |
template<typename T , typename U > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.4","Replaced by simple assignment 'Callback cb = func") void attach(volatile U *obj | |
Attach a member function. | |
template<typename T , typename U > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.4","Replaced by simple assignment 'Callback cb = func") void attach(const volatile U *obj | |
Attach a member function. | |
template<typename T , typename U > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.4","Replaced by simple assignment 'Callback cb = func") void attach(R(*func)(T *) | |
Attach a static function with a bound pointer. | |
template<typename T , typename U > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.4","Replaced by simple assignment 'Callback cb = func") void attach(R(*func)(const T *) | |
Attach a static function with a bound pointer. | |
template<typename T , typename U > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to attach(func, arg)") void attach(const U *obj | |
Attach a static function with a bound pointer. | |
template<typename T , typename U > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to attach(func, arg)") void attach(volatile U *obj | |
Attach a static function with a bound pointer. | |
template<typename T , typename U > | |
MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to attach(func, arg)") void attach(const volatile U *obj | |
Attach a static function with a bound pointer. | |
Callback & | operator= (const Callback &that) |
Assign a callback. | |
R | call () const |
Call the attached function. | |
R | operator() () const |
Call the attached function. | |
operator bool () const | |
Test if function has been attached. | |
Static Public Member Functions | |
static R | thunk (void *func) |
Static thunk for passing as C-style function. | |
Friends | |
bool | operator== (const Callback &l, const Callback &r) |
Test for equality. | |
bool | operator!= (const Callback &l, const Callback &r) |
Test for inequality. |
Detailed Description
template<typename R>
class mbed::Callback< R()>
Callback class based on template specialization.
- Note:
- Synchronization level: Not protected
Definition at line 73 of file Callback.h.
Constructor & Destructor Documentation
Callback | ( | R(*)() | func = 0 ) |
Create a Callback with a static function.
- Parameters:
-
func Static function to attach
Definition at line 78 of file Callback.h.
Callback | ( | const Callback< R()> & | func ) |
Callback | ( | U * | obj, |
R(T::*)() | method | ||
) |
Create a Callback with a member function.
- Parameters:
-
obj Pointer to object to invoke member function on method Member function to attach
Definition at line 101 of file Callback.h.
Callback | ( | const U * | obj, |
R(T::*)() const | method | ||
) |
Create a Callback with a member function.
- Parameters:
-
obj Pointer to object to invoke member function on method Member function to attach
Definition at line 110 of file Callback.h.
Callback | ( | volatile U * | obj, |
R(T::*)() volatile | method | ||
) |
Create a Callback with a member function.
- Parameters:
-
obj Pointer to object to invoke member function on method Member function to attach
Definition at line 119 of file Callback.h.
Callback | ( | const volatile U * | obj, |
R(T::*)() const volatile | method | ||
) |
Create a Callback with a member function.
- Parameters:
-
obj Pointer to object to invoke member function on method Member function to attach
Definition at line 128 of file Callback.h.
Callback | ( | R(*)(T *) | func, |
U * | arg | ||
) |
Create a Callback with a static function and bound pointer.
- Parameters:
-
func Static function to attach arg Pointer argument to function
Definition at line 137 of file Callback.h.
Callback | ( | R(*)(const T *) | func, |
const U * | arg | ||
) |
Create a Callback with a static function and bound pointer.
- Parameters:
-
func Static function to attach arg Pointer argument to function
Definition at line 146 of file Callback.h.
Callback | ( | R(*)(volatile T *) | func, |
volatile U * | arg | ||
) |
Create a Callback with a static function and bound pointer.
- Parameters:
-
func Static function to attach arg Pointer argument to function
Definition at line 155 of file Callback.h.
Callback | ( | R(*)(const volatile T *) | func, |
const volatile U * | arg | ||
) |
Create a Callback with a static function and bound pointer.
- Parameters:
-
func Static function to attach arg Pointer argument to function
Definition at line 164 of file Callback.h.
Callback | ( | F | f, |
MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)()) | |||
) |
Create a Callback with a function object.
- Parameters:
-
f Function object to attach
- Note:
- The function object is limited to a single word of storage
Definition at line 173 of file Callback.h.
Callback | ( | const F | f, |
MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)() const) | |||
) |
Create a Callback with a function object.
- Parameters:
-
f Function object to attach
- Note:
- The function object is limited to a single word of storage
Definition at line 182 of file Callback.h.
Callback | ( | volatile F | f, |
MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)() volatile) | |||
) |
Create a Callback with a function object.
- Parameters:
-
f Function object to attach
- Note:
- The function object is limited to a single word of storage
Definition at line 191 of file Callback.h.
Callback | ( | const volatile F | f, |
MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)() const volatile) | |||
) |
Create a Callback with a function object.
- Parameters:
-
f Function object to attach
- Note:
- The function object is limited to a single word of storage
Definition at line 200 of file Callback.h.
~Callback | ( | ) |
Destroy a callback.
Definition at line 258 of file Callback.h.
Member Function Documentation
R call | ( | ) | const |
Call the attached function.
Definition at line 525 of file Callback.h.
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
"Arguments to callback have been reordered to Callback< R()>(func, arg)" | |||
) |
Create a Callback with a static function and bound pointer.
- Parameters:
-
obj Pointer to object to bind to function func Static function to attach
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
"Arguments to callback have been reordered to Callback< R()>(func, arg)" | |||
) | const volatile |
Create a Callback with a static function and bound pointer.
- Parameters:
-
obj Pointer to object to bind to function func Static function to attach
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.4" | ) | const |
Attach a member function.
- Parameters:
-
obj Pointer to object to invoke member function on method Member function to attach
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.4" | ) | const volatile |
Attach a member function.
- Parameters:
-
obj Pointer to object to invoke member function on method Member function to attach
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
"Arguments to callback have been reordered to attach(func, arg)" | |||
) | const volatile |
Attach a static function with a bound pointer.
- Parameters:
-
obj Pointer to object to bind to function func Static function to attach
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
"Arguments to callback have been reordered to attach(func, arg)" | |||
) | const |
Attach a static function with a bound pointer.
- Parameters:
-
obj Pointer to object to bind to function func Static function to attach
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.4" | ) | volatile |
Attach a member function.
- Parameters:
-
obj Pointer to object to invoke member function on method Member function to attach
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
"Arguments to callback have been reordered to attach(func, arg)" | |||
) | volatile |
Attach a static function with a bound pointer.
- Parameters:
-
obj Pointer to object to bind to function func Static function to attach
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.4" | ) | const |
Attach a static function with a bound pointer.
- Parameters:
-
func Static function to attach arg Pointer argument to function
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
"Arguments to callback have been reordered to Callback< R()>(func, arg)" | |||
) | const |
Create a Callback with a static function and bound pointer.
- Parameters:
-
obj Pointer to object to bind to function func Static function to attach
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.4" | ) |
Attach a static function.
- Parameters:
-
func Static function to attach
Definition at line 269 of file Callback.h.
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.4" | ) |
Attach a static function with a bound pointer.
- Parameters:
-
func Static function to attach arg Pointer argument to function
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
"Arguments to callback have been reordered to Callback< R()>(func, arg)" | |||
) | volatile |
Create a Callback with a static function and bound pointer.
- Parameters:
-
obj Pointer to object to bind to function func Static function to attach
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.4" | ) | const |
Attach a Callback.
- Parameters:
-
func The Callback to attach
Definition at line 281 of file Callback.h.
MBED_DEPRECATED_SINCE | ( | "mbed-os-5.4" | ) |
Attach a member function.
- Parameters:
-
obj Pointer to object to invoke member function on method Member function to attach
operator bool | ( | ) | const |
Test if function has been attached.
Definition at line 538 of file Callback.h.
R operator() | ( | ) | const |
Call the attached function.
Definition at line 532 of file Callback.h.
Callback& operator= | ( | const Callback< R()> & | that ) |
Assign a callback.
Definition at line 514 of file Callback.h.
static R thunk | ( | void * | func ) | [static] |
Static thunk for passing as C-style function.
- Parameters:
-
func Callback to call passed as void pointer
- Returns:
- the value as determined by func which is of type and determined by the signiture of func
Definition at line 559 of file Callback.h.
Friends And Related Function Documentation
bool operator!= | ( | const Callback< R()> & | l, |
const Callback< R()> & | r | ||
) | [friend] |
Test for inequality.
Definition at line 550 of file Callback.h.
bool operator== | ( | const Callback< R()> & | l, |
const Callback< R()> & | r | ||
) | [friend] |
Test for equality.
Definition at line 544 of file Callback.h.
Generated on Tue Jul 12 2022 16:02:35 by 1.7.2