blob: d446059fe87f93444fa85f03862bb98e7f65bfcd [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.5"/>
<title>Apache Mesos: process::Subprocess::Hook Struct 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="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 style="padding-left: 0.5em;">
<div id="projectname">Apache Mesos
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceprocess.html">process</a></li><li class="navelem"><a class="el" href="classprocess_1_1Subprocess.html">Subprocess</a></li><li class="navelem"><a class="el" href="structprocess_1_1Subprocess_1_1Hook.html">Hook</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="structprocess_1_1Subprocess_1_1Hook-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">process::Subprocess::Hook Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A hook can be passed to a <code>subprocess</code> call.
<a href="structprocess_1_1Subprocess_1_1Hook.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="subprocess__base_8hpp_source.html">subprocess_base.hpp</a>&gt;</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:ade4d94d56445a02b5ebb778a982ccc97"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structprocess_1_1Subprocess_1_1Hook.html#ade4d94d56445a02b5ebb778a982ccc97">Hook</a> (const lambda::function&lt; <a class="el" href="classTry.html">Try</a>&lt; <a class="el" href="structNothing.html">Nothing</a> &gt;(<a class="el" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ab03ced250ed239bc3b50b669493997f9">pid_t</a>)&gt; &amp;_parent_callback)</td></tr>
<tr class="separator:ade4d94d56445a02b5ebb778a982ccc97"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a73d2ac70e3a8f6af61c2834654ffd715"><td class="memItemLeft" align="right" valign="top">static std::vector&lt; <a class="el" href="structprocess_1_1Subprocess_1_1Hook.html">Hook</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structprocess_1_1Subprocess_1_1Hook.html#a73d2ac70e3a8f6af61c2834654ffd715">None</a> ()</td></tr>
<tr class="memdesc:a73d2ac70e3a8f6af61c2834654ffd715"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an empty list of hooks. <a href="#a73d2ac70e3a8f6af61c2834654ffd715">More...</a><br/></td></tr>
<tr class="separator:a73d2ac70e3a8f6af61c2834654ffd715"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a8d59fd85f2bf0e7f9be9aa1a0ae5b49d"><td class="memItemLeft" align="right" valign="top">const lambda::function&lt; <a class="el" href="classTry.html">Try</a><br class="typebreak"/>
&lt; <a class="el" href="structNothing.html">Nothing</a> &gt;<a class="el" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ab03ced250ed239bc3b50b669493997f9">pid_t</a>)&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structprocess_1_1Subprocess_1_1Hook.html#a8d59fd85f2bf0e7f9be9aa1a0ae5b49d">parent_callback</a></td></tr>
<tr class="memdesc:a8d59fd85f2bf0e7f9be9aa1a0ae5b49d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The callback that must be sepcified for execution after the child has been cloned, but before it start executing the new process. <a href="#a8d59fd85f2bf0e7f9be9aa1a0ae5b49d">More...</a><br/></td></tr>
<tr class="separator:a8d59fd85f2bf0e7f9be9aa1a0ae5b49d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a3d12fd22e5deb76d3529ce4e6d9179dc"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structprocess_1_1Subprocess_1_1Hook.html#a3d12fd22e5deb76d3529ce4e6d9179dc">Subprocess</a></td></tr>
<tr class="separator:a3d12fd22e5deb76d3529ce4e6d9179dc"><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 hook can be passed to a <code>subprocess</code> call. </p>
<p>It provides a way to inject dynamic implementation behavior between the clone and exec calls in the implementation of <code>subprocess</code>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ade4d94d56445a02b5ebb778a982ccc97"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">process::Subprocess::Hook::Hook </td>
<td>(</td>
<td class="paramtype">const lambda::function&lt; <a class="el" href="classTry.html">Try</a>&lt; <a class="el" href="structNothing.html">Nothing</a> &gt;(<a class="el" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ab03ced250ed239bc3b50b669493997f9">pid_t</a>)&gt; &amp;&#160;</td>
<td class="paramname"><em>_parent_callback</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a73d2ac70e3a8f6af61c2834654ffd715"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static std::vector&lt;<a class="el" href="structprocess_1_1Subprocess_1_1Hook.html">Hook</a>&gt; process::Subprocess::Hook::None </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an empty list of hooks. </p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a3d12fd22e5deb76d3529ce4e6d9179dc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classprocess_1_1Subprocess.html">Subprocess</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a8d59fd85f2bf0e7f9be9aa1a0ae5b49d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const lambda::function&lt;<a class="el" href="classTry.html">Try</a>&lt;<a class="el" href="structNothing.html">Nothing</a>&gt;<a class="el" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ab03ced250ed239bc3b50b669493997f9">pid_t</a>)&gt; process::Subprocess::Hook::parent_callback</td>
</tr>
</table>
</div><div class="memdoc">
<p>The callback that must be sepcified for execution after the child has been cloned, but before it start executing the new process. </p>
<p>This provides access to the child pid after its initialization to add tracking or modify execution state of the child before it executes the new process. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>3rdparty/libprocess/include/process/<a class="el" href="subprocess__base_8hpp_source.html">subprocess_base.hpp</a></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.5
</small></address>
</body>
</html>