annotate Framework/Messages/IMessageEmitter.h @ 1075:81b29bc7c3d4 broker

cont
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 17 Oct 2019 14:39:51 +0200
parents 67f9c27214c5
children 17660df24c36
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
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #include "IObserver.h"
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "IMessage.h"
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
1075
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 843
diff changeset
27 #include <boost/weak_ptr.hpp>
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 843
diff changeset
28
745
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 {
843
67f9c27214c5 Removed extra logging + doc + added GuiAdapter and LockingEmitter
Benjamin Golinvaux <bgo@osimis.io>
parents: 745
diff changeset
31 /**
67f9c27214c5 Removed extra logging + doc + added GuiAdapter and LockingEmitter
Benjamin Golinvaux <bgo@osimis.io>
parents: 745
diff changeset
32 This class may be used to customize the way the messages are sent between
67f9c27214c5 Removed extra logging + doc + added GuiAdapter and LockingEmitter
Benjamin Golinvaux <bgo@osimis.io>
parents: 745
diff changeset
33 a source and a destination, for instance by the ThreadedOracle.
67f9c27214c5 Removed extra logging + doc + added GuiAdapter and LockingEmitter
Benjamin Golinvaux <bgo@osimis.io>
parents: 745
diff changeset
34
67f9c27214c5 Removed extra logging + doc + added GuiAdapter and LockingEmitter
Benjamin Golinvaux <bgo@osimis.io>
parents: 745
diff changeset
35 See the concrete class LockingEmitter for an example of when it is useful.
67f9c27214c5 Removed extra logging + doc + added GuiAdapter and LockingEmitter
Benjamin Golinvaux <bgo@osimis.io>
parents: 745
diff changeset
36 */
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 class IMessageEmitter : public boost::noncopyable
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 {
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 public:
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 virtual ~IMessageEmitter()
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 {
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 }
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
1075
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 843
diff changeset
44 virtual void EmitMessage(boost::weak_ptr<IObserver>& observer,
745
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 const IMessage& message) = 0;
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 };
c44c1d2d3598 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 }