CallBack.h File Reference

FreeRTOS CallBack Wrapper. More...

#include <FreeRTOScpp.h>
#include <timers.h>
#include <stdint.h>

Include dependency graph for CallBack.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	CallBack< Tr, Tp1, Tp2 >
	Base callback with two parameters. More...
class	CallBack< Tr >
	Specialization of CallBack with no parameters. More...
class	CallBack< Tr, Tp >
	Specialization of CallBack with only one parameter. More...
class	CallBack< void, uint32_t >
	Specialization for One parameter of uint32_t, as that can be pended by FreeRTOS. More...
class	FunctionCallback< Tr, Tp1, Tp2 >
	Derived Callback to call to a function. More...
class	FunctionCallback< Tr >
class	FunctionCallback< Tr, Tp >
class	MemberFunctionCallback< Tc, Tr, Tp1, Tp2 >
class	MemberFunctionCallback< Tc, Tr >
class	MemberFunctionCallback< Tc, Tr, Tp >

Functions
void	voidCallbackU32 (void *cb, uint32_t parm)
	Define a "C" Callback trampline suitable for Timer Callbacks.

Detailed Description

FreeRTOS CallBack Wrapper.

This file provides a template to generate wrappers around member function calls with parameters, including one special one for use with the FreeRTOS Pend / pendFromISR functions which includes the C trampoline function

Copyright

(c) 2018-2024 Richard Damon

Author

Richard Damon richa.nosp@m.rd.d.nosp@m.amon@.nosp@m.gmai.nosp@m.l.com

MIT License:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

It is requested (but not required by license) that any bugs found or improvements made be shared, preferably to the author.

Function Documentation

voidCallbackU32()

void voidCallbackU32 ( void * cb, uint32_t parm )

extern

Define a "C" Callback trampline suitable for Timer Callbacks.

This is a "C" API function that takes a void* and a uint32_t points, like a FreeRTOS Timer callback that makes that FreeRTOS callback link to our CallBack templates using the "C" Callbacks void* parameter. This allows a CallBack<void, uint32_t> to be used for a timer

Parameters

cb	The Callback Object to use
parm	The Parameter to send to the Callback

References CallBack< Tr, Tp1, Tp2 >::callback().

Referenced by CallBack< void, uint32_t >::callback().

Here is the call graph for this function:

Here is the caller graph for this function: