<!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::ExceptionHandlerClient 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&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_1ExceptionHandlerClient.html">ExceptionHandlerClient</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classcrashpad_1_1ExceptionHandlerClient-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::ExceptionHandlerClient Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A client for an <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html" title="Runs the main exception-handling server in Crashpad's handler process. ">ExceptionHandlerServer</a>.
<a href="classcrashpad_1_1ExceptionHandlerClient.html#details">More...</a></p>
<p><code>#include "util/linux/exception_handler_client.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:a9d477e6782fadd27067597da3090b2e5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerClient.html#a9d477e6782fadd27067597da3090b2e5">ExceptionHandlerClient</a> (int sock)</td></tr>
<tr class="memdesc:a9d477e6782fadd27067597da3090b2e5"><td class="mdescLeft"> </td><td class="mdescRight">Constructs this object. <a href="#a9d477e6782fadd27067597da3090b2e5">More...</a><br /></td></tr>
<tr class="separator:a9d477e6782fadd27067597da3090b2e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a730285469aed355cc044fdc86b289ca3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerClient.html#a730285469aed355cc044fdc86b289ca3">RequestCrashDump</a> (const <a class="el" href="structcrashpad_1_1ClientInformation.html">ClientInformation</a> &info)</td></tr>
<tr class="memdesc:a730285469aed355cc044fdc86b289ca3"><td class="mdescLeft"> </td><td class="mdescRight">Request a crash dump from the <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html" title="Runs the main exception-handling server in Crashpad's handler process. ">ExceptionHandlerServer</a>. <a href="#a730285469aed355cc044fdc86b289ca3">More...</a><br /></td></tr>
<tr class="separator:a730285469aed355cc044fdc86b289ca3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d2707386968a54508c5641b676f016d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerClient.html#a6d2707386968a54508c5641b676f016d">SetPtracer</a> (pid_t pid)</td></tr>
<tr class="memdesc:a6d2707386968a54508c5641b676f016d"><td class="mdescLeft"> </td><td class="mdescRight">Uses <code>prctl(PR_SET_PTRACER, ...)</code> to set the process with process ID <em>pid</em> as the ptracer for this process. <a href="#a6d2707386968a54508c5641b676f016d">More...</a><br /></td></tr>
<tr class="separator:a6d2707386968a54508c5641b676f016d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae3be7dd029743ef4e469a905f6241bea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerClient.html#ae3be7dd029743ef4e469a905f6241bea">SetCanSetPtracer</a> (bool can_set_ptracer)</td></tr>
<tr class="memdesc:ae3be7dd029743ef4e469a905f6241bea"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables <a class="el" href="classcrashpad_1_1ExceptionHandlerClient.html#a6d2707386968a54508c5641b676f016d" title="Uses prctl(PR_SET_PTRACER, ...) to set the process with process ID pid as the ptracer for this proces...">SetPtracer()</a>. <a href="#ae3be7dd029743ef4e469a905f6241bea">More...</a><br /></td></tr>
<tr class="separator:ae3be7dd029743ef4e469a905f6241bea"><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 client for an <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html" title="Runs the main exception-handling server in Crashpad's handler process. ">ExceptionHandlerServer</a>. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a9d477e6782fadd27067597da3090b2e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d477e6782fadd27067597da3090b2e5">◆ </a></span>ExceptionHandlerClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">crashpad::ExceptionHandlerClient::ExceptionHandlerClient </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>sock</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs this object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sock</td><td>A socket connected to an <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html" title="Runs the main exception-handling server in Crashpad's handler process. ">ExceptionHandlerServer</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a730285469aed355cc044fdc86b289ca3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a730285469aed355cc044fdc86b289ca3">◆ </a></span>RequestCrashDump()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int crashpad::ExceptionHandlerClient::RequestCrashDump </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structcrashpad_1_1ClientInformation.html">ClientInformation</a> & </td>
<td class="paramname"><em>info</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Request a crash dump from the <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html" title="Runs the main exception-handling server in Crashpad's handler process. ">ExceptionHandlerServer</a>. </p>
<p>This method blocks until the crash dump is complete.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">info</td><td>Information about this client. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure. </dd></dl>
</div>
</div>
<a id="ae3be7dd029743ef4e469a905f6241bea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3be7dd029743ef4e469a905f6241bea">◆ </a></span>SetCanSetPtracer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void crashpad::ExceptionHandlerClient::SetCanSetPtracer </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>can_set_ptracer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables or disables <a class="el" href="classcrashpad_1_1ExceptionHandlerClient.html#a6d2707386968a54508c5641b676f016d" title="Uses prctl(PR_SET_PTRACER, ...) to set the process with process ID pid as the ptracer for this proces...">SetPtracer()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">can_set_ptracer</td><td>Whether SetPtracer should be enabled. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6d2707386968a54508c5641b676f016d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d2707386968a54508c5641b676f016d">◆ </a></span>SetPtracer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int crashpad::ExceptionHandlerClient::SetPtracer </td>
<td>(</td>
<td class="paramtype">pid_t </td>
<td class="paramname"><em>pid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Uses <code>prctl(PR_SET_PTRACER, ...)</code> to set the process with process ID <em>pid</em> as the ptracer for this process. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pid</td><td>The process ID of the process to be set as this process' ptracer. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success or an error code on failure. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>util/linux/exception_handler_client.h</li>
<li>util/linux/exception_handler_client.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.14
</small></address>
</body>
</html>