Represents a subprocess as an asynchronous operation. More...

#include <asyncProcess.hpp>

Inheritance diagram for daq::AsyncProcess:

Public Member Functions
	AsyncProcess (boost::asio::io_context &ctx, std::vector< std::string > args)
	Constructor. More...

virtual	~AsyncProcess () noexcept

boost::future< int >	Initiate () override
	Starts process and asynchronous operations that read stdout and stderr. More...

std::optional< pid_t >	GetPid () const noexcept override
	Get PID. More...

std::error_code	Abort () noexcept override
	Aborts the operation by terminating process which completes the operation. More...

std::error_code	Signal (int sig) noexcept override
	Send signal to process. More...

bool	IsRunning () const noexcept override

std::vector< std::string > const &	GetArguments () const noexcept override

Public Member Functions inherited from daq::AsyncProcessIf
virtual	~AsyncProcessIf ()

Signals
boost::signals2::connection	ConnectStdout (SigOutStream::slot_type const &slot) override
	Signal type for stdout/stderr signals. More...

boost::signals2::connection	ConnectStderr (SigOutStream::slot_type const &slot) override
	Signal type for stdout/stderr signals. More...

using	SigOutStream = boost::signals2::signal< void(pid_t, std::string const &)>
	Signal type for stdout/stderr signals. More...

Additional Inherited Members
Public Types inherited from daq::AsyncProcessIf
using	SigOutStream = boost::signals2::signal< void(pid_t, std::string const &)>
	Signal type for stdout/stderr signals. More...

Detailed Description

Represents a subprocess as an asynchronous operation.

Once constructed the operation is initiated (only once) with Initiate() which starts the process and returns a boost::future object that will receive exit code when process terminates and all output has been read.

Note: All completion handlers have been executed and no signals will be emitted after future has received the value or exception, it is safe to delete AsyncProcess after this.

Operation can be aborted with Abort() which will terminate process and set future with exceptional result.

boost::process is pretty buggy so be very careful making changes to this. Examples:

Do not check if process is running with child::is_running() after on_exit has been executed. This cause exit codes to be lost [https://github.com/boostorg/process/issues/187]

Definition at line 135 of file asyncProcess.hpp.

Member Typedef Documentation

◆ SigOutStream

using daq::AsyncProcessIf::SigOutStream = boost::signals2::signal<void(pid_t, std::string const&)>

Signal type for stdout/stderr signals.

Definition at line 85 of file asyncProcess.hpp.

Constructor & Destructor Documentation

◆ AsyncProcess()

daq::AsyncProcess::AsyncProcess	(	boost::asio::io_context &	ctx,
		std::vector< std::string >	args
	)

explicit

Constructor.

Note: Does not start the process or any other asynchronous operations. This is done in AsyncProcess::Initiate().

Parameters

ctx	io_context instance to use.
args	Command line arguments. First argument specify the file to be executed.

Definition at line 37 of file asyncProcess.cpp.

◆ ~AsyncProcess()

daq::AsyncProcess::~AsyncProcess ( )

virtualnoexcept

Definition at line 45 of file asyncProcess.cpp.

Member Function Documentation

◆ Abort()

std::error_code daq::AsyncProcess::Abort ( )

overridevirtualnoexcept

Aborts the operation by terminating process which completes the operation.

If process is not running this will not do anything.

Returns: Error code of operation. If process is not running, because it has not been started for with AsyncProcess::Initiate() for example, it returns std::errc::no_such_process.

Implements daq::AsyncProcessIf.

Definition at line 79 of file asyncProcess.cpp.

◆ ConnectStderr()

boost::signals2::connection daq::AsyncProcess::ConnectStderr ( SigOutStream::slot_type const & slot )

inlineoverridevirtual

Signal type for stdout/stderr signals.

Implements daq::AsyncProcessIf.

Definition at line 199 of file asyncProcess.hpp.

◆ ConnectStdout()

boost::signals2::connection daq::AsyncProcess::ConnectStdout ( SigOutStream::slot_type const & slot )

inlineoverridevirtual

Signal type for stdout/stderr signals.

Implements daq::AsyncProcessIf.

Definition at line 196 of file asyncProcess.hpp.

◆ GetArguments()

std::vector<std::string> const& daq::AsyncProcess::GetArguments ( ) const

inlineoverridevirtualnoexcept

Returns: arguments used when launching process.

Implements daq::AsyncProcessIf.

Definition at line 187 of file asyncProcess.hpp.

◆ GetPid()

std::optional< pid_t > daq::AsyncProcess::GetPid ( ) const

overridevirtualnoexcept

Get PID.

Returns: pid of process if process is running, otherwise nullopt.

Implements daq::AsyncProcessIf.

Definition at line 89 of file asyncProcess.cpp.

◆ Initiate()

boost::future< int > daq::AsyncProcess::Initiate ( )

overridevirtual

Starts process and asynchronous operations that read stdout and stderr.

This can only be called once.

Note: Caller is responsible for keeping AsyncProcess alive until result is set on future.

Returns: Future that will receive process exit code after process has terminated and all output has been read.

Implements daq::AsyncProcessIf.

Reimplemented in daq::RsyncAsyncProcess.

Definition at line 48 of file asyncProcess.cpp.

◆ IsRunning()

bool daq::AsyncProcess::IsRunning ( ) const

overridevirtualnoexcept

Returns: true if process is running.; false otherwise.

Implements daq::AsyncProcessIf.

Definition at line 106 of file asyncProcess.cpp.

◆ Signal()

std::error_code daq::AsyncProcess::Signal ( int sig )

overridevirtualnoexcept

Send signal to process.

Unlike Abort() this can be used to gracefully terminate application by sending e.g. SIGTERM.

Parameters

sig	Signal to send.

Returns: Error code of operation. If process is not running, because it has not been started for with AsyncProcess::Initiate() for example, it returns std::errc::no_such_process.

Implements daq::AsyncProcessIf.

Definition at line 96 of file asyncProcess.cpp.

The documentation for this class was generated from the following files:

common/libdaq/src/include/daq/process/asyncProcess.hpp
common/libdaq/src/asyncProcess.cpp

Public Member Functions

Signals

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SigOutStream

Constructor & Destructor Documentation

◆ AsyncProcess()

◆ ~AsyncProcess()

Member Function Documentation

◆ Abort()

◆ ConnectStderr()

◆ ConnectStdout()

◆ GetArguments()

◆ GetPid()

◆ Initiate()

◆ IsRunning()

◆ Signal()