doc/html/boost/process/extend/handler.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Struct handler</title>
   6 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header &lt;boost/process/extend.hpp&gt;">
  10 <link rel="prev" href="../exe.html" title="Global exe">
  11 <link rel="next" href="require_io_service.html" title="Struct require_io_service">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="../exe.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="require_io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.process.extend.handler"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Struct handler</span></h2>
  30 <p>boost::process::extend::handler</p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../process/reference.html#header.boost.process.extend_hpp" title="Header &lt;boost/process/extend.hpp&gt;">boost/process/extend.hpp</a>&gt;
  34
  35 </span>
  36 <span class="keyword">struct</span> <a class="link" href="handler.html" title="Struct handler">handler</a> <span class="special">{</span>
  37
  38   <span class="comment">// <a class="link" href="handler.html#idp24951072-bb">public member functions</a></span>
  39   <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#idp24951632-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>
  40   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span>
  41     <span class="keyword">void</span> <a class="link" href="handler.html#idp24955456-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>
  42   <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#idp24959872-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>
  43   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span>
  44     <span class="keyword">void</span> <a class="link" href="handler.html#idp24963584-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>
  45   <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#idp24968448-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>
  46   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span>
  47     <span class="keyword">void</span> <a class="link" href="handler.html#idp24973680-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>
  48 <span class="special">}</span><span class="special">;</span></pre></div>
  49 <div class="refsect1">
  50 <a name="idp432403616"></a><h2>Description</h2>
  51 <p>This class is the base for every initializer, to be used for extensions.</p>
  52 <p>The usage is done through compile-time polymorphism, so that the required functions can be overloaded.</p>
  53 <div class="note"><table border="0" summary="Note">
  54 <tr>
  55 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
  56 <th align="left">Note</th>
  57 </tr>
  58 <tr><td align="left" valign="top"><p>None of the function need to be <code class="computeroutput">const</code>. </p></td></tr>
  59 </table></div>
  60 <p>
  61 </p>
  62 <div class="refsect2">
  63 <a name="idp432406128"></a><h3>
  64 <a name="idp24951072-bb"></a><code class="computeroutput">handler</code> public member functions</h3>
  65 <div class="orderedlist"><ol class="orderedlist" type="1">
  66 <li class="listitem">
  67 <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="idp24951632-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">
  68 <tr>
  69 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
  70 <th align="left">Note</th>
  71 </tr>
  72 <tr><td align="left" valign="top"><p>It is not required to be const. </p></td></tr>
  73 </table></div>
  74 <p>
  75 </p>
  76 </li>
  77 <li class="listitem">
  78 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span>
  79   <span class="keyword">void</span> <a name="idp24955456-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>
  80 <p>This function is invoked if an error occured while trying to launch the process. </p>
  81 <div class="note"><table border="0" summary="Note">
  82 <tr>
  83 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
  84 <th align="left">Note</th>
  85 </tr>
  86 <tr><td align="left" valign="top"><p>It is not required to be const. </p></td></tr>
  87 </table></div>
  88 <p>
  89 </p>
  90 </li>
  91 <li class="listitem">
  92 <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="idp24959872-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>
  93 <p>This function is invoked if the process was successfully launched. </p>
  94 <div class="note"><table border="0" summary="Note">
  95 <tr>
  96 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
  97 <th align="left">Note</th>
  98 </tr>
  99 <tr><td align="left" valign="top"><p>It is not required to be const. </p></td></tr>
 100 </table></div>
 101 <p>
 102 </p>
 103 </li>
 104 <li class="listitem">
 105 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span>
 106   <span class="keyword">void</span> <a name="idp24963584-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>
 107 <p>This function is invoked if an error occured during the call of <code class="computeroutput">fork</code>. </p>
 108 <div class="note"><table border="0" summary="Note">
 109 <tr>
 110 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
 111 <th align="left">Note</th>
 112 </tr>
 113 <tr><td align="left" valign="top"><p>This function will only be called on posix. </p></td></tr>
 114 </table></div>
 115 <p>
 116 </p>
 117 </li>
 118 <li class="listitem">
 119 <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="idp24968448-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>
 120 <p>This function is invoked if the call of <code class="computeroutput">fork</code> was successful, before calling <code class="computeroutput">execve</code>. </p>
 121 <div class="note"><table border="0" summary="Note">
 122 <tr>
 123 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
 124 <th align="left">Note</th>
 125 </tr>
 126 <tr><td align="left" valign="top"><p>This function will only be called on posix. </p></td></tr>
 127 </table></div>
 128 <p>
 129 </p>
 130 <div class="note"><table border="0" summary="Note">
 131 <tr>
 132 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
 133 <th align="left">Note</th>
 134 </tr>
 135 <tr><td align="left" valign="top"><p>It will be invoked from the new process. </p></td></tr>
 136 </table></div>
 137 <p>
 138 </p>
 139 </li>
 140 <li class="listitem">
 141 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Executor<span class="special">&gt;</span>
 142   <span class="keyword">void</span> <a name="idp24973680-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>
 143 <p>This function is invoked if the call of <code class="computeroutput">execve</code> failed. </p>
 144 <div class="note"><table border="0" summary="Note">
 145 <tr>
 146 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
 147 <th align="left">Note</th>
 148 </tr>
 149 <tr><td align="left" valign="top"><p>This function will only be called on posix. </p></td></tr>
 150 </table></div>
 151 <p>
 152 </p>
 153 <div class="note"><table border="0" summary="Note">
 154 <tr>
 155 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../doc/src/images/note.png"></td>
 156 <th align="left">Note</th>
 157 </tr>
 158 <tr><td align="left" valign="top"><p>It will be invoked from the new process. </p></td></tr>
 159 </table></div>
 160 <p>
 161 </p>
 162 </li>
 163 </ol></div>
 164 </div>
 165 </div>
 166 </div>
 167 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 168 <td align="left"></td>
 169 <td align="right"><div class="copyright-footer">Copyright &#169; 2006-2012 Julio M. Merino Vidal, Ilya Sokolov,
 170       Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright &#169; 2016 Klemens D. Morgenstern<p>
 171         Distributed under the Boost Software License, Version 1.0. (See accompanying
 172         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 173       </p>
 174 </div></td>
 175 </tr></table>
 176 <hr>
 177 <div class="spirit-nav">
 178 <a accesskey="p" href="../exe.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../process/reference.html#header.boost.process.extend_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="require_io_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 179 </div>
 180 </body>
 181 </html>