RStudio Launcher Plugin SDK  1.1.3
A software development kit for creating plugins that work the the RStudio Launcher.
AbstractTimedResourceStream.hpp
1 /*
2  * AbstractTimedResourceStream.hpp
3  *
4  * Copyright (C) 2020 by RStudio, PBC
5  *
6  * Unless you have received this program directly from RStudio pursuant to the terms of a commercial license agreement
7  * with RStudio, then this program is licensed to you under the following terms:
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
10  * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
11  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
12  * permit persons to whom the Software is furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
15  * Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
18  * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21  *
22  */
23 
24 #ifndef LAUNCHER_PLUGINS_ABSTRACT_TIMED_RESOURCE_STREAM_HPP
25 #define LAUNCHER_PLUGINS_ABSTRACT_TIMED_RESOURCE_STREAM_HPP
26 
27 #include <api/stream/AbstractResourceStream.hpp>
28 
29 #include <memory>
30 
31 #include <PImpl.hpp>
32 #include <system/DateTime.hpp>
33 
34 namespace rstudio {
35 namespace launcher_plugins {
36 namespace api {
37 
40  public std::enable_shared_from_this<AbstractTimedResourceStream>
41 {
42 public:
47 
53  Error initialize() override;
54 
55 protected:
64  system::TimeDuration in_frequency,
65  const ConstJobPtr& in_job,
66  comms::AbstractLauncherCommunicatorPtr in_launcherCommunicator);
67 
68 private:
75  virtual Error onInitialize();
76 
86  virtual Error pollResourceUtilData(ResourceUtilData& out_data) = 0;
87 
88  PRIVATE_IMPL(m_timedBaseImpl);
89 };
90 
91 } // namespace api
92 } // namespace launcher_plugins
93 } // namespace rstudio
94 
95 #endif
rstudio::launcher_plugins::api::AbstractTimedResourceStream::initialize
Error initialize() override
Initializes the timed resource utilization stream.
rstudio::launcher_plugins::api::AbstractResourceStream
Streams job resource utilization data to the Launcher.
Definition: AbstractResourceStream.hpp:42
rstudio::launcher_plugins::api::ResourceUtilData
Represents the current resource utilization of a job.
Definition: ResponseTypes.hpp:111
rstudio::launcher_plugins::api::AbstractTimedResourceStream::AbstractTimedResourceStream
AbstractTimedResourceStream(system::TimeDuration in_frequency, const ConstJobPtr &in_job, comms::AbstractLauncherCommunicatorPtr in_launcherCommunicator)
Constructor.
rstudio::launcher_plugins::Error
Class which represents an error.
Definition: Error.hpp:174
rstudio::launcher_plugins::system::TimeDuration
Represents an duration of time (e.g. 5 hours, 43 minutes, and 21 seconds) as opposed to a point in ti...
Definition: DateTime.hpp:48
rstudio::launcher_plugins::api::AbstractTimedResourceStream
Definition: AbstractTimedResourceStream.hpp:38
rstudio::launcher_plugins::api::AbstractTimedResourceStream::~AbstractTimedResourceStream
virtual ~AbstractTimedResourceStream()
Virtual destructor.