AbstractLauncherCommunicator.hpp

/*
 * AbstractLauncherCommunicator.hpp
 *
 * Copyright (C) 2020 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_ABSTRACT_COMMUNICATOR_HPP
#define LAUNCHER_PLUGINS_ABSTRACT_COMMUNICATOR_HPP
 
#include <Noncopyable.hpp>
 
#include <utils/Functionals.hpp>
 
namespace rstudio {
namespace launcher_plugins {
 
class Error;
 
namespace api {
 
class Request;
class Response;
 
} // namespace api
} // namespace launcher_plugins
} // namespace rstudio
 
namespace rstudio {
namespace launcher_plugins {
namespace comms {
 
typedef std::function<void(const std::shared_ptr<api::Request>&)> RequestHandler;
 
class AbstractLauncherCommunicator : public Noncopyable,
                                     public std::enable_shared_from_this<AbstractLauncherCommunicator>
{
public:
   virtual ~AbstractLauncherCommunicator() = default;
 
   void registerRequestHandler(std::unique_ptr<RequestHandler>&& in_requestHandler);
 
   void sendResponse(const api::Response& in_response);
 
   virtual Error start();
 
   virtual void stop();
 
   virtual void waitForExit();
 
protected:
   AbstractLauncherCommunicator(size_t in_maxMessageSize, const OnError& in_onError);
 
    void reportError(const Error& in_error);
 
   void onDataReceived(const char* in_data, size_t in_length);
 
protected:
   template <typename Derived>
   std::shared_ptr<Derived> shared_from_derived()
   {
      static_assert(
         std::is_base_of<AbstractLauncherCommunicator, Derived>::value,
         "Derived must inherit from AbstractLauncherCommunicator");
 
      return std::static_pointer_cast<Derived>(shared_from_this());
   }
 
 
private:
   virtual void writeResponse(const std::string& in_responseMessage) = 0;
 
   // The private implementation of AbstractLauncherCommunicator.
   PRIVATE_IMPL(m_baseImpl);
};
 
typedef std::shared_ptr<AbstractLauncherCommunicator> AbstractLauncherCommunicatorPtr;
 
} // namespace comms
} // namespace launcher_plugins
} // namespace rstudio
 
#endif