resignMsg.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1998 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: resignMsg.h,v $ $Revision: 1.20 $ $State: Exp $
*********************************************************************/


#ifndef DtResignMsg_H_
#define DtResignMsg_H_

#include "rtiMsg.h"
#include "netResignMsg.h"
#if defined(DtIFSPEC1516) || defined(DtIFSPEC1516E) || defined(DtIFSPEC1516_2025)
#include "RTI/Enums.h"
#endif
#include <vlutil/vlFedTarget.h>

class DtConnectionMgr;
class DtResignMsg;
typedef void (*DtResignCb)(const DtResignMsg& inter, void* usr);

enum DtResignReason
{
   DtNormalResign,                  // Through API call
   DtNotHeartbeatedResign,          // Heartbeat msg not received in time
   DtLostConnectionResign,          // Lost reliable connection
   DtForwarderQueueFullResign,      // Forwarder queue for federate filled
   DtUserForcedResign,              // Forced through GUI or command line
   DtNormalResignExpectingResponse  // Through API call but expects a response from RTIEXEC
};

class DT_DLL_LRC DtResignMsg : public DtRtiMsg
{
public:

   DtResignMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtResignMsg(const char* fedExName,
      DtFederateHandle fedHandle,
      DtResignAction action,
      DtResignReason reason,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtResignMsg(const DtNetResignMsg* netRepMsg,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtResignMsg();

   virtual DtRtiMsg* clone(bool copy = true) const; 

   virtual void set(const char* fedExName,
      DtFederateHandle fedHandle,
      DtResignAction action,
      DtResignReason reason);

   virtual void setResignAction(DtResignAction action);
   virtual DtResignAction resignAction() const;

   virtual void setResignReason(DtResignReason reason);
   virtual DtResignReason resignReason() const;

   virtual void setTimeStamp(DtRtiApiTime const & time);
   virtual DtRtiApiTime const * timeStamp(DtLogicalTimeFactory* logicalTimeFactory) const;

   virtual void setTimeStampSize(int size);
   virtual int timeStampSize() const;

   virtual void printData(DtLogicalTimeFactory* logicalTimeFactory) const;

public:

   static DtRtiMsg* create(const DtNetMsgHeader* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static DtRtiMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static void addCallback(DtConnectionMgr* conn,
      DtResignCb cb, void* usr, bool isMomCallback=false);
   static void removeCallback(DtConnectionMgr* conn,
      DtResignCb cb, void* usr, bool isMomCallback=false);

protected:

   virtual DtNetResignMsg* netResignMsg();
   virtual const DtNetResignMsg* netResignMsg() const;

   virtual DtRtiMsgKind internalDtRtiMsgKind();

   virtual int minSize() const;

   virtual char* timeStampPtr();

   virtual DtResignMsg* self() const;

protected:

   DtRtiApiTime* myTimeStamp;

};


inline DtResignMsg* DtResignMsg::self() const
{
   return const_cast<DtResignMsg*>( this );
}


#endif