OLD | NEW |
1 // Copyright 2014 The Crashpad Authors. All rights reserved. | 1 // Copyright 2014 The Crashpad Authors. All rights reserved. |
2 // | 2 // |
3 // Licensed under the Apache License, Version 2.0 (the "License"); | 3 // Licensed under the Apache License, Version 2.0 (the "License"); |
4 // you may not use this file except in compliance with the License. | 4 // you may not use this file except in compliance with the License. |
5 // You may obtain a copy of the License at | 5 // You may obtain a copy of the License at |
6 // | 6 // |
7 // http://www.apache.org/licenses/LICENSE-2.0 | 7 // http://www.apache.org/licenses/LICENSE-2.0 |
8 // | 8 // |
9 // Unless required by applicable law or agreed to in writing, software | 9 // Unless required by applicable law or agreed to in writing, software |
10 // distributed under the License is distributed on an "AS IS" BASIS, | 10 // distributed under the License is distributed on an "AS IS" BASIS, |
(...skipping 124 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
135 //! \brief Returns key-value string annotations recorded in the module. | 135 //! \brief Returns key-value string annotations recorded in the module. |
136 //! | 136 //! |
137 //! This method retrieves annotations recorded in a module. These annotations | 137 //! This method retrieves annotations recorded in a module. These annotations |
138 //! are intended for diagnostic use, including crash analysis. “Simple | 138 //! are intended for diagnostic use, including crash analysis. “Simple |
139 //! annotations” are structured as a sequence of key-value pairs, where all | 139 //! annotations” are structured as a sequence of key-value pairs, where all |
140 //! keys and values are strings. These are referred to in Chrome as “crash | 140 //! keys and values are strings. These are referred to in Chrome as “crash |
141 //! keys.” | 141 //! keys.” |
142 //! | 142 //! |
143 //! For Mac OS X snapshots, these annotations are found by interpreting the | 143 //! For Mac OS X snapshots, these annotations are found by interpreting the |
144 //! `__DATA, __crashpad_info` section as `CrashpadInfo`. Clients can use the | 144 //! `__DATA, __crashpad_info` section as `CrashpadInfo`. Clients can use the |
145 //! Crashpad client interface to store annotations in this structure. | 145 //! Crashpad client interface to store annotations in this structure. Most |
| 146 //! annotations under the client’s direct control will be retrievable by this |
| 147 //! method. For clients such as Chrome, this includes the process type. |
146 //! | 148 //! |
147 //! The annotations returned by this method do not duplicate those returned by | 149 //! The annotations returned by this method do not duplicate those returned by |
148 //! AnnotationsVector(). | 150 //! AnnotationsVector(). Additional annotations related to the process, |
| 151 //! system, or snapshot producer may be obtained by calling |
| 152 //! ProcessSnapshot::AnnotationsSimpleMap(). |
149 virtual std::map<std::string, std::string> AnnotationsSimpleMap() const = 0; | 153 virtual std::map<std::string, std::string> AnnotationsSimpleMap() const = 0; |
150 }; | 154 }; |
151 | 155 |
152 } // namespace crashpad | 156 } // namespace crashpad |
153 | 157 |
154 #endif // CRASHPAD_SNAPSHOT_MODULE_SNAPSHOT_H_ | 158 #endif // CRASHPAD_SNAPSHOT_MODULE_SNAPSHOT_H_ |
OLD | NEW |