Ben Katz / mbed-dev_spine

mbed library sources. Supersedes mbed-src.

Dependents:   SPIne CH_Communicatuin_Test CH_Communicatuin_Test2 MCP_SPIne ... more

Fork of mbed-dev-f303 by Ben Katz

Embed: (wiki syntax)

« Back to documentation index

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

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

Callback class based on template specialization. More...

#include <Callback.h>

Public Member Functions

 Callback (R(*func)(A0, A1, A2)=0)
 Create a Callback with a static function.
 Callback (const Callback< R(A0, A1, A2)> &func)
 Attach a Callback.
template<typename T , typename U >
 Callback (U *obj, R(T::*method)(A0, A1, A2))
 Create a Callback with a member function.
template<typename T , typename U >
 Callback (const U *obj, R(T::*method)(A0, A1, A2) const)
 Create a Callback with a member function.
template<typename T , typename U >
 Callback (volatile U *obj, R(T::*method)(A0, A1, A2) volatile)
 Create a Callback with a member function.
template<typename T , typename U >
 Callback (const volatile U *obj, R(T::*method)(A0, A1, A2) const volatile)
 Create a Callback with a member function.
template<typename T , typename U >
 Callback (R(*func)(T *, A0, A1, A2), U *arg)
 Create a Callback with a static function and bound pointer.
template<typename T , typename U >
 Callback (R(*func)(const T *, A0, A1, A2), const U *arg)
 Create a Callback with a static function and bound pointer.
template<typename T , typename U >
 Callback (R(*func)(volatile T *, A0, A1, A2), volatile U *arg)
 Create a Callback with a static function and bound pointer.
template<typename T , typename U >
 Callback (R(*func)(const volatile T *, A0, A1, A2), 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::*)(A0, A1, A2)))
 Create a Callback with a function object.
template<typename F >
 Callback (const F f, MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)(A0, A1, A2) const))
 Create a Callback with a function object.
template<typename F >
 Callback (volatile F f, MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)(A0, A1, A2) volatile))
 Create a Callback with a function object.
template<typename F >
 Callback (const volatile F f, MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)(A0, A1, A2) 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)(A0
 Attach a static 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 (A0 a0, A1 a1, A2 a2) const
 Call the attached function.
R operator() (A0 a0, A1 a1, A2 a2) 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, A1 a1, A2 a2)
 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, typename A1, typename A2>
class mbed::Callback< R(A0, A1, A2)>

Callback class based on template specialization.

Note:
Synchronization level: Not protected

Definition at line 1801 of file Callback.h.

Constructor & Destructor Documentation

Callback ( R(*)(A0, A1, A2)  func = 0 )

Create a Callback with a static function.

Parameters:
funcStatic function to attach

Definition at line 1806 of file Callback.h.

Callback ( const Callback< R(A0, A1, A2)> &  func )

Attach a Callback.

Parameters:
funcThe Callback to attach

Definition at line 1817 of file Callback.h.

Callback ( U *  obj,
R(T::*)(A0, A1, A2)  method 
)

Create a Callback with a member function.

Parameters:
objPointer to object to invoke member function on
methodMember function to attach

Definition at line 1829 of file Callback.h.

Callback ( const U *  obj,
R(T::*)(A0, A1, A2) const   method 
)

Create a Callback with a member function.

Parameters:
objPointer to object to invoke member function on
methodMember function to attach

Definition at line 1838 of file Callback.h.

Callback ( volatile U *  obj,
R(T::*)(A0, A1, A2) volatile  method 
)

Create a Callback with a member function.

Parameters:
objPointer to object to invoke member function on
methodMember function to attach

Definition at line 1847 of file Callback.h.

Callback ( const volatile U *  obj,
R(T::*)(A0, A1, A2) const volatile  method 
)

Create a Callback with a member function.

Parameters:
objPointer to object to invoke member function on
methodMember function to attach

Definition at line 1856 of file Callback.h.

Callback ( R(*)(T *, A0, A1, A2)  func,
U *  arg 
)

Create a Callback with a static function and bound pointer.

Parameters:
funcStatic function to attach
argPointer argument to function

Definition at line 1865 of file Callback.h.

