Embedded Template Library 1.0
reference_counted_message.h
1/******************************************************************************
2The MIT License(MIT)
3
4Embedded Template Library.
5https://github.com/ETLCPP/etl
6https://www.etlcpp.com
7
8Copyright(c) 2021 John Wellbelove
9
10Permission is hereby granted, free of charge, to any person obtaining a copy
11of this software and associated documentation files(the "Software"), to deal
12in the Software without restriction, including without limitation the rights
13to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
14copies of the Software, and to permit persons to whom the Software is
15furnished to do so, subject to the following conditions :
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
23AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26SOFTWARE.
27******************************************************************************/
28
29#ifndef ETL_REFERENCE_COUNTED_MESSAGE_INCLUDED
30#define ETL_REFERENCE_COUNTED_MESSAGE_INCLUDED
31
32#include "platform.h"
33#include "message.h"
34#include "atomic.h"
35#include "reference_counted_object.h"
36#include "static_assert.h"
37#include "type_traits.h"
39
40#include <stdint.h>
41
42namespace etl
43{
44 //***************************************************************************
45 // Base class for all reference counted messages.
46 //***************************************************************************
48 {
49 public:
50
52 ETL_NODISCARD virtual etl::imessage& get_message() = 0;
53 ETL_NODISCARD virtual const etl::imessage& get_message() const = 0;
54 ETL_NODISCARD virtual etl::ireference_counter& get_reference_counter() = 0;
55 ETL_NODISCARD virtual const etl::ireference_counter& get_reference_counter() const = 0;
56 virtual void release() = 0;
57 };
58
59 //***************************************************************************
60 // Reference counted message with a counter and owner.
61 //***************************************************************************
62 template <typename TMessage, typename TCounter>
64 {
65 public:
66
67 ETL_STATIC_ASSERT((etl::is_base_of<etl::imessage, TMessage>::value), "Not a message type");
68
69 typedef TMessage message_type;
70 typedef TCounter counter_type;
71
72 //***************************************************************************
75 //***************************************************************************
77 : owner(owner_)
78 {
79 }
80
81 //***************************************************************************
85 //***************************************************************************
87 : rc_object(msg_)
88 , owner(owner_)
89 {
90 }
91
92 //***************************************************************************
95 //***************************************************************************
96 ETL_NODISCARD virtual TMessage& get_message() ETL_OVERRIDE
97 {
98 return rc_object.get_object();
99 }
100
101 //***************************************************************************
104 //***************************************************************************
105 ETL_NODISCARD virtual const TMessage& get_message() const ETL_OVERRIDE
106 {
107 return rc_object.get_object();
108 }
109
110 //***************************************************************************
113 //***************************************************************************
114 ETL_NODISCARD virtual etl::ireference_counter& get_reference_counter() ETL_OVERRIDE
115 {
116 return rc_object.get_reference_counter();
117 }
118
119 //***************************************************************************
122 //***************************************************************************
123 ETL_NODISCARD virtual const etl::ireference_counter& get_reference_counter() const ETL_OVERRIDE
124 {
125 return rc_object.get_reference_counter();
126 }
127
128 //***************************************************************************
131 //***************************************************************************
132 virtual void release() ETL_OVERRIDE
133 {
134 owner.release(*this);
135 }
136
137 private:
138
141 };
142
143 //***************************************************************************
144 // A persistent message with no counter and owner.
145 //***************************************************************************
146 template <typename TMessage>
148 {
149 public:
150
151 ETL_STATIC_ASSERT((etl::is_base_of<etl::imessage, TMessage>::value), "Not a message type");
152
153 typedef TMessage message_type;
154 typedef void counter_type;
155
156 //***************************************************************************
159 //***************************************************************************
160 explicit persistent_message(const TMessage& msg_)
161 : rc_object(msg_)
162 {
163 }
164
165 //***************************************************************************
168 //***************************************************************************
169 ETL_NODISCARD virtual TMessage& get_message() ETL_OVERRIDE
170 {
171 return rc_object.get_object();
172 }
173
174 //***************************************************************************
177 //***************************************************************************
178 ETL_NODISCARD virtual const TMessage& get_message() const ETL_OVERRIDE
179 {
180 return rc_object.get_object();
181 }
182
183 //***************************************************************************
186 //***************************************************************************
187 ETL_NODISCARD virtual etl::ireference_counter& get_reference_counter() ETL_OVERRIDE
188 {
189 return rc_object.get_reference_counter();
190 }
191
192 //***************************************************************************
195 //***************************************************************************
196 ETL_NODISCARD virtual const etl::ireference_counter& get_reference_counter() const ETL_OVERRIDE
197 {
198 return rc_object.get_reference_counter();
199 }
200
201 //***************************************************************************
204 //***************************************************************************
205 virtual void release() ETL_OVERRIDE
206 {
207 // Do nothing.
208 }
209
210 private:
211
213 };
214
215#if ETL_USING_CPP11 && ETL_HAS_ATOMIC
216 //***************************************************************************
219 //***************************************************************************
220 template <typename TMessage>
222#endif
223}
224
225#endif
Definition: message.h:69
Interface for a reference counted message pool.
Definition: ireference_counted_message_pool.h:44
Definition: reference_counted_message.h:48
virtual ETL_NODISCARD etl::ireference_counter & get_reference_counter()=0
Get a reference to the reference counter.
virtual ETL_NODISCARD etl::imessage & get_message()=0
Get a reference to the message.
virtual void release()=0
Release back to the owner.
The base of all reference counters.
Definition: reference_counted_object.h:72
Definition: reference_counted_message.h:148
virtual ETL_NODISCARD etl::ireference_counter & get_reference_counter() ETL_OVERRIDE
Definition: reference_counted_message.h:187
virtual ETL_NODISCARD TMessage & get_message() ETL_OVERRIDE
Definition: reference_counted_message.h:169
virtual void release() ETL_OVERRIDE
Definition: reference_counted_message.h:205
persistent_message(const TMessage &msg_)
Definition: reference_counted_message.h:160
Definition: reference_counted_message.h:64
virtual ETL_NODISCARD etl::ireference_counter & get_reference_counter() ETL_OVERRIDE
Definition: reference_counted_message.h:114
reference_counted_message(etl::ireference_counted_message_pool &owner_)
Definition: reference_counted_message.h:76
virtual ETL_NODISCARD TMessage & get_message() ETL_OVERRIDE
Definition: reference_counted_message.h:96
reference_counted_message(const TMessage &msg_, etl::ireference_counted_message_pool &owner_)
Definition: reference_counted_message.h:86
virtual void release() ETL_OVERRIDE
Definition: reference_counted_message.h:132
virtual ETL_NODISCARD ireference_counter & get_reference_counter() ETL_OVERRIDE
Get a reference to the reference counter.
Definition: reference_counted_object.h:246
ETL_NODISCARD value_type & get_object()
Get a reference to the counted object.
Definition: reference_counted_object.h:229
is_base_of
Definition: type_traits_generator.h:1252
bitset_ext
Definition: absolute.h:38