source: rrlib_crash_handler/crash_handler.h

17.03 tip
Last change on this file was 3:d57230dc982a, checked in by Tobias Föhst <foehst@…>, 8 years ago

Added and updated license information

File size: 2.6 KB
Line 
1//
2// You received this file as part of RRLib
3// Robotics Research Library
4//
5// Copyright (C) Finroc GbR (finroc.org)
6//
7// This program is free software; you can redistribute it and/or modify
8// it under the terms of the GNU General Public License as published by
9// the Free Software Foundation; either version 2 of the License, or
10// (at your option) any later version.
11//
12// This program is distributed in the hope that it will be useful,
13// but WITHOUT ANY WARRANTY; without even the implied warranty of
14// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15// GNU General Public License for more details.
16//
17// You should have received a copy of the GNU General Public License along
18// with this program; if not, write to the Free Software Foundation, Inc.,
19// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20//
21//----------------------------------------------------------------------
22/*!\file    rrlib/crash_handler/crash_handler.h
23 *
24 * \author  Max Reichardt
25 *
26 * \date    2012-06-20
27 *
28 * \brief
29 *
30 * Facilities to install signal handlers to handle program crashes.
31 *
32 */
33//----------------------------------------------------------------------
34#ifndef rrlib__crash_handler__crash_handler_h__
35#define rrlib__crash_handler__crash_handler_h__
36
37//----------------------------------------------------------------------
38// External includes (system with <>, local with "")
39//----------------------------------------------------------------------
40
41//----------------------------------------------------------------------
42// Internal includes with ""
43//----------------------------------------------------------------------
44
45//----------------------------------------------------------------------
46// Namespace declaration
47//----------------------------------------------------------------------
48namespace rrlib
49{
50namespace crash_handler
51{
52
53//----------------------------------------------------------------------
54// Forward declarations / typedefs / enums
55//----------------------------------------------------------------------
56
57//----------------------------------------------------------------------
58// Function declarations
59//----------------------------------------------------------------------
60
61/*!
62 * Installs signal handlers for SIGABRT and SIGSEGV that report crash
63 * and offer to start/attach gdb for inquiries
64 *
65 * \return True if signal handlers were installed successfully
66 */
67bool InstallCrashHandler();
68
69//----------------------------------------------------------------------
70// End of namespace declaration
71//----------------------------------------------------------------------
72}
73}
74
75
76#endif
Note: See TracBrowser for help on using the repository browser.