annotate Framework/Oracle/IOracle.h @ 1098:17660df24c36 broker

simplification of IOracleRunner
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 25 Oct 2019 13:01:24 +0200
parents 53d9c3b96b9e
children c3d4adf8bc70
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Stone of Orthanc
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 * Copyright (C) 2017-2019 Osimis S.A., Belgium
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * Affero General Public License for more details.
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #pragma once
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
825
9a6c7a5dcb76 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 765
diff changeset
24 #include "../Messages/IObserver.h"
1077
d7a18a3cd6f9 IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1075
diff changeset
25 #include "IOracleRunner.h"
d7a18a3cd6f9 IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1075
diff changeset
26
d7a18a3cd6f9 IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1075
diff changeset
27 #include <boost/shared_ptr.hpp>
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 namespace OrthancStone
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 {
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 class IOracle : public boost::noncopyable
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 {
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 public:
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 virtual ~IOracle()
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 }
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
1098
17660df24c36 simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1078
diff changeset
38 /**
17660df24c36 simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1078
diff changeset
39 * Returns "true" iff the command has actually been queued. If
17660df24c36 simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1078
diff changeset
40 * "false" is returned, the command has been freed, and it won't
17660df24c36 simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1078
diff changeset
41 * be processed (this is the case if the oracle is stopped).
17660df24c36 simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1078
diff changeset
42 **/
17660df24c36 simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1078
diff changeset
43 virtual bool Schedule(boost::shared_ptr<IObserver> receiver,
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 IOracleCommand* command) = 0; // Takes ownership
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 };
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 }