MIRA
SignalHandler.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 by
3  * MetraLabs GmbH (MLAB), GERMANY
4  * and
5  * Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
6  * All rights reserved.
7  *
8  * Contact: info@mira-project.org
9  *
10  * Commercial Usage:
11  * Licensees holding valid commercial licenses may use this file in
12  * accordance with the commercial license agreement provided with the
13  * software or, alternatively, in accordance with the terms contained in
14  * a written agreement between you and MLAB or NICR.
15  *
16  * GNU General Public License Usage:
17  * Alternatively, this file may be used under the terms of the GNU
18  * General Public License version 3.0 as published by the Free Software
19  * Foundation and appearing in the file LICENSE.GPL3 included in the
20  * packaging of this file. Please review the following information to
21  * ensure the GNU General Public License version 3.0 requirements will be
22  * met: http://www.gnu.org/copyleft/gpl.html.
23  * Alternatively you may (at your option) use any later version of the GNU
24  * General Public License if such license has been publicly approved by
25  * MLAB and NICR (or its successors, if any).
26  *
27  * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
28  * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
29  * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
30  * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
33  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
34  * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
35  * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
36  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
37  */
38 
47 #ifndef _MIRA_SIGNALHANDLER_H_
48 #define _MIRA_SIGNALHANDLER_H_
49 
50 #include <signal.h> // valid for both unix and windows
51 
52 #ifndef Q_MOC_RUN
53 #include <boost/function.hpp>
54 #endif
55 
56 #include <error/CallStack.h>
57 #include <platform/Platform.h>
58 
59 namespace mira {
60 
62 
67 struct IntSignal
68 {
69  IntSignal(int s, const CallStack& stack) :
70  sig(s), callStack(stack) {}
71 
73  int sig;
76 };
77 
118 void MIRA_BASE_EXPORT installSignalHandler(int sig, boost::function<void (const IntSignal&)> function);
119 
121 
122 }
123 
124 #endif
Encapsulates call stack functionality.
specialize cv::DataType for our ImgPixel and inherit from cv::DataType<Vec>
Definition: IOService.h:67
IntSignal(int s, const CallStack &stack)
Definition: SignalHandler.h:69
Structure used in signal handlers to pass the signal and callstack.
Definition: SignalHandler.h:67
int sig
The signal that was raised (SIGABRT etc.)
Definition: SignalHandler.h:73
const CallStack & callStack
The call stack backtrace at the moment the signal was raised.
Definition: SignalHandler.h:75
void MIRA_BASE_EXPORT installSignalHandler(int sig, boost::function< void(const IntSignal &)> function)
Registers a function for the specified interrupt signal.
Encapsulates unix call stack functionality.
Definition: CallStack.h:86
#define MIRA_BASE_EXPORT
This is required because on windows there is a macro defined called ERROR.
Definition: Platform.h:153
Platform dependent defines and macros.