3party/crashpad
0
0
Fork 0
mirror of https://github.com/chromium/crashpad.git synced 2025-03-20 18:53:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
crashpad/doc/generated/doxygen/classcrashpad_1_1internal_1_1MinidumpStreamWriter.html
Mark Mentovai 6b3d4ea6ea Update documentation to master 6759969bf653
2018-08-01 13:34:49 -04:00

273 lines
35 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crashpad: crashpad::internal::MinidumpStreamWriter 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.14 -->
<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="namespacecrashpad_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpStreamWriter.html">MinidumpStreamWriter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classcrashpad_1_1internal_1_1MinidumpStreamWriter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::internal::MinidumpStreamWriter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The base class for all second-level objects (“streams”) in a minidump file.
<a href="classcrashpad_1_1internal_1_1MinidumpStreamWriter.html#details">More...</a></p>
<p><code>#include &quot;minidump/minidump_stream_writer.h&quot;</code></p>
<div class="dynheader">
Inheritance diagram for crashpad::internal::MinidumpStreamWriter:</div>
<div class="dyncontent">
<div class="center">
<img src="classcrashpad_1_1internal_1_1MinidumpStreamWriter.png" usemap="#crashpad::internal::MinidumpStreamWriter_map" alt=""/>
<map id="crashpad::internal::MinidumpStreamWriter_map" name="crashpad::internal::MinidumpStreamWriter_map">
<area href="classcrashpad_1_1internal_1_1MinidumpWritable.html" title="The base class for all content that might be written to a minidump file. " alt="crashpad::internal::MinidumpWritable" shape="rect" coords="0,0,273,24"/>
<area href="classcrashpad_1_1MinidumpCrashpadInfoWriter.html" title="The writer for a MinidumpCrashpadInfo stream in a minidump file. " alt="crashpad::MinidumpCrashpadInfoWriter" shape="rect" coords="283,112,556,136"/>
<area href="classcrashpad_1_1MinidumpExceptionWriter.html" title="The writer for a MINIDUMP_EXCEPTION_STREAM stream in a minidump file. " alt="crashpad::MinidumpExceptionWriter" shape="rect" coords="283,168,556,192"/>
<area href="classcrashpad_1_1MinidumpHandleDataWriter.html" title="The writer for a MINIDUMP_HANDLE_DATA_STREAM stream in a minidump and its contained MINIDUMP_HANDLE_D..." alt="crashpad::MinidumpHandleDataWriter" shape="rect" coords="283,224,556,248"/>
<area href="classcrashpad_1_1MinidumpMemoryInfoListWriter.html" title="The writer for a MINIDUMP_MEMORY_INFO_LIST stream in a minidump file, containing a list of MINIDUMP_M..." alt="crashpad::MinidumpMemoryInfoListWriter" shape="rect" coords="283,280,556,304"/>
<area href="classcrashpad_1_1MinidumpMemoryListWriter.html" title="The writer for a MINIDUMP_MEMORY_LIST stream in a minidump file, containing a list of MINIDUMP_MEMORY..." alt="crashpad::MinidumpMemoryListWriter" shape="rect" coords="283,336,556,360"/>
<area href="classcrashpad_1_1MinidumpMiscInfoWriter.html" title="The writer for a stream in the MINIDUMP_MISC_INFO family in a minidump file. " alt="crashpad::MinidumpMiscInfoWriter" shape="rect" coords="283,392,556,416"/>
<area href="classcrashpad_1_1MinidumpModuleListWriter.html" title="The writer for a MINIDUMP_MODULE_LIST stream in a minidump file, containing a list of MINIDUMP_MODULE..." alt="crashpad::MinidumpModuleListWriter" shape="rect" coords="283,448,556,472"/>
<area href="classcrashpad_1_1MinidumpSystemInfoWriter.html" title="The writer for a MINIDUMP_SYSTEM_INFO stream in a minidump file. " alt="crashpad::MinidumpSystemInfoWriter" shape="rect" coords="283,504,556,528"/>
<area href="classcrashpad_1_1MinidumpThreadListWriter.html" title="The writer for a MINIDUMP_THREAD_LIST stream in a minidump file, containing a list of MINIDUMP_THREAD..." alt="crashpad::MinidumpThreadListWriter" shape="rect" coords="283,560,556,584"/>
<area href="classcrashpad_1_1MinidumpUnloadedModuleListWriter.html" title="The writer for a MINIDUMP_UNLOADED_MODULE_LIST stream in a minidump file, containing a list of MINIDU..." alt="crashpad::MinidumpUnloadedModuleListWriter" shape="rect" coords="283,616,556,640"/>
<area href="classcrashpad_1_1MinidumpUserStreamWriter.html" title="The writer for a MINIDUMP_USER_STREAM in a minidump file. " alt="crashpad::MinidumpUserStreamWriter" shape="rect" coords="283,672,556,696"/>
</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:aa995c5f93ecfdeb13dbfc4b7fb107632"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespacecrashpad.html#a88363a45a4af1a16f542a8c1ff522ab9">MinidumpStreamType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpStreamWriter.html#aa995c5f93ecfdeb13dbfc4b7fb107632">StreamType</a> () const =0</td></tr>
<tr class="memdesc:aa995c5f93ecfdeb13dbfc4b7fb107632"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an object’s stream type. <a href="#aa995c5f93ecfdeb13dbfc4b7fb107632">More...</a><br /></td></tr>
<tr class="separator:aa995c5f93ecfdeb13dbfc4b7fb107632"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d2658a99963fa9083c07dc2ddc72845"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structMINIDUMP__DIRECTORY.html">MINIDUMP_DIRECTORY</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpStreamWriter.html#a3d2658a99963fa9083c07dc2ddc72845">DirectoryListEntry</a> () const</td></tr>
<tr class="memdesc:a3d2658a99963fa9083c07dc2ddc72845"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a <a class="el" href="structMINIDUMP__DIRECTORY.html" title="A pointer to a stream within a minidump file. ">MINIDUMP_DIRECTORY</a> entry that serves as a pointer to this stream. <a href="#a3d2658a99963fa9083c07dc2ddc72845">More...</a><br /></td></tr>
<tr class="separator:a3d2658a99963fa9083c07dc2ddc72845"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html">crashpad::internal::MinidumpWritable</a></td></tr>
<tr class="memitem:a24507e918299cb566c7f15207de83a7f inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a24507e918299cb566c7f15207de83a7f">WriteEverything</a> (<a class="el" href="classcrashpad_1_1FileWriterInterface.html">FileWriterInterface</a> *file_writer)</td></tr>
<tr class="memdesc:a24507e918299cb566c7f15207de83a7f inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes an object and all of its children to a minidump file. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a24507e918299cb566c7f15207de83a7f">More...</a><br /></td></tr>
<tr class="separator:a24507e918299cb566c7f15207de83a7f inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a686683d78f099a07e2a1df8e6b567d37 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a686683d78f099a07e2a1df8e6b567d37">RegisterRVA</a> (<a class="el" href="dbghelp_8h.html#acf465a1a77ecf067a9d946583bc6a3f8">RVA</a> *rva)</td></tr>
<tr class="memdesc:a686683d78f099a07e2a1df8e6b567d37 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a file offset pointer as one that should point to the object on which this method is called. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a686683d78f099a07e2a1df8e6b567d37">More...</a><br /></td></tr>
<tr class="separator:a686683d78f099a07e2a1df8e6b567d37 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed263c64ecb0597696d080e395af6400 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#aed263c64ecb0597696d080e395af6400">RegisterLocationDescriptor</a> (<a class="el" href="structMINIDUMP__LOCATION__DESCRIPTOR.html">MINIDUMP_LOCATION_DESCRIPTOR</a> *location_descriptor)</td></tr>
<tr class="memdesc:aed263c64ecb0597696d080e395af6400 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a location descriptor as one that should point to the object on which this method is called. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#aed263c64ecb0597696d080e395af6400">More...</a><br /></td></tr>
<tr class="separator:aed263c64ecb0597696d080e395af6400 inherit pub_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a6bace0c62b1f29aa710974a2bbcb3e1c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpStreamWriter.html#a6bace0c62b1f29aa710974a2bbcb3e1c">Freeze</a> () override</td></tr>
<tr class="memdesc:a6bace0c62b1f29aa710974a2bbcb3e1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transitions the object from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a18337604dcbdbdb23ed51810f0587665" title="The object’s properties can be modified. ">kStateMutable</a> to <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af98547144e0e8d4f878f725ef5c0d611" title="The object is “frozen”. ">kStateFrozen</a>. <a href="#a6bace0c62b1f29aa710974a2bbcb3e1c">More...</a><br /></td></tr>
<tr class="separator:a6bace0c62b1f29aa710974a2bbcb3e1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html">crashpad::internal::MinidumpWritable</a></td></tr>
<tr class="memitem:aed27972114564f99cda1e7648aec807a inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top"><a id="aed27972114564f99cda1e7648aec807a"></a>
<a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7">State</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#aed27972114564f99cda1e7648aec807a">state</a> () const</td></tr>
<tr class="memdesc:aed27972114564f99cda1e7648aec807a inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft">&#160;</td><td class="mdescRight">The state of the object. <br /></td></tr>
<tr class="separator:aed27972114564f99cda1e7648aec807a inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1483275a3acbdfcecffb7f3c27cd2feb inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a1483275a3acbdfcecffb7f3c27cd2feb">SizeOfObject</a> ()=0</td></tr>
<tr class="memdesc:a1483275a3acbdfcecffb7f3c27cd2feb inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the amount of space that this object will consume when written to a minidump file, in bytes, not including any leading or trailing padding necessary to maintain proper alignment. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a1483275a3acbdfcecffb7f3c27cd2feb">More...</a><br /></td></tr>
<tr class="separator:a1483275a3acbdfcecffb7f3c27cd2feb inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4e92c46984eb73dbc1315ff5f4c7a9a inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#af4e92c46984eb73dbc1315ff5f4c7a9a">Alignment</a> ()</td></tr>
<tr class="memdesc:af4e92c46984eb73dbc1315ff5f4c7a9a inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the object’s desired byte-boundary alignment. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#af4e92c46984eb73dbc1315ff5f4c7a9a">More...</a><br /></td></tr>
<tr class="separator:af4e92c46984eb73dbc1315ff5f4c7a9a inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32460b7fe2154fbabc3c58bf10dc7861 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">virtual std::vector&lt; <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html">MinidumpWritable</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a32460b7fe2154fbabc3c58bf10dc7861">Children</a> ()</td></tr>
<tr class="memdesc:a32460b7fe2154fbabc3c58bf10dc7861 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the object’s children. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a32460b7fe2154fbabc3c58bf10dc7861">More...</a><br /></td></tr>
<tr class="separator:a32460b7fe2154fbabc3c58bf10dc7861 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a389b0ac1986698e80ebbc49198676ac7 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a009f007265d64a5fb416848480a00ae9">Phase</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a389b0ac1986698e80ebbc49198676ac7">WritePhase</a> ()</td></tr>
<tr class="memdesc:a389b0ac1986698e80ebbc49198676ac7 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the object’s desired write phase. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a389b0ac1986698e80ebbc49198676ac7">More...</a><br /></td></tr>
<tr class="separator:a389b0ac1986698e80ebbc49198676ac7 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8439e05e21ccb78a4d61cd6e817d3bf5 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a8439e05e21ccb78a4d61cd6e817d3bf5">WillWriteAtOffset</a> (<a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a009f007265d64a5fb416848480a00ae9">Phase</a> phase, <a class="el" href="namespacecrashpad.html#a1e53a1957d9edcba8b406ea632b6daf2">FileOffset</a> *offset, std::vector&lt; <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html">MinidumpWritable</a> *&gt; *write_sequence)</td></tr>
<tr class="memdesc:a8439e05e21ccb78a4d61cd6e817d3bf5 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepares the object to be written at a known file offset, transitioning it from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af98547144e0e8d4f878f725ef5c0d611" title="The object is “frozen”. ">kStateFrozen</a> to <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a87483823ca30a8257b2a5fbd21805bcd" title="The object is writable. ">kStateWritable</a>. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a8439e05e21ccb78a4d61cd6e817d3bf5">More...</a><br /></td></tr>
<tr class="separator:a8439e05e21ccb78a4d61cd6e817d3bf5 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2416cb821816b769d95b92e486713ebf inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a2416cb821816b769d95b92e486713ebf">WillWriteAtOffsetImpl</a> (<a class="el" href="namespacecrashpad.html#a1e53a1957d9edcba8b406ea632b6daf2">FileOffset</a> offset)</td></tr>
<tr class="memdesc:a2416cb821816b769d95b92e486713ebf inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called once an object’s writable file offset is determined, as it transitions into <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a87483823ca30a8257b2a5fbd21805bcd" title="The object is writable. ">kStateWritable</a>. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a2416cb821816b769d95b92e486713ebf">More...</a><br /></td></tr>
<tr class="separator:a2416cb821816b769d95b92e486713ebf inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab82b1e92ae0eced8b8e2efe957411773 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ab82b1e92ae0eced8b8e2efe957411773">WritePaddingAndObject</a> (<a class="el" href="classcrashpad_1_1FileWriterInterface.html">FileWriterInterface</a> *file_writer)</td></tr>
<tr class="memdesc:ab82b1e92ae0eced8b8e2efe957411773 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes the object, transitioning it from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a87483823ca30a8257b2a5fbd21805bcd" title="The object is writable. ">kStateWritable</a> to <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af0d794ed29c320fcf35c71f40cc6a510" title="The object has been written to a minidump file. ">kStateWritten</a>. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ab82b1e92ae0eced8b8e2efe957411773">More...</a><br /></td></tr>
<tr class="separator:ab82b1e92ae0eced8b8e2efe957411773 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d3472b11ec3c12184f5d8f946fbb4a1 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a2d3472b11ec3c12184f5d8f946fbb4a1">WriteObject</a> (<a class="el" href="classcrashpad_1_1FileWriterInterface.html">FileWriterInterface</a> *file_writer)=0</td></tr>
<tr class="memdesc:a2d3472b11ec3c12184f5d8f946fbb4a1 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes the object’s content. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a2d3472b11ec3c12184f5d8f946fbb4a1">More...</a><br /></td></tr>
<tr class="separator:a2d3472b11ec3c12184f5d8f946fbb4a1 inherit pro_methods_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_types_classcrashpad_1_1internal_1_1MinidumpWritable"><td colspan="2" onclick="javascript:toggleInherit('pro_types_classcrashpad_1_1internal_1_1MinidumpWritable')"><img src="closed.png" alt="-"/>&#160;Protected Types inherited from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html">crashpad::internal::MinidumpWritable</a></td></tr>
<tr class="memitem:ac14e05f291f5fa713b5ec82a208fa7c7 inherit pro_types_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7">State</a> </td></tr>
<tr class="memdesc:ac14e05f291f5fa713b5ec82a208fa7c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identifies the state of an object. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7">More...</a><br /></td></tr>
<tr class="separator:ac14e05f291f5fa713b5ec82a208fa7c7 inherit pro_types_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a009f007265d64a5fb416848480a00ae9 inherit pro_types_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a009f007265d64a5fb416848480a00ae9">Phase</a> </td></tr>
<tr class="memdesc:a009f007265d64a5fb416848480a00ae9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identifies the phase during which an object will be written to a minidump file. <a href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a009f007265d64a5fb416848480a00ae9">More...</a><br /></td></tr>
<tr class="separator:a009f007265d64a5fb416848480a00ae9 inherit pro_types_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_static_attribs_classcrashpad_1_1internal_1_1MinidumpWritable"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_classcrashpad_1_1internal_1_1MinidumpWritable')"><img src="closed.png" alt="-"/>&#160;Static Protected Attributes inherited from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html">crashpad::internal::MinidumpWritable</a></td></tr>
<tr class="memitem:ac2b31049c4fedaabb24857d82531d6d6 inherit pro_static_attribs_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="memItemLeft" align="right" valign="top"><a id="ac2b31049c4fedaabb24857d82531d6d6"></a>
static constexpr size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac2b31049c4fedaabb24857d82531d6d6">kInvalidSize</a> = std::numeric_limits&lt;size_t&gt;::max()</td></tr>
<tr class="memdesc:ac2b31049c4fedaabb24857d82531d6d6 inherit pro_static_attribs_classcrashpad_1_1internal_1_1MinidumpWritable"><td class="mdescLeft">&#160;</td><td class="mdescRight">A size value used to signal failure by methods that return <code>size_t</code>. <br /></td></tr>
<tr class="separator:ac2b31049c4fedaabb24857d82531d6d6 inherit pro_static_attribs_classcrashpad_1_1internal_1_1MinidumpWritable"><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>The base class for all second-level objects (“streams”) in a minidump file. </p>
<p>Instances of subclasses of this class are children of the root-level <a class="el" href="classcrashpad_1_1MinidumpFileWriter.html" title="The root-level object in a minidump file. ">MinidumpFileWriter</a> object. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a3d2658a99963fa9083c07dc2ddc72845"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d2658a99963fa9083c07dc2ddc72845">&#9670;&nbsp;</a></span>DirectoryListEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structMINIDUMP__DIRECTORY.html">MINIDUMP_DIRECTORY</a> * crashpad::internal::MinidumpStreamWriter::DirectoryListEntry </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="structMINIDUMP__DIRECTORY.html" title="A pointer to a stream within a minidump file. ">MINIDUMP_DIRECTORY</a> entry that serves as a pointer to this stream. </p>
<p>This method is provided for <a class="el" href="classcrashpad_1_1MinidumpFileWriter.html" title="The root-level object in a minidump file. ">MinidumpFileWriter</a>, which calls it in order to obtain the directory entry for a stream.</p>
<dl class="section note"><dt>Note</dt><dd>Valid only in <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a87483823ca30a8257b2a5fbd21805bcd" title="The object is writable. ">kStateWritable</a>. </dd></dl>
</div>
</div>
<a id="a6bace0c62b1f29aa710974a2bbcb3e1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bace0c62b1f29aa710974a2bbcb3e1c">&#9670;&nbsp;</a></span>Freeze()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool crashpad::internal::MinidumpStreamWriter::Freeze </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Transitions the object from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7a18337604dcbdbdb23ed51810f0587665" title="The object’s properties can be modified. ">kStateMutable</a> to <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#ac14e05f291f5fa713b5ec82a208fa7c7af98547144e0e8d4f878f725ef5c0d611" title="The object is “frozen”. ">kStateFrozen</a>. </p>
<p>The default implementation marks the object as frozen and recursively calls <a class="el" href="classcrashpad_1_1internal_1_1MinidumpStreamWriter.html#a6bace0c62b1f29aa710974a2bbcb3e1c" title="Transitions the object from kStateMutable to kStateFrozen. ">Freeze()</a> on all of its children. Subclasses may override this method to perform processing that should only be done once callers have finished populating an object with data. Typically, a subclass implementation would call <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a686683d78f099a07e2a1df8e6b567d37" title="Registers a file offset pointer as one that should point to the object on which this method is called...">RegisterRVA()</a> or <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#aed263c64ecb0597696d080e395af6400" title="Registers a location descriptor as one that should point to the object on which this method is called...">RegisterLocationDescriptor()</a> on other objects as appropriate, because at the time <a class="el" href="classcrashpad_1_1internal_1_1MinidumpStreamWriter.html#a6bace0c62b1f29aa710974a2bbcb3e1c" title="Transitions the object from kStateMutable to kStateFrozen. ">Freeze()</a> runs, the in-memory locations of RVAs and location descriptors are known and will not change for the remaining duration of an object’s lifetime.</p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. <code>false</code> on failure, with an appropriate message logged. </dd></dl>
<p>Reimplemented from <a class="el" href="classcrashpad_1_1internal_1_1MinidumpWritable.html#a773db80946a99c6a3cc29c7d4dd77bd6">crashpad::internal::MinidumpWritable</a>.</p>
<p>Reimplemented in <a class="el" href="classcrashpad_1_1MinidumpThreadListWriter.html#a7517faf9891c1bd588951ab3e0aef55f">crashpad::MinidumpThreadListWriter</a>, <a class="el" href="classcrashpad_1_1MinidumpSystemInfoWriter.html#a76bad6c5eedf1c4c65b89c04e96bc376">crashpad::MinidumpSystemInfoWriter</a>, <a class="el" href="classcrashpad_1_1MinidumpUnloadedModuleListWriter.html#a39aaa6a3d41f9ef2b25f47ec1d75021f">crashpad::MinidumpUnloadedModuleListWriter</a>, and <a class="el" href="classcrashpad_1_1MinidumpUserStreamWriter.html#a0e95d95eb75d4878a6377501b08c6df0">crashpad::MinidumpUserStreamWriter</a>.</p>
</div>
</div>
<a id="aa995c5f93ecfdeb13dbfc4b7fb107632"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa995c5f93ecfdeb13dbfc4b7fb107632">&#9670;&nbsp;</a></span>StreamType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespacecrashpad.html#a88363a45a4af1a16f542a8c1ff522ab9">MinidumpStreamType</a> crashpad::internal::MinidumpStreamWriter::StreamType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Returns an object’s stream type. </p>
<dl class="section note"><dt>Note</dt><dd>Valid in any state. </dd></dl>
<p>Implemented in <a class="el" href="classcrashpad_1_1MinidumpModuleListWriter.html#ac00c0d3e8595449c2fdb254eace80018">crashpad::MinidumpModuleListWriter</a>, <a class="el" href="classcrashpad_1_1MinidumpThreadListWriter.html#a75cada7ca407f1a4d04e62742286af0d">crashpad::MinidumpThreadListWriter</a>, <a class="el" href="classcrashpad_1_1MinidumpSystemInfoWriter.html#a999958c694f5cb49dddc4d3d9b54e93b">crashpad::MinidumpSystemInfoWriter</a>, <a class="el" href="classcrashpad_1_1MinidumpMemoryListWriter.html#ab593614fbd0abd6184b5a66db8dd88b3">crashpad::MinidumpMemoryListWriter</a>, <a class="el" href="classcrashpad_1_1MinidumpUnloadedModuleListWriter.html#a55e89316af0addb62a9fb3125b6cb222">crashpad::MinidumpUnloadedModuleListWriter</a>, <a class="el" href="classcrashpad_1_1MinidumpMiscInfoWriter.html#a3ed89c49422397088e30973fb3ffb375">crashpad::MinidumpMiscInfoWriter</a>, <a class="el" href="classcrashpad_1_1MinidumpExceptionWriter.html#afce2f1831d64fe2d7fd9cd71263dfbce">crashpad::MinidumpExceptionWriter</a>, <a class="el" href="classcrashpad_1_1MinidumpCrashpadInfoWriter.html#ab6e89173daea87a484b6d0a4a453df67">crashpad::MinidumpCrashpadInfoWriter</a>, <a class="el" href="classcrashpad_1_1MinidumpHandleDataWriter.html#aebb90e7ab3575890f4316a92218bfc62">crashpad::MinidumpHandleDataWriter</a>, <a class="el" href="classcrashpad_1_1MinidumpUserStreamWriter.html#ad604ac768ddb503f736d34c87cb8c7e5">crashpad::MinidumpUserStreamWriter</a>, and <a class="el" href="classcrashpad_1_1MinidumpMemoryInfoListWriter.html#ae03d1f47c1eb1283d6a00a066c275bed">crashpad::MinidumpMemoryInfoListWriter</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>minidump/minidump_stream_writer.h</li>
<li>minidump/minidump_stream_writer.cc</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.14
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink