message.h

Go to the documentation of this file.

/*
 Copyright (c) 2026 - SD-Innovation S.A.S. - FRANCE
*/
 
/*
ver: 2.x.x - build: 2026-04-28
*/
 
/*
The zlib License

Copyright (c) 2026 SD-Innovation S.A.S. 

This software is provided ‘as-is’, without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.

2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.

3. This notice may not be removed or altered from any source
distribution.

*/
 
#pragma once
 
#include "defs.h"
 
namespace sdi_toolBox::desktop::eventBus
{
//--------------------------------------------------------------
class Message
{
  friend class Bus;     
 
  public:
 
  Message() = delete;
 
  virtual ~Message() = default;
 
  Message(const Message &obj) = delete;
 
  Message(Message &&obj) noexcept = delete;
 
  Message &operator=(const Message &obj) = delete;
 
  Message &operator=(Message &&obj) noexcept = delete;
 
  explicit Message(MessageTypeID messageTypeID);
 
 
  [[nodiscard]] MessageTypeID getMessageTypeID() const;
 
  [[nodiscard]] TimePoint getTimestamp() const;
 
 
  private:
  void updateTimestamp();
 
  MessageTypeID m_messageTypeID;              
  TimePoint     m_messagePostTimestamp{};     
};
//--------------------------------------------------------------
 
//--------------------------------------------------------------
/* Constructor */
inline Message::Message(const MessageTypeID messageTypeID)
{
  m_messageTypeID = messageTypeID;
}
//--------------------------------------------------------------
/* Get the unique identifier for the message type */
inline MessageTypeID Message::getMessageTypeID() const
{
  return m_messageTypeID;
}
//--------------------------------------------------------------
/* Get the timestamp of when the message was posted to the bus */
inline TimePoint Message::getTimestamp() const
{
  return m_messagePostTimestamp;
}
//--------------------------------------------------------------
/* Update the timestamp of when the message was posted to the bus */
inline void Message::updateTimestamp()
{
  m_messagePostTimestamp = std::chrono::steady_clock::now();
}
//--------------------------------------------------------------
}     // namespace sdi_toolBox::desktop::eventBus