RStudio Launcher Plugin SDK  1.1.3
A software development kit for creating plugins that work the the RStudio Launcher.
Public Member Functions | List of all members
rstudio::launcher_plugins::system::process::SyncChildProcess Class Referencefinal

A blocking child process. More...

#include <Process.hpp>

Inheritance diagram for rstudio::launcher_plugins::system::process::SyncChildProcess:
rstudio::launcher_plugins::system::process::AbstractChildProcess rstudio::launcher_plugins::Noncopyable

Public Member Functions

 SyncChildProcess (const ProcessOptions &in_options)
 Constructor. More...
 
Error run (ProcessResult &out_result)
 Runs the child process, blocking until it completes. More...
 
Error writeToStdin (const std::string &in_string, bool in_eof) override
 Writes the specified string to stdin. More...
 
- Public Member Functions inherited from rstudio::launcher_plugins::system::process::AbstractChildProcess
virtual ~AbstractChildProcess ()=default
 Virtual destructor for inheritance.
 
pid_t getPid () const
 Gets the PID of this child process. More...
 
virtual Error terminate ()
 Terminates the child process. More...
 
- Public Member Functions inherited from rstudio::launcher_plugins::Noncopyable
 Noncopyable ()=default
 Default constructor.
 
 Noncopyable (const Noncopyable &)=delete
 Deleted copy constructor.
 
Noncopyableoperator= (const Noncopyable &)=delete
 Deleted assignment operator.
 

Additional Inherited Members

- Protected Member Functions inherited from rstudio::launcher_plugins::system::process::AbstractChildProcess
 AbstractChildProcess (const ProcessOptions &in_options)
 Constructor. More...
 
Error run ()
 Forks and executes the child process, passing along arguments and environment variables. More...
 
 PRIVATE_IMPL (m_baseImpl)
 

Detailed Description

A blocking child process.

Constructor & Destructor Documentation

◆ SyncChildProcess()

rstudio::launcher_plugins::system::process::SyncChildProcess::SyncChildProcess ( const ProcessOptions in_options)
explicit

Constructor.

Parameters
in_optionsThe options for the child process.

Member Function Documentation

◆ run()

Error rstudio::launcher_plugins::system::process::SyncChildProcess::run ( ProcessResult out_result)

Runs the child process, blocking until it completes.

Parameters
out_resultThe process result.
Returns
Success if the child process could be started; Error otherwise.

◆ writeToStdin()

Error rstudio::launcher_plugins::system::process::SyncChildProcess::writeToStdin ( const std::string &  in_string,
bool  in_eof 
)
overridevirtual

Writes the specified string to stdin.

Parameters
in_stringThe data to write to stdin.
in_eofTrue if this is the last data to write to stdin.
Returns
Success if the data could be written; Error otherwise.

Implements rstudio::launcher_plugins::system::process::AbstractChildProcess.


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