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
	)

Constructor.

Parameters

in_hostname	The hostname of the machine on which jobs will be run (this machine).
in_notifier	The job status notifier, for posting job status updates.
in_jobRepository	The job repository, for saving jobs and job output.

Member Function Documentation

initialize()

Error rstudio::launcher_plugins::local::LocalJobRunner::initialize

(

)

Initializes the job runner.

Returns

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.

Parameters

io_job	The Job to be run.
out_wasInvalidJob	Whether the error that occurred was because the requested Job was invalid.

Returns

Success if the job could be run; Error otherwise.

---

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

• /var/lib/jenkins/workspace/IDE/launcher-plugin-sdk/master/plugins/Local/include/LocalJobRunner.hpp