Base class for responses which are returned to multiple stream requests. More...
#include <Response.hpp>
Inheritance diagram for rstudio::launcher_plugins::api::MultiStreamResponse:
Public Member Functions | |
| json::Object | toJson () const override |
| Converts this MultiStreamResponse to a JSON object. More... | |
 Public Member Functions inherited from rstudio::launcher_plugins::api::Response | |
| virtual | ~Response ()=default |
| Virtual destructor to allow for inheritance. | |
| 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 | |
| MultiStreamResponse (Type in_responseType, StreamSequences in_sequences) | |
| Constructor. More... | |
| Protected Member Functions inherited from rstudio::launcher_plugins::api::Response | |
| Response (Type in_responseType, uint64_t in_requestId) | |
| Constructor. More... | |
Additional Inherited Members | |
| Protected Types inherited from rstudio::launcher_plugins::api::Response | |
| enum | Type { Type::ERROR = -1, Type::HEARTBEAT = 0, Type::BOOTSTRAP = 1, Type::JOB_STATE = 2, Type::JOB_STATUS = 3, Type::CONTROL_JOB = 4, Type::JOB_OUTPUT = 5, Type::JOB_RESOURCE_UTIL = 6, Type::JOB_NETWORK = 7, Type::CLUSTER_INFO = 8 } |
Detailed Description
Base class for responses which are returned to multiple stream requests.
Constructor & Destructor Documentation
◆ MultiStreamResponse()
|
protected |
Constructor.
- Parameters
-
in_responseType The type of the base class. in_sequences The sequence IDs for which this response should be sent.
Member Function Documentation
◆ toJson()
|
overridevirtual |
Converts this MultiStreamResponse to a JSON object.
- Returns
- The JSON object which represents this MultiStreamResponse.
Reimplemented from rstudio::launcher_plugins::api::Response.
Reimplemented in rstudio::launcher_plugins::api::ResourceUtilStreamResponse, and rstudio::launcher_plugins::api::JobStatusResponse.
The documentation for this class was generated from the following file:
- /var/lib/jenkins/workspace/IDE/launcher-plugin-sdk/master/sdk/include/api/Response.hpp
