src/AsyncFramework/JobBase.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2009-2010 by Stefan Fuhrmann                            *
   3  *   stefanfuhrmann@alice-dsl.de                                           *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #include "stdafx.h"
  22 #include "JobBase.h"
  23 #include "JobScheduler.h"
  24
  25 namespace async
  26 {
  27
  28 // For now, update the internal @a scheduled flag only.
  29
  30 void CJobBase::OnSchedule (CJobScheduler*)
  31 {
  32     if (InterlockedExchange (&scheduled, TRUE) == TRUE)
  33         assert (0);
  34 }
  35
  36 // For now, update the internal @a scheduled flag only.
  37
  38 void CJobBase::OnUnSchedule (CJobScheduler*)
  39 {
  40     if (InterlockedExchange (&scheduled, FALSE) == FALSE)
  41         assert (0);
  42     else
  43         if (executionDone.Test())
  44             deletable.Set();
  45 }
  46
  47 // nothing special during construction / destuction
  48
  49 CJobBase::CJobBase(void)
  50     : waiting (TRUE)
  51     , terminated (FALSE)
  52     , scheduled (FALSE)
  53 {
  54 }
  55
  56 CJobBase::~CJobBase(void)
  57 {
  58     assert (deletable.Test());
  59 }
  60
  61 // call this to put the job into the scheduler
  62
  63 void CJobBase::Schedule (bool transferOwnership, CJobScheduler* scheduler)
  64 {
  65     if (scheduler == NULL)
  66         scheduler = CJobScheduler::GetDefault();
  67
  68     scheduler->Schedule (this, transferOwnership);
  69 }
  70
  71 // will be called by job execution thread
  72
  73 void CJobBase::Execute()
  74 {
  75     // intended for one-shot execution only
  76     // skip jobs that have already been executed or
  77     // are already/still being executed.
  78
  79     if (InterlockedExchange (&waiting, FALSE) == TRUE)
  80     {
  81         if (terminated == FALSE)
  82             InternalExecute();
  83
  84         executionDone.Set();
  85
  86         if (scheduled == FALSE)
  87             deletable.Set();
  88     }
  89 }
  90
  91 // may be called by other (observing) threads
  92
  93 IJob::Status CJobBase::GetStatus() const
  94 {
  95     if (waiting == TRUE)
  96         return IJob::waiting;
  97
  98     return executionDone.Test() ? IJob::done : IJob::running;
  99 }
 100
 101 void CJobBase::WaitUntilDone (bool inlineExecution)
 102 {
 103     if (inlineExecution)
 104         Execute();
 105
 106     executionDone.WaitFor();
 107 }
 108
 109 bool CJobBase::WaitUntilDoneOrTimeout(DWORD milliSeconds)
 110 {
 111     return executionDone.WaitForEndOrTimeout(milliSeconds);
 112 }
 113
 114 // handle early termination
 115
 116 void CJobBase::Terminate()
 117 {
 118     InterlockedExchange (&terminated, TRUE);
 119 }
 120
 121 bool CJobBase::HasBeenTerminated() const
 122 {
 123     return terminated == TRUE;
 124 }
 125
 126 // Call @a delete on this job as soon as it is safe to do so.
 127
 128 void CJobBase::Delete (bool terminate)
 129 {
 130     if (terminate)
 131         Terminate();
 132
 133     if (waiting)
 134         Execute();
 135
 136     deletable.WaitFor();
 137     delete this;
 138 }
 139
 140 }