pTransferControlInteraction.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2016 MAK Technologies, Inc.
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <portal/pInteraction.h>
#include <portal/vrxRecordSetList.h>

namespace MAKVrExchange
{

   class DtPortalConnection;

   class DT_DLL_LIBPORTAL DtPortalTransferControlInteraction
      : public DtPortalInteraction
   {
   public:

      typedef void (*functionCallback_type) (
         const DtPortalTransferControlInteraction& interaction, void* usr );

      DtPortalTransferControlInteraction();

      DtPortalTransferControlInteraction( const DtPortalTransferControlInteraction& other );

      virtual ~DtPortalTransferControlInteraction();

      DtPortalTransferControlInteraction& operator = ( const DtPortalTransferControlInteraction& other );

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

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


      DtDEC_ATTRIBUTE( DtString, OriginatingEntity, originatingEntity );
      DtDEC_ATTRIBUTE( DtString, ReceivingEntity, receivingEntity );
      DtDEC_ATTRIBUTE( DtU32, RequestIdentifier, requestIdentifier );
      DtDEC_ATTRIBUTE( DtU32, TransferType, transferType );
      DtDEC_ATTRIBUTE( DtString, TransferredEntityID, transferredEntityID );

   public:

      virtual DtU32 numRecordSets() const;

      virtual bool setRecordSet( int index, const DtRecordSet& set );
      virtual const DtRecordSet& recordSet( int index,
         bool* valid = NULL ) const;

      virtual const DtVrxRecordSetList& recordSetList() const;


   public:

      static const DtPortalMessageKind theKind;

      static DtPortalMessage* create();

      virtual unsigned int netSize() const;
      virtual void writeSelfToBuffer( void* buffer, int bufferSize ) const;
      virtual void readSelfFromBuffer( const void* buffer, int bufferSize );

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

   protected:

      DtVrxRecordSetList myRecordSetList;

   };


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

}