messageExecutive.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include "vrfmsgs/simMessage.h"
#include <vlutil/vlTime.h>

#include <map>
#include <list>


class DtMessageCallbackInfo;

typedef void (*DtMessageCallbackFcn)(DtSimMessage * msg, void * usr);
typedef std::list<DtMessageCallbackInfo> DtMessageCallbackList;

#include "vrfmsgs/vrfmsgsDefines.h"
#include <vector>

class DT_DLL_vrfmsgs DtMessageExecutive
{
public:

   DtMessageExecutive();

   virtual ~DtMessageExecutive();

   virtual void addSimMessageCallback(DtMessageCallbackFcn fcn, 
      void* usrData);

   virtual void removeSimMessageCallback(DtMessageCallbackFcn fcn, 
      void* usrData);

   virtual void processMessage(const DtSimMessage& msg) const;

   virtual int numSimCallbacks() const;

public:
   static unsigned generateMessageId();

   static int maximumContentSize();
   static void setMaximumContentSize(int sz);

   static unsigned maximumSignalDataSize();

   static DtTime timeoutCheckInterval();
   static void setTimeoutCheckInterval(DtTime nSecs);
   static DtTime timeoutDuration();
   static void setTimeoutDuration(DtTime nSecs);

protected:
   DtMessageExecutive(const DtMessageExecutive& orig);

   DtMessageExecutive& operator=(const DtMessageExecutive& orig);

   std::vector<DtMessageCallbackInfo> mySimMessageCallbackList;

   static int     theMaximumContentSize;
   static unsigned theMaxSignalDataSize;

   static unsigned   theSplitId;

   static DtTime  theTimeoutCheckInterval;
   static DtTime  theTimeoutDuration;
};

#if THREADING_ISSUES
This is not thread safe.  Will need to make the addition/removal of message types thread safe (if need be) -- see evalReceiveTextMessage.cxx
#endif
class DT_DLL_vrfmsgs DtIntMessageExecutive : public DtMessageExecutive
{
public:

   typedef std::map<int, DtMessageCallbackList > DtIntCallbackMap;

   DtIntMessageExecutive();

   virtual ~DtIntMessageExecutive();

   virtual void addMessageCallback(int type, DtMessageCallbackFcn fcn, 
      void* usrData);

   virtual void removeMessageCallback(int type, DtMessageCallbackFcn fcn, 
      void* usrData);

   virtual void processMessage(const DtSimMessage& msg) const;

   virtual int numCallbacks(int type) const;

   virtual int messageType(const DtSimMessage & message) const = 0;

protected:
   DtIntMessageExecutive(const DtIntMessageExecutive& orig);

   DtIntMessageExecutive& operator=(const DtIntMessageExecutive& orig);

   DtIntCallbackMap  myIntCallbackMap;
};

class DT_DLL_vrfmsgs DtStringMessageExecutive : public DtMessageExecutive
{
public:

   typedef std::map<DtString, DtMessageCallbackList > DtStringCallbackMap;

   DtStringMessageExecutive();

   virtual ~DtStringMessageExecutive();

   virtual void addMessageCallback(DtString type, DtMessageCallbackFcn fcn, 
      void* usrData);

   virtual void removeMessageCallback(DtString type, DtMessageCallbackFcn fcn, 
      void* usrData);

   virtual void processMessage(const DtSimMessage& msg) const;

   virtual int numCallbacks(DtString type) const;

   virtual DtString messageType(const DtSimMessage & message) const = 0;

protected:
   DtStringMessageExecutive(const DtStringMessageExecutive& orig);

   DtStringMessageExecutive& operator=(const DtStringMessageExecutive& orig);

   DtStringCallbackMap  myStringCallbackMap;
};