Mercurial > hg > orthanc

annotate OrthancFramework/Sources/MultiThreading/Semaphore.h @ 5049:8c9a1cce076e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
CPP Wrapper: new helpers
author Alain Mazy <am@osimis.io>
date Wed, 29 Jun 2022 15:32:44 +0200
parents 43e613a7756b
children 0ea402b4d901
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
8c67382f44a7 limit number of jobs in the scheduler
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: 995
diff changeset
4 * Department, University Hospital of Liege, Belgium
4870
43e613a7756b upgrade to year 2022
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4831
diff changeset
5 * Copyright (C) 2017-2022 Osimis S.A., Belgium
43e613a7756b upgrade to year 2022
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4831
diff changeset
6 * Copyright (C) 2021-2022 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * 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: 4104
diff changeset
9 * 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: 4104
diff changeset
10 * 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: 4104
diff changeset
11 * the License, or (at your option) any later version.
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
12 *
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * 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: 4104
diff changeset
16 * Lesser General Public License for more details.
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4104
diff changeset
18 * 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: 4104
diff changeset
19 * 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: 4104
diff changeset
20 * <http://www.gnu.org/licenses/>.
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #pragma once
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
4104
d5c09b5f882f publishing Orthanc::Semaphore in shared library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4068
diff changeset
26 #include "../OrthancFramework.h"
d5c09b5f882f publishing Orthanc::Semaphore in shared library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4068
diff changeset
27
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 #include <boost/noncopyable.hpp>
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 #include <boost/thread.hpp>
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 namespace Orthanc
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 {
4104
d5c09b5f882f publishing Orthanc::Semaphore in shared library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4068
diff changeset
33 class ORTHANC_PUBLIC Semaphore : public boost::noncopyable
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 {
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 private:
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
36 unsigned int availableResources_;
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 boost::mutex mutex_;
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 boost::condition_variable condition_;
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
39
4797
4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents: 4437
diff changeset
40 public:
4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents: 4437
diff changeset
41 explicit Semaphore(unsigned int availableResources);
4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents: 4437
diff changeset
42
4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents: 4437
diff changeset
43 unsigned int GetAvailableResourcesCount() const;
4e765c18ace7 enable using multiple threads to load instances when generating zip archive/media
Alain Mazy <am@osimis.io>
parents: 4437
diff changeset
44
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
45 void Release(unsigned int resourceCount = 1);
2794
f790999a250a Semaphore removed from graveyard, SystemToolbox::GetHardwareConcurrency()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2611
diff changeset
46
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
47 void Acquire(unsigned int resourceCount = 1);
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
49 bool TryAcquire(unsigned int resourceCount = 1);
3483
4d26261fd05a get semaphore count for debug purpose
Alain Mazy <alain@mazy.be>
parents: 3480
diff changeset
50
2108
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
51 class Locker : public boost::noncopyable
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
52 {
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
53 private:
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
54 Semaphore& that_;
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
55 unsigned int resourceCount_;
2108
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
56
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
57 public:
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
58 explicit Locker(Semaphore& that, unsigned int resourceCount = 1) :
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
59 that_(that),
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
60 resourceCount_(resourceCount)
2108
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
61 {
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
62 that_.Acquire(resourceCount_);
2108
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
63 }
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
64
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
65 ~Locker()
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
66 {
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
67 that_.Release(resourceCount_);
2108
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
68 }
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
69 };
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
70
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
71 class TryLocker : public boost::noncopyable
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
72 {
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
73 private:
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
74 Semaphore& that_;
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
75 unsigned int resourceCount_;
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
76 bool isAcquired_;
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
77
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
78 public:
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
79 explicit TryLocker(Semaphore& that, unsigned int resourceCount = 1) :
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
80 that_(that),
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
81 resourceCount_(resourceCount)
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
82 {
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
83 isAcquired_ = that_.TryAcquire(resourceCount_);
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
84 }
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
85
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
86 ~TryLocker()
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
87 {
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
88 if (isAcquired_)
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
89 {
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
90 that_.Release(resourceCount_);
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
91 }
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
92 }
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
93
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
94 bool IsAcquired() const
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
95 {
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
96 return isAcquired_;
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
97 }
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
98 };
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
99
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100 };
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 }