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::LocalJobRepository Class Reference

Responsible for job persistence. More...

#include <LocalJobRepository.hpp>

Inheritance diagram for rstudio::launcher_plugins::local::LocalJobRepository:
rstudio::launcher_plugins::jobs::AbstractJobRepository rstudio::launcher_plugins::Noncopyable

Public Member Functions

 LocalJobRepository (const std::string &in_hostname, jobs::JobStatusNotifierPtr in_notifier)
 Constructor. More...
void saveJob (api::JobPtr in_job) const
 Saves a job to disk. More...
Error setJobOutputPaths (api::JobPtr io_job) const
 Sets the default output paths for the specified job. More...
- Public Member Functions inherited from rstudio::launcher_plugins::jobs::AbstractJobRepository
 AbstractJobRepository (JobStatusNotifierPtr in_jobStatusNotifier)
 Constructor. More...
virtual ~AbstractJobRepository ()=default
 Virtual Destructor, to allow for inheritance, if necessary.
void addJob (const api::JobPtr &in_job)
 Adds the job to the repository. More...
api::JobPtr getJob (const std::string &in_jobId, const system::User &in_user=system::User()) const
 Gets the specified job for the specified user from the repository. More...
api::JobList getJobs (const system::User &in_use=system::User()) const
 Gets all jobs belonging to the specified user. More...
Error initialize ()
 Initializes the AbstractJobRepository. More...
void removeJob (const std::string &in_jobId)
 Removes a job from the repository. 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.

Detailed Description

Responsible for job persistence.

Constructor & Destructor Documentation

◆ LocalJobRepository()

rstudio::launcher_plugins::local::LocalJobRepository::LocalJobRepository ( const std::string &  in_hostname,
jobs::JobStatusNotifierPtr  in_notifier 


in_hostnameThe hostname of machine which is hosting this instance of the Local Plugin.
in_notifierThe job status notifier from which to receive job status update notifications.

Member Function Documentation

◆ saveJob()

void rstudio::launcher_plugins::local::LocalJobRepository::saveJob ( api::JobPtr  in_job) const

Saves a job to disk.

in_jobThe job to be saved.

◆ setJobOutputPaths()

Error rstudio::launcher_plugins::local::LocalJobRepository::setJobOutputPaths ( api::JobPtr  io_job) const

Sets the default output paths for the specified job.

io_jobThe job to modify.

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