annotate Core/MultiThreading/SharedMessageQueue.h @ 3616:b6a569e6e85b

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