signalMessageTransporter.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2007 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: signalMessageTransporter.h,v $ $Revision: 1.3 $ $State: Exp $
*******************************************************************************/



#ifndef signalMessageTransporter_h
#define signalMessageTransporter_h

#include "vrfMsgTransport/vrfMsgTransportDefines.h"
#include <vlpi/disEnums.h>
#include <vl/globalObjectDesignator.h>
#include "vrfmsgs/vrfObjectMessage.h"
#include "vrfutil/noArgumentCallbackList.h"
#include <vl/signalInteraction.h>
#include <vrfmsgs/splitMessageHandle.h>
#include <vrfutil/splitContentTimer.h>

class DtExerciseConn;
class DtSplitMessageKey;
class DtSignalMessageHeader;

const DtUserProtocol DtVrForcesSignalUserProtocol = (DtUserProtocol) 11050;

struct DtSignalMessageParams
{
   DtString commModelName;
   DtGlobalObjectDesignator senderDesignator;
   int radioIndex;
   double sampleRate;
};

typedef std::pair<DtSignalMessageParams*, DtVrfObjectMessageConstPtr> DtSignalMessageTransporterCallbackParams;

class DT_DLL_vrfMsgTransport DtSignalMessageTransporter
{
public:

   typedef struct _tSplitContentEntry{unsigned nSize; char* pBuffer;} SplitContentEntry;

   typedef std::map<DtSplitMessageKey, std::map<unsigned, SplitContentEntry> > SplitContentMap;

private:

   DtSignalMessageTransporter();
   DtSignalMessageTransporter(const DtSignalMessageTransporter& orig);
   DtSignalMessageTransporter& operator=(const DtSignalMessageTransporter& orig);

protected:
   DtSignalMessageTransporter(DtExerciseConn* exConn);
   virtual bool init();

public:
   static DtSignalMessageTransporter* create(DtExerciseConn* exConn);

   virtual ~DtSignalMessageTransporter();

   virtual void clearSplitContent();

   bool enabled() const;
   virtual void setEnabled(bool bEnabled);
   virtual bool processSplitContent(const DtSignalMessageParams& params,
      const DtSignalMessageHeader& msgHdr,
      const char *pContent);

   virtual void processSplitContentTimeout(const DtSplitMessageKey& key);

   virtual bool processVrfObjectMessageReceived(const DtSignalMessageParams& params,
      const char *pVrfObjectMessageBuffer);

   virtual bool reassembleVrfObjectMessage(const DtSignalMessageParams& params,
      const DtSignalMessageHeader& msgHdr);

   virtual void removeSplitContent(const DtSplitMessageKey& key);

   virtual void sendInteraction(const DtSignalMessageParams& params,
      const DtSignalMessageHeader& msgHdr,
      const char* pContent);

   virtual void sendMessage(const DtSignalMessageParams& params, 
      const DtVrfObjectMessage* message);

   typedef DtCallbackList<DtSignalMessageTransporterCallbackParams*> DtMessageReceivedCallbackList;


   virtual void addMessageReceivedCallback(DtMessageReceivedCallbackList::DtCallbackFunctionType fcn,
      void* usr);
   virtual void removeMessageReceivedCallback(DtMessageReceivedCallbackList::DtCallbackFunctionType fcn,
      void* usr);

   static void splitContentTimeoutCbk(const DtSplitMessageKey& key, void *pUsr);

protected:
   static void signalInteractionCallback(DtSignalInteraction* inter, void* usr);
   virtual void processSignalInteraction(DtSignalInteraction* inter);

   virtual void sendSignalInteraction(DtSignalInteraction& signalInteraction);

protected:
   bool myEnabled;
   DtExerciseConn* myExConn;
   DtMessageReceivedCallbackList myMessageReceivedCallbacks;
   SplitContentMap mySplitContentMap;
   DtSplitContentTimer mySplitContentTimer;
};

inline bool DtSignalMessageTransporter::enabled() const
{
   return myEnabled;
}
#endif