asyncJob.h

Go to the documentation of this file.

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


#pragma once

#include <vrfutil/vrfutilDefines.h>

#include <vlutil/vlPrint.h>
#include <vlutil/vlExceptions.h>

#include "asyncJobMapEntry.h"
#include "asyncJobServer.h"

#include "vrfutil/algorithmManager.h"
#include <vrfutil/objectCounter.h>

#include <boost/function.hpp>

class DtAsyncJob;

struct job_canceled{};

class DT_DLL_vrfutil DtJobCancelledFunc
{ 
public:
   DtJobCancelledFunc(const DtAsyncJob& job);
   bool operator()() const;

protected:
   const DtAsyncJob& job;
};

class DT_DLL_vrfutil DtAsyncJob
   : public DtAlgorithmManager
#ifdef DtObjectDebugger_Enable
   , public DtObjectDebugger<DtAsyncJob>
#endif
{
public:
   DtAsyncJob();

   virtual ~DtAsyncJob();

   virtual void execute();

   virtual void onExecute() = 0;

   virtual void onException() = 0;

   virtual void tick();

   virtual std::shared_ptr<DtAsyncJobMapEntry> getEntry() const = 0;

   virtual void setEntry(std::shared_ptr<DtAsyncJobMapEntry>) = 0;

   virtual bool cancel() const override;
   
protected:
   DtAsyncJobServer* myServer;
};

class DT_DLL_vrfutil DtAsyncManagedJob : public DtAsyncJob
{
public:
   virtual std::shared_ptr<DtAsyncJobMapEntry> getEntry() const override;
   virtual void setEntry(std::shared_ptr<DtAsyncJobMapEntry>) override;

protected:
   std::weak_ptr<DtAsyncJobMapEntry> myEntry;
};

class DT_DLL_vrfutil DtAsyncDetachedJob : public DtAsyncJob
{
public:
   virtual std::shared_ptr<DtAsyncJobMapEntry> getEntry() const override;
   virtual void setEntry(std::shared_ptr<DtAsyncJobMapEntry>) override;

   virtual void execute() override;

protected:
   std::shared_ptr<DtAsyncJobMapEntry> myEntry;
};

DT_DEFINE_OBJECT_DEBUGGER_NAME(DtAsyncJob);