Callback ( R(*)(const T *, A0, A1, A2)  func,
const U *  arg 
)

Create a Callback with a static function and bound pointer.

Parameters:
funcStatic function to attach
argPointer argument to function

Definition at line 1874 of file Callback.h.

Callback ( R(*)(volatile T *, A0, A1, A2)  func,
volatile U *  arg 
)

Create a Callback with a static function and bound pointer.

Parameters:
funcStatic function to attach
argPointer argument to function

Definition at line 1883 of file Callback.h.

Callback ( R(*)(const volatile T *, A0, A1, A2)  func,
const volatile U *  arg 
)

Create a Callback with a static function and bound pointer.

Parameters:
funcStatic function to attach
argPointer argument to function

Definition at line 1892 of file Callback.h.

Callback ( F  f,
MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)(A0, A1, A2))   
)

Create a Callback with a function object.

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

Definition at line 1901 of file Callback.h.

Callback ( const F  f,
MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)(A0, A1, A2) const)   
)

Create a Callback with a function object.

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

Definition at line 1910 of file Callback.h.

Callback ( volatile F  f,
MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)(A0, A1, A2) volatile)   
)

Create a Callback with a function object.

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

Definition at line 1919 of file Callback.h.

Callback ( const volatile F  f,
MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, R(F::*)(A0, A1, A2) const volatile)   
)

Create a Callback with a function object.

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

Definition at line 1928 of file Callback.h.

~Callback (  )

Destroy a callback.

Definition at line 1986 of file Callback.h.

Member Function Documentation

R call ( A0  a0,
A1  a1,
A2  a2 
) const

Call the attached function.

Definition at line 2253 of file Callback.h.

MBED_DEPRECATED_SINCE ( "mbed-os-5.1"  ,
"Arguments to callback have been reordered to Callback< R(A0, A1, A2)>(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, A1, A2)>(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
MBED_DEPRECATED_SINCE ( "mbed-os-5.4"   ) volatile

Attach a member function.

Parameters:
objPointer to object to invoke member function on
methodMember function to attach
MBED_DEPRECATED_SINCE ( "mbed-os-5.4"   ) const volatile

Attach a member function.

Parameters:
objPointer to object to invoke member function on
methodMember 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 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 Callback< R(A0, A1, A2)>(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.4"   )

Attach a static function.

Parameters:
funcStatic function to attach
MBED_DEPRECATED_SINCE ( "mbed-os-5.4"   )

Attach a static function with a bound pointer.

Parameters:
funcStatic function to attach
argPointer argument to function
MBED_DEPRECATED_SINCE ( "mbed-os-5.1"  ,
"Arguments to callback have been reordered to Callback< R(A0, A1, A2)>(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.4"   ) const

Attach a member function.

Parameters:
objPointer to object to invoke member function on
methodMember function to attach
operator bool (  ) const

Test if function has been attached.

Definition at line 2266 of file Callback.h.

R operator() ( A0  a0,
A1  a1,
A2  a2 
) const

Call the attached function.

Definition at line 2260 of file Callback.h.

Callback& operator= ( const Callback< R(A0, A1, A2)> &  that )

Assign a callback.

Definition at line 2242 of file Callback.h.

static R thunk ( void *  func,
A0  a0,
A1  a1,
A2  a2 
) [static]

Static thunk for passing as C-style function.

Parameters:
funcCallback to call passed as void pointer
a0An argument to be called with function func
a1An argument to be called with function func
a2An argument to be called with function func
Returns:
the value as determined by func which is of type and determined by the signiture of func

Definition at line 2290 of file Callback.h.

Friends And Related Function Documentation

bool operator!= ( const Callback< R(A0, A1, A2)> &  l,
const Callback< R(A0, A1, A2)> &  r 
) [friend]

Test for inequality.

Definition at line 2278 of file Callback.h.

bool operator== ( const Callback< R(A0, A1, A2)> &  l,
const Callback< R(A0, A1, A2)> &  r 
) [friend]

Test for equality.

Definition at line 2272 of file Callback.h.

Generated on Tue Jul 12 2022 19:39:50 by  doxygen 1.7.2