Mercurial > hg > orthanc

annotate OrthancFramework/Sources/MultiThreading/SharedMessageQueue.h @ 4690:13efc0967cea

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
cppcheck
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 10 Jun 2021 11:21:22 +0200
parents d9473bd5ed43
children 7053502fbf97
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
4437
d9473bd5ed43 upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4300
diff changeset
5 * Copyright (C) 2017-2021 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
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
8 * modify it under the terms of the GNU Lesser General Public License
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
10 * the License, or (at your option) any later version.
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
15 * Lesser General Public License for more details.
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
17 * You should have received a copy of the GNU Lesser General Public
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
18 * License along with this program. If not, see
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
19 * <http://www.gnu.org/licenses/>.
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "../IDynamicObject.h"
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
451
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 450
diff changeset
27 #include <stdint.h>
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 #include <list>
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 #include <boost/thread.hpp>
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 namespace Orthanc
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 {
4037
5e26d004838c adding option "system" to DownloadOrthancFramework.cmake
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
33 class ORTHANC_PUBLIC SharedMessageQueue : public boost::noncopyable
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 {
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 private:
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 typedef std::list<IDynamicObject*> Queue;
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
1227
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
38 bool isFifo_;
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 unsigned int maxSize_;
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 Queue queue_;
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 boost::mutex mutex_;
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 boost::condition_variable elementAvailable_;
452
80f7539147a2 WaitEmpty
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 451
diff changeset
43 boost::condition_variable emptied_;
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 public:
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
46 explicit SharedMessageQueue(unsigned int maxSize = 0);
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 689
diff changeset
47
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 ~SharedMessageQueue();
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 // This transfers the ownership of the message
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 void Enqueue(IDynamicObject* message);
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 // The caller is responsible to delete the dequeud message!
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 IDynamicObject* Dequeue(int32_t millisecondsTimeout);
452
80f7539147a2 WaitEmpty
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 451
diff changeset
55
80f7539147a2 WaitEmpty
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 451
diff changeset
56 bool WaitEmpty(int32_t millisecondsTimeout);
1227
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
57
4300
b30a8de92ad9 abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4169
diff changeset
58 bool IsFifoPolicy() const;
1227
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
59
4300
b30a8de92ad9 abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4169
diff changeset
60 bool IsLifoPolicy() const;
1227
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
61
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
62 void SetFifoPolicy();
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
63
7266c37d0354 lifo policy in SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
64 void SetLifoPolicy();
2078
93afa6134ab3 SharedMessageQueue::Clear
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
65
93afa6134ab3 SharedMessageQueue::Clear
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
66 void Clear();
4169
e8005a58de16 SharedMessageQueue::GetSize()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
67
e8005a58de16 SharedMessageQueue::GetSize()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
68 size_t GetSize();
450
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 };
58b433bb9762 SharedMessageQueue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 }