Google Git
Sign in
fuchsia / third_party / crashpad / 6b3d4ea6eabeb046bb6aeae27dcd42557c46a581 / . / doc / generated / doxygen / classcrashpad_1_1InitialClientData.html
blob: a2a4bbaf2af07ea498bb202206a9f6ba498d5c9c [file] [log] [blame]
<!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::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>
<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="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> &#124;
<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 &quot;util/win/initial_client_data.h&quot;</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 id="a80131e5552fc537b18fe019d47e32fb6"></a>
&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:ade29b844a82ae4f712a4ba89099f9b6d"><td class="memItemLeft" align="right" valign="top">&#160;</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">&#160;</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">&#160;</td></tr>
<tr class="memitem:a0dae406f4503330a5c74c713873da20f"><td class="memItemLeft" align="right" valign="top"><a id="a0dae406f4503330a5c74c713873da20f"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1InitialClientData.html#a0dae406f4503330a5c74c713873da20f">IsValid</a> () const</td></tr>
<tr class="memdesc:a0dae406f4503330a5c74c713873da20f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the object has been initialized successfully. <br /></td></tr>
<tr class="separator:a0dae406f4503330a5c74c713873da20f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c27fc3f1b70ec4ab0b6f4fdc9d5f27b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1InitialClientData.html#a9c27fc3f1b70ec4ab0b6f4fdc9d5f27b">InitializeFromString</a> (const std::string &amp;str)</td></tr>
<tr class="separator:a9c27fc3f1b70ec4ab0b6f4fdc9d5f27b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad945c7d48f44d3baad4133f070c3805f"><td class="memItemLeft" align="right" valign="top"><a id="ad945c7d48f44d3baad4133f070c3805f"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1InitialClientData.html#ad945c7d48f44d3baad4133f070c3805f">StringRepresentation</a> () const</td></tr>
<tr class="memdesc:ad945c7d48f44d3baad4133f070c3805f"><td class="mdescLeft">&#160;</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:ad945c7d48f44d3baad4133f070c3805f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8243f3d6b4a466bec0f14720bc9e4b50"><td class="memItemLeft" align="right" valign="top"><a id="a8243f3d6b4a466bec0f14720bc9e4b50"></a>
HANDLE&#160;</td><td class="memItemRight" valign="bottom"><b>request_crash_dump</b> () const</td></tr>
<tr class="separator:a8243f3d6b4a466bec0f14720bc9e4b50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac6a8d2ae79e61f52c14bb73f73081aa"><td class="memItemLeft" align="right" valign="top"><a id="aac6a8d2ae79e61f52c14bb73f73081aa"></a>
HANDLE&#160;</td><td class="memItemRight" valign="bottom"><b>request_non_crash_dump</b> () const</td></tr>
<tr class="separator:aac6a8d2ae79e61f52c14bb73f73081aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3716b1697de2ba624f6b2ca8e868bd5c"><td class="memItemLeft" align="right" valign="top"><a id="a3716b1697de2ba624f6b2ca8e868bd5c"></a>
HANDLE&#160;</td><td class="memItemRight" valign="bottom"><b>non_crash_dump_completed</b> () const</td></tr>
<tr class="separator:a3716b1697de2ba624f6b2ca8e868bd5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af955ae43b57736c4d7108166922e2648"><td class="memItemLeft" align="right" valign="top"><a id="af955ae43b57736c4d7108166922e2648"></a>
HANDLE&#160;</td><td class="memItemRight" valign="bottom"><b>first_pipe_instance</b> () const</td></tr>
<tr class="separator:af955ae43b57736c4d7108166922e2648"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ab0ba990a075cb68adc655e7dd24d30"><td class="memItemLeft" align="right" valign="top"><a id="a9ab0ba990a075cb68adc655e7dd24d30"></a>
HANDLE&#160;</td><td class="memItemRight" valign="bottom"><b>client_process</b> () const</td></tr>
<tr class="separator:a9ab0ba990a075cb68adc655e7dd24d30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca6c7599b091c34cc0f6e4a38eae9fd6"><td class="memItemLeft" align="right" valign="top"><a id="aca6c7599b091c34cc0f6e4a38eae9fd6"></a>
<a class="el" href="namespacecrashpad.html#a368af6d88f68998b5c5eb80b8f6ebb76">WinVMAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><b>crash_exception_information</b> () const</td></tr>
<tr class="separator:aca6c7599b091c34cc0f6e4a38eae9fd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55b6db5f1e850e4e28285af42d31a2c7"><td class="memItemLeft" align="right" valign="top"><a id="a55b6db5f1e850e4e28285af42d31a2c7"></a>
<a class="el" href="namespacecrashpad.html#a368af6d88f68998b5c5eb80b8f6ebb76">WinVMAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><b>non_crash_exception_information</b> () const</td></tr>
<tr class="separator:a55b6db5f1e850e4e28285af42d31a2c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a5448ea3368c466e1d34c784d3f12f6"><td class="memItemLeft" align="right" valign="top"><a id="a2a5448ea3368c466e1d34c784d3f12f6"></a>
<a class="el" href="namespacecrashpad.html#a368af6d88f68998b5c5eb80b8f6ebb76">WinVMAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><b>debug_critical_section_address</b> () const</td></tr>
<tr class="separator:a2a5448ea3368c466e1d34c784d3f12f6"><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>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 &amp; Destructor Documentation</h2>
<a id="ade29b844a82ae4f712a4ba89099f9b6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade29b844a82ae4f712a4ba89099f9b6d">&#9670;&nbsp;</a></span>InitialClientData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">crashpad::InitialClientData::InitialClientData </td>
<td>(</td>
<td class="paramtype">HANDLE&#160;</td>
<td class="paramname"><em>request_crash_dump</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">HANDLE&#160;</td>
<td class="paramname"><em>request_non_crash_dump</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">HANDLE&#160;</td>
<td class="paramname"><em>non_crash_dump_completed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">HANDLE&#160;</td>
<td class="paramname"><em>first_pipe_instance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">HANDLE&#160;</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>&#160;</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>&#160;</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>&#160;</td>
<td class="paramname"><em>debug_critical_section_address</em>&#160;</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 id="a9c27fc3f1b70ec4ab0b6f4fdc9d5f27b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c27fc3f1b70ec4ab0b6f4fdc9d5f27b">&#9670;&nbsp;</a></span>InitializeFromString()</h2>
<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 &amp;&#160;</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#ad945c7d48f44d3baad4133f070c3805f" 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#ad945c7d48f44d3baad4133f070c3805f" 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 &#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>