OpenWalnut 1.3.1
|
00001 //--------------------------------------------------------------------------- 00002 // 00003 // Project: OpenWalnut ( http://www.openwalnut.org ) 00004 // 00005 // Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS 00006 // For more information see http://www.openwalnut.org/copying 00007 // 00008 // This file is part of OpenWalnut. 00009 // 00010 // OpenWalnut is free software: you can redistribute it and/or modify 00011 // it under the terms of the GNU Lesser General Public License as published by 00012 // the Free Software Foundation, either version 3 of the License, or 00013 // (at your option) any later version. 00014 // 00015 // OpenWalnut is distributed in the hope that it will be useful, 00016 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00018 // GNU Lesser General Public License for more details. 00019 // 00020 // You should have received a copy of the GNU Lesser General Public License 00021 // along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>. 00022 // 00023 //--------------------------------------------------------------------------- 00024 00025 #ifndef WMODULESIGNALS_H 00026 #define WMODULESIGNALS_H 00027 00028 #include <boost/signals2/signal.hpp> 00029 #include <boost/function.hpp> 00030 00031 class WModule; 00032 class WException; 00033 00034 /** 00035 * Enum of all possible signals WModule instances can emit. 00036 */ 00037 typedef enum 00038 { 00039 WM_ASSOCIATED, // module got associated to a container 00040 WM_READY, // module ready 00041 WM_ERROR, // error during execution 00042 WM_REMOVED // removed from the container 00043 } 00044 MODULE_SIGNAL; 00045 00046 // ************************************************************************************************************************** 00047 // Types 00048 // ************************************************************************************************************************** 00049 00050 /** 00051 * Signal for generic events like "WM_READY". 00052 * 00053 * \param module The module emitting the signal. 00054 * 00055 */ 00056 typedef boost::function< void ( boost::shared_ptr< WModule > ) > t_ModuleGenericSignalHandlerType; 00057 00058 /** 00059 * Generic signal type used in the most signals involving just the emitting signal. 00060 * 00061 * \param module The module emitting the signal. 00062 */ 00063 typedef boost::signals2::signal< void ( boost::shared_ptr< WModule > ) > t_ModuleGenericSignalType; 00064 00065 /** 00066 * Signal for error events like "WM_ERROR". 00067 * 00068 * \param module The module emitting the signal. 00069 * 00070 */ 00071 typedef boost::function< void ( boost::shared_ptr< WModule >, const WException& ) > t_ModuleErrorSignalHandlerType; 00072 00073 /** 00074 * Signal type used in the most signals involving exceptions. 00075 * 00076 * \param module The module emitting the signal. 00077 */ 00078 typedef boost::signals2::signal< void ( boost::shared_ptr< WModule >, const WException& ) > t_ModuleErrorSignalType; 00079 00080 #endif // WMODULESIGNALS_H 00081