Imported Upstream version 1.64.0
[platform/upstream/boost.git] / doc / html / boost / process / group.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>Class group</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.group_hpp" title="Header &lt;boost/process/group.hpp&gt;">
10 <link rel="prev" href="extend/get_io_service.html" title="Function template get_io_service">
11 <link rel="next" href="close.html" title="Global close">
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="extend/get_io_service.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.group_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="close.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25 </div>
26 <div class="refentry">
27 <a name="boost.process.group"></a><div class="titlepage"></div>
28 <div class="refnamediv">
29 <h2><span class="refentrytitle">Class group</span></h2>
30 <p>boost::process::group</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.group_hpp" title="Header &lt;boost/process/group.hpp&gt;">boost/process/group.hpp</a>&gt;
34
35 </span>
36 <span class="keyword">class</span> <a class="link" href="group.html" title="Class group">group</a> <span class="special">{</span>
37 <span class="keyword">public</span><span class="special">:</span>
38   <span class="comment">// types</span>
39   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>            <a name="boost.process.group.group_handle"></a><span class="identifier">group_handle</span><span class="special">;</span>   
40   <span class="keyword">typedef</span> <span class="identifier">group_handle</span><span class="special">::</span><span class="identifier">handle_t</span> <a name="boost.process.group.native_handle_t"></a><span class="identifier">native_handle_t</span><span class="special">;</span>  <span class="comment">// Native representation of the handle. </span>
41
42   <span class="comment">// <a class="link" href="group.html#boost.process.groupconstruct-copy-destruct">construct/copy/destruct</a></span>
43   <span class="keyword">explicit</span> <a class="link" href="group.html#idp25177440-bb"><span class="identifier">group</span></a><span class="special">(</span><span class="identifier">group_handle</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
44   <span class="keyword">explicit</span> <a class="link" href="group.html#idp25178688-bb"><span class="identifier">group</span></a><span class="special">(</span><span class="identifier">native_handle_t</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
45   <a class="link" href="group.html#idp25180256-bb"><span class="identifier">group</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="group.html" title="Class group">group</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
46   <a class="link" href="group.html#idp25181952-bb"><span class="identifier">group</span></a><span class="special">(</span><a class="link" href="group.html" title="Class group">group</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
47   <a class="link" href="group.html#idp25183504-bb"><span class="identifier">group</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span>
48   <a class="link" href="group.html" title="Class group">group</a> <span class="special">&amp;</span> <a class="link" href="group.html#idp25184352-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="group.html" title="Class group">group</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
49   <a class="link" href="group.html" title="Class group">group</a> <span class="special">&amp;</span> <a class="link" href="group.html#idp25186624-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="group.html" title="Class group">group</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
50   <a class="link" href="group.html#idp25188752-bb"><span class="special">~</span><span class="identifier">group</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
51
52   <span class="comment">// <a class="link" href="group.html#idp25133072-bb">public member functions</a></span>
53   <span class="keyword">void</span> <a class="link" href="group.html#idp25133632-bb"><span class="identifier">detach</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
54   <span class="keyword">void</span> <a class="link" href="group.html#idp25134768-bb"><span class="identifier">join</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
55   <span class="keyword">bool</span> <a class="link" href="group.html#idp25136112-bb"><span class="identifier">joinable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
56   <span class="identifier">native_handle_t</span> <a class="link" href="group.html#idp25137392-bb"><span class="identifier">native_handle</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
57   <span class="keyword">void</span> <a class="link" href="group.html#idp25138816-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
58   <span class="keyword">void</span> <a class="link" href="group.html#idp25139968-bb"><span class="identifier">wait</span></a><span class="special">(</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">noexcept</span><span class="special">;</span>
59   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Rep<span class="special">,</span> <span class="keyword">typename</span> Period<span class="special">&gt;</span> 
60     <span class="keyword">bool</span> <a class="link" href="group.html#idp25142320-bb"><span class="identifier">wait_for</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">duration</span><span class="special">&lt;</span> <span class="identifier">Rep</span><span class="special">,</span> <span class="identifier">Period</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
61   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Rep<span class="special">,</span> <span class="keyword">typename</span> Period<span class="special">&gt;</span> 
62     <span class="keyword">bool</span> <a class="link" href="group.html#idp25146208-bb"><span class="identifier">wait_for</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">duration</span><span class="special">&lt;</span> <span class="identifier">Rep</span><span class="special">,</span> <span class="identifier">Period</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> 
63                   <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">noexcept</span><span class="special">;</span>
64   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Clock<span class="special">,</span> <span class="keyword">typename</span> Duration<span class="special">&gt;</span> 
65     <span class="keyword">bool</span> <a class="link" href="group.html#idp25150688-bb"><span class="identifier">wait_until</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">time_point</span><span class="special">&lt;</span> <span class="identifier">Clock</span><span class="special">,</span> <span class="identifier">Duration</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
66   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Clock<span class="special">,</span> <span class="keyword">typename</span> Duration<span class="special">&gt;</span> 
67     <span class="keyword">bool</span> <a class="link" href="group.html#idp25154576-bb"><span class="identifier">wait_until</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">time_point</span><span class="special">&lt;</span> <span class="identifier">Clock</span><span class="special">,</span> <span class="identifier">Duration</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> 
68                     <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">noexcept</span><span class="special">;</span>
69   <span class="keyword">bool</span> <a class="link" href="group.html#idp25159056-bb"><span class="identifier">valid</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
70   <span class="keyword">explicit</span> <a class="link" href="group.html#idp25160480-bb"><span class="keyword">operator</span> <span class="keyword">bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
71   <span class="keyword">void</span> <a class="link" href="group.html#idp25162176-bb"><span class="identifier">terminate</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
72   <span class="keyword">void</span> <a class="link" href="group.html#idp25163360-bb"><span class="identifier">terminate</span></a><span class="special">(</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">noexcept</span><span class="special">;</span>
73   <span class="keyword">void</span> <a class="link" href="group.html#idp25165712-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
74   <span class="keyword">void</span> <a class="link" href="group.html#idp25168000-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&amp;</span><span class="special">,</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">noexcept</span><span class="special">;</span>
75   <span class="keyword">bool</span> <a class="link" href="group.html#idp25171488-bb"><span class="identifier">has</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
76   <span class="keyword">bool</span> <a class="link" href="group.html#idp25173792-bb"><span class="identifier">has</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&amp;</span><span class="special">,</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">noexcept</span><span class="special">;</span>
77 <span class="special">}</span><span class="special">;</span></pre></div>
78 <div class="refsect1">
79 <a name="idp433383824"></a><h2>Description</h2>
80 <p>Represents a process group.</p>
81 <p>Groups are movable but non-copyable. The destructor automatically closes handles to the group process.</p>
82 <p>The group will have the same interface as std::thread.</p>
83 <div class="note"><table border="0" summary="Note">
84 <tr>
85 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
86 <th align="left">Note</th>
87 </tr>
88 <tr><td align="left" valign="top"><p>If the destructor is called without a previous detach or wait, the group will be terminated.</p></td></tr>
89 </table></div>
90 <p>
91 </p>
92 <div class="note"><table border="0" summary="Note">
93 <tr>
94 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
95 <th align="left">Note</th>
96 </tr>
97 <tr><td align="left" valign="top">
98 <p>If a default-constructed group is used before being used in a process launch, the behaviour is undefined.</p>
99 <p>Waiting for groups is currently broken on windows and will most likely result in a dead-lock. </p>
100 </td></tr>
101 </table></div>
102 <p>
103 </p>
104 <div class="refsect2">
105 <a name="idp433386992"></a><h3>
106 <a name="boost.process.groupconstruct-copy-destruct"></a><code class="computeroutput">group</code> 
107         public
108        construct/copy/destruct</h3>
109 <div class="orderedlist"><ol class="orderedlist" type="1">
110 <li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idp25177440-bb"></a><span class="identifier">group</span><span class="special">(</span><span class="identifier">group_handle</span> <span class="special">&amp;&amp;</span> ch<span class="special">)</span><span class="special">;</span></pre></li>
111 <li class="listitem">
112 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp25178688-bb"></a><span class="identifier">group</span><span class="special">(</span><span class="identifier">native_handle_t</span> <span class="special">&amp;</span> handle<span class="special">)</span><span class="special">;</span></pre>Construct the group from a native_handle. </li>
113 <li class="listitem"><pre class="literallayout"><a name="idp25180256-bb"></a><span class="identifier">group</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="group.html" title="Class group">group</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
114 <li class="listitem">
115 <pre class="literallayout"><a name="idp25181952-bb"></a><span class="identifier">group</span><span class="special">(</span><a class="link" href="group.html" title="Class group">group</a> <span class="special">&amp;&amp;</span> lhs<span class="special">)</span><span class="special">;</span></pre>Move constructor. </li>
116 <li class="listitem">
117 <pre class="literallayout"><a name="idp25183504-bb"></a><span class="identifier">group</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">default</span><span class="special">;</span></pre>Default constructor. </li>
118 <li class="listitem"><pre class="literallayout"><a class="link" href="group.html" title="Class group">group</a> <span class="special">&amp;</span> <a name="idp25184352-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="group.html" title="Class group">group</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
119 <li class="listitem">
120 <pre class="literallayout"><a class="link" href="group.html" title="Class group">group</a> <span class="special">&amp;</span> <a name="idp25186624-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="group.html" title="Class group">group</a> <span class="special">&amp;&amp;</span> lhs<span class="special">)</span><span class="special">;</span></pre>Move assign. </li>
121 <li class="listitem">
122 <pre class="literallayout"><a name="idp25188752-bb"></a><span class="special">~</span><span class="identifier">group</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
123 <p>Destructor</p>
124 <div class="note"><table border="0" summary="Note">
125 <tr>
126 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
127 <th align="left">Note</th>
128 </tr>
129 <tr><td align="left" valign="top"><p>If the destructor is called without a previous detach or wait, the group will be terminated. </p></td></tr>
130 </table></div>
131 <p>
132 </p>
133 </li>
134 </ol></div>
135 </div>
136 <div class="refsect2">
137 <a name="idp433439808"></a><h3>
138 <a name="idp25133072-bb"></a><code class="computeroutput">group</code> public member functions</h3>
139 <div class="orderedlist"><ol class="orderedlist" type="1">
140 <li class="listitem">
141 <pre class="literallayout"><span class="keyword">void</span> <a name="idp25133632-bb"></a><span class="identifier">detach</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Detach the group. </li>
142 <li class="listitem">
143 <pre class="literallayout"><span class="keyword">void</span> <a name="idp25134768-bb"></a><span class="identifier">join</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
144 <p>Join the child. This just calls wait, but that way the naming is similar to std::thread </p>
145 </li>
146 <li class="listitem">
147 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp25136112-bb"></a><span class="identifier">joinable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
148 <p>Check if the child is joinable. </p>
149 </li>
150 <li class="listitem">
151 <pre class="literallayout"><span class="identifier">native_handle_t</span> <a name="idp25137392-bb"></a><span class="identifier">native_handle</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Obtain the native handle of the group. </li>
152 <li class="listitem">
153 <pre class="literallayout"><span class="keyword">void</span> <a name="idp25138816-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Wait for the process group to exit. </li>
154 <li class="listitem">
155 <pre class="literallayout"><span class="keyword">void</span> <a name="idp25139968-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
156 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
157 </li>
158 <li class="listitem">
159 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Rep<span class="special">,</span> <span class="keyword">typename</span> Period<span class="special">&gt;</span> 
160   <span class="keyword">bool</span> <a name="idp25142320-bb"></a><span class="identifier">wait_for</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">duration</span><span class="special">&lt;</span> <span class="identifier">Rep</span><span class="special">,</span> <span class="identifier">Period</span> <span class="special">&gt;</span> <span class="special">&amp;</span> rel_time<span class="special">)</span><span class="special">;</span></pre>
161 <p>Wait for the process group to exit for period of time. 
162 </p>
163 <div class="variablelist"><table border="0" class="variablelist compact">
164 <colgroup>
165 <col align="left" valign="top">
166 <col>
167 </colgroup>
168 <tbody><tr>
169 <td><p><span class="term">Returns:</span></p></td>
170 <td><p>True if all child processes exited while waiting. </p></td>
171 </tr></tbody>
172 </table></div>
173 </li>
174 <li class="listitem">
175 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Rep<span class="special">,</span> <span class="keyword">typename</span> Period<span class="special">&gt;</span> 
176   <span class="keyword">bool</span> <a name="idp25146208-bb"></a><span class="identifier">wait_for</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">duration</span><span class="special">&lt;</span> <span class="identifier">Rep</span><span class="special">,</span> <span class="identifier">Period</span> <span class="special">&gt;</span> <span class="special">&amp;</span> rel_time<span class="special">,</span> 
177                 <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
178 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
179 </li>
180 <li class="listitem">
181 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Clock<span class="special">,</span> <span class="keyword">typename</span> Duration<span class="special">&gt;</span> 
182   <span class="keyword">bool</span> <a name="idp25150688-bb"></a><span class="identifier">wait_until</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">time_point</span><span class="special">&lt;</span> <span class="identifier">Clock</span><span class="special">,</span> <span class="identifier">Duration</span> <span class="special">&gt;</span> <span class="special">&amp;</span> timeout_time<span class="special">)</span><span class="special">;</span></pre>
183 <p>Wait for the process group to exit until a point in time. 
184 </p>
185 <div class="variablelist"><table border="0" class="variablelist compact">
186 <colgroup>
187 <col align="left" valign="top">
188 <col>
189 </colgroup>
190 <tbody><tr>
191 <td><p><span class="term">Returns:</span></p></td>
192 <td><p>True if all child processes exited while waiting. </p></td>
193 </tr></tbody>
194 </table></div>
195 </li>
196 <li class="listitem">
197 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Clock<span class="special">,</span> <span class="keyword">typename</span> Duration<span class="special">&gt;</span> 
198   <span class="keyword">bool</span> <a name="idp25154576-bb"></a><span class="identifier">wait_until</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">chrono</span><span class="special">::</span><span class="identifier">time_point</span><span class="special">&lt;</span> <span class="identifier">Clock</span><span class="special">,</span> <span class="identifier">Duration</span> <span class="special">&gt;</span> <span class="special">&amp;</span> timeout_time<span class="special">,</span> 
199                   <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
200 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
201 </li>
202 <li class="listitem">
203 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp25159056-bb"></a><span class="identifier">valid</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Check if the group has a valid handle. </li>
204 <li class="listitem">
205 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp25160480-bb"></a><span class="keyword">operator</span> <span class="keyword">bool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Convenience to call valid. </li>
206 <li class="listitem">
207 <pre class="literallayout"><span class="keyword">void</span> <a name="idp25162176-bb"></a><span class="identifier">terminate</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Terminate the process group, i.e. all processes in the group. </li>
208 <li class="listitem">
209 <pre class="literallayout"><span class="keyword">void</span> <a name="idp25163360-bb"></a><span class="identifier">terminate</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
210 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
211 </li>
212 <li class="listitem">
213 <pre class="literallayout"><span class="keyword">void</span> <a name="idp25165712-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&amp;</span> c<span class="special">)</span><span class="special">;</span></pre>Assign a child process to the group. </li>
214 <li class="listitem">
215 <pre class="literallayout"><span class="keyword">void</span> <a name="idp25168000-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&amp;</span> c<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
216 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
217 </li>
218 <li class="listitem">
219 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp25171488-bb"></a><span class="identifier">has</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&amp;</span> c<span class="special">)</span><span class="special">;</span></pre>Check if the child process is in the group. </li>
220 <li class="listitem">
221 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp25173792-bb"></a><span class="identifier">has</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="child.html" title="Class child">child</a> <span class="special">&amp;</span> c<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&amp;</span> ec<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
222 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
223 </li>
224 </ol></div>
225 </div>
226 </div>
227 </div>
228 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
229 <td align="left"></td>
230 <td align="right"><div class="copyright-footer">Copyright &#169; 2006-2012 Julio M. Merino Vidal, Ilya Sokolov,
231       Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright &#169; 2016 Klemens D. Morgenstern<p>
232         Distributed under the Boost Software License, Version 1.0. (See accompanying
233         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
234       </p>
235 </div></td>
236 </tr></table>
237 <hr>
238 <div class="spirit-nav">
239 <a accesskey="p" href="extend/get_io_service.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.group_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="close.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
240 </div>
241 </body>
242 </html>