RStudio Launcher Plugin SDK  1.1.3
A software development kit for creating plugins that work the the RStudio Launcher.
Public Member Functions | Protected Types | Protected Member Functions | List of all members
rstudio::launcher_plugins::api::Response Class Reference

Represents the common components of all responses which can be sent the RStudio Launcher. More...

#include <Response.hpp>

Inheritance diagram for rstudio::launcher_plugins::api::Response:
rstudio::launcher_plugins::Noncopyable rstudio::launcher_plugins::api::BootstrapResponse rstudio::launcher_plugins::api::ClusterInfoResponse rstudio::launcher_plugins::api::ControlJobResponse rstudio::launcher_plugins::api::ErrorResponse rstudio::launcher_plugins::api::HeartbeatResponse rstudio::launcher_plugins::api::JobStateResponse rstudio::launcher_plugins::api::MultiStreamResponse rstudio::launcher_plugins::api::NetworkResponse rstudio::launcher_plugins::api::OutputStreamResponse

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.
 
Noncopyableoperator= (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

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()

rstudio::launcher_plugins::api::Response::Response ( Type  in_responseType,
uint64_t  in_requestId 
)
protected

Constructor.

Parameters
in_responseTypeThe type of response to be constructed.
in_requestIdThe ID of the request for which this response is being sent.

Member Function Documentation

◆ toJson()

virtual json::Object rstudio::launcher_plugins::api::Response::toJson ( ) const
virtual

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