Add concurrency model with uv loops

CMakeLists.txt

@@ -73,8 +73,8 @@ endif()
 
 message(STATUS "XEUS_ZMQ_BUILD_SHARED_LIBS:          ${XEUS_ZMQ_BUILD_SHARED_LIBS}")
 message(STATUS "XEUS_ZMQ_BUILD_STATIC_LIBS:          ${XEUS_ZMQ_BUILD_STATIC_LIBS}")
-message(STATUS "XEUS_ZMQ_STATIC_DEPENDENCIES:        ${XEUS_ZMQ_STATIC_DEPENDENCIES}")  
-message(STATUS "XEUS_ZMQ_BUILD_TESTS:                ${XEUS_ZMQ_BUILD_TESTS}")  
+message(STATUS "XEUS_ZMQ_STATIC_DEPENDENCIES:        ${XEUS_ZMQ_STATIC_DEPENDENCIES}")
+message(STATUS "XEUS_ZMQ_BUILD_TESTS:                ${XEUS_ZMQ_BUILD_TESTS}")
 
 # Dependencies
 # ============
@@ -122,6 +122,9 @@ endif ()
 
 find_package(OpenSSL REQUIRED)
 
+find_library(UVW_LIBRARY uvw)
+find_path(UVW_INCLUDE_DIR uvw.hpp)
+
 # Source files
 # ============
 
@@ -134,6 +137,7 @@ set(XEUS_ZMQ_HEADERS
     ${XEUS_ZMQ_INCLUDE_DIR}/xeus-zmq/xserver_zmq.hpp
     ${XEUS_ZMQ_INCLUDE_DIR}/xeus-zmq/xthread.hpp
     ${XEUS_ZMQ_INCLUDE_DIR}/xeus-zmq/xzmq_context.hpp
+    ${XEUS_ZMQ_INCLUDE_DIR}/xeus-zmq/xhook_base.hpp
 )
 
 set(XEUS_ZMQ_SOURCES
@@ -175,15 +179,20 @@ set(XEUS_ZMQ_SOURCES
     ${XEUS_ZMQ_SOURCE_DIR}/xserver_zmq_split.cpp
     ${XEUS_ZMQ_SOURCE_DIR}/xserver_zmq_split.hpp
     ${XEUS_ZMQ_SOURCE_DIR}/xserver_zmq.cpp
-    ${XEUS_ZMQ_SOURCE_DIR}/xshell.hpp
-    ${XEUS_ZMQ_SOURCE_DIR}/xshell.cpp
+    ${XEUS_ZMQ_SOURCE_DIR}/xshell_base.hpp
+    ${XEUS_ZMQ_SOURCE_DIR}/xshell_base.cpp
+    ${XEUS_ZMQ_SOURCE_DIR}/xshell_default.hpp
+    ${XEUS_ZMQ_SOURCE_DIR}/xshell_default.cpp
+    ${XEUS_ZMQ_SOURCE_DIR}/xshell_uv.hpp
+    ${XEUS_ZMQ_SOURCE_DIR}/xshell_uv.cpp
     ${XEUS_ZMQ_SOURCE_DIR}/xtrivial_messenger.hpp
     ${XEUS_ZMQ_SOURCE_DIR}/xtrivial_messenger.cpp
     ${XEUS_ZMQ_SOURCE_DIR}/xzmq_context.cpp
     ${XEUS_ZMQ_SOURCE_DIR}/xzmq_messenger.hpp
     ${XEUS_ZMQ_SOURCE_DIR}/xzmq_messenger.cpp
     ${XEUS_ZMQ_SOURCE_DIR}/xzmq_serializer.cpp
     ${XEUS_ZMQ_SOURCE_DIR}/xzmq_serializer.hpp
+    ${XEUS_ZMQ_SOURCE_DIR}/xhook_base.cpp
 )
 
 # Targets and link
@@ -226,6 +235,7 @@ macro(xeus_zmq_create_target target_name linkage output_name)
         PUBLIC ${XEUS_TARGET_NAME}
         PRIVATE ${CPPZMQ_TARGET_NAME}
         PRIVATE OpenSSL::Crypto
+        PUBLIC ${UVW_LIBRARY}
     )
 
     if (NOT MSVC)
@@ -274,6 +284,7 @@ macro(xeus_zmq_create_target target_name linkage output_name)
     # =================
 
     target_compile_features(${target_name} PRIVATE cxx_std_17)
