pAcknowledgeInter.h

Go to the documentation of this file.

/******************************************************************************
 ** Copyright (c) 1992-2010 VT MAK
******************************************************************************/

#ifndef pAcknowledgeInter_H_
#define pAcknowledgeInter_H_


 
#include <portal/pBaseInteraction.h> 

namespace MAKVrExchange 
{

   class DtPortalConnection;


   class DT_DLL_LIBPORTAL DtPortalAcknowledgeInteraction : public DtPortalBaseInteraction
   {
   public:
      typedef void (*functionCallback_type) (const DtPortalAcknowledgeInteraction &interaction, 
         void *userData);

      DtPortalAcknowledgeInteraction();

      virtual ~DtPortalAcknowledgeInteraction();




      DtDEC_ATTRIBUTE( DtString, OriginatingEntity, originatingEntity );
      DtDEC_ATTRIBUTE( DtString, ReceivingEntity,   receivingEntity );
      DtDEC_ATTRIBUTE( DtU32,    RequestIdentifier, requestIdentifier );
      DtDEC_ATTRIBUTE( DtU32,    AcknowledgeFlag,   acknowledgeFlag );
      DtDEC_ATTRIBUTE( DtU32,    ResponseFlag,      responseFlag );

   public:

      static const DtPortalMessageKind theKind;

      //Doxygen comments inherited from parent class
      virtual DtPortalMessageKind kind() const;

      // Returns the name of the interaction: "Acknowledge"
      virtual const char *interactionKindName() const;

      //Doxygen comments inherited from parent class
      virtual unsigned int netSize() const;

      //Doxygen comments inherited from parent class
      virtual void writeSelfToBuffer( void *buffer ) const;

      //Doxygen comments inherited from parent class
      virtual void readSelfFromBuffer( const void *buffer );

      static void addCallback( DtPortalConnection *connection, 
         functionCallback_type  callbackFunction, void *userData );

      static void removeCallback( DtPortalConnection *connection, 
         functionCallback_type  callbackFunction, void *userData );

      static DtPortalMessage *create();

      //Doxygen comments inherited from parent class
      virtual std::ostream &printDataToStream( std::ostream &str ) const;

   private:

      DtPortalAcknowledgeInteraction &operator=( const DtPortalAcknowledgeInteraction & );

      int operator==( const DtPortalAcknowledgeInteraction & );

      int operator!=( const DtPortalAcknowledgeInteraction & );

   }; //end class DtPortalAcknowledgeInteraction

   inline DtPortalMessage *DtPortalAcknowledgeInteraction::create()
   {
      return new DtPortalAcknowledgeInteraction();
   }

   inline const char *DtPortalAcknowledgeInteraction::interactionKindName() const
   {
      return "Acknowledge";
   }

   inline DtPortalMessageKind DtPortalAcknowledgeInteraction::kind() const
   {
      return theKind;
   }

}

#endif //end #ifndef pAcknowledgeInter_H_