Inheritance diagram for rstudio::launcher_plugins::api::AbstractTimedResourceStream:
Public Member Functions | |
| virtual | ~AbstractTimedResourceStream () |
| Virtual destructor. | |
| Error | initialize () override |
| Initializes the timed resource utilization stream. More... | |
 Public Member Functions inherited from rstudio::launcher_plugins::api::AbstractResourceStream | |
| virtual | ~AbstractResourceStream ()=default |
| Virtual destructor for inheritance. | |
| void | addRequest (uint64_t in_requestId, const system::User &in_requestUser) override |
| Adds a request to the stream. More... | |
| void | setStreamComplete () |
| Notifies that the data stream has completed. More... | |
| Public Member Functions inherited from rstudio::launcher_plugins::api::AbstractMultiStream< ResourceUtilStreamResponse, ResourceUtilData, bool > | |
| AbstractMultiStream (comms::AbstractLauncherCommunicatorPtr in_launcherCommunicator) | |
| Constructor. More... | |
| bool | isEmpty () const |
| Checks whether there are any requests listening to this stream. More... | |
| virtual void | removeRequest (uint64_t in_requestId) |
| Removes a request from the multi-stream response. More... | |
| 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 | |
| AbstractTimedResourceStream (system::TimeDuration in_frequency, const ConstJobPtr &in_job, comms::AbstractLauncherCommunicatorPtr in_launcherCommunicator) | |
| Constructor. More... | |
| Protected Member Functions inherited from rstudio::launcher_plugins::api::AbstractResourceStream | |
| AbstractResourceStream (const ConstJobPtr &in_job, comms::AbstractLauncherCommunicatorPtr in_launcherCommunicator) | |
| Constructor. More... | |
| void | reportData (const ResourceUtilData &in_data) |
| Reports resource utilization data to the Launcher. More... | |
| void | reportError (const Error &in_error) |
| Reports an error to the Launcher. More... | |
| Protected Member Functions inherited from rstudio::launcher_plugins::api::AbstractMultiStream< ResourceUtilStreamResponse, ResourceUtilData, bool > | |
| void | onAddRequest (uint64_t in_requestId) |
| Adds a new request ID to the multi-stream response. More... | |
| void | onRemoveRequest (uint64_t in_requestId) |
| Removes a request from the multi-stream response. More... | |
| void | sendResponse (Args... in_responseArgs) |
| Sends a response to the Launcher for all requests. More... | |
| void | sendResponse (const std::set< uint64_t > &in_requestIds, Args... in_responseArgs) |
| Sends a response to the Launcher for the specified requests. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from rstudio::launcher_plugins::api::AbstractResourceStream | |
| const ConstJobPtr | m_job |
| The job for which resource utilization metrics should be streamed. More... | |
| Protected Attributes inherited from rstudio::launcher_plugins::api::AbstractMultiStream< ResourceUtilStreamResponse, ResourceUtilData, bool > | |
| std::mutex | m_mutex |
Constructor & Destructor Documentation
◆ AbstractTimedResourceStream()
|
protected |
Constructor.
- Parameters
-
in_frequency The frequency at which job resource utilization metrics should be polled. in_job The job for which resource utilization metrics should be streamed. in_launcherCommunicator The communicator through which messages may be sent to the launcher.
Member Function Documentation
◆ initialize()
|
overridevirtual |
Initializes the timed resource utilization stream.
Implements rstudio::launcher_plugins::api::AbstractResourceStream.
The documentation for this class was generated from the following file:
- /var/lib/jenkins/workspace/IDE/launcher-plugin-sdk/master/sdk/include/api/stream/AbstractTimedResourceStream.hpp
