toolkit/crashreporter/google-breakpad/src/client/ios/BreakpadController.h@6474c204b198 (annotated)
toolkit/crashreporter/google-breakpad/src/client/ios/BreakpadController.h
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | // Copyright (c) 2012, Google Inc. |
| michael@0 | 2 | // All rights reserved. |
| michael@0 | 3 | // |
| michael@0 | 4 | // Redistribution and use in source and binary forms, with or without |
| michael@0 | 5 | // modification, are permitted provided that the following conditions are |
| michael@0 | 6 | // met: |
| michael@0 | 7 | // |
| michael@0 | 8 | // * Redistributions of source code must retain the above copyright |
| michael@0 | 9 | // notice, this list of conditions and the following disclaimer. |
| michael@0 | 10 | // * Redistributions in binary form must reproduce the above |
| michael@0 | 11 | // copyright notice, this list of conditions and the following disclaimer |
| michael@0 | 12 | // in the documentation and/or other materials provided with the |
| michael@0 | 13 | // distribution. |
| michael@0 | 14 | // * Neither the name of Google Inc. nor the names of its |
| michael@0 | 15 | // contributors may be used to endorse or promote products derived from |
| michael@0 | 16 | // this software without specific prior written permission. |
| michael@0 | 17 | // |
| michael@0 | 18 | // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| michael@0 | 19 | // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| michael@0 | 20 | // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| michael@0 | 21 | // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| michael@0 | 22 | // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| michael@0 | 23 | // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| michael@0 | 24 | // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| michael@0 | 25 | // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| michael@0 | 26 | // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| michael@0 | 27 | // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| michael@0 | 28 | // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| michael@0 | 29 | |
| michael@0 | 30 | #ifndef CLIENT_IOS_HANDLER_IOS_BREAKPAD_CONTROLLER_H_ |
| michael@0 | 31 | #define CLIENT_IOS_HANDLER_IOS_BREAKPAD_CONTROLLER_H_ |
| michael@0 | 32 | |
| michael@0 | 33 | #import <Foundation/Foundation.h> |
| michael@0 | 34 | |
| michael@0 | 35 | #import "client/ios/Breakpad.h" |
| michael@0 | 36 | |
| michael@0 | 37 | // This class is used to offer a higher level API around BreakpadRef. It |
| michael@0 | 38 | // configures it, ensures thread-safety, and sends crash reports back to the |
| michael@0 | 39 | // collecting server. By default, no crash reports are sent, the user must call |
| michael@0 | 40 | // |setUploadingEnabled:YES| to start the uploading. |
| michael@0 | 41 | @interface BreakpadController : NSObject { |
| michael@0 | 42 | @private |
| michael@0 | 43 | // The dispatch queue that will own the breakpad reference. |
| michael@0 | 44 | dispatch_queue_t queue_; |
| michael@0 | 45 | |
| michael@0 | 46 | // Instance of Breakpad crash reporter. This is owned by the queue, but can |
| michael@0 | 47 | // be created on the main thread at startup. |
| michael@0 | 48 | BreakpadRef breakpadRef_; |
| michael@0 | 49 | |
| michael@0 | 50 | // The dictionary that contains configuration for breakpad. Modifying it |
| michael@0 | 51 | // should only happen when the controller is not started. The initial value |
| michael@0 | 52 | // is the infoDictionary of the bundle of the application. |
| michael@0 | 53 | NSMutableDictionary* configuration_; |
| michael@0 | 54 | |
| michael@0 | 55 | // Whether or not crash reports should be uploaded. |
| michael@0 | 56 | BOOL enableUploads_; |
| michael@0 | 57 | |
| michael@0 | 58 | // Whether the controller has been started on the main thread. This is only |
| michael@0 | 59 | // used to assert the initialization order is correct. |
| michael@0 | 60 | BOOL started_; |
| michael@0 | 61 | |
| michael@0 | 62 | // The interval to wait between two uploads. Value is 0 if no upload must be |
| michael@0 | 63 | // done. |
| michael@0 | 64 | int uploadIntervalInSeconds_; |
| michael@0 | 65 | } |
| michael@0 | 66 | |
| michael@0 | 67 | // Singleton. |
| michael@0 | 68 | + (BreakpadController*)sharedInstance; |
| michael@0 | 69 | |
| michael@0 | 70 | // Update the controller configuration. Merges its old configuration with the |
| michael@0 | 71 | // new one. Merge is done by replacing the old values by the new values. |
| michael@0 | 72 | - (void)updateConfiguration:(NSDictionary*)configuration; |
| michael@0 | 73 | |
| michael@0 | 74 | // Configure the URL to upload the report to. This must be called at least once |
| michael@0 | 75 | // if the URL is not in the bundle information. |
| michael@0 | 76 | - (void)setUploadingURL:(NSString*)url; |
| michael@0 | 77 | |
| michael@0 | 78 | // Set the minimal interval between two uploads in seconds. This must be called |
| michael@0 | 79 | // at least once if the interval is not in the bundle information. A value of 0 |
| michael@0 | 80 | // will prevent uploads. |
| michael@0 | 81 | - (void)setUploadInterval:(int)intervalInSeconds; |
| michael@0 | 82 | |
| michael@0 | 83 | // Specify a parameter that will be uploaded to the crash server. See |
| michael@0 | 84 | // |BreakpadAddUploadParameter|. |
| michael@0 | 85 | - (void)addUploadParameter:(NSString*)value forKey:(NSString*)key; |
| michael@0 | 86 | |
| michael@0 | 87 | // Remove a previously-added parameter from the upload parameter set. See |
| michael@0 | 88 | // |BreakpadRemoveUploadParameter|. |
| michael@0 | 89 | - (void)removeUploadParameterForKey:(NSString*)key; |
| michael@0 | 90 | |
| michael@0 | 91 | // Access the underlying BreakpadRef. This method is asynchronous, and will be |
| michael@0 | 92 | // executed on the thread owning the BreakpadRef variable. Moreover, if the |
| michael@0 | 93 | // controller is not started, the block will be called with a NULL parameter. |
| michael@0 | 94 | - (void)withBreakpadRef:(void(^)(BreakpadRef))callback; |
| michael@0 | 95 | |
| michael@0 | 96 | // Starts the BreakpadController by registering crash handlers. If |
| michael@0 | 97 | // |onCurrentThread| is YES, all setup is done on the current thread, otherwise |
| michael@0 | 98 | // it is done on a private queue. |
| michael@0 | 99 | - (void)start:(BOOL)onCurrentThread; |
| michael@0 | 100 | |
| michael@0 | 101 | // Unregisters the crash handlers. |
| michael@0 | 102 | - (void)stop; |
| michael@0 | 103 | |
| michael@0 | 104 | // Enables or disables uploading of crash reports, but does not stop the |
| michael@0 | 105 | // BreakpadController. |
| michael@0 | 106 | - (void)setUploadingEnabled:(BOOL)enabled; |
| michael@0 | 107 | |
| michael@0 | 108 | // Check if there is currently a crash report to upload. |
| michael@0 | 109 | - (void)hasReportToUpload:(void(^)(BOOL))callback; |
| michael@0 | 110 | |
| michael@0 | 111 | @end |
| michael@0 | 112 | |
| michael@0 | 113 | #endif // CLIENT_IOS_HANDLER_IOS_BREAKPAD_CONTROLLER_H_ |
