forwarderPingMsg.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2005 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: forwarderPingMsg.h,v $ $Revision: 1.7 $ $State: Exp $
*********************************************************************/


#ifndef DtForwarderPingMsg_H_
#define DtForwarderPingMsg_H_

#include "rtiMsConfig.h"
#include "rtiMsg.h"

class DtConnectionMgr;
class DtForwarderPingMsg;
class DtNetForwarderPingMsg;
typedef void (*DtForwarderPingCb)(const DtForwarderPingMsg& inter, void* usr);

class DT_DLL_LRC DtForwarderPingMsg : public DtRtiMsg
{
public:
   enum DtPingStatus
   {
      PingRequest = 0,
      PingResponseSuccess,
      PingResponseNotFound
   };
         
   DtForwarderPingMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtForwarderPingMsg(const DtNetForwarderPingMsg* netRep,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtForwarderPingMsg( unsigned long target, DtPingStatus status,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtForwarderPingMsg();

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


   virtual void set( unsigned long target, DtPingStatus status );
   
   virtual void setPingStatus( DtPingStatus status );
   virtual DtPingStatus pingStatus() const;
   
   virtual void setDestination( unsigned long target );
   virtual unsigned long destination() 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,
      DtForwarderPingCb cb, void* usr, bool isMomCallback=false);
   static void removeCallback(DtConnectionMgr* conn,
      DtForwarderPingCb cb, void* usr, bool isMomCallback=false);

protected:

   virtual DtNetForwarderPingMsg* netForwarderPingMsg();
   virtual const DtNetForwarderPingMsg* netForwarderPingMsg() const;

   virtual DtRtiMsgKind internalDtRtiMsgKind();

   virtual int minSize() const;

   virtual DtForwarderPingMsg* self() const;
   
protected:

};

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


#endif