assistantShutdownMsg.h

Go to the documentation of this file.

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


#ifndef assistantShutdownMsg_H_
#define assistantShutdownMsg_H_


#include "assistantMsg.h"
#include "netAssistantShutdownMsg.h"

class DtAssistantShutdownMsg;
class DtRtiAssistantServer;
class DtAssistantMsgQueue;

typedef void (*DtAssistantShutdownMsgCb)(const DtAssistantShutdownMsg& inter, void* usr);


class DT_DLL_ASSISTANT DtAssistantShutdownMsg : public DtAssistantMsg
{

public:

   enum DtShutdownEnum 
   { 
      DtDoNotShutdown = 0, 
      DtRequestShutdown, 
      DtForceShutdown 
   };
   
   DtAssistantShutdownMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtAssistantShutdownMsg(const DtNetAssistantShutdownMsg* netRep,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtAssistantShutdownMsg();

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

   virtual void setIsAssistantToAssistant(bool yesNo);
   virtual bool isAssistantToAssistant() const;

   virtual void setForceShutdown(bool yesNo);
   virtual bool isForceShutdown() const;

   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(DtRtiAssistantServer* conn,
      DtAssistantShutdownMsgCb cb, void* usr);
   static void removeCallback(DtRtiAssistantServer* conn, 
      DtAssistantShutdownMsgCb cb, void* usr);
   static void addCallback(DtAssistantMsgQueue* queue, 
      DtAssistantShutdownMsgCb cb, void* usr);
   static void removeCallback(DtAssistantMsgQueue* queue, 
      DtAssistantShutdownMsgCb cb, void* usr);

protected:

   virtual DtNetAssistantShutdownMsg* netAssistantShutdownMsg();
   virtual const DtNetAssistantShutdownMsg* netAssistantShutdownMsg() const;

   virtual DtAssistantMsgKind internalMsgKind();

   virtual int minSize() const;

};

#endif