KSCrashMonitor.h 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. //
  2. // KSCrashMonitor.h
  3. //
  4. // Created by Karl Stenerud on 2012-02-12.
  5. //
  6. // Copyright (c) 2012 Karl Stenerud. All rights reserved.
  7. //
  8. // Permission is hereby granted, free of charge, to any person obtaining a copy
  9. // of this software and associated documentation files (the "Software"), to deal
  10. // in the Software without restriction, including without limitation the rights
  11. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12. // copies of the Software, and to permit persons to whom the Software is
  13. // furnished to do so, subject to the following conditions:
  14. //
  15. // The above copyright notice and this permission notice shall remain in place
  16. // in this source code.
  17. //
  18. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24. // THE SOFTWARE.
  25. //
  26. /** Keeps watch for crashes and informs via callback when on occurs.
  27. */
  28. #ifndef HDR_KSCrashMonitor_h
  29. #define HDR_KSCrashMonitor_h
  30. #ifdef __cplusplus
  31. extern "C" {
  32. #endif
  33. #include "KSCrashMonitorType.h"
  34. #include "KSThread.h"
  35. #include <stdbool.h>
  36. struct KSCrash_MonitorContext;
  37. // ============================================================================
  38. #pragma mark - External API -
  39. // ============================================================================
  40. /** Set which monitors are active.
  41. *
  42. * @param monitorTypes Which monitors should be active.
  43. */
  44. void kscm_setActiveMonitors(KSCrashMonitorType monitorTypes);
  45. /** Get the currently active monitors.
  46. */
  47. KSCrashMonitorType kscm_getActiveMonitors(void);
  48. /** Set the callback to call when an event is captured.
  49. *
  50. * @param onEvent Called whenever an event is captured.
  51. */
  52. void kscm_setEventCallback(void (*onEvent)(struct KSCrash_MonitorContext* monitorContext));
  53. // ============================================================================
  54. #pragma mark - Internal API -
  55. // ============================================================================
  56. typedef struct
  57. {
  58. void (*setEnabled)(bool isEnabled);
  59. bool (*isEnabled)(void);
  60. void (*addContextualInfoToEvent)(struct KSCrash_MonitorContext* eventContext);
  61. } KSCrashMonitorAPI;
  62. /** Notify that a fatal exception has been captured.
  63. * This allows the system to take appropriate steps in preparation.
  64. *
  65. * @oaram isAsyncSafeEnvironment If true, only async-safe functions are allowed from now on.
  66. */
  67. bool kscm_notifyFatalExceptionCaptured(bool isAsyncSafeEnvironment);
  68. /** Start general exception processing.
  69. *
  70. * @oaram context Contextual information about the exception.
  71. */
  72. void kscm_handleException(struct KSCrash_MonitorContext* context);
  73. #ifdef __cplusplus
  74. }
  75. #endif
  76. #endif // HDR_KSCrashMonitor_h