mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-15 16:36:03 +08:00
4a88884b39
* Add ranges * Initial Hugo setup * Work in progress * Added selection for local or remote site * Updated to 'light' theme * Changed to using Hextra Hugo theme * Changed to using Hextra Hugo theme * Changed to Hextra Hugo theme * Change to Hextra Hugo theme * Updated Hugo setup. * Updated Hugo setup. # Conflicts: # docs/releases/_index.md * Work in progress * Added new fonts Added new documentation * Latest documentation updates * Latest documentation updates # Conflicts: # docs/containers/array.md # docs/containers/array_view.md # docs/containers/array_wrapper.md # docs/containers/bip_buffer_spsc_atomic.md # docs/containers/bitset.md # docs/containers/indirect_vector.md # docs/containers/vector.md # docs/getting-started/compilers.md * Added bloom_filter markdown doc * Added more documentation Updated CSS for light and dark modes * Fixed some menus Added mode documentation files * Updated CSS rules Added badges to home page Added uniqur_ptr + pool tutorial * Fixed formatting on the home page markdown Modified light amd dark code formatting * Updated unique_ptr-with-pool * Added container and shared message tutorials * Updates to documentation * Added const_multimap * Updated source-formatting.md * Added initial raw text files form Web site editor * Innore coverage build directory * Exported raw text documentation files from the web site editor * Hugo updates * Added Hugo intalation and markdown descriptions * More addition to the documentation * Added closure.md and updates to delegate.md * Added format.md * Added documentation for etl::delegate_observable, etl::function, Base64 codec * Added io_port documentation * Added basic_format_spec * Added documentation for string_stream and string utilities. * Added more documentation Updated the documentation CSS * Added documentation for clocks, day, duration * Added more documentation for chrono classes Updated callouts * More chrono documentation * Completed chrono documentation * Maths functions documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Added multiple documentation files * Added iterator.md * Added debug_count.md and versions.md * Added debug_count.md and versions.md * Added more documentation * More documentation * Added some design pattern documentation Modified some of the layout files Modified the About documentation * Converted more documentation pages Modified the site CSS * Added more documentation Moced some documentation files to new directories * Added more documentation Tweaks to CSS * Added callback_timer_deferred_locked documentation * Added callback_timer_locked documentation * More documentation updates * More documentation updates * More documentation updates * New documentation files. Harmonised file name format * New documentation files. * Multiple document updates * Multiple document updates * Final conversion of web pages * Updates before PR * Updates before PR * Updates before PR # Conflicts: # docs/blog/_index.md * Final pre PR updates * Updates to message framework documentation * Renamed directory * Fix spelling * Added author and date to blog files Moved documentation files merged from development * Fixed 'Description' typo * Fix typos # Conflicts: # docs/IO/io_port.md # docs/containers/sets/const-multiset.md # docs/containers/sets/const-set.md # docs/maths/correlation.md # docs/maths/gamma.md * Renamed two files to lower case * Minor renaming * Added author and date * Updated callout on bresenham_line.md Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset. Updated the Python 'update_release.py' to copy 'version.txt' * Replace space in filename with hyphen. Added more information to hugo-commands.md * Replace space in filename with hyphen. Added more information to hugo-commands.md # Conflicts: # docs/getting-started/view-the-docs-locally/hugo-commands.md * Added a link to pseudo_moving_average.md * Updated title pages for groups * Fixed missing 404 for non-existent pages * Fixed coordinate variable names in the 'Calculating the intersection' example --------- Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>
94 lines
2.7 KiB
Markdown
94 lines
2.7 KiB
Markdown
---
|
|
title: "delegate_service"
|
|
---
|
|
|
|
{{< callout type="info">}}
|
|
Header: `delegate_service.h`
|
|
{{< /callout >}}
|
|
|
|
Delegate Service
|
|
This template class allows easier integration of 'C' style events (such as interrupt vectors) and C++ handlers.
|
|
It can allow abstraction between low level events such as interrupts and their application dependent handlers.
|
|
The handlers may be any combination of global, static, member functions, lambdas and functors.
|
|
It utilises the templated function wrapper.
|
|
|
|
The delegate callbacks are identified by an id. The values of the ids must range from zero or a specified offset, up to the maximum range of specified delegates. Calling an unused delegate id will either do nothing or, if the user has specified a handler, call this with the id of the delegate.
|
|
|
|
There are functions that use both runtime and compile time checks of the delegate id.
|
|
Compile time is preferable.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <size_t Range, size_t Offset = 0U, const etl::delegate<void(size_t)>* Delegates = nullptr>
|
|
delegate_service
|
|
```
|
|
`Range`
|
|
The id range of the delegates (last - first + 1).
|
|
|
|
`Offset`
|
|
The starting id for the range. Default `0`.
|
|
|
|
`Delegates`
|
|
An optional pointer to an array of delegate pointers.
|
|
|
|
If the pointer to a delegate array is supplied as a template parameter then the delegate service may be declared `constexpr`, otherwise the service is runtime only.
|
|
|
|
## Member functions
|
|
|
|
```cpp
|
|
delegate_service()
|
|
```
|
|
Runtime only.
|
|
Sets all of the delegates to route to the unhandled delegate.
|
|
Sets the unhandled delegate to default (do nothing).
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <const size_t ID>
|
|
void register_delegate(etl::delegate<void(size_t)>& callback)
|
|
```
|
|
Runtime only.
|
|
Registers delegate with the id specified in the template parameter.
|
|
A compile time error will occur if the id is out of range.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void register_delegate(size_t id, etl::delegate<void(size_t)>& callback)
|
|
```
|
|
Runtime only.
|
|
Registers delegate with the id specified in the template parameter.
|
|
The registration will be ignored if the id is out of range.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void register_unhandled_delegate(etl::delegate<void(size_t)>& callback)
|
|
```
|
|
Runtime only.
|
|
Registers the delegate to be used for unhandled ids.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <const size_t ID>
|
|
void call()
|
|
```
|
|
Calls the delegate associated with the id.
|
|
Calls the unhandled delegate if the id has not been registered.
|
|
A compile time error will occur if the id is out of range.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void call(const size_t id)
|
|
```
|
|
Calls the delegate associated with the id.
|
|
Calls the unhandled delegate if the id has not been registered or if is out of range.
|
|
|
|
## Example
|
|
|
|
See the example project in `examples\FunctionInterruptSimulation-Delegates`.
|