Represents the common components of all responses which can be sent the RStudio Launcher. More...
#include <Response.hpp>
Public Member Functions | |
| virtual | ~Response ()=default |
| Virtual destructor to allow for inheritance. | |
| virtual json::Object | toJson () const |
| Converts this response to a JSON object. 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 Types | |
| 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 } |
Protected Member Functions | |
| Response (Type in_responseType, uint64_t in_requestId) | |
| Constructor. More... | |
Detailed Description
Represents the common components of all responses which can be sent the RStudio Launcher.
Member Enumeration Documentation
◆ Type
|
strongprotected |
| Enumerator | |
|---|---|
| ERROR | Error response |
| HEARTBEAT | Heartbeat response |
| BOOTSTRAP | Bootstrap response |
| JOB_STATE | Job State response |
| JOB_STATUS | Job Status response |
| CONTROL_JOB | Control Job response |
| JOB_OUTPUT | Control Job output response |
| JOB_RESOURCE_UTIL | Job Resource utilization response |
| JOB_NETWORK | Job Network information response |
| CLUSTER_INFO | Cluster Info response |
Constructor & Destructor Documentation
◆ Response()
|
protected |
Constructor.
- Parameters
-
in_responseType The type of response to be constructed. in_requestId The ID of the request for which this response is being sent.
Member Function Documentation
◆ toJson()
|
virtual |
Converts this response to a JSON object.
- Returns
- The JSON object which represents this response.
Reimplemented in rstudio::launcher_plugins::api::ClusterInfoResponse, rstudio::launcher_plugins::api::NetworkResponse, rstudio::launcher_plugins::api::ResourceUtilStreamResponse, rstudio::launcher_plugins::api::OutputStreamResponse, rstudio::launcher_plugins::api::ControlJobResponse, rstudio::launcher_plugins::api::JobStatusResponse, rstudio::launcher_plugins::api::JobStateResponse, rstudio::launcher_plugins::api::BootstrapResponse, rstudio::launcher_plugins::api::ErrorResponse, and rstudio::launcher_plugins::api::MultiStreamResponse.
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
