[80] | 1 | // |
---|
| 2 | // TaskManager.h |
---|
| 3 | // |
---|
| 4 | // $Id: //poco/1.3/Foundation/include/Poco/TaskManager.h#1 $ |
---|
| 5 | // |
---|
| 6 | // Library: Foundation |
---|
| 7 | // Package: Tasks |
---|
| 8 | // Module: Tasks |
---|
| 9 | // |
---|
| 10 | // Definition of the TaskManager class. |
---|
| 11 | // |
---|
| 12 | // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. |
---|
| 13 | // and Contributors. |
---|
| 14 | // |
---|
| 15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
| 16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
| 17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
| 18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
| 19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
| 20 | // do so, all subject to the following: |
---|
| 21 | // |
---|
| 22 | // The copyright notices in the Software and this entire statement, including |
---|
| 23 | // the above license grant, this restriction and the following disclaimer, |
---|
| 24 | // must be included in all copies of the Software, in whole or in part, and |
---|
| 25 | // all derivative works of the Software, unless such copies or derivative |
---|
| 26 | // works are solely in the form of machine-executable object code generated by |
---|
| 27 | // a source language processor. |
---|
| 28 | // |
---|
| 29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
| 30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
| 31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
| 32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
| 33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
| 34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
| 35 | // DEALINGS IN THE SOFTWARE. |
---|
| 36 | // |
---|
| 37 | |
---|
| 38 | |
---|
| 39 | #ifndef Foundation_TaskManager_INCLUDED |
---|
| 40 | #define Foundation_TaskManager_INCLUDED |
---|
| 41 | |
---|
| 42 | |
---|
| 43 | #include "Poco/Foundation.h" |
---|
| 44 | #include "Poco/Mutex.h" |
---|
| 45 | #include "Poco/Task.h" |
---|
| 46 | #include "Poco/AutoPtr.h" |
---|
| 47 | #include "Poco/NotificationCenter.h" |
---|
| 48 | #include "Poco/Timestamp.h" |
---|
| 49 | #include <list> |
---|
| 50 | |
---|
| 51 | |
---|
| 52 | namespace Poco { |
---|
| 53 | |
---|
| 54 | |
---|
| 55 | class Notification; |
---|
| 56 | class ThreadPool; |
---|
| 57 | class Exception; |
---|
| 58 | |
---|
| 59 | |
---|
| 60 | class Foundation_API TaskManager |
---|
| 61 | /// The TaskManager manages a collection of tasks |
---|
| 62 | /// and monitors their lifetime. |
---|
| 63 | /// |
---|
| 64 | /// A TaskManager has a built-in NotificationCenter that |
---|
| 65 | /// is used to send out notifications on task progress |
---|
| 66 | /// and task states. See the TaskNotification class and its |
---|
| 67 | /// subclasses for the various events that result in a notification. |
---|
| 68 | /// To keep the number of notifications small, a TaskProgressNotification |
---|
| 69 | /// will only be sent out once in 100 milliseconds. |
---|
| 70 | { |
---|
| 71 | public: |
---|
| 72 | typedef AutoPtr<Task> TaskPtr; |
---|
| 73 | typedef std::list<TaskPtr> TaskList; |
---|
| 74 | |
---|
| 75 | TaskManager(); |
---|
| 76 | /// Creates the TaskManager, using the |
---|
| 77 | /// default ThreadPool. |
---|
| 78 | |
---|
| 79 | TaskManager(ThreadPool& pool); |
---|
| 80 | /// Creates the TaskManager, using the |
---|
| 81 | /// given ThreadPool. |
---|
| 82 | |
---|
| 83 | ~TaskManager(); |
---|
| 84 | /// Destroys the TaskManager. |
---|
| 85 | |
---|
| 86 | void start(Task* pTask); |
---|
| 87 | /// Starts the given task in a thread obtained |
---|
| 88 | /// from the thread pool. |
---|
| 89 | /// |
---|
| 90 | /// The TaskManager takes ownership of the Task object |
---|
| 91 | /// and deletes it when it it finished. |
---|
| 92 | |
---|
| 93 | void cancelAll(); |
---|
| 94 | /// Requests cancellation of all tasks. |
---|
| 95 | |
---|
| 96 | void joinAll(); |
---|
| 97 | /// Waits for the completion of all the threads |
---|
| 98 | /// in the TaskManager's thread pool. |
---|
| 99 | |
---|
| 100 | TaskList taskList() const; |
---|
| 101 | /// Returns a copy of the internal task list. |
---|
| 102 | |
---|
| 103 | int count() const; |
---|
| 104 | /// Returns the number of tasks in the internal task list. |
---|
| 105 | |
---|
| 106 | void addObserver(const AbstractObserver& observer); |
---|
| 107 | /// Registers an observer with the NotificationCenter. |
---|
| 108 | /// Usage: |
---|
| 109 | /// Observer<MyClass, MyNotification> obs(*this, &MyClass::handleNotification); |
---|
| 110 | /// notificationCenter.addObserver(obs); |
---|
| 111 | |
---|
| 112 | void removeObserver(const AbstractObserver& observer); |
---|
| 113 | /// Unregisters an observer with the NotificationCenter. |
---|
| 114 | |
---|
| 115 | static const int MIN_PROGRESS_NOTIFICATION_INTERVAL; |
---|
| 116 | |
---|
| 117 | protected: |
---|
| 118 | void postNotification(Notification* pNf); |
---|
| 119 | /// Posts a notification to the task manager's |
---|
| 120 | /// notification center. |
---|
| 121 | |
---|
| 122 | void taskStarted(Task* pTask); |
---|
| 123 | void taskProgress(Task* pTask, float progress); |
---|
| 124 | void taskCancelled(Task* pTask); |
---|
| 125 | void taskFinished(Task* pTask); |
---|
| 126 | void taskFailed(Task* pTask, const Exception& exc); |
---|
| 127 | |
---|
| 128 | private: |
---|
| 129 | ThreadPool& _threadPool; |
---|
| 130 | TaskList _taskList; |
---|
| 131 | Timestamp _lastProgressNotification; |
---|
| 132 | NotificationCenter _nc; |
---|
| 133 | mutable FastMutex _mutex; |
---|
| 134 | |
---|
| 135 | friend class Task; |
---|
| 136 | }; |
---|
| 137 | |
---|
| 138 | |
---|
| 139 | // |
---|
| 140 | // inlines |
---|
| 141 | // |
---|
| 142 | inline int TaskManager::count() const |
---|
| 143 | { |
---|
| 144 | FastMutex::ScopedLock lock(_mutex); |
---|
| 145 | |
---|
| 146 | return (int) _taskList.size(); |
---|
| 147 | } |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | } // namespace Poco |
---|
| 151 | |
---|
| 152 | |
---|
| 153 | #endif // Foundation_TaskManager_INCLUDED |
---|