| <!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::NotifyServer 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_1NotifyServer.html">NotifyServer</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="classcrashpad_1_1NotifyServer-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">crashpad::NotifyServer Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A server interface for the <code>notify</code> Mach subsystem. |
| <a href="classcrashpad_1_1NotifyServer.html#details">More...</a></p> |
| |
| <p><code>#include "util/mach/notify_server.h"</code></p> |
| <div class="dynheader"> |
| Inheritance diagram for crashpad::NotifyServer:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classcrashpad_1_1NotifyServer.png" usemap="#crashpad::NotifyServer_map" alt=""/> |
| <map id="crashpad::NotifyServer_map" name="crashpad::NotifyServer_map"> |
| <area href="classcrashpad_1_1MachMessageServer_1_1Interface.html" title="A Mach RPC callback interface, called by Run()." alt="crashpad::MachMessageServer::Interface" shape="rect" coords="0,0,249,24"/> |
| </map> |
| </div></div> |
| <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_1NotifyServer_1_1DefaultInterface.html">DefaultInterface</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A concrete implementation of <a class="el" href="classcrashpad_1_1NotifyServer_1_1Interface.html" title="An interface that the different request messages that are a part of the notify Mach subsystem can be ...">Interface</a> that provides a default behavior for all <code>notify</code> routines. <a href="classcrashpad_1_1NotifyServer_1_1DefaultInterface.html#details">More...</a><br /></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </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_1NotifyServer_1_1Interface.html">Interface</a></td></tr> |
| <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An interface that the different request messages that are a part of the <code>notify</code> Mach subsystem can be dispatched to. <a href="classcrashpad_1_1NotifyServer_1_1Interface.html#details">More...</a><br /></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:aa0c2780f12f549e8b7d6c4b9177bca40"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1NotifyServer.html#aa0c2780f12f549e8b7d6c4b9177bca40">NotifyServer</a> (<a class="el" href="classcrashpad_1_1NotifyServer_1_1Interface.html">Interface</a> *interface)</td></tr> |
| <tr class="memdesc:aa0c2780f12f549e8b7d6c4b9177bca40"><td class="mdescLeft"> </td><td class="mdescRight">Constructs an object of this class. <a href="classcrashpad_1_1NotifyServer.html#aa0c2780f12f549e8b7d6c4b9177bca40">More...</a><br /></td></tr> |
| <tr class="separator:aa0c2780f12f549e8b7d6c4b9177bca40"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a96630849312a63d91f0d94a5618803a3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1NotifyServer.html#a96630849312a63d91f0d94a5618803a3">MachMessageServerFunction</a> (const mach_msg_header_t *in_header, mach_msg_header_t *out_header, bool *destroy_complex_request) override</td></tr> |
| <tr class="memdesc:a96630849312a63d91f0d94a5618803a3"><td class="mdescLeft"> </td><td class="mdescRight">Handles a Mach RPC request. <a href="classcrashpad_1_1NotifyServer.html#a96630849312a63d91f0d94a5618803a3">More...</a><br /></td></tr> |
| <tr class="separator:a96630849312a63d91f0d94a5618803a3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aedce681312094a8ed81f5275d2f70070"><td class="memItemLeft" align="right" valign="top">std::set< mach_msg_id_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1NotifyServer.html#aedce681312094a8ed81f5275d2f70070">MachMessageServerRequestIDs</a> () override</td></tr> |
| <tr class="separator:aedce681312094a8ed81f5275d2f70070"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4a08edc6b102a6c36cad7f5f38290540"><td class="memItemLeft" align="right" valign="top">mach_msg_size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1NotifyServer.html#a4a08edc6b102a6c36cad7f5f38290540">MachMessageServerRequestSize</a> () override</td></tr> |
| <tr class="separator:a4a08edc6b102a6c36cad7f5f38290540"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af824bc4888e15ed26769d0ff8571fc38"><td class="memItemLeft" align="right" valign="top">mach_msg_size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1NotifyServer.html#af824bc4888e15ed26769d0ff8571fc38">MachMessageServerReplySize</a> () override</td></tr> |
| <tr class="separator:af824bc4888e15ed26769d0ff8571fc38"><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 server interface for the <code>notify</code> Mach subsystem. </p> |
| <p>The <a href="https://lists.apple.com/archives/darwin-development/2001/Sep/msg00451.html">mach port notifications</a> thread on the <a href="https://lists.apple.com/archives/darwin-development/">darwin-development</a> mailing list (now known as <a href="https://lists.apple.com/mailman/listinfo/darwin-dev">darwin-dev</a>) is good background for the various notification types. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="aa0c2780f12f549e8b7d6c4b9177bca40"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa0c2780f12f549e8b7d6c4b9177bca40">◆ </a></span>NotifyServer()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">crashpad::NotifyServer::NotifyServer </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classcrashpad_1_1NotifyServer_1_1Interface.html">NotifyServer::Interface</a> * </td> |
| <td class="paramname"><em>interface</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 an object of this class. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">interface</td><td>The interface to dispatch requests to. Weak. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a96630849312a63d91f0d94a5618803a3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a96630849312a63d91f0d94a5618803a3">◆ </a></span>MachMessageServerFunction()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool crashpad::NotifyServer::MachMessageServerFunction </td> |
| <td>(</td> |
| <td class="paramtype">const mach_msg_header_t * </td> |
| <td class="paramname"><em>in</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">mach_msg_header_t * </td> |
| <td class="paramname"><em>out</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool * </td> |
| <td class="paramname"><em>destroy_complex_request</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Handles a Mach RPC request. </p> |
| <p>This method is a stand-in for a MIG-generated Mach RPC server “demux” function such as <code>exc_server()</code> and <code>mach_exc_server()</code>. Implementations may call such a function directly. This method is expected to behave exactly as these functions behave.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[in]</td><td class="paramname">in</td><td>The request message, received as a Mach message. Note that this interface uses a <code>const</code> parameter for this purpose, whereas MIG-generated “demux” functions do not. </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>The reply message. The caller allocates storage, and the callee is expected to populate the reply message appropriately. After returning, the caller will send this reply as a Mach message via the message’s reply port. </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">destroy_complex_request</td><td><code>true</code> if a complex request message is to be destroyed even when handled successfully, <code>false</code> otherwise. The traditional behavior is <code>false</code>. In this case, the caller only destroys the request message in <em>in</em> when the reply message in <em>out</em> is not complex and when it indicates a return code other than <code>KERN_SUCCESS</code> or <code>MIG_NO_REPLY</code>. The assumption is that the rights or out-of-line data carried in a complex message may be retained by the server in this situation, and that it is the responsibility of the server to release these resources as needed. However, in many cases, these resources are not needed beyond the duration of a request-reply transaction, and in such cases, it is less error-prone to always have the caller, <a class="el" href="classcrashpad_1_1MachMessageServer.html#ace981f2e495984f119aa074f7d33bff6" title="Runs a Mach message server to handle a Mach RPC request for MIG servers.">MachMessageServer::Run()</a>, destroy complex request messages. To choose this behavior, this parameter should be set to <code>true</code>.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd><code>true</code> on success and <code>false</code> on failure, although the caller ignores the return value. However, the return code to be included in the reply message should be set as <code>mig_reply_error_t::RetCode</code>. The non-<code>void</code> return value is used for increased compatibility with MIG-generated functions. </dd></dl> |
| |
| <p>Implements <a class="el" href="classcrashpad_1_1MachMessageServer_1_1Interface.html#ad1632cba188c113600abc94d1b45efe6">crashpad::MachMessageServer::Interface</a>.</p> |
| |
| </div> |
| </div> |
| <a id="af824bc4888e15ed26769d0ff8571fc38"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af824bc4888e15ed26769d0ff8571fc38">◆ </a></span>MachMessageServerReplySize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mach_msg_size_t crashpad::NotifyServer::MachMessageServerReplySize </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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>The maximum size, in bytes, of a reply message to be sent via the <em>out</em> parameter of <a class="el" href="classcrashpad_1_1NotifyServer.html#a96630849312a63d91f0d94a5618803a3" title="Handles a Mach RPC request.">MachMessageServerFunction()</a>. This value does not need to include the size of any trailer to be sent with the message. </dd></dl> |
| |
| <p>Implements <a class="el" href="classcrashpad_1_1MachMessageServer_1_1Interface.html#ad4e6169aeb91074d573e77b9a47266c5">crashpad::MachMessageServer::Interface</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aedce681312094a8ed81f5275d2f70070"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aedce681312094a8ed81f5275d2f70070">◆ </a></span>MachMessageServerRequestIDs()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::set< mach_msg_id_t > crashpad::NotifyServer::MachMessageServerRequestIDs </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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>The set of request message Mach message IDs that <a class="el" href="classcrashpad_1_1NotifyServer.html#a96630849312a63d91f0d94a5618803a3" title="Handles a Mach RPC request.">MachMessageServerFunction()</a> is able to handle. </dd></dl> |
| |
| <p>Implements <a class="el" href="classcrashpad_1_1MachMessageServer_1_1Interface.html#af0a4b1e3b83c7226604837b32ef6428e">crashpad::MachMessageServer::Interface</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a4a08edc6b102a6c36cad7f5f38290540"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4a08edc6b102a6c36cad7f5f38290540">◆ </a></span>MachMessageServerRequestSize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mach_msg_size_t crashpad::NotifyServer::MachMessageServerRequestSize </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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="section return"><dt>Returns</dt><dd>The expected or maximum size, in bytes, of a request message to be received as the <em>in</em> parameter of <a class="el" href="classcrashpad_1_1NotifyServer.html#a96630849312a63d91f0d94a5618803a3" title="Handles a Mach RPC request.">MachMessageServerFunction()</a>. </dd></dl> |
| |
| <p>Implements <a class="el" href="classcrashpad_1_1MachMessageServer_1_1Interface.html#a319dd9279e87b4407cee3c8feca405ab">crashpad::MachMessageServer::Interface</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>util/mach/notify_server.h</li> |
| <li>util/mach/notify_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> |
