Response.hpp

/*
 * Response.hpp
 *
 * Copyright (C) 2019-20 by RStudio, PBC
 *
 * Unless you have received this program directly from RStudio pursuant to the terms of a commercial license agreement
 * with RStudio, then this program is licensed to you under the following terms:
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */
 
 
#ifndef LAUNCHER_PLUGINS_RESPONSE_HPP
#define LAUNCHER_PLUGINS_RESPONSE_HPP
 
#include <Noncopyable.hpp>
 
#include <vector>
 
#include <PImpl.hpp>
#include <api/Job.hpp>
#include <api/ResponseTypes.hpp>
#include <api/stream/AbstractOutputStream.hpp>
 
namespace rstudio {
namespace launcher_plugins {
namespace json {
 
class Object;
 
} // namespace json
} // namespace launcher_plugins
} // namespace rstudio
 
namespace rstudio {
namespace launcher_plugins {
namespace api {
 
struct JobSourceConfiguration;
 
class Response : public Noncopyable
{
public:
   virtual ~Response() = default;
 
   virtual json::Object toJson() const;
 
protected:
   enum class Type
   {
      ERROR                = -1,
 
      HEARTBEAT            = 0,
 
      BOOTSTRAP            = 1,
 
      JOB_STATE            = 2,
 
      JOB_STATUS           = 3,
 
      CONTROL_JOB          = 4,
 
      JOB_OUTPUT           = 5,
 
      JOB_RESOURCE_UTIL    = 6,
 
      JOB_NETWORK          = 7,
 
      CLUSTER_INFO         = 8,
   };
 
   Response(Type in_responseType, uint64_t in_requestId);
 
private:
   // The private implementation of Response.
   PRIVATE_IMPL(m_responseImpl);
};
 
class MultiStreamResponse : public Response
{
public:
   json::Object toJson() const override;
 
protected:
   MultiStreamResponse(Type in_responseType, StreamSequences in_sequences);
 
private:
   // The private implementation of MultiStreamResponse
   PRIVATE_IMPL(m_streamResponseImpl);
};
 
class ErrorResponse final : public Response
{
public:
   enum class 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,
   };
 
   ErrorResponse(uint64_t in_requestId, Type in_errorType, std::string in_errorMessage);
 
   json::Object toJson() const override;
 
private:
   // The private implementation of ErrorResponse.
   PRIVATE_IMPL(m_impl);
};
 
class HeartbeatResponse final : public Response
{
public:
   HeartbeatResponse();
};
 
class BootstrapResponse final : public Response
{
public:
   explicit BootstrapResponse(uint64_t in_requestId);
 
   json::Object toJson() const override;
};
 
class JobStateResponse final : public Response
{
public:
   JobStateResponse(
      uint64_t in_requestId,
      JobList in_jobs,
      Optional<std::set<std::string> > in_jobFields = Optional<std::set<std::string> >());
 
   json::Object toJson() const override;
 
private:
   // The private implementation of ClusterInfoResponse
   PRIVATE_IMPL(m_impl);
};
 
class JobStatusResponse final : public MultiStreamResponse
{
public:
   JobStatusResponse(StreamSequences in_sequences, const JobPtr& in_job);
 
   json::Object toJson() const override;
 
private:
   // The private implementation of JobStatusResponse.
   PRIVATE_IMPL(m_impl);
};
 
class ControlJobResponse final : public Response
{
public:
   ControlJobResponse(uint64_t in_requestId, std::string in_statusMessage, bool in_isComplete);
 
 
   json::Object toJson() const override;
 
private:
   // The private implementation of ControlJobResponse
   PRIVATE_IMPL(m_impl);
};
 
class OutputStreamResponse final : public Response
{
public:
   OutputStreamResponse(
      uint64_t in_requestId,
      uint64_t in_sequenceId,
      std::string in_output,
      OutputType in_outputType);
 
   OutputStreamResponse(
      uint64_t in_requestId,
      uint64_t in_sequenceId);
 
   json::Object toJson() const override;
 
private:
   // The private implementation of OutputStreamResponse
   PRIVATE_IMPL(m_impl);
};
 
class ResourceUtilStreamResponse : public MultiStreamResponse
{
public:
   ResourceUtilStreamResponse(
      StreamSequences in_sequences,
      const ResourceUtilData& in_resourceData,
      bool in_isComplete);
 
   json::Object toJson() const override;
 
private:
   // The private implementation of ResourceUtilStreamResponse
   PRIVATE_IMPL(m_impl);
};
 
class NetworkResponse final : public Response
{
public:
   NetworkResponse(uint64_t in_requestId, NetworkInfo in_networkInfo);
   json::Object toJson() const override;
 
private:
   // The private implementation of NetworkResponse
   PRIVATE_IMPL(m_impl);
};
 
 class ClusterInfoResponse final : public Response
 {
 public:
    ClusterInfoResponse(uint64_t in_requestId, const JobSourceConfiguration& in_configuration);
 
    json::Object toJson() const override;
 
 private:
    // The private implementation of ClusterInfoResponse
    PRIVATE_IMPL(m_impl);
};
 
} // namespace api
} // namespace launcher_plugins
} // namespace rstudio
 
#endif