fsIMessageDispatcher.h

Go to the documentation of this file.

/********************************************************************
*
*       Created:        4/3/2014   11:49
*
*       File:           fsIMessageDispatcher.h
*
*       Author:         Mick Waites
*       
*       Purpose:        Base class for any message transmitting classes. All
*                               messages are sent to listeners in the order that they
*                               register themselves.
*
*********************************************************************/
 
#ifndef fsIMessageDispatcherhdr
#define fsIMessageDispatcherhdr
 
#include <map>
#include <vector>
 
#include <fsCore/src/fsCUniqueId.h>
#include <fsCore/fsBaseTypes.h>
 
class fsIMessageListener;
 
 
class fsIMessageDispatcher
{
public:
 
        struct sMessageParameters
        {
                virtual ~sMessageParameters()
                {
                }
        };
 
        struct sStrMessageParam : public sMessageParameters
        {
                sStrMessageParam() = default;
                explicit sStrMessageParam(const fsStr& pStr) : mStr(pStr) {}
                fsStr mStr;
        };
 
        void priorityListenerButtonClear();
        void priorityListenerRegister(fsIMessageListener* pListener);
        void priorityListenerDeregister(fsIMessageListener* pListener);
 
        void listenerRegister(const fsCUniqueId& pMessageType, fsIMessageListener* pListener);
        void listenerDeregister(const fsCUniqueId& pMessageType, fsIMessageListener* pListener);
 
        fsBool messageDispatch(const fsCUniqueId& pMessageType, const sMessageParameters& pParam);
 
        static sMessageParameters mNullParam;
 
protected:
 
        virtual fsBool messageDispatchDo(const fsCUniqueId& pMessageType, const sMessageParameters& pParam);
 
        fsIMessageDispatcher();
        virtual ~fsIMessageDispatcher();
 
private:
 
        void pendingListenerRegistrationsProcess();
 
        fsBool mInDispatch;
 
        fsIMessageListener* mPriorityListener;
 
        std::map<fsCUniqueId, std::vector<fsIMessageListener*>> mMsgTypes;
        std::vector<std::pair<fsIMessageListener*, fsCUniqueId>> mListenersToRegister;
        std::vector<std::pair<fsIMessageListener*, fsCUniqueId>> mListenersToDeregister;
};
 
#endif