ok
Callback< R(ArgTs...)> Class Template Reference
[Callback class]
Callback class based on template specialization. More...
#include <Callback.h>
Public Member Functions | |
| Callback (R(*func)(ArgTs...)=0) | |
| Create a Callback with a static function. | |
| Callback (const Callback< R(ArgTs...)> &func) | |
| Attach a Callback. | |
| template<typename T , typename U > | |
| Callback (U *obj, R(T::*method)(ArgTs...)) | |
| Create a Callback with a member function. | |
| template<typename T , typename U > | |
| Callback (const U *obj, R(T::*method)(ArgTs...) const) | |
| Create a Callback with a member function. | |
| template<typename T , typename U > | |
| Callback (volatile U *obj, R(T::*method)(ArgTs...) volatile) | |
| Create a Callback with a member function. | |
| template<typename T , typename U > | |
| Callback (const volatile U *obj, R(T::*method)(ArgTs...) const volatile) | |
| Create a Callback with a member function. | |
| template<typename T , typename U > | |
| Callback (R(*func)(T *, ArgTs...), U *arg) | |
| Create a Callback with a static function and bound pointer. | |
| template<typename T , typename U > | |
| Callback (R(*func)(const T *, ArgTs...), const U *arg) | |
| Create a Callback with a static function and bound pointer. | |
| template<typename T , typename U > | |
| Callback (R(*func)(volatile T *, ArgTs...), volatile U *arg) | |
| Create a Callback with a static function and bound pointer. | |
| template<typename T , typename U > | |
| Callback (R(*func)(const volatile T *, ArgTs...), 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::*)(ArgTs...))) | |
| Create a Callback with a function object. | |
| template<typename F > | |
| Callback (const F f, MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)(ArgTs...) const)) | |
| Create a Callback with a function object. | |
| template<typename F > | |
| Callback (volatile F f, MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)(ArgTs...) volatile)) | |
| Create a Callback with a function object. | |
| template<typename F > | |
| Callback (const volatile F f, MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)(ArgTs...) 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)(ArgTs...)) | |
| Attach a static function. | |
| MBED_DEPRECATED_SINCE ("mbed-os-5.4","Replaced by simple assignment 'Callback cb = func") void attach(const Callback< R(ArgTs...)> &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.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 (ArgTs...args) const |
| Call the attached function. | |
| R | operator() (ArgTs...args) const |
| Call the attached function. | |
| operator bool () const | |
| Test if function has been attached. | |
Static Public Member Functions | |
| static R | thunk (void *func, ArgTs...args) |
| 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, typename... ArgTs>
class mbed::Callback< R(ArgTs...)>
Callback class based on template specialization.
- Note:
- Synchronization level: Not protected
Definition at line 78 of file Callback.h.
Constructor & Destructor Documentation
| Callback | ( | R(*)(ArgTs...) | func = 0 ) |
Create a Callback with a static function.
- Parameters:
-
func Static function to attach
Definition at line 83 of file Callback.h.
| Callback | ( | const Callback< R(ArgTs...)> & | func ) |
| Callback | ( | U * | obj, |
| R(T::*)(ArgTs...) | 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 109 of file Callback.h.
| Callback | ( | const U * | obj, |
| R(T::*)(ArgTs...) 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 119 of file Callback.h.
| Callback | ( | volatile U * | obj, |
| R(T::*)(ArgTs...) 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 129 of file Callback.h.
| Callback | ( | const volatile U * | obj, |
| R(T::*)(ArgTs...) 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 139 of file Callback.h.
| Callback | ( | R(*)(T *, ArgTs...) | 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 149 of file Callback.h.
| Callback | ( | R(*)(const T *, ArgTs...) | 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 159 of file Callback.h.
| Callback | ( | R(*)(volatile T *, ArgTs...) | 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 169 of file Callback.h.
| Callback | ( | R(*)(const volatile T *, ArgTs...) | 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 179 of file Callback.h.
| Callback | ( | F | f, |
| MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)(ArgTs...)) | |||
| ) |
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 189 of file Callback.h.
| Callback | ( | const F | f, |
| MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)(ArgTs...) 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 199 of file Callback.h.
| Callback | ( | volatile F | f, |
| MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)(ArgTs...) 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 209 of file Callback.h.
| Callback | ( | const volatile F | f, |
| MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)(ArgTs...) 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 219 of file Callback.h.
| ~Callback | ( | ) |
Destroy a callback.
Definition at line 282 of file Callback.h.
Member Function Documentation
| R call | ( | ArgTs... | args ) | const |
Call the attached function.
Definition at line 569 of file Callback.h.
| MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
| "Arguments to callback have been reordered to Callback< R(ArgTs...)>(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(ArgTs...)>(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 |
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)" | |||
| ) | 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" | ) | 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.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(ArgTs...)>(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 294 of file Callback.h.
| MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
| "Arguments to callback have been reordered to Callback< R(ArgTs...)>(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" | ) |
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 |
Attach a Callback.
- Parameters:
-
func The Callback to attach
Definition at line 307 of file Callback.h.
| operator bool | ( | ) | const |
Test if function has been attached.
Definition at line 584 of file Callback.h.
| R operator() | ( | ArgTs... | args ) | const |
Call the attached function.
Definition at line 577 of file Callback.h.
| Callback& operator= | ( | const Callback< R(ArgTs...)> & | that ) |
Assign a callback.
Definition at line 557 of file Callback.h.
| static R thunk | ( | void * | func, |
| ArgTs... | args | ||
| ) | [static] |
Static thunk for passing as C-style function.
- Parameters:
-
func Callback to call passed as void pointer args Arguments to be called with function func
- Returns:
- the value as determined by func which is of type and determined by the signature of func
Definition at line 609 of file Callback.h.
Friends And Related Function Documentation
| bool operator!= | ( | const Callback< R(ArgTs...)> & | l, |
| const Callback< R(ArgTs...)> & | r | ||
| ) | [friend] |
Test for inequality.
Definition at line 598 of file Callback.h.
| bool operator== | ( | const Callback< R(ArgTs...)> & | l, |
| const Callback< R(ArgTs...)> & | r | ||
| ) | [friend] |
Test for equality.
Definition at line 591 of file Callback.h.
Generated on Sun Jul 17 2022 16:29:55 by
1.7.2