Asio.hpp

/*
 * AsioService.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_ASIO_HPP
#define LAUNCHER_PLUGINS_ASIO_HPP
 
#include <Noncopyable.hpp>
 
#include <functional>
 
#include <PImpl.hpp>
#include <utils/Functionals.hpp>
 
namespace rstudio {
namespace launcher_plugins {
namespace system {
 
// Forward declarations
class DateTime;
class TimeDuration;
 
typedef std::function<void()> AsioFunction;
 
typedef std::function<void(const char*, size_t)> OnReadBytes;
 
typedef std::function<void(int)> OnSignal;
 
class AsioService final : public Noncopyable
{
public:
 
   static void post(const AsioFunction& in_work);
 
   static void setSignalHandler(const OnSignal& in_onSignal);
 
   static void startThreads(size_t in_numThreads);
 
   static void stop();
 
   /*
    * @brief Waits for the ASIO service to exit.
    */
   static void waitForExit();
 
private:
   AsioService();
 
   static AsioService& getAsioService();
 
   // Private implementation of AsioService.
   PRIVATE_IMPL_SHARED(m_impl);
};
 
class AsioStream final
{
public:
   explicit AsioStream(int in_streamHandle);
 
   ~AsioStream() noexcept;
 
   void close() noexcept;
 
   void readBytes(const OnReadBytes& in_onReadBytes, const OnError& in_onError);
 
   void writeBytes(
      const std::string& in_data,
      const OnError& in_onError,
      const AsioFunction& in_onFinishedWriting = AsioFunction());
 
private:
   // The private implementation of AsioStream.
   PRIVATE_IMPL_SHARED(m_impl);
};
 
class AsyncTimedEvent final
{
public:
   AsyncTimedEvent();
 
   void start(const TimeDuration& in_timeDuration, const AsioFunction& in_event);
 
   void cancel();
 
   void reportError(const Error& in_error);
 
private:
 
   // The private implementation of AsyncTimedEvent.
   PRIVATE_IMPL_SHARED(m_impl);
};
 
class AsyncDeadlineEvent final
{
public:
   AsyncDeadlineEvent(const AsioFunction& in_work, const DateTime& in_deadlineTime);
   AsyncDeadlineEvent(const AsioFunction& in_work, const TimeDuration& in_waitTime);
 
   ~AsyncDeadlineEvent();
 
   void cancel();
 
   void start();
 
private:
   // The private implementation of AsioDeadlineEvent.
   PRIVATE_IMPL_SHARED(m_impl);
};
 
} // namespace system
} // namespace launcher_plugins
} // namespace rstudio
 
#endif