Mercurial > hg > orthanc

annotate Core/MultiThreading/ThreadedCommandProcessor.h @ 1196:669bb978d52e db-changes

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
rename
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 23 Oct 2014 13:18:26 +0200
parents 2d0a347e8cfc
children 6e7e5ed91c2d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
458
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
689
2d0a347e8cfc switch to 2014
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 467
diff changeset
3 * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege,
458
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Belgium
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 *
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * This program is free software: you can redistribute it and/or
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * modify it under the terms of the GNU General Public License as
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * published by the Free Software Foundation, either version 3 of the
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * License, or (at your option) any later version.
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 *
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * In addition, as a special exception, the copyright holders of this
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * program give permission to link the code of its release with the
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * that use the same license as the "OpenSSL" library), and distribute
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * the linked executables. You must obey the GNU General Public License
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * in all respects for all of the code used other than "OpenSSL". If you
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * modify file(s) with this exception, you may extend this exception to
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * your version of the file(s), but you are not obligated to do so. If
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * you do not wish to do so, delete this exception statement from your
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * version. If you delete this exception statement from all source files
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * in the program, then also delete it here.
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 *
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * This program is distributed in the hope that it will be useful, but
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * WITHOUT ANY WARRANTY; without even the implied warranty of
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * General Public License for more details.
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 *
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 * You should have received a copy of the GNU General Public License
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 **/
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 #pragma once
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 #include "../ICommand.h"
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #include "SharedMessageQueue.h"
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 namespace Orthanc
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 {
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 class ThreadedCommandProcessor
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
467
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
43 public:
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
44 class IListener
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
45 {
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
46 public:
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
47 virtual ~IListener()
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
48 {
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
49 }
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
50
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
51 virtual void SignalProgress(unsigned int current,
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
52 unsigned int total) = 0;
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
53
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
54 virtual void SignalSuccess(unsigned int total) = 0;
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
55
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
56 virtual void SignalFailure() = 0;
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
57
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
58 virtual void SignalCancel() = 0;
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
59 };
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
60
458
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 private:
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 SharedMessageQueue queue_;
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 bool done_;
467
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
64 bool cancel_;
458
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 std::vector<boost::thread*> threads_;
467
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
66 IListener* listener_;
458
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 boost::mutex mutex_;
466
9da3596069b8 handling failed commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 458
diff changeset
69 bool success_;
467
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
70 unsigned int remainingCommands_, totalCommands_;
458
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 boost::condition_variable processedCommand_;
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 static void Processor(ThreadedCommandProcessor* that);
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 public:
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 ThreadedCommandProcessor(unsigned int numThreads);
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 ~ThreadedCommandProcessor();
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 // This takes the ownership of the command
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 void Post(ICommand* command);
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
466
9da3596069b8 handling failed commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 458
diff changeset
83 bool Join();
467
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
84
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
85 void Cancel();
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
86
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
87 void SetListener(IListener& listener);
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
88
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
89 IListener& GetListener() const
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
90 {
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
91 return *listener_;
322c1b497036 cancel and listener for commands
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 466
diff changeset
92 }
458
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 };
84966299c8f8 ThreadedCommandProcessor
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 }