etl/docs/callbacks/delegate_observable.md
John Wellbelove 4a88884b39
Issue/add hugo support for documentation (#1449)
* 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>
2026-06-06 13:12:44 +01:00

116 lines
2.6 KiB
Markdown

---
title: "delegate_observable"
---
{{< callout type="info">}}
Header: `delegate_observable.h`
Since: `TBC`
{{< /callout >}}
`etl::delegate_observable` is a variation on the observer pattern idea, but using delegates as the callback mechanism.
```cpp
template <typename TNotification, size_t Max_Observers>
class delegate_observable
```
`TNotification` is the notification type.
`Max_Observers` is the maximum number of observers that can be handled.
## Template deduction guide
```cpp
template <typename TNotification, typename... TDelegates>
delegate_observable(TNotification, TDelegates...)
-> delegate_observable<TNotification, sizeof...(TDelegates)>;
```
**Example**
```cpp
etl::delegate<void(int)> delegate1;
etl::delegate<void(int)> delegate2;
etl::delegate_observable observable(int{}, delegate1, delegate2);
```
## Public types
| Type | Description |
| ------------------- | ------------------------------------------- |
| `delegate_type` | The type of delegate used in this observer. |
| `size_type` | The type used internally for sizes. |
| `notification_type` | The type of the notification. |
## Construction
```cpp
ETL_CONSTEXPR14 delegate_observable()
```
**Description**
Default constructor.
---
```cpp
template <typename... TDelegate>
ETL_CONSTEXPR14 delegate_observable(TDelegate&&... delegates)
```
**Description**
Construct from a collection of observers.
---
```cpp
template <typename... TDelegate>
ETL_CONSTEXPR14 delegate_observable(notification_type, TDelegate&&... delegates)
```
**Description**
Construct from notification type and a list of observers.
Variant for template deduction guide.
The notification value is ignored. It is here to allow deduction of the notification type for the template deduction guide.
## Modifiers
```cpp
ETL_CONSTEXPR14 bool add_observer(delegate_type observer)
```
**Description**
Add an observer to the list.
**Return**
`true` if the observer was removed, `false` if not.
---
```cpp
ETL_CONSTEXPR14 bool remove_observer(const delegate_type& observer)
```
**Description**
Remove a particular observer from the list.
**Return**
`true if the observer was removed, false if not.
---
```cpp
ETL_CONSTEXPR14 void clear_observers()
```
**Description**
Clear all observers.
## Status
```cpp
ETL_CONSTEXPR14 size_type number_of_observers() const
```
**Return**
The number of observers.
## Notofication
```cpp
ETL_CONSTEXPR14 void notify_observers(notification_type n) const
```
**Description**
Notify all of the observers, sending them the notification.