Imported Upstream version 1.72.0
[platform/upstream/boost.git] / doc / html / boost / process / extend / handler.html
index b9bac9c..4fd7cfa 100644 (file)
 </span>
 <span class="keyword">struct</span> <a class="link" href="handler.html" title="Struct handler">handler</a> <span class="special">{</span>
 
-  <span class="comment">// <a class="link" href="handler.html#idm45477675302496-bb">public member functions</a></span>
-  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="handler.html#idm45477675301936-bb"><span class="identifier">on_setup</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="comment">// <a class="link" href="handler.html#idm45170604907632-bb">public member functions</a></span>
+  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="handler.html#idm45170604907072-bb"><span class="identifier">on_setup</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> 
-    <span class="keyword">void</span> <a class="link" href="handler.html#idm45477675297952-bb"><span class="identifier">on_error</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="handler.html#idm45477675293376-bb"><span class="identifier">on_success</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+    <span class="keyword">void</span> <a class="link" href="handler.html#idm45170604903088-bb"><span class="identifier">on_error</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="handler.html#idm45170604898512-bb"><span class="identifier">on_success</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> 
-    <span class="keyword">void</span> <a class="link" href="handler.html#idm45477675289504-bb"><span class="identifier">on_fork_error</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
-  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="handler.html#idm45477675284480-bb"><span class="identifier">on_exec_setup</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+    <span class="keyword">void</span> <a class="link" href="handler.html#idm45170604894640-bb"><span class="identifier">on_fork_error</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="handler.html#idm45170604889616-bb"><span class="identifier">on_exec_setup</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> 
-    <span class="keyword">void</span> <a class="link" href="handler.html#idm45477675278928-bb"><span class="identifier">on_exec_error</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+    <span class="keyword">void</span> <a class="link" href="handler.html#idm45170604884064-bb"><span class="identifier">on_exec_error</span></a><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
 <span class="special">}</span><span class="special">;</span></pre></div>
 <div class="refsect1">
 <a name="id-1.3.31.9.13.6.4"></a><h2>Description</h2>
 </p>
 <div class="refsect2">
 <a name="id-1.3.31.9.13.6.4.5"></a><h3>
-<a name="idm45477675302496-bb"></a><code class="computeroutput">handler</code> public member functions</h3>
+<a name="idm45170604907632-bb"></a><code class="computeroutput">handler</code> public member functions</h3>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45477675301936-bb"></a><span class="identifier">on_setup</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>This function is invoked before the process launch. <div class="note"><table border="0" summary="Note">
+<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45170604907072-bb"></a><span class="identifier">on_setup</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>This function is invoked before the process launch. <div class="note"><table border="0" summary="Note">
 <tr>
 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
 <th align="left">Note</th>
@@ -76,7 +76,7 @@
 </li>
 <li class="listitem">
 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> 
-  <span class="keyword">void</span> <a name="idm45477675297952-bb"></a><span class="identifier">on_error</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+  <span class="keyword">void</span> <a name="idm45170604903088-bb"></a><span class="identifier">on_error</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 <p>This function is invoked if an error occured while trying to launch the process. </p>
 <div class="note"><table border="0" summary="Note">
 <tr>
@@ -89,7 +89,7 @@
 </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45477675293376-bb"></a><span class="identifier">on_success</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45170604898512-bb"></a><span class="identifier">on_success</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 <p>This function is invoked if the process was successfully launched. </p>
 <div class="note"><table border="0" summary="Note">
 <tr>
 </li>
 <li class="listitem">
 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> 
-  <span class="keyword">void</span> <a name="idm45477675289504-bb"></a><span class="identifier">on_fork_error</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+  <span class="keyword">void</span> <a name="idm45170604894640-bb"></a><span class="identifier">on_fork_error</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 <p>This function is invoked if an error occured during the call of <code class="computeroutput">fork</code>. </p>
 <div class="note"><table border="0" summary="Note">
 <tr>
 </p>
 </li>
 <li class="listitem">
-<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45477675284480-bb"></a><span class="identifier">on_exec_setup</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm45170604889616-bb"></a><span class="identifier">on_exec_setup</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 <p>This function is invoked if the call of <code class="computeroutput">fork</code> was successful, before calling <code class="computeroutput">execve</code>. </p>
 <div class="note"><table border="0" summary="Note">
 <tr>
 </li>
 <li class="listitem">
 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span> 
-  <span class="keyword">void</span> <a name="idm45477675278928-bb"></a><span class="identifier">on_exec_error</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+  <span class="keyword">void</span> <a name="idm45170604884064-bb"></a><span class="identifier">on_exec_error</span><span class="special">(</span><span class="identifier">Executor</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 <p>This function is invoked if the call of <code class="computeroutput">execve</code> failed. </p>
 <div class="note"><table border="0" summary="Note">
 <tr>