etl/docs/Messaging/reference-counted-messages.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

3.7 KiB

title
reference_counted_message

{{< callout type="info">}} Header: reference_counted_message.h
{{< /callout >}}

Reference counted message types that are used by etl::shared_message.

Defines the following classes

etl::ireference_counted_message

The interface of all reference counted message types.


etl::reference_counted_message<typename TMessage, typename TCounter>

Derived from etl::ireference_counted_message.

etl::persistent_message<typename TMessage>

Derived from etl::ireference_counted_message.

ireference_counted_message

etl::ireference_counted_message

The interface of all reference counted message types.


virtual ~ireference_counted_message()

ETL_NODISCARD virtual etl::imessage& get_message() = 0;

Get a reference to the message.


ETL_NODISCARD virtual const etl::imessage& get_message() const = 0;

Get a const reference to the message.


ETL_NODISCARD virtual etl::ireference_counter& get_reference_counter() = 0;

Get a reference to the reference counter.


ETL_NODISCARD virtual const etl::ireference_counter& get_reference_counter() const = 0; 

Get a const reference to the reference counter.


virtual void release() = 0;

Release back to the owner.

reference_counted_message

etl::reference_counted_message<typename TMessage, typename TCounter>     

The implementation of reference counted messages owned by a pool.
Will static assert if TMessage is no derived from etl::imessage.


reference_counted_message(const TMessage& message, etl::ireference_counted_message_pool& owner)

Constructs from a message and the pool from which the reference counted message is allocated.
The message is copied.


reference_counted_message(etl::ireference_counted_message_pool& owner)

Constructs from a message and the pool from which the reference counted message is allocated.
The message is default constructed.


ETL_NODISCARD TMessage& get_message() ETL_OVERRIDE

Get a reference to the message.


ETL_NODISCARD const TMessage& get_message() const ETL_OVERRIDE

Get a const reference to the message.


ETL_NODISCARD etl::ireference_counter& get_reference_counter() ETL_OVERRIDE

Get a reference to the reference counter.


ETL_NODISCARD const etl::ireference_counter& get_reference_counter() const ETL_OVERRIDE

Get a const reference to the reference counter.


void release() ETL_OVERRIDE

Release back to the owner pool.

persistent_message

etl::persistent_message<typename TMessage>     

The implementation of reference counted messages not owned by a pool.
It's counter type is void.
Will static assert if TMessage is not derived from etl::imessage.


persistent_message(const TMessage& message)

Constructs from a message.
The message is copied.


ETL_NODISCARD TMessage& get_message() ETL_OVERRIDE

Get a reference to the message.


ETL_NODISCARD const TMessage& get_message() const ETL_OVERRIDE

Get a const reference to the message.


ETL_NODISCARD etl::ireference_counter& get_reference_counter() ETL_OVERRIDE

Get a reference to the reference counter.


ETL_NODISCARD const etl::ireference_counter& get_reference_counter() const ETL_OVERRIDE

Get a const reference to the reference counter.


void release() ETL_OVERRIDE

Does nothing for a persistent message.

For C++11, with atomic support.

template <typename TMessage>
using atomic_counted_message = etl::reference_counted_message<TMessage, etl::atomic_int32_t>;

Defines an alias to a reference counted message that uses an atomic.