pControlMessage.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2012 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <portal/pMessage.h>


namespace MAKVrExchange
{

   class DtPortalConnection;

   class DT_DLL_LIBPORTAL DtPortalControlMessage : public DtPortalMessage
   {
   public:

      typedef void (*MessageCbFcn)( const DtPortalMessage& message, void* usr );

   public:

      DtPortalControlMessage();

      virtual ~DtPortalControlMessage();

      DtPortalControlMessage( const DtPortalControlMessage& original );

      virtual DtPortalMessageKind kind() const  = 0;

      virtual unsigned int netSize() const;

      virtual void writeSelfToBuffer( void* buffer ) const;

      virtual void readSelfFromBuffer( const void* buffer );

      DtDEC_ATTRIBUTE( DtString, BrokerName, brokerName );

      DtDEC_ATTRIBUTE( DtU32, BrokerId, brokerId );

   public:

      virtual std::ostream &printDataToStream( std::ostream &str ) const;

   };


   template <DtPortalMessageKind V_MessageKind>
   class DtPortalControlMessageTemplate: public DtPortalControlMessage
   {
   public:

      typedef void (*DtPortalControlMessageCb)(
         const DtPortalControlMessageTemplate<V_MessageKind> &msg, void *usr );

   public:

      DtPortalControlMessageTemplate();
      virtual ~DtPortalControlMessageTemplate();

      virtual DtPortalMessageKind kind() const;
      static DtPortalMessage *create();

      static void addCallback( DtPortalConnection* pConn,
         DtPortalControlMessageCb cb, void *usr );

      static void removeCallback( DtPortalConnection* pConn,
         DtPortalControlMessageCb cb, void *usr );

      static const DtPortalMessageKind theKind;

   };


   class DT_DLL_LIBPORTAL DtFilterObjectMessage
      : public DtPortalControlMessageTemplate<DtObjectFilterKind>
   {
   public:

      typedef DtPortalControlMessageTemplate<DtObjectFilterKind> BaseClassType;

      typedef void (*MessageCallbackType)(
         const DtFilterObjectMessage& message, void* userData );

   public:

      DtFilterObjectMessage();

      DtFilterObjectMessage( const DtFilterObjectMessage& original );

      DtFilterObjectMessage& operator = ( const DtFilterObjectMessage& original );

      virtual ~DtFilterObjectMessage();


      DtDEC_ATTRIBUTE( DtString, ObjectId, objectId );

      DtDEC_ATTRIBUTE( DtEntityIdentifier, EntityId, entityId );

      DtDEC_ATTRIBUTE( DtEntityType, EntityType, entityType );

      DtDEC_ATTRIBUTE( DtU16, FilterType, filterType );

      DtDEC_ATTRIBUTE( DtString, MarkingText, markingText );

      DtDEC_ATTRIBUTE( bool, FilterFlag, filterFlag );


   public:  //NOTE: DtDEC_ATTRIBUTE resets the access specifier to protected.

      bool operator == ( const DtFilterObjectMessage& leftHandOperand ) const;
      bool operator != ( const DtFilterObjectMessage& leftHandOperand ) const;

      virtual unsigned int netSize() const;

      virtual void writeSelfToBuffer( void* buffer ) const;

      virtual void readSelfFromBuffer( const void* buffer );

      virtual std::ostream& printDataToStream( std::ostream& stream ) const;

   public:

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

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

      static DtPortalMessage *create();

   };


   typedef DtPortalControlMessageTemplate<DtBrokerShutdownRequestKind> DtPortalBrokerShutdownRequestMessage;

   typedef DtPortalControlMessageTemplate<DtBrokerEnableOneToOneKind> DtPortalBrokerEnableOneToOneMessage;


   typedef DtPortalControlMessageTemplate<DtBrokerDisableOneToOneKind> DtPortalBrokerDisableOneToOneMessage;

   typedef DtPortalControlMessageTemplate<DtBrokerExitingMessageKind>  DtBrokerExitingMessage;

   typedef DtPortalControlMessageTemplate<DtBrokerStartedMessageKind> DtBrokerStartedMessage;

   typedef DtPortalControlMessageTemplate<DtRequestBrokerLaunchGuiMessageKind> DtBrokerLaunchGuiRequest;

   typedef DtPortalControlMessageTemplate<DtAbnormalBrokerExitKind> DtAbnormalBrokerExitMessage;

   typedef DtPortalControlMessageTemplate<DtHeartbeatRequestMessageKind> DtHeartbeatRequest;

   typedef DtPortalControlMessageTemplate<DtHeartbeatResponceMessageKind> DtHeartbeatResponce;

}

#define pControlMessage_INL_
#include <portal/pControlMessage.inl>
#undef  pControlMessage_INL_