| <!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::test::TestMemorySnapshot 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="namespacecrashpad_1_1test.html">test</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1test_1_1TestMemorySnapshot.html">TestMemorySnapshot</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classcrashpad_1_1test_1_1TestMemorySnapshot-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">crashpad::test::TestMemorySnapshot Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A test <a class="el" href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process.">MemorySnapshot</a> that can carry arbitrary data for testing purposes. |
| <a href="classcrashpad_1_1test_1_1TestMemorySnapshot.html#details">More...</a></p> |
| |
| <p><code>#include "snapshot/test/test_memory_snapshot.h"</code></p> |
| <div class="dynheader"> |
| Inheritance diagram for crashpad::test::TestMemorySnapshot:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classcrashpad_1_1test_1_1TestMemorySnapshot.png" usemap="#crashpad::test::TestMemorySnapshot_map" alt=""/> |
| <map id="crashpad::test::TestMemorySnapshot_map" name="crashpad::test::TestMemorySnapshot_map"> |
| <area href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process." alt="crashpad::MemorySnapshot" shape="rect" coords="0,0,217,24"/> |
| </map> |
| </div></div> |
| <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:a056143550431056ad3ec52e547c1d6ff"><td class="memItemLeft" align="right" valign="top"><a id="a056143550431056ad3ec52e547c1d6ff"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>SetAddress</b> (uint64_t address)</td></tr> |
| <tr class="separator:a056143550431056ad3ec52e547c1d6ff"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a09eee61648e8d082fd3e504291e25903"><td class="memItemLeft" align="right" valign="top"><a id="a09eee61648e8d082fd3e504291e25903"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>SetSize</b> (size_t size)</td></tr> |
| <tr class="separator:a09eee61648e8d082fd3e504291e25903"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac52de4a7a927ac6d5feb13c2a398aa3a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1test_1_1TestMemorySnapshot.html#ac52de4a7a927ac6d5feb13c2a398aa3a">SetValue</a> (char value)</td></tr> |
| <tr class="memdesc:ac52de4a7a927ac6d5feb13c2a398aa3a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the value to fill the test memory region with. <a href="classcrashpad_1_1test_1_1TestMemorySnapshot.html#ac52de4a7a927ac6d5feb13c2a398aa3a">More...</a><br /></td></tr> |
| <tr class="separator:ac52de4a7a927ac6d5feb13c2a398aa3a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad6c880c7eae43cd08fbfca026ef7fe0c"><td class="memItemLeft" align="right" valign="top"><a id="ad6c880c7eae43cd08fbfca026ef7fe0c"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>SetShouldFailRead</b> (bool should_fail)</td></tr> |
| <tr class="separator:ad6c880c7eae43cd08fbfca026ef7fe0c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a515bc4e6d55ae98fe90c169b40659be7"><td class="memItemLeft" align="right" valign="top"><a id="a515bc4e6d55ae98fe90c169b40659be7"></a> |
| uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1test_1_1TestMemorySnapshot.html#a515bc4e6d55ae98fe90c169b40659be7">Address</a> () const override</td></tr> |
| <tr class="memdesc:a515bc4e6d55ae98fe90c169b40659be7"><td class="mdescLeft"> </td><td class="mdescRight">The base address of the memory snapshot in the snapshot process’ address space. <br /></td></tr> |
| <tr class="separator:a515bc4e6d55ae98fe90c169b40659be7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6af5648bca88c709a75c129f96893087"><td class="memItemLeft" align="right" valign="top"><a id="a6af5648bca88c709a75c129f96893087"></a> |
| size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1test_1_1TestMemorySnapshot.html#a6af5648bca88c709a75c129f96893087">Size</a> () const override</td></tr> |
| <tr class="memdesc:a6af5648bca88c709a75c129f96893087"><td class="mdescLeft"> </td><td class="mdescRight">The size of the memory snapshot. <br /></td></tr> |
| <tr class="separator:a6af5648bca88c709a75c129f96893087"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a89b8798372679d4aef3cf823b165d1d3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1test_1_1TestMemorySnapshot.html#a89b8798372679d4aef3cf823b165d1d3">Read</a> (<a class="el" href="classcrashpad_1_1MemorySnapshot_1_1Delegate.html">Delegate</a> *delegate) const override</td></tr> |
| <tr class="memdesc:a89b8798372679d4aef3cf823b165d1d3"><td class="mdescLeft"> </td><td class="mdescRight">Calls <a class="el" href="classcrashpad_1_1MemorySnapshot_1_1Delegate.html#a844f77076dc607ce0cd8946aea75f73b" title="Called by MemorySnapshot::Read() to provide data requested by a call to that method.">Delegate::MemorySnapshotDelegateRead()</a>, providing it with the memory snapshot’s data. <a href="classcrashpad_1_1test_1_1TestMemorySnapshot.html#a89b8798372679d4aef3cf823b165d1d3">More...</a><br /></td></tr> |
| <tr class="separator:a89b8798372679d4aef3cf823b165d1d3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aeae5e5eb887e1c1efadcaad2657a60ee"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1test_1_1TestMemorySnapshot.html#aeae5e5eb887e1c1efadcaad2657a60ee">MergeWithOtherSnapshot</a> (const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> *other) const override</td></tr> |
| <tr class="memdesc:aeae5e5eb887e1c1efadcaad2657a60ee"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process.">MemorySnapshot</a> based on merging this one with <em>other</em>. <a href="classcrashpad_1_1test_1_1TestMemorySnapshot.html#aeae5e5eb887e1c1efadcaad2657a60ee">More...</a><br /></td></tr> |
| <tr class="separator:aeae5e5eb887e1c1efadcaad2657a60ee"><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 test <a class="el" href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process.">MemorySnapshot</a> that can carry arbitrary data for testing purposes. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="aeae5e5eb887e1c1efadcaad2657a60ee"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aeae5e5eb887e1c1efadcaad2657a60ee">◆ </a></span>MergeWithOtherSnapshot()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> * crashpad::test::TestMemorySnapshot::MergeWithOtherSnapshot </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> * </td> |
| <td class="paramname"><em>other</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Creates a new <a class="el" href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process.">MemorySnapshot</a> based on merging this one with <em>other</em>. </p> |
| <p>The ranges described by the two snapshots must either overlap or abut, and must be of the same concrete type.</p> |
| <dl class="section return"><dt>Returns</dt><dd>A newly allocated <a class="el" href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process.">MemorySnapshot</a> representing the merged range, or <code>nullptr</code> with an error logged. </dd></dl> |
| |
| <p>Implements <a class="el" href="classcrashpad_1_1MemorySnapshot.html#ac215c8c515725ac43f2bf5ec5d7a27a4">crashpad::MemorySnapshot</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a89b8798372679d4aef3cf823b165d1d3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a89b8798372679d4aef3cf823b165d1d3">◆ </a></span>Read()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool crashpad::test::TestMemorySnapshot::Read </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classcrashpad_1_1MemorySnapshot_1_1Delegate.html">Delegate</a> * </td> |
| <td class="paramname"><em>delegate</em></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Calls <a class="el" href="classcrashpad_1_1MemorySnapshot_1_1Delegate.html#a844f77076dc607ce0cd8946aea75f73b" title="Called by MemorySnapshot::Read() to provide data requested by a call to that method.">Delegate::MemorySnapshotDelegateRead()</a>, providing it with the memory snapshot’s data. </p> |
| <p>Implementations do not necessarily read the memory snapshot data prior to this method being called. Memory snapshot data may be loaded lazily and may be discarded after being passed to the delegate. This provides clean memory management without burdening a snapshot implementation with the requirement that it track all memory region data simultaneously.</p> |
| <dl class="section return"><dt>Returns</dt><dd><code>false</code> on failure, otherwise, the return value of <a class="el" href="classcrashpad_1_1MemorySnapshot_1_1Delegate.html#a844f77076dc607ce0cd8946aea75f73b" title="Called by MemorySnapshot::Read() to provide data requested by a call to that method.">Delegate::MemorySnapshotDelegateRead()</a>, which should be <code>true</code> on success and <code>false</code> on failure. </dd></dl> |
| |
| <p>Implements <a class="el" href="classcrashpad_1_1MemorySnapshot.html#ad7bd3e85268e7b8d9d78e03be977ee52">crashpad::MemorySnapshot</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ac52de4a7a927ac6d5feb13c2a398aa3a"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac52de4a7a927ac6d5feb13c2a398aa3a">◆ </a></span>SetValue()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void crashpad::test::TestMemorySnapshot::SetValue </td> |
| <td>(</td> |
| <td class="paramtype">char </td> |
| <td class="paramname"><em>value</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the value to fill the test memory region with. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The value to be written to <em>delegate</em> when <a class="el" href="classcrashpad_1_1test_1_1TestMemorySnapshot.html#a89b8798372679d4aef3cf823b165d1d3" title="Calls Delegate::MemorySnapshotDelegateRead(), providing it with the memory snapshot’s data.">Read()</a> is called. This value will be repeated <a class="el" href="classcrashpad_1_1test_1_1TestMemorySnapshot.html#a6af5648bca88c709a75c129f96893087" title="The size of the memory snapshot.">Size()</a> times. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>snapshot/test/test_memory_snapshot.h</li> |
| <li>snapshot/test/test_memory_snapshot.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> |
