asyncJob.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright 2010 VT MAK
*******************************************************************************/


#pragma once

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

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

#include "tbb/task.h"

#include "boost/function.hpp"


#include <vrfutil/vrfutilDefines.h>

struct job_canceled{}; //exception for termination of a task during execution.
struct outside_search_radius{}; //exception for graph search has gone too far out of the way.

struct DtJobCancelStruct
{ 
   DtJobCancelStruct(size_t id, DtAsyncJobServer* jobServer)
      : myId(id)
      , myJobServer(jobServer)
   {

   }

   bool operator()() const 
   { 
      return myJobServer->jobStatus(myId) == canceled;
   }

   size_t myId;
   DtAsyncJobServer* myJobServer;
};

//An asynchronous job that can be added to and executed by a job server.
class DT_DLL_vrfutil DtAsyncJob : public tbb::task
{
public:
   DtAsyncJob();

   virtual ~DtAsyncJob();

   //Do not override. Calls onExecute, then onException if there is an exception thrown.
   virtual task* execute();

   virtual task* onExecute() = 0;
   virtual task* onException() = 0;
   
protected:
   friend class DtAsyncJobServer;
   DtAsyncJobServer* myJobServer;
   size_t myId;
};