externalCommModel.h

Go to the documentation of this file.

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



#ifndef externalCommModel_h
#define externalCommModel_h

#include <vl/globalObjectDesignator.h>
#include <map>
#include <deque>
#include "vrfobjcore/commModel.h"
#include "vrfMsgTransport/externalCommsMessageTransporter.h"
#include "vrfobjcore/vrfobjcoreDefines.h"

class DtExternalCommModelDescriptor;

class DT_DLL_vrfobjcore DtExternalCommModel : public DtCommModel
{
private:

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

protected:
   DtExternalCommModel(DtCommModelCreationParams& params);
   virtual bool init();

public:
   static DtCommModel* create(DtCommModelCreationParams& params);

   virtual ~DtExternalCommModel();

   virtual DtString type() const;

   virtual void registerRadio(DtVrfRadio* radio);

   virtual void sendMessage(DtVrfObjectMessage* message, DtVrfRadio* sendingRadio);

   virtual void tick();

protected:
   virtual DtU32 nextMessageId(const DtEntityIdentifier& entityId);

   virtual void passMessageToReceiver(DtVrfObjectMessageConstPtr, const DtEntityIdentifier& receiver);

   static void messageClearToReceiveCallback(const DtExternalCommsProcessMessageData& data, void* usr);
   virtual void processMessageClearToReceive(const DtExternalCommsProcessMessageData& data);

   static void messageTimeoutCallback(const DtExternalCommsTimeoutData& data, void* usr);
   virtual void processMessageTimeout(const DtExternalCommsTimeoutData& data);

   static void newMessageCallback(const DtExternalCommsMessageTransporter::DtExternalCommsMessageCallbackParams& params, void* usr);
   virtual void processNewMessage(const DtExternalCommsMessageTransporter::DtExternalCommsMessageCallbackParams& params);

   static void readyToSendCallback(const DtExternalCommsReadyToSendData& data, void* usr);
   virtual void processReadyToSend(const DtExternalCommsReadyToSendData& data);

protected:
   

   struct DtClearToReceiveData
   {
      DtVrfObjectMessageConstPtr myRadioMessage;
      DtEntityIdentifier myReceiver;
   };

   DtU32 myLastMessageId;
   
   typedef std::map<DtU32, DtVrfObjectMessageConstPtr> DtRadioMessageMap;
   DtRadioMessageMap mySentMessages;
   DtExternalCommsMessageTransporter* myTransporter;

   typedef std::deque<DtClearToReceiveData> DtClearToReceiveDeque;
   DtClearToReceiveDeque myClearToReceiveDeque;

   const DtExternalCommModelDescriptor* myExternalCommModelDescriptor;

   typedef std::map<DtU32, DtExternalCommsProcessMessageData> DtExternalCommsMessageDataMap;
   DtExternalCommsMessageDataMap myWaitingForMessageMap;

   typedef std::map<DtU32, DtExternalCommsTimeoutData> DtExternalCommsTimeoutMap;
   DtExternalCommsTimeoutMap myTimedOutMessageMap;
};

#endif