assistantStateObserveMsg.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2008 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: assistantStateObserveMsg.h,v $ $Revision: 1.8 $ $State: Exp $
*********************************************************************/

#ifndef DtAssistantStateObserveMsg_H_
#define DtAssistantStateObserveMsg_H_


#include <vlutil/vlString.h>
#include <vlutil/vlUtil.h>

#include "assistantMsg.h"
#include "netAssistantStateObserveMsg.h"

class DtRtiAssistantPeer;
class DtRtiAssistantClient;
class DtAssistantStateObserveMsg;
class DtRtiConnectionInfo;

typedef void (*DtAssistantStateObserveCb)(const DtAssistantStateObserveMsg& inter, void* usr);

enum DtAssistantStateObserveType
{
   DtAssistantStateObserveFederationsOrRtiexec = 0,
   DtAssistantStateObserveForwarder,
   DtAssistantStateObserveForwarderPersistent
};

class DT_DLL_ASSISTANT DtAssistantStateObserveMsg : public DtAssistantMsg
{
public:

   DtAssistantStateObserveMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtAssistantStateObserveMsg(const DtNetAssistantStateObserveMsg* netRepMsg,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtAssistantStateObserveMsg();

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

   virtual bool isObserved() const;

   virtual void setIsObserved( bool observed );

   virtual bool isLogRequest() const;

   virtual void setIsLogRequest( bool observed );

   virtual void setDefunctRemovalTime( int removalTime );

   virtual int getDefunctRemovalTime() const;

   virtual bool isSingleView() const;

   virtual void setIsSingleView( bool oneTime ); 

   virtual unsigned int timeStateUpdateInterval() const;

   virtual void setTimeStateUpdateInterval( unsigned int interval );

   virtual DtAssistantStateObserveType targetType() const;

   virtual void setTargetType(DtAssistantStateObserveType target);

   virtual void getConnection( DtRtiConnectionInfo& conn,
      const MAKRti::DtInetAddr& address ) const;

   virtual void setConnection( const DtRtiConnectionInfo& conn );

   virtual void printData() const;

public:

   static DtAssistantMsg* create(const DtNetAssistantMsgHeader* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static DtAssistantMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static void addCallback(DtRtiAssistantClient* conn,
      DtAssistantStateObserveCb cb, void* usr);
   static void removeCallback(DtRtiAssistantClient* conn,
      DtAssistantStateObserveCb cb, void* usr);
      
   static void addCallback(DtRtiAssistantPeer* conn,
      DtAssistantStateObserveCb cb, void* usr);
   static void removeCallback(DtRtiAssistantPeer* conn,
      DtAssistantStateObserveCb cb, void* usr);
      
protected:

   virtual DtNetAssistantStateObserveMsg* netAssistantStateObserveMsg();
   virtual const DtNetAssistantStateObserveMsg* netAssistantStateObserveMsg() const;


   virtual MAKRti::DtString hostName() const;
   virtual void setHostName(const MAKRti::DtString& name);
   virtual void setHostNameSize(unsigned size);
   virtual unsigned hostNameSize() const;
   virtual const char* hostNamePtr() const;
   virtual char* hostNamePtr();


   virtual DtAssistantMsgKind internalMsgKind();

   virtual int minSize() const;

};

#endif