annotate Core/MultiThreading/SharedMessageQueue.h @ 2029:df9c1738d92e

merge
author sjodogne
date Mon, 20 Jun 2016 14:07:48 +0200
parents b1291df2f780
children 93afa6134ab3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1227
diff changeset
4 * Department, University Hospital of Liege, Belgium
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 *
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * This program is free software: you can redistribute it and/or
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * modify it under the terms of the GNU General Public License as
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * published by the Free Software Foundation, either version 3 of the
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * License, or (at your option) any later version.
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 *
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * In addition, as a special exception, the copyright holders of this
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * program give permission to link the code of its release with the
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * that use the same license as the "OpenSSL" library), and distribute
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * the linked executables. You must obey the GNU General Public License
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * in all respects for all of the code used other than "OpenSSL". If you
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * modify file(s) with this exception, you may extend this exception to
58b433bb9762 SharedMessageQueue
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
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * you do not wish to do so, delete this exception statement from your
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * version. If you delete this exception statement from all source files
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * in the program, then also delete it here.
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 *
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * This program is distributed in the hope that it will be useful, but
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * WITHOUT ANY WARRANTY; without even the implied warranty of
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * General Public License for more details.
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 *
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 * You should have received a copy of the GNU General Public License
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 **/
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 #pragma once
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 #include "../IDynamicObject.h"
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
451
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 450
diff changeset
37 #include <stdint.h>
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 #include <list>
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 #include <boost/thread.hpp>
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 namespace Orthanc
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
43 class SharedMessageQueue : public boost::noncopyable
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 {
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 private:
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 typedef std::list<IDynamicObject*> Queue;
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47
1227
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
48 bool isFifo_;
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 unsigned int maxSize_;
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 Queue queue_;
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 boost::mutex mutex_;
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 boost::condition_variable elementAvailable_;
452
80f7539147a2 WaitEmpty
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 451
diff changeset
53 boost::condition_variable emptied_;
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 public:
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
56 explicit SharedMessageQueue(unsigned int maxSize = 0);
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
57
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 ~SharedMessageQueue();
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 // This transfers the ownership of the message
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 void Enqueue(IDynamicObject* message);
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 // The caller is responsible to delete the dequeud message!
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 IDynamicObject* Dequeue(int32_t millisecondsTimeout);
452
80f7539147a2 WaitEmpty
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 451
diff changeset
65
80f7539147a2 WaitEmpty
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 451
diff changeset
66 bool WaitEmpty(int32_t millisecondsTimeout);
1227
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
67
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
68 bool IsFifoPolicy() const
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
69 {
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
70 return isFifo_;
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
71 }
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
72
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
73 bool IsLifoPolicy() const
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
74 {
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
75 return !isFifo_;
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
76 }
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
77
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
78 void SetFifoPolicy();
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
79
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
80 void SetLifoPolicy();
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 };
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 }