annotate Plugin/Cache/CacheScheduler.h @ 266:4e9d30c19b4b

linking against orthanc framework library
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 10 Jun 2020 12:32:46 +0200
parents aee499712ac4
children e376158e2dbb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
122
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 115
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
0
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
226
aee499712ac4 upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 209
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
0
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * Affero General Public License for more details.
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #pragma once
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #include "CacheManager.h"
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "ICacheFactory.h"
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 #include "IPrefetchPolicy.h"
266
4e9d30c19b4b linking against orthanc framework library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 226
diff changeset
27
4e9d30c19b4b linking against orthanc framework library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 226
diff changeset
28 #include <Compatibility.h> // For std::unique_ptr<>
4e9d30c19b4b linking against orthanc framework library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 226
diff changeset
29 #include <MultiThreading/SharedMessageQueue.h>
0
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 #include <boost/thread.hpp>
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 #include <stdio.h>
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 namespace OrthancPlugins
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 class CacheScheduler : public boost::noncopyable
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 {
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 private:
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 class Prefetcher;
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 class PrefetchQueue;
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 class BundleScheduler;
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 typedef std::map<int, BundleScheduler*> BundleSchedulers;
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44
266
4e9d30c19b4b linking against orthanc framework library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 226
diff changeset
45 size_t maxPrefetchSize_;
4e9d30c19b4b linking against orthanc framework library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 226
diff changeset
46 boost::mutex cacheMutex_;
4e9d30c19b4b linking against orthanc framework library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 226
diff changeset
47 boost::mutex factoryMutex_;
4e9d30c19b4b linking against orthanc framework library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 226
diff changeset
48 boost::recursive_mutex policyMutex_;
4e9d30c19b4b linking against orthanc framework library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 226
diff changeset
49 CacheManager& cache_;
4e9d30c19b4b linking against orthanc framework library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 226
diff changeset
50 std::unique_ptr<IPrefetchPolicy> policy_;
4e9d30c19b4b linking against orthanc framework library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 226
diff changeset
51 BundleSchedulers bundles_;
0
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 void ApplyPrefetchPolicy(int bundle,
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 const std::string& item,
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 const std::string& content);
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 BundleScheduler& GetBundleScheduler(unsigned int bundleIndex);
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 public:
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 CacheScheduler(CacheManager& cache,
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 unsigned int maxPrefetchSize);
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 ~CacheScheduler();
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 void Register(int bundle,
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 ICacheFactory* factory /* takes ownership */,
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 size_t numThreads);
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68
4
ecefd45026bf configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
69 void SetQuota(int bundle,
ecefd45026bf configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
70 uint32_t maxCount,
ecefd45026bf configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
71 uint64_t maxSpace);
ecefd45026bf configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 0
diff changeset
72
0
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 void RegisterPolicy(IPrefetchPolicy* policy /* takes ownership */);
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 void Invalidate(int bundle,
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 const std::string& item);
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 bool Access(std::string& content,
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 int bundle,
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 const std::string& item);
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 void Prefetch(int bundle,
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 const std::string& item);
96
a6ba21a083e5 major refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 26
diff changeset
84
a6ba21a083e5 major refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 26
diff changeset
85 ICacheFactory& GetFactory(int bundle);
115
c8ca47a67bf3 automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 96
diff changeset
86
c8ca47a67bf3 automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 96
diff changeset
87 void SetProperty(CacheProperty property,
c8ca47a67bf3 automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 96
diff changeset
88 const std::string& value);
c8ca47a67bf3 automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 96
diff changeset
89
c8ca47a67bf3 automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 96
diff changeset
90 bool LookupProperty(std::string& target,
c8ca47a67bf3 automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 96
diff changeset
91 CacheProperty property);
c8ca47a67bf3 automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 96
diff changeset
92
c8ca47a67bf3 automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 96
diff changeset
93 void Clear();
0
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 };
02f7a0400a91 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 }