rfxMessageHandler.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*********************************************************************************/
 
//! \file rfxMessageHandler.h
//! \brief Defines a handler for RadarFX message callbacks
//! \ingroup vreRadarFxShared
//!
//! This file contains the message handler class that manages callback delegates
//! for different types of RadarFX messages
 
#pragma once
 
#include <vreRadarFxShared/export.h>
#include <vreRadarFxShared/delegate.h>
 
#include <map>
 
namespace makRadarFx
{
 
//! \brief Forward declaration of the base message class
class DtBaseMessage;
 
//! \brief Delegate type for message callbacks
//!
//! This typedef defines a delegate that takes a DtBaseMessage pointer as a parameter
//! and returns void. It is used for registering callback functions that will be
//! invoked when messages of specific types are received.
typedef DtDelegate<void, DtBaseMessage*> DtVreMessageDelegate;
 
//! \brief Manages message callbacks for different message types
//!
//! This class maintains a registry of callback delegates for various message types.
//! When a message is received, it can be passed to this handler, which will invoke
//! all registered callbacks for that message type. Multiple callbacks can be
//! registered for the same message type, allowing different components to respond
//! to the same messages.
class RFX_DLL_SHARED DtVreMessageHandler
{
public:
   //! \brief Default constructor
   //!
   //! Creates a new message handler with an empty callback registry
   DtVreMessageHandler();
 
   //! \brief Virtual destructor
   //!
   //! Cleans up the message handler resources
   virtual ~DtVreMessageHandler();
 
   //! \brief Registers a callback for a specific message type
   //! \param messageType The type of message to register for
   //! \param delegate The callback delegate to invoke when a message of this type is received
   //!
   //! Adds a callback delegate to be invoked when a message of the specified type
   //! is processed. Multiple callbacks can be registered for the same message type.
   //! Note that this class does not take ownership of the delegate's memory.
   virtual void addMessageCallback(unsigned int messageType, DtVreMessageDelegate& delegate);
 
   //! \brief Unregisters a specific callback for a message type
   //! \param messageType The type of message to unregister from
   //! \param delegate The callback delegate to remove
   //!
   //! Removes a previously registered callback delegate for the specified message type.
   //! This method does not free the memory associated with the delegate object.
   virtual void removeMessageCallback(unsigned int messageType, DtVreMessageDelegate& delegate);
 
   //! \brief Unregisters all callbacks for a specific message type
   //! \param messageType The type of message to clear all callbacks for
   //!
   //! Removes all registered callback delegates for the specified message type.
   //! This method does not free the memory associated with the delegate objects.
   virtual void clearMessageCallbacks(unsigned int messageType);
 
   //! \brief Processes a message by invoking all registered callbacks
   //! \param msg Pointer to the message to process
   //!
   //! Invokes all callback delegates that have been registered for the type
   //! of the provided message. The message is passed to each callback.
   virtual void processMessage(DtBaseMessage* msg);
 
protected:
   //! \brief Type definition for the multimap of message types to callback delegates
   typedef std::multimap<unsigned int, DtVreMessageDelegate> MessageMap;
 
   //! \brief Type definition for a message type and callback delegate pair
   typedef std::pair<unsigned int, DtVreMessageDelegate> MessagePair;
 
   //! \brief Map of message types to their associated callback delegates
   //!
   //! This multimap allows multiple callbacks to be registered for each message type
   MessageMap myMessageHandlers;
};
 
} // namespace makRadarFx