NDEVR
API Documentation
CrashManager.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: Base
28File: CrashManager
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include "DLLInfo.h"
34#include <NDEVR/Exception.h>
35#include <NDEVR/SoftwareService.h>
36#include <NDEVR/File.h>
37#include <functional>
38
39namespace NDEVR
40{
45 class NDEVR_BASE_API CrashManager : public SoftwareService, public SoftwareServiceManager
46 {
47 public:
52
56 virtual ~CrashManager();
57
63
69 {
70 return false;
71 }
72
78 bool handleException(void* e);
79
84 void setCallback(std::function<void(const Exception&)> callback) { m_callback = callback; }
85
91
97 protected:
98 std::function<void(const Exception&)> m_callback;
100 };
102}
103
Manages crash handling, exception reporting, and mini-dump creation.
CrashManager()
Constructs a CrashManager with default settings.
bool handleException(void *e)
Handles a platform-specific exception, potentially writing a crash report or mini-dump.
File m_minidump_directory
Directory where mini-dump files are written on crash.
bool setAsTopLevelExceptionHandler()
Registers this CrashManager as the top-level unhandled exception handler for the process.
static CrashManager * CurrentCrashManager()
Retrieves the currently active CrashManager instance.
void setMiniDumpDirectory(const File &file)
Sets the directory where mini-dump files will be written on crash.
virtual ~CrashManager()
Destroys the CrashManager and cleans up any registered handlers.
void setCallback(std::function< void(const Exception &)> callback)
Sets a callback function to be invoked when an exception is caught.
bool recordAllExceptions() const
Returns whether all exceptions should be recorded.
std::function< void(const Exception &)> m_callback
Callback invoked when an exception is caught.
Provides consistent interface to handle errors through the throw expression.
Definition Exception.hpp:47
Logic for reading or writing to a file as well as navigating filesystems or other common file operati...
Definition File.h:53
Software Service Managers take a Software service to modify the behavior of the software.
Base interface for services that extend or modify software behavior through modules.
The primary namespace for the NDEVR SDK.
CrashManager * g_crash_manager
Global pointer to the active CrashManager instance.
@ file
The source file path associated with this object.