Files
externals/linux/include/ActivMiddleware/ActivBase/MessageHandler.h
T
2023-12-15 13:15:08 -05:00

162 lines
4.6 KiB
C++

/**
* @file include/ActivMiddleware/ActivBase/MessageHandler.h
*
* @brief Header file for the base message handler class.
*/
#if (!defined ACTIV_BASE_MESSAGE_HANDLER_H)
#define ACTIV_BASE_MESSAGE_HANDLER_H
#include "ActivMiddleware/ActivBase/External.h"
//! Activ namespace.
namespace Activ
{
/**
* @brief Base class for validator and builder.
*/
class MessageHandler
{
public:
typedef uint16_t DefaultStringLength; ///< Definition of the default string length type.
typedef uint8_t MessageVersion; ///< Definition of the version type.
static const byte_t MIN_PRINTABLE_ASCII = 0x20; ///< The minimum printable ascii character.
static const byte_t MAX_PRINTABLE_ASCII = 0x7e; ///< The maximum printable ascii character.
static const MessageVersion MESSAGE_VERSION_UNDEFINED = ~0; ///< Undefined version value.
/**
* @brief Endian enumeration.
*/
enum Endian
{
ENDIAN_LITTLE, ///< Little endian
ENDIAN_BIG, ///< Big endian
#if (defined ACTIV_LITTLE_ENDIAN)
ENDIAN_LOCAL = ENDIAN_LITTLE, ///< Local endian
ENDIAN_ALIEN = ENDIAN_BIG
#else
ENDIAN_LOCAL = ENDIAN_BIG, ///< Local endian
ENDIAN_ALIEN = ENDIAN_LITTLE
#endif
};
/**
* @brief Helper class to scope changes to message version.
*/
class ScopedVersion : private Boost::noncopyable
{
public:
/**
* @brief Constructor.
*
* Caches the current message version to restore when this object is destructed.
*
* @param messageHandler MessageHandler to set version of.
*/
ScopedVersion(MessageHandler &messageHandler);
/**
* @brief Constructor.
*
* Caches the current message version to restore when this object is destructed and
* sets the current version to a new value.
*
* @param messageHandler MessageHandler to set version of.
* @param newVersion version to set.
*/
ScopedVersion(MessageHandler &messageHandler, const MessageVersion newVersion);
/**
* @brief Destructor.
*
* The original message version is restored.
*/
~ScopedVersion();
private:
MessageHandler & m_messageHandler;
const MessageVersion m_oldVersion;
};
/**
* @brief Constructor.
*
* @param messageVersion optional version.
*/
MessageHandler(const MessageVersion messageVersion = MESSAGE_VERSION_UNDEFINED);
/**
* @brief Get the version.
*
* @return The version.
*/
MessageVersion GetMessageVersion() const;
/**
* @brief Set the version.
*
* @param messageVersion the new version to set.
*
* @return The previous version.
*/
MessageVersion SetMessageVersion(const MessageVersion messageVersion);
private:
MessageVersion m_messageVersion;
};
// ---------------------------------------------------------------------------------------------------------------------------------
inline MessageHandler::MessageHandler(const MessageVersion messageVersion)
{
SetMessageVersion(messageVersion);
}
// ---------------------------------------------------------------------------------------------------------------------------------
inline MessageHandler::MessageVersion MessageHandler::GetMessageVersion() const
{
return m_messageVersion;
}
// ---------------------------------------------------------------------------------------------------------------------------------
inline MessageHandler::MessageVersion MessageHandler::SetMessageVersion(const MessageVersion messageVersion)
{
const MessageVersion oldMessageVersion = m_messageVersion;
m_messageVersion = messageVersion;
return oldMessageVersion;
}
// ---------------------------------------------------------------------------------------------------------------------------------
// ---------------------------------------------------------------------------------------------------------------------------------
inline MessageHandler::ScopedVersion::ScopedVersion(MessageHandler &messageHandler) :
m_messageHandler(messageHandler),
m_oldVersion(m_messageHandler.GetMessageVersion())
{
}
// ---------------------------------------------------------------------------------------------------------------------------------
inline MessageHandler::ScopedVersion::ScopedVersion(MessageHandler &messageHandler, const MessageVersion newVersion) :
m_messageHandler(messageHandler),
m_oldVersion(m_messageHandler.SetMessageVersion(newVersion))
{
}
// ---------------------------------------------------------------------------------------------------------------------------------
inline MessageHandler::ScopedVersion::~ScopedVersion()
{
(void) m_messageHandler.SetMessageVersion(m_oldVersion);
}
} // namespace Activ
#endif // (!defined ACTIV_BASE_MESSAGE_HANDLER_H)