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::local::LocalJobRunner Class Reference

Runs jobs on the local machine. More...

#include <LocalJobRunner.hpp>

Inheritance diagram for rstudio::launcher_plugins::local::LocalJobRunner:

Public Member Functions

 LocalJobRunner (const std::string &in_hostname, jobs::JobStatusNotifierPtr in_notifier, std::shared_ptr< LocalJobRepository > in_jobRepository)
 Constructor. More...
Error initialize ()
 Initializes the job runner. More...
Error runJob (api::JobPtr &io_job, bool &out_wasInvalidJob)
 Runs the specified job. More...

Detailed Description

Runs jobs on the local machine.

Constructor & Destructor Documentation

◆ LocalJobRunner()

rstudio::launcher_plugins::local::LocalJobRunner::LocalJobRunner ( const std::string &  in_hostname,
jobs::JobStatusNotifierPtr  in_notifier,
std::shared_ptr< LocalJobRepository in_jobRepository 


in_hostnameThe hostname of the machine on which jobs will be run (this machine).
in_notifierThe job status notifier, for posting job status updates.
in_jobRepositoryThe job repository, for saving jobs and job output.

Member Function Documentation

◆ initialize()

Error rstudio::launcher_plugins::local::LocalJobRunner::initialize ( )

Initializes the job runner.

Success if the job runner could be initialized; Error otherwise.

◆ runJob()

Error rstudio::launcher_plugins::local::LocalJobRunner::runJob ( api::JobPtr &  io_job,
bool &  out_wasInvalidJob 

Runs the specified job.

io_jobThe Job to be run.
out_wasInvalidJobWhether the error that occurred was because the requested Job was invalid.
Success if the job could be run; Error otherwise.

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