RStudio Launcher Plugin SDK  1.1.3
A software development kit for creating plugins that work the the RStudio Launcher.
Public Member Functions | Protected Member Functions | List of all members
rstudio::launcher_plugins::jobs::AbstractTimedJobStatusWatcher Class Referenceabstract

Responsible for polling job statuses on a timer. More...

#include <AbstractTimedJobStatusWatcher.hpp>

Inheritance diagram for rstudio::launcher_plugins::jobs::AbstractTimedJobStatusWatcher:
rstudio::launcher_plugins::jobs::AbstractJobStatusWatcher rstudio::launcher_plugins::Noncopyable rstudio::launcher_plugins::quickstart::QuickStartJobStatusWatcher

Public Member Functions

 ~AbstractTimedJobStatusWatcher () noexcept override
 Virtual destructor for inheritance. Invokes stop().
 
Error start () final
 Starts the timed job status watcher.
 
void stop () final
 Stops the timed job status watcher.
 
- Public Member Functions inherited from rstudio::launcher_plugins::jobs::AbstractJobStatusWatcher
virtual ~AbstractJobStatusWatcher ()=default
 Virtual destructor for inheritance.
 
- 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.
 

Protected Member Functions

 AbstractTimedJobStatusWatcher (system::TimeDuration in_frequency, JobRepositoryPtr in_jobRepository, JobStatusNotifierPtr in_jobStatusNotifier)
 Constructor. More...
 
- Protected Member Functions inherited from rstudio::launcher_plugins::jobs::AbstractJobStatusWatcher
 AbstractJobStatusWatcher (JobRepositoryPtr in_jobRepository, JobStatusNotifierPtr in_jobStatusNotifier)
 Constructor. More...
 
Error updateJobStatus (const std::string &in_jobId, api::Job::State in_newStatus, const std::string &in_statusMessage="", const system::DateTime &in_invocationTime=system::DateTime())
 Updates the job status for the specified job. More...
 

Detailed Description

Responsible for polling job statuses on a timer.

Constructor & Destructor Documentation

◆ AbstractTimedJobStatusWatcher()

rstudio::launcher_plugins::jobs::AbstractTimedJobStatusWatcher::AbstractTimedJobStatusWatcher ( system::TimeDuration  in_frequency,
JobRepositoryPtr  in_jobRepository,
JobStatusNotifierPtr  in_jobStatusNotifier 
)
protected

Constructor.

Parameters
in_frequencyThe frequency at which job statuses should be polled.
in_jobRepositoryThe job repository, from which to look-up jobs.
in_jobStatusNotifierThe job status notifier to which to post job updates.

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