+    target_compile_definitions(${target_name} PUBLIC UVW_AS_LIB)
 
     if (CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR
         CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR

environment-dev.yml

@@ -13,9 +13,10 @@ dependencies:
   - cppzmq
   - xtl=0.7
   - xeus>=4.0.3,<5.0
-  - OpenSSL=1 
+  - OpenSSL=1
   - libopenssl-static=1
   - nlohmann_json=3.11.3
+  - libuvw
   # Test dependencies
   - doctest >= 2.4.6
   - pytest

include/xeus-zmq/xhook_base.hpp

@@ -0,0 +1,48 @@
+/***************************************************************************
+* Copyright (c) 2016, Johan Mabille, Sylvain Corlay, Martin Renou          *
+* Copyright (c) 2016, QuantStack                                           *
+*                                                                          *
+* Distributed under the terms of the BSD 3-Clause License.                 *
+*                                                                          *
+* The full license is in the file LICENSE, distributed with this software. *
+****************************************************************************/
+
+#ifndef XHOOK_BASE_HPP
+#define XHOOK_BASE_HPP
+
+#include "xeus-zmq.hpp"
+
+#include <uvw.hpp>
+
+namespace xeus
+{
+    class XEUS_ZMQ_API xhook_base
+    {
+    public:
+
+        virtual ~xhook_base() = default;
+
+        xhook_base(const xhook_base&) = delete;
+        xhook_base& operator=(const xhook_base&) = delete;
+
+        xhook_base(xhook_base&&) = delete;
+        xhook_base& operator=(xhook_base&&) = delete;
+
+        void pre_hook();
+        void post_hook();
+        void run(std::shared_ptr<uvw::loop> loop);
+
+    protected:
+
+        xhook_base() = default;
+
+    private:
+
+        virtual void pre_hook_impl() = 0;
+        virtual void post_hook_impl() = 0;
+        virtual void run_impl(std::shared_ptr<uvw::loop> loop);
+
+    };
+}
+
+#endif

include/xeus-zmq/xserver_zmq.hpp

@@ -10,11 +10,16 @@
 #ifndef XEUS_SERVER_ZMQ_HPP
 #define XEUS_SERVER_ZMQ_HPP
 
+#include <uvw.hpp>
+
+#include <memory>
+
 #include "xeus/xeus_context.hpp"
 #include "xeus/xkernel_configuration.hpp"
 #include "xeus/xserver.hpp"
 
 #include "xeus-zmq.hpp"
+#include "xhook_base.hpp"
 
 namespace xeus
 {
@@ -63,6 +68,15 @@ namespace xeus
     std::unique_ptr<xserver> make_xserver_shell_main(xcontext& context,
                                                      const xconfiguration& config,
                                                      nl::json::error_handler_t eh = nl::json::error_handler_t::strict);
+
+    XEUS_ZMQ_API
+    std::unique_ptr<xserver> make_xserver_uv_shell_main(
+        xcontext& context,
+        const xconfiguration& config,
+        nl::json::error_handler_t eh = nl::json::error_handler_t::strict,
+        std::shared_ptr<uvw::loop> loop_ptr = nullptr,
+        std::unique_ptr<xhook_base> hook = nullptr);
+
 }
 
 #endif

src/xhook_base.cpp

@@ -0,0 +1,35 @@
+/***************************************************************************
+* Copyright (c) 2016, Johan Mabille, Sylvain Corlay, Martin Renou          *
+* Copyright (c) 2016, QuantStack                                           *
+*                                                                          *
+* Distributed under the terms of the BSD 3-Clause License.                 *
+*                                                                          *
+* The full license is in the file LICENSE, distributed with this software. *
+****************************************************************************/
+
+#include "xeus-zmq/xhook_base.hpp"
+
+#include <uvw.hpp>
+
+namespace xeus
+{
+    void xhook_base::pre_hook()
+    {
+        pre_hook_impl();
+    }
+
+    void xhook_base::post_hook()
+    {
+        post_hook_impl();
+    }
+
+    void xhook_base::run(std::shared_ptr<uvw::loop> loop)
+    {
+        run_impl(loop);
+    }
+
+    void xhook_base::run_impl(std::shared_ptr<uvw::loop> loop)
+    {
+        loop->run();
+    }
+}

src/xserver_shell_main.cpp

@@ -11,11 +11,13 @@
 #include <chrono>
 #include <iostream>
 
+#include <uvw.hpp>
+
 #include "zmq_addon.hpp"
 #include "xeus/xguid.hpp"
 #include "xeus-zmq/xmiddleware.hpp"
 #include "xserver_shell_main.hpp"
-#include "xshell.hpp"
+#include "xshell_base.hpp"
 
 namespace xeus
 {
@@ -27,6 +29,15 @@ namespace xeus
     {
     }
 
+    xserver_shell_main::xserver_shell_main(zmq::context_t& context,
+                                           const xconfiguration& config,
+                                           nl::json::error_handler_t eh,
+                                           std::shared_ptr<uvw::loop> loop_ptr,
+                                           std::unique_ptr<xhook_base> hook)
+        : xserver_zmq_split(context, config, eh, loop_ptr, std::move(hook))
+    {
+    }
+
     xserver_shell_main::~xserver_shell_main()
     {
     }

src/xserver_shell_main.hpp

@@ -10,11 +10,14 @@
 #ifndef XEUS_SERVER_SHELL_MAIN_HPP
 #define XEUS_SERVER_SHELL_MAIN_HPP
 
+#include <uvw.hpp>
+
 #include "xeus/xeus_context.hpp"
 #include "xeus/xkernel_configuration.hpp"
 
 #include "xeus-zmq/xeus-zmq.hpp"
 #include "xserver_zmq_split.hpp"
+#include "xeus-zmq/xhook_base.hpp"
 
 namespace xeus
 {
@@ -25,6 +28,14 @@ namespace xeus
         xserver_shell_main(zmq::context_t& context,
                            const xconfiguration& config,
                            nl::json::error_handler_t he);
+
+
+        xserver_shell_main(zmq::context_t& context,
+                           const xconfiguration& config,
+                           nl::json::error_handler_t he,
+                           std::shared_ptr<uvw::loop> loop_ptr,
+                           std::unique_ptr<xhook_base> hook);
+
         virtual ~xserver_shell_main();
 
     private:

src/xserver_zmq.cpp

@@ -7,6 +7,10 @@
 * The full license is in the file LICENSE, distributed with this software. *
 ****************************************************************************/
 
+#include <memory>
+
+#include <uvw.hpp>
+
 #include "xeus-zmq/xserver_zmq.hpp"
 #include "xserver_zmq_impl.hpp"
 #include "xserver_zmq_default.hpp"
@@ -46,7 +50,7 @@ namespace xeus
     {
         return xserver::notify_internal_listener(std::move(msg));
     }
-    
+
     xcontrol_messenger& xserver_zmq::get_control_messenger_impl()
     {
         return p_impl->get_control_messenger();
@@ -93,8 +97,8 @@ namespace xeus
     }
 
     std::unique_ptr<xserver> make_xserver_default(xcontext& context,
-                                              const xconfiguration& config,
-                                              nl::json::error_handler_t eh)
+                                                  const xconfiguration& config,
+                                                  nl::json::error_handler_t eh)
     {
         auto impl = std::make_unique<xserver_zmq_default>(context.get_wrapped_context<zmq::context_t>(), config, eh);
         return std::make_unique<xserver_zmq>(std::move(impl));
@@ -115,4 +119,18 @@ namespace xeus
         auto impl = std::make_unique<xserver_shell_main>(context.get_wrapped_context<zmq::context_t>(), config, eh);
         return std::make_unique<xserver_zmq>(std::move(impl));
     }
+
+    // Since xkernel only accepts three arguments, it is recommended to create a lambda function which
+    // captures a loop pointer and a hook object pointer. For example:
+    // auto make_xserver = [&loop_ptr, &hook_ptr](context, config, eh){ return make_xserver_uv_shell_main(...); }
+    std::unique_ptr<xserver> make_xserver_uv_shell_main(xcontext& context,
+                                                        const xconfiguration& config,
+                                                        nl::json::error_handler_t eh,
+                                                        std::shared_ptr<uvw::loop> loop_ptr,
+                                                        std::unique_ptr<xhook_base> hook)
+    {
+        auto impl = std::make_unique<xserver_shell_main>(
+            context.get_wrapped_context<zmq::context_t>(), config, eh, loop_ptr, std::move(hook));
+        return std::make_unique<xserver_zmq>(std::move(impl));
+    }
 }