| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.18"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Crashpad: crashpad::AnnotationList Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <link href="crashpad_doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Crashpad |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.18 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacecrashpad.html">crashpad</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1AnnotationList.html">AnnotationList</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classcrashpad_1_1AnnotationList-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">crashpad::AnnotationList Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A list that contains all the currently set annotations. |
| <a href="classcrashpad_1_1AnnotationList.html#details">More...</a></p> |
| |
| <p><code>#include "client/annotation_list.h"</code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1AnnotationList_1_1Iterator.html">Iterator</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An InputIterator for the <a class="el" href="classcrashpad_1_1AnnotationList.html" title="A list that contains all the currently set annotations.">AnnotationList</a>. <a href="classcrashpad_1_1AnnotationList_1_1Iterator.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a3e63684dc6a77a3d32450bfc79531ac8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1AnnotationList.html#a3e63684dc6a77a3d32450bfc79531ac8">Add</a> (<a class="el" href="classcrashpad_1_1Annotation.html">Annotation</a> *annotation)</td></tr> |
| <tr class="memdesc:a3e63684dc6a77a3d32450bfc79531ac8"><td class="mdescLeft"> </td><td class="mdescRight">Adds <em>annotation</em> to the global list. This method does not need to be called by clients directly. The <a class="el" href="classcrashpad_1_1Annotation.html" title="Base class for an annotation, which records a name-value pair of arbitrary data when set.">Annotation</a> object will do so automatically. <a href="classcrashpad_1_1AnnotationList.html#a3e63684dc6a77a3d32450bfc79531ac8">More...</a><br /></td></tr> |
| <tr class="separator:a3e63684dc6a77a3d32450bfc79531ac8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a80de1820032ee18c516f476661fecb59"><td class="memItemLeft" align="right" valign="top"><a id="a80de1820032ee18c516f476661fecb59"></a> |
| <a class="el" href="classcrashpad_1_1AnnotationList_1_1Iterator.html">Iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1AnnotationList.html#a80de1820032ee18c516f476661fecb59">begin</a> ()</td></tr> |
| <tr class="memdesc:a80de1820032ee18c516f476661fecb59"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator to the first element of the annotation list. <br /></td></tr> |
| <tr class="separator:a80de1820032ee18c516f476661fecb59"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6d027d4cdfb321624f2620070d63613f"><td class="memItemLeft" align="right" valign="top"><a id="a6d027d4cdfb321624f2620070d63613f"></a> |
| <a class="el" href="classcrashpad_1_1AnnotationList_1_1Iterator.html">Iterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1AnnotationList.html#a6d027d4cdfb321624f2620070d63613f">end</a> ()</td></tr> |
| <tr class="memdesc:a6d027d4cdfb321624f2620070d63613f"><td class="mdescLeft"> </td><td class="mdescRight">Returns an iterator past the last element of the annotation list. <br /></td></tr> |
| <tr class="separator:a6d027d4cdfb321624f2620070d63613f"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a664f120cd933b02f71332eba369bb644"><td class="memItemLeft" align="right" valign="top"><a id="a664f120cd933b02f71332eba369bb644"></a> |
| static <a class="el" href="classcrashpad_1_1AnnotationList.html">AnnotationList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1AnnotationList.html#a664f120cd933b02f71332eba369bb644">Get</a> ()</td></tr> |
| <tr class="memdesc:a664f120cd933b02f71332eba369bb644"><td class="mdescLeft"> </td><td class="mdescRight">Returns the instance of the list that has been registered on the CrashapdInfo structure. <br /></td></tr> |
| <tr class="separator:a664f120cd933b02f71332eba369bb644"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac3f6faf1ddf517756af29eca69af458c"><td class="memItemLeft" align="right" valign="top"><a id="ac3f6faf1ddf517756af29eca69af458c"></a> |
| static <a class="el" href="classcrashpad_1_1AnnotationList.html">AnnotationList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1AnnotationList.html#ac3f6faf1ddf517756af29eca69af458c">Register</a> ()</td></tr> |
| <tr class="memdesc:ac3f6faf1ddf517756af29eca69af458c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the instace of the list, creating and registering it if one is not already set on the CrashapdInfo structure. <br /></td></tr> |
| <tr class="separator:ac3f6faf1ddf517756af29eca69af458c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A list that contains all the currently set annotations. </p> |
| <p>An instance of this class must be registered on the <em><a class="el" href="structcrashpad_1_1CrashpadInfo.html" title="A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad cra...">CrashpadInfo</a></em> structure in order to use the annotations system. Once a list object has been registered on the <a class="el" href="structcrashpad_1_1CrashpadInfo.html" title="A structure that can be used by a Crashpad-enabled program to provide information to the Crashpad cra...">CrashpadInfo</a>, a different instance should not be used instead. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a3e63684dc6a77a3d32450bfc79531ac8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3e63684dc6a77a3d32450bfc79531ac8">◆ </a></span>Add()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void crashpad::AnnotationList::Add </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classcrashpad_1_1Annotation.html">Annotation</a> * </td> |
| <td class="paramname"><em>annotation</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Adds <em>annotation</em> to the global list. This method does not need to be called by clients directly. The <a class="el" href="classcrashpad_1_1Annotation.html" title="Base class for an annotation, which records a name-value pair of arbitrary data when set.">Annotation</a> object will do so automatically. </p> |
| <p>Once an annotation is added to the list, it is not removed. This is because the <a class="el" href="classcrashpad_1_1AnnotationList.html" title="A list that contains all the currently set annotations.">AnnotationList</a> avoids the use of locks/mutexes, in case it is being manipulated in a compromised context. Instead, an <a class="el" href="classcrashpad_1_1Annotation.html" title="Base class for an annotation, which records a name-value pair of arbitrary data when set.">Annotation</a> keeps track of when it has been cleared, which excludes it from a crash report. This design also avoids linear scans of the list when repeatedly setting and/or clearing the value. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>client/annotation_list.h</li> |
| <li>client/annotation_list.cc</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.18 |
| </small></address> |
| </body> |
| </html> |
