vrlinkOwnershipTransferTranslator.h

Go to the documentation of this file.

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


#pragma once

#include <vrlinkNetworkInterface/vrlinkNetworkInterfaceDefines.h>
#include <vrlinkNetworkInterface/vrlinkEventTranslator.h>
#include <vl/transferControlInteraction.h>
#include <vl/acknowledgeInteraction.h>

#include <vrfutil/uuid.h>

class DtTransferControlManager;
class DtEntityPublisher;
class DtReflectedEntity;
class DtReflectedDIGuyObject;

#if DtHLA
class DtHlaObject;
namespace makVrfVrlinkExtToolkit
{
   class DtReflectedExtendedAttributesObject;
}
#endif

namespace makVrfEvents
{
   class DtInitiateTakeEvent;
   class DtTransferResponseEvent;
}

namespace makVrf
{
   class DtVrfTransferControlManager;

   class DT_DLL_vrlinkNetworkInterface DtVrlinkOwnershipTransferTranslator : public DtVrlinkEventTranslator
   {
   public:
      enum RecordDatum
      {
         VrfDatumRecord = 613
      };

   public:
      DtVrlinkOwnershipTransferTranslator();
      virtual ~DtVrlinkOwnershipTransferTranslator() override;

      virtual void init(DtVrlinkNetworkInterface*) override;

      static void transferControlRequestNotificationCallback(DtTransferControlInteraction* tci, void* user);
      virtual void processTransferControlRequestNotification(DtTransferControlInteraction*);

      static void acknowledgeMentNotificationCallback(DtAcknowledgeInteraction* tci, void* user);
      virtual void processAcknowledgeMentNotification(DtAcknowledgeInteraction*);

      static void gainedOwnershipOfEntityCallback(DtEntityPublisher* newEntityPublisher, DtU32 requestIdentifier, void* usr);
      virtual void processGainedOwnershipOfEntity(DtEntityPublisher* newEntityPublisher, DtU32 requestIdentifier);

      static void lostOwnershipOfEntityCallback(DtReflectedEntity* lostEntity, void* usr);
      virtual void processLostOwnershipOfEntity(DtReflectedEntity* lostEntity);

      virtual bool supportsOwnershipTransfer() const;

   protected:
      virtual bool processEvent(const makVrfEvents::DtEvent&) override;

#if DtHLA
      static bool pullRequestCallback(DtHlaObject*, void*);
      static void lostOwnershipOfDIGuyCallback(DtReflectedDIGuyObject* lostDiguy, void* usr);
      virtual void processLostOwnershipOfDIGuy(DtReflectedDIGuyObject* lostDiguy);

      static void lostOwnershipOfExtendedAttributesCallback(makVrfVrlinkExtToolkit::DtReflectedExtendedAttributesObject* lostExtAttr, void* usr);
      virtual void processLostOwnershipOfExtendedAttributes(makVrfVrlinkExtToolkit::DtReflectedExtendedAttributesObject* lostExtAttr);
#else
      static bool pullRequestCallback(const DtEntityIdentifier*, void*);
#endif

      virtual void initiateTake(const makVrfEvents::DtInitiateTakeEvent&);
      virtual void transferResponse(const makVrfEvents::DtTransferResponseEvent&);

   protected:
      DtVrfTransferControlManager* myControlManager = nullptr;
      std::set<DtUUID> myAwaitingTransfer;
   };
}