Plausible CrashReporter
Instance Methods | Properties | List of all members
PLCrashReport Class Reference

Provides decoding of crash logs generated by the PLCrashReporter framework. More...

Inherits NSObject.

Collaboration diagram for PLCrashReport:
Collaboration graph
[legend]

Instance Methods

(id) - initWithData:error:
 Initialize with the provided crash log data. More...
 
(PLCrashReportBinaryImageInfo *) - imageForAddress:
 Return the binary image containing the given address, or nil if no binary image is found. More...
 

Properties

PLCrashReportSystemInfosystemInfo
 System information.
 
BOOL hasMachineInfo
 YES if machine information is available.
 
PLCrashReportMachineInfomachineInfo
 Machine information. More...
 
PLCrashReportApplicationInfoapplicationInfo
 Application information.
 
BOOL hasProcessInfo
 YES if process information is available.
 
PLCrashReportProcessInfoprocessInfo
 Process information. More...
 
PLCrashReportSignalInfosignalInfo
 Signal information. More...
 
PLCrashReportMachExceptionInfomachExceptionInfo
 Mach exception information, if available. More...
 
NSArray * threads
 Thread information. More...
 
NSArray * images
 Binary image information. More...
 
BOOL hasExceptionInfo
 YES if exception information is available.
 
PLCrashReportExceptionInfoexceptionInfo
 Exception information. More...
 
CFUUIDRef uuidRef
 A client-generated 16-byte UUID. More...
 

Detailed Description

Provides decoding of crash logs generated by the PLCrashReporter framework.

Warning
This API should be considered in-development and subject to change.

Method Documentation

- (PLCrashReportBinaryImageInfo *) imageForAddress: (uint64_t)  address

Return the binary image containing the given address, or nil if no binary image is found.

Parameters
addressThe address to search for.
- (id) initWithData: (NSData *)  encodedData
error: (NSError **)  outError 

Initialize with the provided crash log data.

On error, nil will be returned, and an NSError instance will be provided via error, if non-NULL.

Parameters
encodedDataEncoded plcrash crash log.
outErrorIf an error occurs, this pointer will contain an NSError object indicating why the crash log could not be parsed. If no error occurs, this parameter will be left unmodified. You may specify NULL for this parameter, and no error information will be provided.
Designated Initializer
This method is the designated initializer for the PLCrashReport class.

Property Documentation

- (PLCrashReportExceptionInfo*) exceptionInfo
readnonatomicassign

Exception information.

Only available if a crash was caused by an uncaught exception, otherwise nil.

- (NSArray*) images
readnonatomicassign

Binary image information.

Returns a list of PLCrashReportBinaryImageInfo instances.

- (PLCrashReportMachExceptionInfo*) machExceptionInfo
readnonatomicassign

Mach exception information, if available.

This will only be included in the case that encoding crash reporter's exception-based reporting was enabled, and a Mach exception was caught.

Warning
If Mach exception information is available, the legacy signalInfo property will also be provided; this s required to maintain backwards compatibility with the established API. Note, however, that the signal info may be derived from the Mach exception info by the encoding crash reporter, and thus may not exactly match the kernel exception-to-signal mappings implemented in xnu. As such, when Mach exception info is available, its use should be preferred.
- (PLCrashReportMachineInfo*) machineInfo
readnonatomicassign

Machine information.

Only available in later (v1.1+) crash report format versions. If not available, will be nil.

- (PLCrashReportProcessInfo*) processInfo
readnonatomicassign

Process information.

Only available in later (v1.1+) crash report format versions. If not available, will be nil.

- (PLCrashReportSignalInfo*) signalInfo
readnonatomicassign

Signal information.

This provides the signal and signal code of the fatal signal.

- (NSArray*) threads
readnonatomicassign

Thread information.

Returns a list of PLCrashReportThreadInfo instances.

- (CFUUIDRef) uuidRef
readnonatomicassign

A client-generated 16-byte UUID.

May be used to filter duplicate reports submitted or generated by a single client. Only available in later (v1.2+) crash report format versions. If not available, will be NULL.


The documentation for this class was generated from the following files: