Lee Kai Xuan / mbed-os

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-os by erkin yucel

Embed: (wiki syntax)

« Back to documentation index

Callback< R(A0)> Class Template Reference
Public Member Functions | Static Public Member Functions | Friends

Callback< R(A0)> Class Template Reference
[Platform]

Callback class based on template specialization. More...

#include <Callback.h>

Public Member Functions

 Callback (R(*func)(A0)=0)
 Create a Callback with a static function.
 Callback (const Callback< R(A0)> &func)
 Attach a Callback.
template<typename T >
 Callback (T *obj, R(T::*method)(A0))
 Create a Callback with a member function.
template<typename T >
 Callback (const T *obj, R(T::*method)(A0) const)
 Create a Callback with a member function.
template<typename T >
 Callback (volatile T *obj, R(T::*method)(A0) volatile)
 Create a Callback with a member function.
template<typename T >
 Callback (const volatile T *obj, R(T::*method)(A0) const volatile)
 Create a Callback with a member function.
 Callback (R(*func)(void *, A0), void *arg)
 Create a Callback with a static function and bound pointer.
 Callback (R(*func)(const void *, A0), const void *arg)
 Create a Callback with a static function and bound pointer.
 Callback (R(*func)(volatile void *, A0), volatile void *arg)
 Create a Callback with a static function and bound pointer.
 Callback (R(*func)(const volatile void *, A0), const volatile void *arg)
 Create a Callback with a static function and bound pointer.
template<typename T >
 Callback (R(*func)(T *, A0), T *arg)
 Create a Callback with a static function and bound pointer.
template<typename T >
 Callback (R(*func)(const T *, A0), const T *arg)
 Create a Callback with a static function and bound pointer.
template<typename T >
 Callback (R(*func)(volatile T *, A0), volatile T *arg)
 Create a Callback with a static function and bound pointer.
template<typename T >
 Callback (R(*func)(const volatile T *, A0), const volatile T *arg)
 Create a Callback with a static function and bound pointer.
template<typename F >
 Callback (F f, typename detail::enable_if< detail::is_type< R(F::*)(A0),&F::operator()>::value &&sizeof(F)<=sizeof(uintptr_t) >::type=detail::nil())
 Create a Callback with a function object.
template<typename F >
 Callback (const F f, typename detail::enable_if< detail::is_type< R(F::*)(A0) const,&F::operator()>::value &&sizeof(F)<=sizeof(uintptr_t) >::type=detail::nil())
 Create a Callback with a function object.
template<typename F >
 Callback (volatile F f, typename detail::enable_if< detail::is_type< R(F::*)(A0) volatile,&F::operator()>::value &&sizeof(F)<=sizeof(uintptr_t) >::type=detail::nil())
 Create a Callback with a function object.
template<typename F >
 Callback (const volatile F f, typename detail::enable_if< detail::is_type< R(F::*)(A0) const volatile,&F::operator()>::value &&sizeof(F)<=sizeof(uintptr_t) >::type=detail::nil())
 Create a Callback with a function object.
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to Callback(func, arg)") Callback(void *obj
 Create a Callback with a static function and bound pointer.
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to Callback(func, arg)") Callback(const void *obj
 Create a Callback with a static function and bound pointer.
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to Callback(func, arg)") Callback(volatile void *obj
 Create a Callback with a static function and bound pointer.
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to Callback(func, arg)") Callback(const volatile void *obj
 Create a Callback with a static function and bound pointer.
template<typename T >
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to Callback(func, arg)") Callback(T *obj
 Create a Callback with a static function and bound pointer.
template<typename T >
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to Callback(func, arg)") Callback(const T *obj
 Create a Callback with a static function and bound pointer.
template<typename T >
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to Callback(func, arg)") Callback(volatile T *obj
 Create a Callback with a static function and bound pointer.
template<typename T >
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to Callback(func, arg)") Callback(const volatile T *obj
 Create a Callback with a static function and bound pointer.
 ~Callback ()
 Destroy a callback.
void attach (R(*func)(A0))
 Attach a static function.
void attach (const Callback< R(A0)> &func)
 Attach a Callback.
template<typename T >
void attach (T *obj, R(T::*method)(A0))
 Attach a member function.
template<typename T >
void attach (const T *obj, R(T::*method)(A0) const)
 Attach a member function.
template<typename T >
void attach (volatile T *obj, R(T::*method)(A0) volatile)
 Attach a member function.
template<typename T >
void attach (const volatile T *obj, R(T::*method)(A0) const volatile)
 Attach a member function.
void attach (R(*func)(void *, A0), void *arg)
 Attach a static function with a bound pointer.
void attach (R(*func)(const void *, A0), const void *arg)
 Attach a static function with a bound pointer.
void attach (R(*func)(volatile void *, A0), volatile void *arg)
 Attach a static function with a bound pointer.
void attach (R(*func)(const volatile void *, A0), const volatile void *arg)
 Attach a static function with a bound pointer.
template<typename T >
void attach (R(*func)(T *, A0), T *arg)
 Attach a static function with a bound pointer.
template<typename T >
void attach (R(*func)(const T *, A0), const T *arg)
 Attach a static function with a bound pointer.
template<typename T >
void attach (R(*func)(volatile T *, A0), volatile T *arg)
 Attach a static function with a bound pointer.
template<typename T >
void attach (R(*func)(const volatile T *, A0), const volatile T *arg)
 Attach a static function with a bound pointer.
