Class which represents an error response which can be sent to the Launcher in response to any request. More...

#include <Response.hpp>

Inheritance diagram for rstudio::launcher_plugins::api::ErrorResponse:

Public Types
enum	Type { INVALID_RESPONSE = -1, UNKNOWN = 0, REQUEST_NOT_SUPPORTED = 1, INVALID_REQUEST = 2, JOB_NOT_FOUND = 3, PLUGIN_RESTARTED = 4, TIMEOUT = 5, JOB_NOT_RUNNING = 6, JOB_OUTPUT_NOT_FOUND = 7, INVALID_JOB_STATE = 8, JOB_CONTROL_FAILURE = 9, UNSUPPORTED_VERSION = 10 }

Public Member Functions
	ErrorResponse (uint64_t in_requestId, Type in_errorType, std::string in_errorMessage)
	Constructor. More...

json::Object	toJson () const override
	Converts this error response 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.

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 }

Protected Member Functions inherited from rstudio::launcher_plugins::api::Response
	Response (Type in_responseType, uint64_t in_requestId)
	Constructor. More...

Detailed Description

Class which represents an error response which can be sent to the Launcher in response to any request.

Constructor & Destructor Documentation

rstudio::launcher_plugins::api::ErrorResponse::ErrorResponse	(	uint64_t	in_requestId,
		Type	in_errorType,
		std::string	in_errorMessage
	)

Constructor.

Parameters

in_requestId	The ID of the request for which this error is being returned.
in_errorType	The type of error which occurred while processing the request.
in_errorMessage	A message describing the details of the error.

json::Object rstudio::launcher_plugins::api::ErrorResponse::toJson ( ) const

overridevirtual

Converts this error response to a JSON object.

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