mirror of
https://github.com/chromium/crashpad.git
synced 2025-03-22 20:03:50 +00:00
266 lines
19 KiB
HTML
266 lines
19 KiB
HTML
<!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.10"/>
|
|
<title>Crashpad: crashpad::InitialClientData 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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="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.10 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</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_1InitialClientData.html">InitialClientData</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classcrashpad_1_1InitialClientData-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">crashpad::InitialClientData Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A container for the data associated with the <code>--initial-client-data</code> method for initializing the handler process on Windows.
|
|
<a href="classcrashpad_1_1InitialClientData.html#details">More...</a></p>
|
|
|
|
<p><code>#include "util/win/initial_client_data.h"</code></p>
|
|
<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:a80131e5552fc537b18fe019d47e32fb6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80131e5552fc537b18fe019d47e32fb6"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1InitialClientData.html#a80131e5552fc537b18fe019d47e32fb6">InitialClientData</a> ()</td></tr>
|
|
<tr class="memdesc:a80131e5552fc537b18fe019d47e32fb6"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an unintialized instance to be used with <a class="el" href="classcrashpad_1_1InitialClientData.html#a9c27fc3f1b70ec4ab0b6f4fdc9d5f27b">InitializeFromString()</a>. <br /></td></tr>
|
|
<tr class="separator:a80131e5552fc537b18fe019d47e32fb6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade29b844a82ae4f712a4ba89099f9b6d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1InitialClientData.html#ade29b844a82ae4f712a4ba89099f9b6d">InitialClientData</a> (HANDLE request_crash_dump, HANDLE request_non_crash_dump, HANDLE non_crash_dump_completed, HANDLE first_pipe_instance, HANDLE client_process, <a class="el" href="namespacecrashpad.html#a368af6d88f68998b5c5eb80b8f6ebb76">WinVMAddress</a> crash_exception_information, <a class="el" href="namespacecrashpad.html#a368af6d88f68998b5c5eb80b8f6ebb76">WinVMAddress</a> non_crash_exception_information, <a class="el" href="namespacecrashpad.html#a368af6d88f68998b5c5eb80b8f6ebb76">WinVMAddress</a> debug_critical_section_address)</td></tr>
|
|
<tr class="memdesc:ade29b844a82ae4f712a4ba89099f9b6d"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an instance of <a class="el" href="classcrashpad_1_1InitialClientData.html" title="A container for the data associated with the --initial-client-data method for initializing the handle...">InitialClientData</a>. This object does not take ownership of any of the referenced HANDLEs. <a href="#ade29b844a82ae4f712a4ba89099f9b6d">More...</a><br /></td></tr>
|
|
<tr class="separator:ade29b844a82ae4f712a4ba89099f9b6d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae9c006b03e21af12d92d670af98beb4e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9c006b03e21af12d92d670af98beb4e"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1InitialClientData.html#ae9c006b03e21af12d92d670af98beb4e">IsValid</a> () const </td></tr>
|
|
<tr class="memdesc:ae9c006b03e21af12d92d670af98beb4e"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the object has been initialized successfully. <br /></td></tr>
|
|
<tr class="separator:ae9c006b03e21af12d92d670af98beb4e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c27fc3f1b70ec4ab0b6f4fdc9d5f27b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1InitialClientData.html#a9c27fc3f1b70ec4ab0b6f4fdc9d5f27b">InitializeFromString</a> (const std::string &str)</td></tr>
|
|
<tr class="separator:a9c27fc3f1b70ec4ab0b6f4fdc9d5f27b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a714a64b7bb0d54232a042ce30d2541b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a714a64b7bb0d54232a042ce30d2541b0"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1InitialClientData.html#a714a64b7bb0d54232a042ce30d2541b0">StringRepresentation</a> () const </td></tr>
|
|
<tr class="memdesc:a714a64b7bb0d54232a042ce30d2541b0"><td class="mdescLeft"> </td><td class="mdescRight">Returns a string representation of the data of this object, suitable for passing on the command line. <br /></td></tr>
|
|
<tr class="separator:a714a64b7bb0d54232a042ce30d2541b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20aa3a5d96df7135bdf23196f9efb723"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20aa3a5d96df7135bdf23196f9efb723"></a>
|
|
HANDLE </td><td class="memItemRight" valign="bottom"><b>request_crash_dump</b> () const </td></tr>
|
|
<tr class="separator:a20aa3a5d96df7135bdf23196f9efb723"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c7ba7cf40e83e628ec79e311e5164e0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c7ba7cf40e83e628ec79e311e5164e0"></a>
|
|
HANDLE </td><td class="memItemRight" valign="bottom"><b>request_non_crash_dump</b> () const </td></tr>
|
|
<tr class="separator:a8c7ba7cf40e83e628ec79e311e5164e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e68490e12099a80d87de663dac39f2d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e68490e12099a80d87de663dac39f2d"></a>
|
|
HANDLE </td><td class="memItemRight" valign="bottom"><b>non_crash_dump_completed</b> () const </td></tr>
|
|
<tr class="separator:a8e68490e12099a80d87de663dac39f2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adaaad716f06bd535321c8ebb64c724a4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adaaad716f06bd535321c8ebb64c724a4"></a>
|
|
HANDLE </td><td class="memItemRight" valign="bottom"><b>first_pipe_instance</b> () const </td></tr>
|
|
<tr class="separator:adaaad716f06bd535321c8ebb64c724a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1838b6e2c086fe6b6f9ba06d7a6e5636"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1838b6e2c086fe6b6f9ba06d7a6e5636"></a>
|
|
HANDLE </td><td class="memItemRight" valign="bottom"><b>client_process</b> () const </td></tr>
|
|
<tr class="separator:a1838b6e2c086fe6b6f9ba06d7a6e5636"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0e7e28edda4238639b34c050178435a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0e7e28edda4238639b34c050178435a"></a>
|
|
<a class="el" href="namespacecrashpad.html#a368af6d88f68998b5c5eb80b8f6ebb76">WinVMAddress</a> </td><td class="memItemRight" valign="bottom"><b>crash_exception_information</b> () const </td></tr>
|
|
<tr class="separator:ae0e7e28edda4238639b34c050178435a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afabddc126c785e996deefd6677065c1b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afabddc126c785e996deefd6677065c1b"></a>
|
|
<a class="el" href="namespacecrashpad.html#a368af6d88f68998b5c5eb80b8f6ebb76">WinVMAddress</a> </td><td class="memItemRight" valign="bottom"><b>non_crash_exception_information</b> () const </td></tr>
|
|
<tr class="separator:afabddc126c785e996deefd6677065c1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd07200167bb65ae734a4d5de0ba092c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd07200167bb65ae734a4d5de0ba092c"></a>
|
|
<a class="el" href="namespacecrashpad.html#a368af6d88f68998b5c5eb80b8f6ebb76">WinVMAddress</a> </td><td class="memItemRight" valign="bottom"><b>debug_critical_section_address</b> () const </td></tr>
|
|
<tr class="separator:abd07200167bb65ae734a4d5de0ba092c"><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 container for the data associated with the <code>--initial-client-data</code> method for initializing the handler process on Windows. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="ade29b844a82ae4f712a4ba89099f9b6d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">crashpad::InitialClientData::InitialClientData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">HANDLE </td>
|
|
<td class="paramname"><em>request_crash_dump</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">HANDLE </td>
|
|
<td class="paramname"><em>request_non_crash_dump</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">HANDLE </td>
|
|
<td class="paramname"><em>non_crash_dump_completed</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">HANDLE </td>
|
|
<td class="paramname"><em>first_pipe_instance</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">HANDLE </td>
|
|
<td class="paramname"><em>client_process</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespacecrashpad.html#a368af6d88f68998b5c5eb80b8f6ebb76">WinVMAddress</a> </td>
|
|
<td class="paramname"><em>crash_exception_information</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespacecrashpad.html#a368af6d88f68998b5c5eb80b8f6ebb76">WinVMAddress</a> </td>
|
|
<td class="paramname"><em>non_crash_exception_information</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespacecrashpad.html#a368af6d88f68998b5c5eb80b8f6ebb76">WinVMAddress</a> </td>
|
|
<td class="paramname"><em>debug_critical_section_address</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs an instance of <a class="el" href="classcrashpad_1_1InitialClientData.html" title="A container for the data associated with the --initial-client-data method for initializing the handle...">InitialClientData</a>. This object does not take ownership of any of the referenced HANDLEs. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">request_crash_dump</td><td>An event signalled from the client on crash. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">request_non_crash_dump</td><td>An event signalled from the client when it would like a dump to be taken, but allowed to continue afterwards. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">non_crash_dump_completed</td><td>An event signalled from the handler to tell the client that the non-crash dump has completed, and it can continue execution. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">first_pipe_instance</td><td>The server end and first instance of a pipe that will be used for communication with all other clients after this initial one. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">client_process</td><td>A process handle for the client being registered. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">crash_exception_information</td><td>The address, in the client's address space, of an <a class="el" href="structcrashpad_1_1ExceptionInformation.html" title="Structure read out of the client process by the crash handler when an exception occurs. ">ExceptionInformation</a> structure, used when handling a crash dump request. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">non_crash_exception_information</td><td>The address, in the client's address space, of an <a class="el" href="structcrashpad_1_1ExceptionInformation.html" title="Structure read out of the client process by the crash handler when an exception occurs. ">ExceptionInformation</a> structure, used when handling a non-crashing dump request. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">debug_critical_section_address</td><td>The address, in the client process's address space, of a <code>CRITICAL_SECTION</code> allocated with a valid .DebugInfo field. This can be accomplished by using <a class="el" href="namespacecrashpad.html#af8340c24a2983e788d2a3ba90d1d4846" title="Equivalent to InitializeCritialSection(), but attempts to allocate with a valid .DebugInfo field on v...">InitializeCriticalSectionWithDebugInfoIfPossible()</a> or equivalent. This value can be <code>0</code>, however then limited lock data will be available in minidumps. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a9c27fc3f1b70ec4ab0b6f4fdc9d5f27b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool crashpad::InitialClientData::InitializeFromString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>str</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Initializes this object from a string representation presumed to have been created by <a class="el" href="classcrashpad_1_1InitialClientData.html#a714a64b7bb0d54232a042ce30d2541b0" title="Returns a string representation of the data of this object, suitable for passing on the command line...">StringRepresentation()</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>The output of <a class="el" href="classcrashpad_1_1InitialClientData.html#a714a64b7bb0d54232a042ce30d2541b0" title="Returns a string representation of the data of this object, suitable for passing on the command line...">StringRepresentation()</a>.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success, or <code>false</code> with a message logged on failure. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>util/win/initial_client_data.h</li>
|
|
<li>util/win/initial_client_data.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.10
|
|
</small></address>
|
|
</body>
|
|
</html>
|