template<typename F >
void attach (F f, typename detail::enable_if< detail::is_type< R(F::*)(A0),&F::operator()>::value &&sizeof(F)<=sizeof(uintptr_t) >::type=detail::nil())
 Attach a function object.
template<typename F >
void attach (const F f, typename detail::enable_if< detail::is_type< R(F::*)(A0) const,&F::operator()>::value &&sizeof(F)<=sizeof(uintptr_t) >::type=detail::nil())
 Attach a function object.
template<typename F >
void attach (volatile F f, typename detail::enable_if< detail::is_type< R(F::*)(A0) volatile,&F::operator()>::value &&sizeof(F)<=sizeof(uintptr_t) >::type=detail::nil())
 Attach a function object.
template<typename F >
void attach (const volatile F f, typename detail::enable_if< detail::is_type< R(F::*)(A0) const volatile,&F::operator()>::value &&sizeof(F)<=sizeof(uintptr_t) >::type=detail::nil())
 Attach a function object.
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to attach(func, arg)") void attach(void *obj
 Attach a static function with a bound pointer.
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to attach(func, arg)") void attach(const void *obj
 Attach a static function with a bound pointer.
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to attach(func, arg)") void attach(volatile void *obj
 Attach a static function with a bound pointer.
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to attach(func, arg)") void attach(const volatile void *obj
 Attach a static function with a bound pointer.
template<typename T >
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to attach(func, arg)") void attach(T *obj
 Attach a static function with a bound pointer.
template<typename T >
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to attach(func, arg)") void attach(const T *obj
 Attach a static function with a bound pointer.
template<typename T >
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to attach(func, arg)") void attach(volatile T *obj
 Attach a static function with a bound pointer.
template<typename T >
 MBED_DEPRECATED_SINCE ("mbed-os-5.1","Arguments to callback have been reordered to attach(func, arg)") void attach(const volatile T *obj
 Attach a static function with a bound pointer.
Callback & operator= (const Callback &that)
 Assign a callback.
R call (A0 a0) const
 Call the attached function.
R operator() (A0 a0) const
 Call the attached function.
 operator bool () const
 Test if function has been attached.

Static Public Member Functions

static R thunk (void *func, A0 a0)
 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 A0>
class mbed::Callback< R(A0)>

Callback class based on template specialization.

Synchronization level: Not protected

Definition at line 772 of file Callback.h.

Constructor & Destructor Documentation

Callback ( R(*)(A0)  func = 0 )

Create a Callback with a static function.

Parameters:
funcStatic function to attach

Definition at line 777 of file Callback.h.

Callback ( const F  f )

Create a Callback with a function object.

Parameters:
funcFunction object to attach
Note:
The function object is limited to a single word of storage

Definition at line 916 of file Callback.h.

Callback ( volatile F  f )

Create a Callback with a function object.

Parameters:
funcFunction object to attach
Note:
The function object is limited to a single word of storage

Definition at line 928 of file Callback.h.

Callback ( const volatile F  f )

Create a Callback with a function object.

Parameters:
funcFunction object to attach
Note:
The function object is limited to a single word of storage

Definition at line 940 of file Callback.h.

Member Function Documentation

void attach ( const F  f )

Attach a function object.

Parameters:
funcFunction object to attach
Note:
The function object is limited to a single word of storage

Definition at line 1205 of file Callback.h.

void attach ( volatile F  f )

Attach a function object.

Parameters:
funcFunction object to attach
Note:
The function object is limited to a single word of storage

Definition at line 1218 of file Callback.h.

void attach ( const volatile F  f )

Attach a function object.

Parameters:
funcFunction object to attach
Note:
The function object is limited to a single word of storage

Definition at line 1231 of file Callback.h.

MBED_DEPRECATED_SINCE ( "mbed-os-5.1"  ,
"Arguments to callback have been reordered to Callback< R(A0)>(func, arg)"   
)

Create a Callback with a static function and bound pointer.

Parameters:
objPointer to object to bind to function
funcStatic function to attach
MBED_DEPRECATED_SINCE ( "mbed-os-5.1"  ,
"Arguments to callback have been reordered to Callback< R(A0)>(func, arg)"   
) const volatile

Create a Callback with a static function and bound pointer.

Parameters:
objPointer to object to bind to function
funcStatic 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:
objPointer to object to bind to function
funcStatic function to attach
MBED_DEPRECATED_SINCE ( "mbed-os-5.1"  ,
"Arguments to callback have been reordered to Callback< R(A0)>(func, arg)"   
) volatile

Create a Callback with a static function and bound pointer.

Parameters:
objPointer to object to bind to function
funcStatic function to attach
MBED_DEPRECATED_SINCE ( "mbed-os-5.1"  ,
"Arguments to callback have been reordered to attach(func, arg)"   
)

Attach a static function with a bound pointer.

Parameters:
objPointer to object to bind to function
funcStatic 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:
objPointer to object to bind to function
funcStatic 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:
objPointer to object to bind to function
funcStatic function to attach
MBED_DEPRECATED_SINCE ( "mbed-os-5.1"  ,
"Arguments to callback have been reordered to Callback< R(A0)>(func, arg)"   
) const

Create a Callback with a static function and bound pointer.

Parameters:
objPointer to object to bind to function
funcStatic function to attach
Generated on Tue Jul 12 2022 13:17:07 by  doxygen 1.7.2