1 // Copyright (c) 2006, 2007 Julio M. Merino Vidal
2 // Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
3 // Copyright (c) 2009 Boris Schaeling
4 // Copyright (c) 2010 Felipe Tanus, Boris Schaeling
5 // Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
6 // Copyright (c) 2016 Klemens D. Morgenstern
8 // Distributed under the Boost Software License, Version 1.0. (See accompanying
9 // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
12 * \file boost/process/child.hpp
14 * Defines a child process class.
17 #ifndef BOOST_PROCESS_CHILD_DECL_HPP
18 #define BOOST_PROCESS_CHILD_DECL_HPP
20 #include <boost/process/detail/config.hpp>
24 #include <boost/none.hpp>
27 #if defined(BOOST_POSIX_API)
28 #include <boost/process/detail/posix/child_handle.hpp>
29 #include <boost/process/detail/posix/terminate.hpp>
30 #include <boost/process/detail/posix/wait_for_exit.hpp>
31 #include <boost/process/detail/posix/is_running.hpp>
32 #elif defined(BOOST_WINDOWS_API)
33 #include <boost/process/detail/windows/child_handle.hpp>
34 #include <boost/process/detail/windows/terminate.hpp>
35 #include <boost/process/detail/windows/wait_for_exit.hpp>
36 #include <boost/process/detail/windows/is_running.hpp>
43 using ::boost::process::detail::api::pid_t;
47 ::boost::process::detail::api::child_handle _child_handle;
48 std::shared_ptr<std::atomic<int>> _exit_status = std::make_shared<std::atomic<int>>(::boost::process::detail::api::still_active);
49 bool _attached = true;
50 bool _terminated = false;
54 return _terminated || !::boost::process::detail::api::is_running(_exit_status->load());
57 typedef ::boost::process::detail::api::child_handle child_handle;
58 typedef child_handle::process_handle_t native_handle_t;
59 explicit child(child_handle &&ch, std::shared_ptr<std::atomic<int>> &ptr) : _child_handle(std::move(ch)), _exit_status(ptr) {}
60 explicit child(child_handle &&ch, const std::shared_ptr<std::atomic<int>> &ptr) : _child_handle(std::move(ch)), _exit_status(ptr) {}
61 explicit child(child_handle &&ch) : _child_handle(std::move(ch)) {}
63 explicit child(pid_t & pid) : _child_handle(pid), _attached(false) {};
64 child(const child&) = delete;
65 child(child && lhs) noexcept
66 : _child_handle(std::move(lhs._child_handle)),
67 _exit_status(std::move(lhs._exit_status)),
68 _attached (lhs._attached),
69 _terminated (lhs._terminated)
71 lhs._attached = false;
74 template<typename ...Args>
75 explicit child(Args&&...args);
76 child() { } // Must be kept non defaulted for MSVC 14.1 & 14.2 #113
77 child& operator=(const child&) = delete;
78 child& operator=(child && lhs)
80 _child_handle= std::move(lhs._child_handle);
81 _exit_status = std::move(lhs._exit_status);
82 _attached = lhs._attached;
83 _terminated = lhs._terminated;
84 lhs._attached = false;
88 void detach() {_attached = false; }
90 bool joinable() { return _attached;}
95 if (_attached && !_exited() && running(ec))
98 native_handle_t native_handle() const { return _child_handle.process_handle(); }
101 int exit_code() const {return ::boost::process::detail::api::eval_exit_status(_exit_status->load());}
102 pid_t id() const {return _child_handle.id(); }
104 int native_exit_code() const {return _exit_status->load();}
109 bool b = running(ec);
110 boost::process::detail::throw_error(ec, "running error");
118 boost::process::detail::throw_error(ec, "terminate error");
125 boost::process::detail::throw_error(ec, "wait error");
128 template< class Rep, class Period >
129 bool wait_for (const std::chrono::duration<Rep, Period>& rel_time)
132 bool b = wait_for(rel_time, ec);
133 boost::process::detail::throw_error(ec, "wait_for error");
137 template< class Clock, class Duration >
138 bool wait_until(const std::chrono::time_point<Clock, Duration>& timeout_time )
141 bool b = wait_until(timeout_time, ec);
142 boost::process::detail::throw_error(ec, "wait_until error");
146 bool running(std::error_code & ec) noexcept
149 if (valid() && !_exited() && !ec)
152 auto res = boost::process::detail::api::is_running(_child_handle, exit_code, ec);
153 if (!ec && !res && !_exited())
154 _exit_status->store(exit_code);
161 void terminate(std::error_code & ec) noexcept
163 if (valid() && running(ec) && !ec)
164 boost::process::detail::api::terminate(_child_handle, ec);
170 void wait(std::error_code & ec) noexcept
172 if (!_exited() && valid())
175 boost::process::detail::api::wait(_child_handle, exit_code, ec);
177 _exit_status->store(exit_code);
181 template< class Rep, class Period >
182 bool wait_for (const std::chrono::duration<Rep, Period>& rel_time, std::error_code & ec) noexcept
184 return wait_until(std::chrono::steady_clock::now() + rel_time, ec);
187 template< class Clock, class Duration >
188 bool wait_until(const std::chrono::time_point<Clock, Duration>& timeout_time, std::error_code & ec) noexcept
193 auto b = boost::process::detail::api::wait_until(_child_handle, exit_code, timeout_time, ec);
196 _exit_status->store(exit_code);
204 return _child_handle.valid();
206 operator bool() const {return valid();}
208 bool in_group() const
210 return _child_handle.in_group();
212 bool in_group(std::error_code &ec) const noexcept
214 return _child_handle.in_group(ec);