Loading...
Searching...
No Matches
reference_counted_message.h
/******************************************************************************
The MIT License(MIT)
Embedded Template Library.
https://github.com/ETLCPP/etl
https://www.etlcpp.com
Copyright(c) 2021 John Wellbelove
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.
******************************************************************************/
#ifndef ETL_REFERENCE_COUNTED_MESSAGE_INCLUDED
#define ETL_REFERENCE_COUNTED_MESSAGE_INCLUDED
#include "platform.h"
#include "atomic.h"
#include "ireference_counted_message_pool.h"
#include "message.h"
#include "reference_counted_object.h"
#include "static_assert.h"
#include "type_traits.h"
#include <stdint.h>
namespace etl
{
//***************************************************************************
// Base class for all reference counted messages.
//***************************************************************************
class ireference_counted_message
{
public:
virtual ~ireference_counted_message() {}
ETL_NODISCARD
virtual etl::imessage& get_message() = 0;
ETL_NODISCARD
virtual const etl::imessage& get_message() const = 0;
ETL_NODISCARD
virtual etl::ireference_counter& get_reference_counter() = 0;
ETL_NODISCARD
virtual const etl::ireference_counter& get_reference_counter() const = 0;
virtual void release() = 0;
};
//***************************************************************************
// Reference counted message with a counter and owner.
//***************************************************************************
template <typename TMessage, typename TCounter>
class reference_counted_message : public etl::ireference_counted_message
{
public:
ETL_STATIC_ASSERT((etl::is_base_of<etl::imessage, TMessage>::value), "Not a message type");
typedef TMessage message_type;
typedef TCounter counter_type;
#if ETL_USING_CPP11
//***************************************************************************
//***************************************************************************
template <typename... TArgs>
reference_counted_message(etl::ireference_counted_message_pool& owner_, TArgs&&... args)
: rc_object(etl::forward<TArgs>(args)...)
, owner(owner_)
{
}
#endif
//***************************************************************************
//***************************************************************************
reference_counted_message(const TMessage& msg_, etl::ireference_counted_message_pool& owner_)
: rc_object(msg_)
, owner(owner_)
{
}
//***************************************************************************
//***************************************************************************
ETL_NODISCARD
virtual TMessage& get_message() ETL_OVERRIDE
{
return rc_object.get_object();
}
//***************************************************************************
//***************************************************************************
ETL_NODISCARD
virtual const TMessage& get_message() const ETL_OVERRIDE
{
return rc_object.get_object();
}
//***************************************************************************
//***************************************************************************
ETL_NODISCARD
virtual etl::ireference_counter& get_reference_counter() ETL_OVERRIDE
{
return rc_object.get_reference_counter();
}
//***************************************************************************
//***************************************************************************
ETL_NODISCARD
virtual const etl::ireference_counter& get_reference_counter() const ETL_OVERRIDE
{
return rc_object.get_reference_counter();
}
//***************************************************************************
//***************************************************************************
virtual void release() ETL_OVERRIDE
{
owner.release(*this);
}
private:
etl::reference_counted_object<TMessage, TCounter> rc_object;
etl::ireference_counted_message_pool& owner;
};
//***************************************************************************
// A persistent message with no counter and owner.
//***************************************************************************
template <typename TMessage>
class persistent_message : public etl::ireference_counted_message
{
public:
ETL_STATIC_ASSERT((etl::is_base_of<etl::imessage, TMessage>::value), "Not a message type");
typedef TMessage message_type;
typedef void counter_type;
//***************************************************************************
//***************************************************************************
explicit persistent_message(const TMessage& msg_)
: rc_object(msg_)
{
}
//***************************************************************************
//***************************************************************************
ETL_NODISCARD
virtual TMessage& get_message() ETL_OVERRIDE
{
return rc_object.get_object();
}
//***************************************************************************
//***************************************************************************
ETL_NODISCARD
virtual const TMessage& get_message() const ETL_OVERRIDE
{
return rc_object.get_object();
}
//***************************************************************************
//***************************************************************************
ETL_NODISCARD
virtual etl::ireference_counter& get_reference_counter() ETL_OVERRIDE
{
return rc_object.get_reference_counter();
}
//***************************************************************************
//***************************************************************************
ETL_NODISCARD
virtual const etl::ireference_counter& get_reference_counter() const ETL_OVERRIDE
{
return rc_object.get_reference_counter();
}
//***************************************************************************
//***************************************************************************
virtual void release() ETL_OVERRIDE
{
// Do nothing.
}
private:
etl::reference_counted_object<TMessage, void> rc_object;
};
#if ETL_USING_CPP11 && ETL_HAS_ATOMIC
//***************************************************************************
//***************************************************************************
template <typename TMessage>
using atomic_counted_message = etl::reference_counted_message<TMessage, etl::atomic_int32_t>;
#endif
} // namespace etl
#endif
etl::imessage
Definition message.h:73
etl::ireference_counted_message_pool
Interface for a reference counted message pool.
Definition ireference_counted_message_pool.h:44
etl::ireference_counted_message
Definition reference_counted_message.h:48
etl::ireference_counted_message::get_message
virtual ETL_NODISCARD const etl::imessage & get_message() const =0
Get a const reference to the message.
etl::ireference_counted_message::get_reference_counter
virtual ETL_NODISCARD etl::ireference_counter & get_reference_counter()=0
etl::ireference_counted_message::get_message
virtual ETL_NODISCARD etl::imessage & get_message()=0
Get a reference to the message.
etl::ireference_counted_message::get_reference_counter
virtual ETL_NODISCARD const etl::ireference_counter & get_reference_counter() const =0
Get a const reference to the reference counter.
etl::ireference_counted_message::release
virtual void release()=0
Release back to the owner.
etl::ireference_counter
The base of all reference counters.
Definition reference_counted_object.h:76
etl::persistent_message::get_reference_counter
virtual ETL_NODISCARD etl::ireference_counter & get_reference_counter() ETL_OVERRIDE
Definition reference_counted_message.h:204
etl::persistent_message::get_reference_counter
virtual ETL_NODISCARD const etl::ireference_counter & get_reference_counter() const ETL_OVERRIDE
Definition reference_counted_message.h:214
etl::persistent_message::get_message
virtual ETL_NODISCARD TMessage & get_message() ETL_OVERRIDE
Definition reference_counted_message.h:184
etl::persistent_message::release
virtual void release() ETL_OVERRIDE
Definition reference_counted_message.h:223
etl::persistent_message::get_message
virtual ETL_NODISCARD const TMessage & get_message() const ETL_OVERRIDE
Definition reference_counted_message.h:194
etl::persistent_message::persistent_message
persistent_message(const TMessage &msg_)
Definition reference_counted_message.h:174
etl::reference_counted_message
Definition reference_counted_message.h:69
etl::reference_counted_message::get_reference_counter
virtual ETL_NODISCARD etl::ireference_counter & get_reference_counter() ETL_OVERRIDE
Definition reference_counted_message.h:127
etl::reference_counted_message::get_message
virtual ETL_NODISCARD const TMessage & get_message() const ETL_OVERRIDE
Definition reference_counted_message.h:117
etl::reference_counted_message::get_reference_counter
virtual ETL_NODISCARD const etl::ireference_counter & get_reference_counter() const ETL_OVERRIDE
Definition reference_counted_message.h:137
etl::reference_counted_message::get_message
virtual ETL_NODISCARD TMessage & get_message() ETL_OVERRIDE
Definition reference_counted_message.h:107
etl::reference_counted_message::reference_counted_message
reference_counted_message(const TMessage &msg_, etl::ireference_counted_message_pool &owner_)
Definition reference_counted_message.h:96
etl::reference_counted_message::release
virtual void release() ETL_OVERRIDE
Definition reference_counted_message.h:146
etl::reference_counted_object
Definition reference_counted_object.h:217
ireference_counted_message_pool.h
etl
Definition absolute.h:40
platform.h
type_traits.h