OpenWalnut  1.4.0
WModuleSignals.h
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 enum MODULE_SIGNAL
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 
00045 // **************************************************************************************************************************
00046 // Types
00047 // **************************************************************************************************************************
00048 
00049 /**
00050  * Signal for generic events like "WM_READY".
00051  *
00052  * \param module The module emitting the signal.
00053  *
00054  */
00055 typedef boost::function< void ( boost::shared_ptr< WModule > ) > t_ModuleGenericSignalHandlerType;
00056 
00057 /**
00058  * Generic signal type used in the most signals involving just the emitting signal.
00059  *
00060  * \param module The module emitting the signal.
00061  */
00062 typedef boost::signals2::signal< void ( boost::shared_ptr< WModule > ) >  t_ModuleGenericSignalType;
00063 
00064 /**
00065  * Signal for error events like "WM_ERROR".
00066  *
00067  * \param module The module emitting the signal.
00068  *
00069  */
00070 typedef boost::function< void ( boost::shared_ptr< WModule >, const WException& ) > t_ModuleErrorSignalHandlerType;
00071 
00072 /**
00073  * Signal type used in the most signals involving exceptions.
00074  *
00075  * \param module The module emitting the signal.
00076  */
00077 typedef boost::signals2::signal< void ( boost::shared_ptr< WModule >, const WException& ) >  t_ModuleErrorSignalType;
00078 
00079 #endif  // WMODULESIGNALS_H
00080