comparison deps/Platinum/Source/Core/PltThreadTask.h @ 0:3425707ddbf6

Initial import (hopefully this mercurial stuff works...)
author fraserofthenight
date Mon, 06 Jul 2009 08:06:28 -0700
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:3425707ddbf6
1 /*****************************************************************
2 |
3 | Platinum - Thread Tasks
4 |
5 | Copyright (c) 2004-2008, Plutinosoft, LLC.
6 | All rights reserved.
7 | http://www.plutinosoft.com
8 |
9 | This program is free software; you can redistribute it and/or
10 | modify it under the terms of the GNU General Public License
11 | as published by the Free Software Foundation; either version 2
12 | of the License, or (at your option) any later version.
13 |
14 | OEMs, ISVs, VARs and other distributors that combine and
15 | distribute commercially licensed software with Platinum software
16 | and do not wish to distribute the source code for the commercially
17 | licensed software under version 2, or (at your option) any later
18 | version, of the GNU General Public License (the "GPL") must enter
19 | into a commercial license agreement with Plutinosoft, LLC.
20 |
21 | This program is distributed in the hope that it will be useful,
22 | but WITHOUT ANY WARRANTY; without even the implied warranty of
23 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 | GNU General Public License for more details.
25 |
26 | You should have received a copy of the GNU General Public License
27 | along with this program; see the file LICENSE.txt. If not, write to
28 | the Free Software Foundation, Inc.,
29 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
30 | http://www.gnu.org/licenses/gpl-2.0.html
31 |
32 ****************************************************************/
33
34 #ifndef _PLT_THREADTASK_H_
35 #define _PLT_THREADTASK_H_
36
37 /*----------------------------------------------------------------------
38 | includes
39 +---------------------------------------------------------------------*/
40 #include "Neptune.h"
41 #include "PltTaskManager.h"
42
43 /*----------------------------------------------------------------------
44 | PLT_ThreadTask class
45 +---------------------------------------------------------------------*/
46 class PLT_ThreadTask : public NPT_Runnable
47 {
48 public:
49 friend class PLT_TaskManager;
50
51 PLT_ThreadTask();
52
53 NPT_Result Kill();
54
55 virtual bool IsAborting(NPT_Timeout timeout = NPT_TIMEOUT_INFINITE) {
56 return NPT_SUCCEEDED(m_Abort.WaitUntilEquals(1, timeout));
57 }
58
59 protected:
60 NPT_Result Start(PLT_TaskManager* task_manager = NULL,
61 NPT_TimeInterval* delay = NULL,
62 bool auto_destroy = true);
63 NPT_Result Stop(bool blocking = true);
64
65 // overridable
66 virtual void DoAbort() {}
67 virtual void DoRun() {}
68 virtual void DoInit() {}
69
70 // the task manager will destroy the task when finished
71 // if m_AutoDestroy is set otherwise use Kill
72 virtual ~PLT_ThreadTask();
73
74 private:
75 // NPT_Thread methods
76 void Run();
77
78 protected:
79 // members
80 PLT_TaskManager* m_TaskManager;
81
82 private:
83 // members
84 NPT_SharedVariable m_Abort;
85 NPT_Thread* m_Thread;
86 bool m_AutoDestroy;
87 NPT_TimeInterval m_Delay;
88 };
89
90 /*----------------------------------------------------------------------
91 | PLT_ThreadTaskCallback class
92 +---------------------------------------------------------------------*/
93 class PLT_ThreadTaskCallback
94 {
95 public:
96 PLT_ThreadTaskCallback(NPT_Mutex& lock) : m_Lock(lock) {}
97 virtual ~PLT_ThreadTaskCallback() {};
98
99 NPT_Result Callback();
100
101 protected:
102 virtual NPT_Result DoCallback() = 0;
103
104 protected:
105 NPT_Mutex& m_Lock;
106 };
107
108 #endif /* _PLT_THREADTASK_H_ */