OpenWalnut  1.2.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
WModuleSignals.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 WMODULESIGNALS_H
26 #define WMODULESIGNALS_H
27 
28 #include <boost/signals2/signal.hpp>
29 #include <boost/function.hpp>
30 
31 class WModule;
32 class WException;
33 
34 /**
35  * Enum of all possible signals WModule instances can emit.
36  */
37 typedef enum
38 {
39  WM_ASSOCIATED, // module got associated to a container
40  WM_READY, // module ready
41  WM_ERROR, // error during execution
42  WM_REMOVED // removed from the container
43 }
44 MODULE_SIGNAL;
45 
46 // **************************************************************************************************************************
47 // Types
48 // **************************************************************************************************************************
49 
50 /**
51  * Signal for generic events like "WM_READY".
52  *
53  * \param module The module emitting the signal.
54  *
55  */
56 typedef boost::function< void ( boost::shared_ptr< WModule > ) > t_ModuleGenericSignalHandlerType;
57 
58 /**
59  * Generic signal type used in the most signals involving just the emitting signal.
60  *
61  * \param module The module emitting the signal.
62  */
63 typedef boost::signals2::signal< void ( boost::shared_ptr< WModule > ) > t_ModuleGenericSignalType;
64 
65 /**
66  * Signal for error events like "WM_ERROR".
67  *
68  * \param module The module emitting the signal.
69  *
70  */
71 typedef boost::function< void ( boost::shared_ptr< WModule >, const WException& ) > t_ModuleErrorSignalHandlerType;
72 
73 /**
74  * Signal type used in the most signals involving exceptions.
75  *
76  * \param module The module emitting the signal.
77  */
78 typedef boost::signals2::signal< void ( boost::shared_ptr< WModule >, const WException& ) > t_ModuleErrorSignalType;
79 
80 
81 #endif // WMODULESIGNALS_H
82 
83