legionOwnershipTransferManager.h

Go to the documentation of this file.

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

#pragma once

#include "legionNetworkInterface/legionNetworkInterfaceDefines.h"
#include "legionNet/ownershipManager.h"
#include <boost/signals2.hpp>
#include <legionDataStore/dataTypes.h>
#include <vrfutil/rwUUID.h>

#include <set>

namespace Legion
{
   typedef UInt64 GlobalIdentifier;
}

namespace makVrfEvents
{
   class DtTransferRequestEvent;
   class DtTransferResponseEvent;
   class DtTransferAcquisitionRequestEvent;
   class DtTransferAcquisitionResponseEvent;
   class DtEvent;
   class DtEventManager;
}

namespace makVrf
{
   class DtLegionNetworkInterface;
   class DtLegionOwnershipTransferManager;

   typedef DtLegionOwnershipTransferManager* (*DtLegionOwnershipTransferManagerCreatorFcn)(DtLegionNetworkInterface*);

   class DT_DLL_legionNetworkInterface DtLegionOwnershipTransferManager
   {
   public:

      DtLegionOwnershipTransferManager(DtLegionNetworkInterface*);

      virtual ~DtLegionOwnershipTransferManager();

      static void setLegionOwnershipTransferManagerCreatorFcn(DtLegionOwnershipTransferManagerCreatorFcn);
      static DtLegionOwnershipTransferManager* create(DtLegionNetworkInterface*);

      virtual void setEventManager(makVrfEvents::DtEventManager*);

   protected:
      virtual void processOwnershipDivestitureRequest(Legion::TransactionIdentifier transactionId,
         Legion::Span<Legion::GlobalIdentifier> globalIds, Legion::Span<char> privateData);

      boost::signals2::signal<void (const makVrfEvents::DtTransferRequestEvent&, Legion::Span<Legion::GlobalIdentifier>, bool& continueOn)> signal_preOwnershipDivestitureRequest;
      boost::signals2::signal<void (const makVrfEvents::DtTransferAcquisitionRequestEvent&,
         Legion::Span<Legion::GlobalIdentifier>, bool& continueOn)> signal_preOwnershipAcquisitionRequest;

      virtual void processTransferEventResponse(const makVrfEvents::DtEvent&);
      virtual void processTransferAcquisitionEventResponse(const makVrfEvents::DtEvent&);

      virtual void processInitiateTakeEvent(const makVrfEvents::DtEvent&);

      virtual void processOwnershipAcquisitionRejected(Legion::TransactionIdentifier transactionId, Legion::Span<Legion::GlobalIdentifier> globalIds, Legion::Span<char> privateData);
      virtual void processOwnershipAcquired(Legion::TransactionIdentifier transactionId, Legion::Span<Legion::GlobalIdentifier> globalIds, Legion::Span<char> privateData);
      virtual void processOwnershipAcquisitionInitiateRequest(Legion::TransactionIdentifier transactionId,
         const Legion::Span<Legion::GlobalIdentifier> globalIds, Legion::Span<char> requestPrivateData);
      virtual std::set<DtUUID> globalIdsToUUIDs(const std::set<Legion::GlobalIdentifier>&) const;
      virtual std::set<DtUUID> globalIdsToUUIDs(const Legion::Span<Legion::GlobalIdentifier>&) const;

   protected:
      DtLegionNetworkInterface* myNetworkInterface;
      boost::signals2::connection myEventTransferResponseConnection;
      boost::signals2::connection myEventTransferAcquisitionResponseConnection;
      boost::signals2::connection myInitiateTakeEventConnection;
      static DtLegionOwnershipTransferManagerCreatorFcn theCreatorFunction;

      makVrfEvents::DtEventManager* myEventManager;

      Legion::UInt32 myDivestureCallbackHandle;
      Legion::UInt32 myAcquiredCallbackHandle;
      Legion::UInt32 myRequestRejectedCallbackHandle;
      Legion::UInt32 myInitiateAcquisitionRequestCallbackHandle;

      typedef std::map<Legion::TransactionIdentifier, std::set<Legion::GlobalIdentifier>> PendingTransactions;
      PendingTransactions myPendingTransactions;

      typedef std::map<Legion::TransactionIdentifier, std::vector<Legion::GlobalIdentifier>> PendingDivestRequests;
      PendingDivestRequests myPendingDivestRequests;
   };
}