RSB  0.19.0
Bus.h
Go to the documentation of this file.
1 /* ============================================================
2  *
3  * This file is part of the RSB project
4  *
5  * Copyright (C) 2011-2018 Jan Moringen <jmoringe@techfak.uni-bielefeld.de>
6  *
7  * This file may be licensed under the terms of the
8  * GNU Lesser General Public License Version 3 (the ``LGPL''),
9  * or (at your option) any later version.
10  *
11  * Software distributed under the License is distributed
12  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
13  * express or implied. See the LGPL for the specific language
14  * governing rights and limitations.
15  *
16  * You should have received a copy of the LGPL along with this
17  * program. If not, go to http://www.gnu.org/licenses/lgpl.html
18  * or write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The development of this software was supported by:
22  * CoR-Lab, Research Institute for Cognition and Robotics
23  * Bielefeld University
24  *
25  * ============================================================ */
26 
27 #pragma once
28 
29 #include <string>
30 
31 #include <boost/shared_ptr.hpp>
32 
33 #include "../../Event.h"
34 
35 #include "../../eventprocessing/Handler.h"
36 
37 #include "rsb/rsbexports.h"
38 
39 namespace rsb {
40 namespace transport {
41 namespace socket {
42 
44 typedef boost::shared_ptr<InConnector> InConnectorPtr;
45 
47 typedef boost::shared_ptr<BusConnection> BusConnectionPtr;
48 
64 class RSB_EXPORT Bus: public eventprocessing::Handler {
65 friend class BusConnection;
66 public:
67  virtual ~Bus();
68 
69  virtual void addSink(InConnectorPtr sink) = 0;
70  virtual void removeSink(const InConnector* sink) = 0;
71 
79  virtual void addConnection(BusConnectionPtr connection) = 0;
80 
87  virtual void removeConnection(BusConnectionPtr connection) = 0;
88 
89  virtual bool isTcpnodelay() const = 0;
90 
91  virtual void handle(EventPtr event) = 0;
92 
93  virtual void handleIncoming(EventPtr event,
94  BusConnectionPtr connection) = 0;
95 
96  virtual const std::string getTransportURL() const = 0;
97 };
98 
99 typedef boost::shared_ptr<Bus> BusPtr;
100 
101 }
102 }
103 }
boost::shared_ptr< InConnector > InConnectorPtr
Definition: Bus.h:43
Instances of this class provide access to a socket-based bus.
Definition: Bus.h:64
EventPtr event
Definition: BusImpl.cpp:129
Instances of this class receive events from a bus that is accessed via a socket connection.
Definition: InConnector.h:61
boost::shared_ptr< BusConnection > BusConnectionPtr
Definition: Bus.h:46
Instances of this class implement connections to a socket-based bus.
Definition: BusConnection.h:74
Implementations of this class can be used in contexts where an "event sink" is required.
Definition: Handler.h:48
boost::shared_ptr< Event > EventPtr
Definition: Event.h:264
boost::shared_ptr< Bus > BusPtr
Definition: Bus.h:99