doc/generated/doxygen/classcrashpad_1_1MemorySnapshot_1_1Delegate.html - third_party/crashpad - Git at Google

 <!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::MemorySnapshot::Delegate 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&amp;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&amp;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_1MemorySnapshot.html">MemorySnapshot</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1MemorySnapshot_1_1Delegate.html">Delegate</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#pub-methods">Public Member Functions</a> &#124;
 <a href="classcrashpad_1_1MemorySnapshot_1_1Delegate-members.html">List of all members</a>  </div>
   <div class="headertitle">
 <div class="title">crashpad::MemorySnapshot::Delegate Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
 </div><!--header-->
 <div class="contents">

 <p>An interface that <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> clients must implement in order to receive memory snapshot data.
  <a href="classcrashpad_1_1MemorySnapshot_1_1Delegate.html#details">More...</a></p>

 <p><code>#include &quot;snapshot/memory_snapshot.h&quot;</code></p>
 <div class="dynheader">
 Inheritance diagram for crashpad::MemorySnapshot::Delegate:</div>
 <div class="dyncontent">
  <div class="center">
   <img src="classcrashpad_1_1MemorySnapshot_1_1Delegate.png" usemap="#crashpad::MemorySnapshot::Delegate_map" alt=""/>
   <map id="crashpad::MemorySnapshot::Delegate_map" name="crashpad::MemorySnapshot::Delegate_map">
 <area href="classcrashpad_1_1MinidumpUserStreamWriter_1_1SnapshotContentsWriter.html" alt="crashpad::MinidumpUserStreamWriter::SnapshotContentsWriter" shape="rect" coords="0,56,365,80"/>
 <area href="classcrashpad_1_1SnapshotMinidumpMemoryWriter.html" title="The base class for writers of memory ranges pointed to by MINIDUMP_MEMORY_DESCRIPTOR objects in a min..." alt="crashpad::SnapshotMinidumpMemoryWriter" shape="rect" coords="375,56,740,80"/>
 <area href="classcrashpad_1_1test_1_1TestMinidumpMemoryWriter.html" title="A SnapshotMinidumpMemoryWriter implementation used for testing." alt="crashpad::test::TestMinidumpMemoryWriter" shape="rect" coords="375,112,740,136"/>
   </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:a844f77076dc607ce0cd8946aea75f73b"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MemorySnapshot_1_1Delegate.html#a844f77076dc607ce0cd8946aea75f73b">MemorySnapshotDelegateRead</a> (void *data, size_t size)=0</td></tr>
 <tr class="memdesc:a844f77076dc607ce0cd8946aea75f73b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by <a class="el" href="classcrashpad_1_1MemorySnapshot.html#ad7bd3e85268e7b8d9d78e03be977ee52" title="Calls Delegate::MemorySnapshotDelegateRead(), providing it with the memory snapshot’s data.">MemorySnapshot::Read()</a> to provide data requested by a call to that method.  <a href="classcrashpad_1_1MemorySnapshot_1_1Delegate.html#a844f77076dc607ce0cd8946aea75f73b">More...</a><br /></td></tr>
 <tr class="separator:a844f77076dc607ce0cd8946aea75f73b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>An interface that <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> clients must implement in order to receive memory snapshot data. </p>
 <p>This callback-based model frees <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> implementations from having to deal with memory region ownership problems. When a memory snapshot’s data is read, it will be passed to a delegate method. </p>
 </div><h2 class="groupheader">Member Function Documentation</h2>
 <a id="a844f77076dc607ce0cd8946aea75f73b"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a844f77076dc607ce0cd8946aea75f73b">&#9670;&nbsp;</a></span>MemorySnapshotDelegateRead()</h2>

 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">virtual bool crashpad::MemorySnapshot::Delegate::MemorySnapshotDelegateRead </td>
           <td>(</td>
           <td class="paramtype">void *&#160;</td>
           <td class="paramname"><em>data</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">size_t&#160;</td>
           <td class="paramname"><em>size</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
           <td>)</td>
           <td></td><td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Called by <a class="el" href="classcrashpad_1_1MemorySnapshot.html#ad7bd3e85268e7b8d9d78e03be977ee52" title="Calls Delegate::MemorySnapshotDelegateRead(), providing it with the memory snapshot’s data.">MemorySnapshot::Read()</a> to provide data requested by a call to that method. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>A pointer to the data that was read. The callee does not take ownership of this data. This data is only valid for the duration of the call to this method. This parameter may be <code>nullptr</code> if <em>size</em> is <code>0</code>. </td></tr>
     <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the data that was read.</td></tr>
   </table>
   </dd>
 </dl>
 <dl class="section return"><dt>Returns</dt><dd><code>true</code> on success, <code>false</code> on failure. MemoryDelegate::Read() will use this as its own return value. </dd></dl>

 <p>Implemented in <a class="el" href="classcrashpad_1_1MinidumpUserStreamWriter_1_1SnapshotContentsWriter.html#aff28cd8e727ed7ade0fe8ff86b7cf265">crashpad::MinidumpUserStreamWriter::SnapshotContentsWriter</a>.</p>

 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>
 <li>snapshot/memory_snapshot.h</li>
 </ul>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.8.18
 </small></address>
 </body>
 </html>
	<!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::MemorySnapshot::Delegate 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_1MemorySnapshot.html">MemorySnapshot</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1MemorySnapshot_1_1Delegate.html">Delegate</a></li> </ul>
	</div>
	</div><!-- top -->
	<div class="header">
	<div class="summary">
	<a href="#pub-methods">Public Member Functions</a> \|
	<a href="classcrashpad_1_1MemorySnapshot_1_1Delegate-members.html">List of all members</a> </div>
	<div class="headertitle">
	<div class="title">crashpad::MemorySnapshot::Delegate Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
	</div><!--header-->
	<div class="contents">

	<p>An interface that <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> clients must implement in order to receive memory snapshot data.
	<a href="classcrashpad_1_1MemorySnapshot_1_1Delegate.html#details">More...</a></p>

	<p><code>#include "snapshot/memory_snapshot.h"</code></p>
	<div class="dynheader">
	Inheritance diagram for crashpad::MemorySnapshot::Delegate:</div>
	<div class="dyncontent">
	<div class="center">
	<img src="classcrashpad_1_1MemorySnapshot_1_1Delegate.png" usemap="#crashpad::MemorySnapshot::Delegate_map" alt=""/>
	<map id="crashpad::MemorySnapshot::Delegate_map" name="crashpad::MemorySnapshot::Delegate_map">
	<area href="classcrashpad_1_1MinidumpUserStreamWriter_1_1SnapshotContentsWriter.html" alt="crashpad::MinidumpUserStreamWriter::SnapshotContentsWriter" shape="rect" coords="0,56,365,80"/>
	<area href="classcrashpad_1_1SnapshotMinidumpMemoryWriter.html" title="The base class for writers of memory ranges pointed to by MINIDUMP_MEMORY_DESCRIPTOR objects in a min..." alt="crashpad::SnapshotMinidumpMemoryWriter" shape="rect" coords="375,56,740,80"/>
	<area href="classcrashpad_1_1test_1_1TestMinidumpMemoryWriter.html" title="A SnapshotMinidumpMemoryWriter implementation used for testing." alt="crashpad::test::TestMinidumpMemoryWriter" shape="rect" coords="375,112,740,136"/>
	</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:a844f77076dc607ce0cd8946aea75f73b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1MemorySnapshot_1_1Delegate.html#a844f77076dc607ce0cd8946aea75f73b">MemorySnapshotDelegateRead</a> (void *data, size_t size)=0</td></tr>
	<tr class="memdesc:a844f77076dc607ce0cd8946aea75f73b"><td class="mdescLeft"> </td><td class="mdescRight">Called by <a class="el" href="classcrashpad_1_1MemorySnapshot.html#ad7bd3e85268e7b8d9d78e03be977ee52" title="Calls Delegate::MemorySnapshotDelegateRead(), providing it with the memory snapshot’s data.">MemorySnapshot::Read()</a> to provide data requested by a call to that method. <a href="classcrashpad_1_1MemorySnapshot_1_1Delegate.html#a844f77076dc607ce0cd8946aea75f73b">More...</a><br /></td></tr>
	<tr class="separator:a844f77076dc607ce0cd8946aea75f73b"><td class="memSeparator" colspan="2"> </td></tr>
	</table>
	<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
	<div class="textblock"><p>An interface that <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> clients must implement in order to receive memory snapshot data. </p>
	<p>This callback-based model frees <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> implementations from having to deal with memory region ownership problems. When a memory snapshot’s data is read, it will be passed to a delegate method. </p>
	</div><h2 class="groupheader">Member Function Documentation</h2>
	<a id="a844f77076dc607ce0cd8946aea75f73b"></a>
	<h2 class="memtitle"><span class="permalink"><a href="#a844f77076dc607ce0cd8946aea75f73b">◆ </a></span>MemorySnapshotDelegateRead()</h2>

	<div class="memitem">
	<div class="memproto">
	<table class="mlabels">
	<tr>
	<td class="mlabels-left">
	<table class="memname">
	<tr>
	<td class="memname">virtual bool crashpad::MemorySnapshot::Delegate::MemorySnapshotDelegateRead </td>
	<td>(</td>
	<td class="paramtype">void * </td>
	<td class="paramname"><em>data</em>, </td>
	</tr>
	<tr>
	<td class="paramkey"></td>
	<td></td>
	<td class="paramtype">size_t </td>
	<td class="paramname"><em>size</em> </td>
	</tr>
	<tr>
	<td></td>
	<td>)</td>
	<td></td><td></td>
	</tr>
	</table>
	</td>
	<td class="mlabels-right">
	<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
	</tr>
	</table>
	</div><div class="memdoc">

	<p>Called by <a class="el" href="classcrashpad_1_1MemorySnapshot.html#ad7bd3e85268e7b8d9d78e03be977ee52" title="Calls Delegate::MemorySnapshotDelegateRead(), providing it with the memory snapshot’s data.">MemorySnapshot::Read()</a> to provide data requested by a call to that method. </p>
	<dl class="params"><dt>Parameters</dt><dd>
	<table class="params">
	<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>A pointer to the data that was read. The callee does not take ownership of this data. This data is only valid for the duration of the call to this method. This parameter may be <code>nullptr</code> if <em>size</em> is <code>0</code>. </td></tr>
	<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the data that was read.</td></tr>
	</table>
	</dd>
	</dl>
	<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success, <code>false</code> on failure. MemoryDelegate::Read() will use this as its own return value. </dd></dl>

	<p>Implemented in <a class="el" href="classcrashpad_1_1MinidumpUserStreamWriter_1_1SnapshotContentsWriter.html#aff28cd8e727ed7ade0fe8ff86b7cf265">crashpad::MinidumpUserStreamWriter::SnapshotContentsWriter</a>.</p>

	</div>
	</div>
	<hr/>The documentation for this class was generated from the following file:<ul>
	<li>snapshot/memory_snapshot.h</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>