OpenWalnut  1.4.0
WModuleConnectorSignals.h
1 //---------------------------------------------------------------------------
2 //
3 // Project: OpenWalnut ( http://www.openwalnut.org )
4 //
5 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
6 // For more information see http://www.openwalnut.org/copying
7 //
8 // This file is part of OpenWalnut.
9 //
10 // OpenWalnut is free software: you can redistribute it and/or modify
11 // it under the terms of the GNU Lesser General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // OpenWalnut is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU Lesser General Public License for more details.
19 //
20 // You should have received a copy of the GNU Lesser General Public License
21 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
22 //
23 //---------------------------------------------------------------------------
24 
25 #ifndef WMODULECONNECTORSIGNALS_H
26 #define WMODULECONNECTORSIGNALS_H
27 
28 #include <boost/signals2/signal.hpp>
29 #include <boost/function.hpp>
30 
31 class WModuleConnector;
32 
33 /**
34  * Enum of all possible signals between WModuleConnector instances.
35  * TODO(ebaum): Replace this by an automatic mapping class also able to allow varying function signatures.
36  */
37 typedef enum
38 {
39 CONNECTION_ESTABLISHED, // a connection has been established
40 CONNECTION_CLOSED, // a connection has been closed
41 DATA_CHANGED // data on an output connector has been changed
42 }
43 MODULE_CONNECTOR_SIGNAL;
44 
45 // **************************************************************************************************************************
46 // Types
47 // **************************************************************************************************************************
48 
49 /**
50  * Signal transmitting sender and receiver.
51  *
52  * \param boost::shared_ptr<WModuleConnector> this should be the receiver, depending on specific signal.
53  * \param boost::shared_ptr<WModuleConnector> this should be the sender, depending on specific signal.
54  *
55  */
56 typedef boost::function<void ( boost::shared_ptr<WModuleConnector>,
57  boost::shared_ptr<WModuleConnector> )> t_GenericSignalHandlerType;
58 
59 /**
60  * Generic signal type used in the most signals involving a sender and receiver.
61  *
62  * \param recv The connector receiving the signal.
63  * \param sender The counterpart (sender).
64  */
65 typedef boost::signals2::signal<void ( boost::shared_ptr<WModuleConnector>,
66  boost::shared_ptr<WModuleConnector> )> t_GenericSignalType;
67 
68 #endif // WMODULECONNECTORSIGNALS_H
69