Manages posting job status updates to the notifier. More...

Inheritance diagram for rstudio::launcher_plugins::jobs::AbstractJobStatusWatcher:

Public Member Functions
virtual	~AbstractJobStatusWatcher ()=default
	Virtual destructor for inheritance.

virtual Error	start ()=0
	Starts the job status watcher.

virtual void	stop ()=0
	Stops the job status watcher.

Public Member Functions inherited from rstudio::launcher_plugins::Noncopyable
	Noncopyable ()=default
	Default constructor.

	Noncopyable (const Noncopyable &)=delete
	Deleted copy constructor.

Noncopyable &	operator= (const Noncopyable &)=delete
	Deleted assignment operator.

Protected Member Functions
	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

Manages posting job status updates to the notifier.

Constructor & Destructor Documentation

rstudio::launcher_plugins::jobs::AbstractJobStatusWatcher::AbstractJobStatusWatcher	(	JobRepositoryPtr	in_jobRepository,
		JobStatusNotifierPtr	in_jobStatusNotifier
	)

protected

Constructor.

Parameters

in_jobRepository	The job repository, from which to look-up jobs.
in_jobStatusNotifier	The job status notifier to which to post job updates.

Error rstudio::launcher_plugins::jobs::AbstractJobStatusWatcher::updateJobStatus	(	const std::string &	in_jobId,
		api::Job::State	in_newStatus,
		const std::string &	in_statusMessage = `""`,
		const system::DateTime &	in_invocationTime = `system::DateTime()`
	)

protected

Updates the job status for the specified job.

Attempts to look up the job in the repository. If the job cannot be found getJobDetails(...) will be invoked.

Parameters

in_jobId	The ID of the job which should be updated.
in_newStatus	The new status of the job.
in_statusMessage	The new status message of the job, if any.
in_invocationTime	The time at which the job was updated, if different from now.

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

/var/lib/jenkins/workspace/IDE/launcher-plugin-sdk/master/sdk/include/jobs/AbstractJobStatusWatcher.hpp