| <!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::ExceptionHandlerServer 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_1ExceptionHandlerServer.html">ExceptionHandlerServer</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="classcrashpad_1_1ExceptionHandlerServer-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">crashpad::ExceptionHandlerServer Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Runs the main exception-handling server in Crashpad’s handler process. |
| <a href="classcrashpad_1_1ExceptionHandlerServer.html#details">More...</a></p> |
| |
| <p><code>#include "util/win/exception_handler_server.h"</code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer_1_1Delegate.html">Delegate</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><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:afe3a905c640eac71a6ec23f872a26fa7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#afe3a905c640eac71a6ec23f872a26fa7">SetPtraceStrategyDecider</a> (std::unique_ptr< <a class="el" href="classcrashpad_1_1PtraceStrategyDecider.html">PtraceStrategyDecider</a> > decider)</td></tr> |
| <tr class="memdesc:afe3a905c640eac71a6ec23f872a26fa7"><td class="mdescLeft"> </td><td class="mdescRight">Sets the handler's <a class="el" href="classcrashpad_1_1PtraceStrategyDecider.html" title="Abstract base class for deciding how the handler should ptrace a client.">PtraceStrategyDecider</a>. <a href="classcrashpad_1_1ExceptionHandlerServer.html#afe3a905c640eac71a6ec23f872a26fa7">More...</a><br /></td></tr> |
| <tr class="separator:afe3a905c640eac71a6ec23f872a26fa7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6ca205943a9cd12ae22389bcbae17ae8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a6ca205943a9cd12ae22389bcbae17ae8">InitializeWithClient</a> (<a class="el" href="namespacecrashpad.html#a9daa1b956487883acd9f43d13cc77339">ScopedFileHandle</a> sock, bool multiple_clients)</td></tr> |
| <tr class="memdesc:a6ca205943a9cd12ae22389bcbae17ae8"><td class="mdescLeft"> </td><td class="mdescRight">Initializes this object. <a href="classcrashpad_1_1ExceptionHandlerServer.html#a6ca205943a9cd12ae22389bcbae17ae8">More...</a><br /></td></tr> |
| <tr class="separator:a6ca205943a9cd12ae22389bcbae17ae8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8ddcf9cff0364e46378ef575ded9a773"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773">Run</a> (<a class="el" href="classcrashpad_1_1ExceptionHandlerServer_1_1Delegate.html">Delegate</a> *delegate)</td></tr> |
| <tr class="memdesc:a8ddcf9cff0364e46378ef575ded9a773"><td class="mdescLeft"> </td><td class="mdescRight">Runs the exception-handling server. <a href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773">More...</a><br /></td></tr> |
| <tr class="separator:a8ddcf9cff0364e46378ef575ded9a773"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a75dd814798b8f8224f53d84cea8368be"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be">Stop</a> ()</td></tr> |
| <tr class="memdesc:a75dd814798b8f8224f53d84cea8368be"><td class="mdescLeft"> </td><td class="mdescRight">Stops a running exception-handling server. <a href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be">More...</a><br /></td></tr> |
| <tr class="separator:a75dd814798b8f8224f53d84cea8368be"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a98dba7a5b210d88d5133cae5a615086d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a98dba7a5b210d88d5133cae5a615086d">ExceptionHandlerServer</a> (base::mac::ScopedMachReceiveRight receive_port, bool launchd)</td></tr> |
| <tr class="memdesc:a98dba7a5b210d88d5133cae5a615086d"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html" title="Runs the main exception-handling server in Crashpad’s handler process.">ExceptionHandlerServer</a> object. <a href="classcrashpad_1_1ExceptionHandlerServer.html#a98dba7a5b210d88d5133cae5a615086d">More...</a><br /></td></tr> |
| <tr class="separator:a98dba7a5b210d88d5133cae5a615086d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a348789edd93bcd388ddd38c77230583d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a348789edd93bcd388ddd38c77230583d">Run</a> (<a class="el" href="classcrashpad_1_1UniversalMachExcServer_1_1Interface.html">UniversalMachExcServer::Interface</a> *exception_interface)</td></tr> |
| <tr class="memdesc:a348789edd93bcd388ddd38c77230583d"><td class="mdescLeft"> </td><td class="mdescRight">Runs the exception-handling server. <a href="classcrashpad_1_1ExceptionHandlerServer.html#a348789edd93bcd388ddd38c77230583d">More...</a><br /></td></tr> |
| <tr class="separator:a348789edd93bcd388ddd38c77230583d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a75dd814798b8f8224f53d84cea8368be"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be">Stop</a> ()</td></tr> |
| <tr class="memdesc:a75dd814798b8f8224f53d84cea8368be"><td class="mdescLeft"> </td><td class="mdescRight">Stops a running exception-handling server. <a href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be">More...</a><br /></td></tr> |
| <tr class="separator:a75dd814798b8f8224f53d84cea8368be"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6493334c96948606db2553cbbc5a2877"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a6493334c96948606db2553cbbc5a2877">ExceptionHandlerServer</a> (bool persistent)</td></tr> |
| <tr class="memdesc:a6493334c96948606db2553cbbc5a2877"><td class="mdescLeft"> </td><td class="mdescRight">Constructs the exception handling server. <a href="classcrashpad_1_1ExceptionHandlerServer.html#a6493334c96948606db2553cbbc5a2877">More...</a><br /></td></tr> |
| <tr class="separator:a6493334c96948606db2553cbbc5a2877"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab7a18e94b43bbe192e37a28638e25a51"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#ab7a18e94b43bbe192e37a28638e25a51">SetPipeName</a> (const std::wstring &pipe_name)</td></tr> |
| <tr class="memdesc:ab7a18e94b43bbe192e37a28638e25a51"><td class="mdescLeft"> </td><td class="mdescRight">Sets the pipe name to listen for client registrations on. <a href="classcrashpad_1_1ExceptionHandlerServer.html#ab7a18e94b43bbe192e37a28638e25a51">More...</a><br /></td></tr> |
| <tr class="separator:ab7a18e94b43bbe192e37a28638e25a51"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3093cf1cbe8a36428c6333841c0c7e86"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a3093cf1cbe8a36428c6333841c0c7e86">InitializeWithInheritedDataForInitialClient</a> (const <a class="el" href="classcrashpad_1_1InitialClientData.html">InitialClientData</a> &initial_client_data, <a class="el" href="classcrashpad_1_1ExceptionHandlerServer_1_1Delegate.html">Delegate</a> *delegate)</td></tr> |
| <tr class="memdesc:a3093cf1cbe8a36428c6333841c0c7e86"><td class="mdescLeft"> </td><td class="mdescRight">Sets the pipe to listen for client registrations on, providing the first precreated instance. <a href="classcrashpad_1_1ExceptionHandlerServer.html#a3093cf1cbe8a36428c6333841c0c7e86">More...</a><br /></td></tr> |
| <tr class="separator:a3093cf1cbe8a36428c6333841c0c7e86"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8ddcf9cff0364e46378ef575ded9a773"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773">Run</a> (<a class="el" href="classcrashpad_1_1ExceptionHandlerServer_1_1Delegate.html">Delegate</a> *delegate)</td></tr> |
| <tr class="memdesc:a8ddcf9cff0364e46378ef575ded9a773"><td class="mdescLeft"> </td><td class="mdescRight">Runs the exception-handling server. <a href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773">More...</a><br /></td></tr> |
| <tr class="separator:a8ddcf9cff0364e46378ef575ded9a773"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a75dd814798b8f8224f53d84cea8368be"><td class="memItemLeft" align="right" valign="top"><a id="a75dd814798b8f8224f53d84cea8368be"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be">Stop</a> ()</td></tr> |
| <tr class="memdesc:a75dd814798b8f8224f53d84cea8368be"><td class="mdescLeft"> </td><td class="mdescRight">Stops the exception-handling server. Returns immediately. The object must not be destroyed until <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a> returns. <br /></td></tr> |
| <tr class="separator:a75dd814798b8f8224f53d84cea8368be"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:aa0182e8bb9a9931d96acf84f93eb81cd"><td class="memItemLeft" align="right" valign="top"><a id="aa0182e8bb9a9931d96acf84f93eb81cd"></a> |
| static const size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#aa0182e8bb9a9931d96acf84f93eb81cd">kPipeInstances</a> = 2</td></tr> |
| <tr class="memdesc:aa0182e8bb9a9931d96acf84f93eb81cd"><td class="mdescLeft"> </td><td class="mdescRight">The number of server-side pipe instances that the exception handler server creates to listen for connections from clients. <br /></td></tr> |
| <tr class="separator:aa0182e8bb9a9931d96acf84f93eb81cd"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Runs the main exception-handling server in Crashpad’s handler process. </p> |
| <p>Runs the main exception-handling server in Crashpad's handler process. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a98dba7a5b210d88d5133cae5a615086d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a98dba7a5b210d88d5133cae5a615086d">◆ </a></span>ExceptionHandlerServer() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">crashpad::ExceptionHandlerServer::ExceptionHandlerServer </td> |
| <td>(</td> |
| <td class="paramtype">base::mac::ScopedMachReceiveRight </td> |
| <td class="paramname"><em>receive_port</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>launchd</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructs an <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html" title="Runs the main exception-handling server in Crashpad’s handler process.">ExceptionHandlerServer</a> object. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">receive_port</td><td>The port that exception messages and no-senders notifications will be received on. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">launchd</td><td>If <code>true</code>, the exception handler is being run from launchd. <em>receive_port</em> is not monitored for no-senders notifications, and instead, <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be" title="Stops a running exception-handling server.">Stop()</a> must be called to provide a “quit” signal. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a6493334c96948606db2553cbbc5a2877"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6493334c96948606db2553cbbc5a2877">◆ </a></span>ExceptionHandlerServer() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">crashpad::ExceptionHandlerServer::ExceptionHandlerServer </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>persistent</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 the exception handling server. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">persistent</td><td><code>true</code> if <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a> should not return until <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be" title="Stops a running exception-handling server.">Stop()</a> is called. If <code>false</code>, <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a> will return when all clients have exited, although <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a> will always wait for the first client to connect. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a6ca205943a9cd12ae22389bcbae17ae8"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6ca205943a9cd12ae22389bcbae17ae8">◆ </a></span>InitializeWithClient()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool crashpad::ExceptionHandlerServer::InitializeWithClient </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="namespacecrashpad.html#a9daa1b956487883acd9f43d13cc77339">ScopedFileHandle</a> </td> |
| <td class="paramname"><em>sock</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>multiple_clients</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes this object. </p> |
| <p>This method must be successfully called before <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a>.</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 on which to receive client requests. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">multiple_clients</td><td><code>true</code> if this socket is used by multiple clients. Using a broker process is not supported in this configuration. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. <code>false</code> on failure with a message logged. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a3093cf1cbe8a36428c6333841c0c7e86"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3093cf1cbe8a36428c6333841c0c7e86">◆ </a></span>InitializeWithInheritedDataForInitialClient()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void crashpad::ExceptionHandlerServer::InitializeWithInheritedDataForInitialClient </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classcrashpad_1_1InitialClientData.html">InitialClientData</a> & </td> |
| <td class="paramname"><em>initial_client_data</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer_1_1Delegate.html">Delegate</a> * </td> |
| <td class="paramname"><em>delegate</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the pipe to listen for client registrations on, providing the first precreated instance. </p> |
| <p>This method, or <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#ab7a18e94b43bbe192e37a28638e25a51" title="Sets the pipe name to listen for client registrations on.">SetPipeName()</a>, must be called before <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a>. All of these parameters are generally created in a parent process that launches the handler. For more details see the Windows implementation of <a class="el" href="classcrashpad_1_1CrashpadClient.html" title="The primary interface for an application to have Crashpad monitor it for crashes.">CrashpadClient</a>.</p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="classcrashpad_1_1CrashpadClient.html" title="The primary interface for an application to have Crashpad monitor it for crashes.">CrashpadClient</a> </dd> |
| <dd> |
| <a class="el" href="structcrashpad_1_1RegistrationRequest.html" title="A client registration request.">RegistrationRequest</a></dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">initial_client_data</td><td>The handles and addresses of data inherited from a parent process needed to initialize and register the first client. Ownership of these handles is taken. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">delegate</td><td>The interface to which the exceptions are delegated when they are caught in <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a>. Ownership is not transferred. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a8ddcf9cff0364e46378ef575ded9a773"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8ddcf9cff0364e46378ef575ded9a773">◆ </a></span>Run() <span class="overload">[1/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void crashpad::ExceptionHandlerServer::Run </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer_1_1Delegate.html">Delegate</a> * </td> |
| <td class="paramname"><em>delegate</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Runs the exception-handling server. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">delegate</td><td>The interface to which the exceptions are delegated when they are caught in <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a>. Ownership is not transferred. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a8ddcf9cff0364e46378ef575ded9a773"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8ddcf9cff0364e46378ef575ded9a773">◆ </a></span>Run() <span class="overload">[2/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void crashpad::ExceptionHandlerServer::Run </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classcrashpad_1_1ExceptionHandlerServer_1_1Delegate.html">Delegate</a> * </td> |
| <td class="paramname"><em>delegate</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Runs the exception-handling server. </p> |
| <p>This method must only be called once on an <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html" title="Runs the main exception-handling server in Crashpad’s handler process.">ExceptionHandlerServer</a> object. This method returns when there are no more client connections or <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be" title="Stops a running exception-handling server.">Stop()</a> has been called.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">delegate</td><td>An object to send exceptions to. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a348789edd93bcd388ddd38c77230583d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a348789edd93bcd388ddd38c77230583d">◆ </a></span>Run() <span class="overload">[3/3]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void crashpad::ExceptionHandlerServer::Run </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classcrashpad_1_1UniversalMachExcServer_1_1Interface.html">UniversalMachExcServer::Interface</a> * </td> |
| <td class="paramname"><em>exception_interface</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Runs the exception-handling server. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">exception_interface</td><td>An object to send exception messages to.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>This method monitors the receive port for exception messages and, if not being run by launchd, no-senders notifications. It continues running until it has no more clients, indicated by the receipt of a no-senders notification, or until <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be" title="Stops a running exception-handling server.">Stop()</a> is called. When not being run by launchd, it is important to assure that a send right exists in a client (or has been queued by <code>mach_msg()</code> to be sent to a client) prior to calling this method, or it will detect that it is sender-less and return immediately.</p> |
| <p>All exception messages will be passed to <em>exception_interface</em>.</p> |
| <p>This method must only be called once on an <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html" title="Runs the main exception-handling server in Crashpad’s handler process.">ExceptionHandlerServer</a> object.</p> |
| <p>If an unexpected condition that prevents this method from functioning is encountered, it will log a message and terminate execution. Receipt of an invalid message on the receive port will cause a message to be logged, but this method will continue running normally. </p> |
| |
| </div> |
| </div> |
| <a id="ab7a18e94b43bbe192e37a28638e25a51"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab7a18e94b43bbe192e37a28638e25a51">◆ </a></span>SetPipeName()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void crashpad::ExceptionHandlerServer::SetPipeName </td> |
| <td>(</td> |
| <td class="paramtype">const std::wstring & </td> |
| <td class="paramname"><em>pipe_name</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the pipe name to listen for client registrations on. </p> |
| <p>This method, or <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a3093cf1cbe8a36428c6333841c0c7e86" title="Sets the pipe to listen for client registrations on, providing the first precreated instance.">InitializeWithInheritedDataForInitialClient()</a>, must be called before <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">pipe_name</td><td>The name of the pipe to listen on. Must be of the form "\\.\pipe\<some_name>". </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="afe3a905c640eac71a6ec23f872a26fa7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#afe3a905c640eac71a6ec23f872a26fa7">◆ </a></span>SetPtraceStrategyDecider()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void crashpad::ExceptionHandlerServer::SetPtraceStrategyDecider </td> |
| <td>(</td> |
| <td class="paramtype">std::unique_ptr< <a class="el" href="classcrashpad_1_1PtraceStrategyDecider.html">PtraceStrategyDecider</a> > </td> |
| <td class="paramname"><em>decider</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Sets the handler's <a class="el" href="classcrashpad_1_1PtraceStrategyDecider.html" title="Abstract base class for deciding how the handler should ptrace a client.">PtraceStrategyDecider</a>. </p> |
| <p>If this method is not called, a default <a class="el" href="classcrashpad_1_1PtraceStrategyDecider.html" title="Abstract base class for deciding how the handler should ptrace a client.">PtraceStrategyDecider</a> will be used. </p> |
| |
| </div> |
| </div> |
| <a id="a75dd814798b8f8224f53d84cea8368be"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a75dd814798b8f8224f53d84cea8368be">◆ </a></span>Stop() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void crashpad::ExceptionHandlerServer::Stop </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Stops a running exception-handling server. </p> |
| <p><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be" title="Stops a running exception-handling server.">Stop()</a> may be called at any time, and may be called from a signal handler. If <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be" title="Stops a running exception-handling server.">Stop()</a> is called before <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a> it will cause <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a> to return as soon as it is called. It is harmless to call <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be" title="Stops a running exception-handling server.">Stop()</a> after <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a> has already returned, or to call <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be" title="Stops a running exception-handling server.">Stop()</a> after it has already been called. </p> |
| |
| </div> |
| </div> |
| <a id="a75dd814798b8f8224f53d84cea8368be"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a75dd814798b8f8224f53d84cea8368be">◆ </a></span>Stop() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void crashpad::ExceptionHandlerServer::Stop </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Stops a running exception-handling server. </p> |
| <p><a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be" title="Stops a running exception-handling server.">Stop()</a> may be called at any time, and may be called from a signal handler. If <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be" title="Stops a running exception-handling server.">Stop()</a> is called before <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a> it will cause <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a> to return as soon as it is called. It is harmless to call <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be" title="Stops a running exception-handling server.">Stop()</a> after <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a8ddcf9cff0364e46378ef575ded9a773" title="Runs the exception-handling server.">Run()</a> has already returned, or to call <a class="el" href="classcrashpad_1_1ExceptionHandlerServer.html#a75dd814798b8f8224f53d84cea8368be" title="Stops a running exception-handling server.">Stop()</a> after it has already been called. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>handler/linux/exception_handler_server.h</li> |
| <li>handler/linux/exception_handler_server.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.18 |
| </small></address> |
| </body> |
| </html> |
