Move set/reset_request into protocol_http.

Author: evoskuil

Makefile.am

@@ -71,6 +71,7 @@ src_libbitcoin_node_la_SOURCES = \
     src/protocols/protocol_header_out_31800.cpp \
     src/protocols/protocol_header_out_70012.cpp \
     src/protocols/protocol_html.cpp \
+    src/protocols/protocol_http.cpp \
     src/protocols/protocol_observer.cpp \
     src/protocols/protocol_peer.cpp \
     src/protocols/protocol_performer.cpp \

builds/cmake/CMakeLists.txt

@@ -283,6 +283,7 @@ add_library( ${CANONICAL_LIB_NAME}
     "../../src/protocols/protocol_header_out_31800.cpp"
     "../../src/protocols/protocol_header_out_70012.cpp"
     "../../src/protocols/protocol_html.cpp"
+    "../../src/protocols/protocol_http.cpp"
     "../../src/protocols/protocol_observer.cpp"
     "../../src/protocols/protocol_peer.cpp"
     "../../src/protocols/protocol_performer.cpp"

builds/msvc/vs2022/libbitcoin-node/libbitcoin-node.vcxproj

@@ -156,6 +156,7 @@
     <ClCompile Include="..\..\..\..\src\protocols\protocol_header_out_31800.cpp" />
     <ClCompile Include="..\..\..\..\src\protocols\protocol_header_out_70012.cpp" />
     <ClCompile Include="..\..\..\..\src\protocols\protocol_html.cpp" />
+    <ClCompile Include="..\..\..\..\src\protocols\protocol_http.cpp" />
     <ClCompile Include="..\..\..\..\src\protocols\protocol_observer.cpp" />
     <ClCompile Include="..\..\..\..\src\protocols\protocol_peer.cpp" />
     <ClCompile Include="..\..\..\..\src\protocols\protocol_performer.cpp" />

builds/msvc/vs2022/libbitcoin-node/libbitcoin-node.vcxproj.filters

@@ -168,6 +168,9 @@
     <ClCompile Include="..\..\..\..\src\protocols\protocol_html.cpp">
       <Filter>src\protocols</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\..\..\src\protocols\protocol_http.cpp">
+      <Filter>src\protocols</Filter>
+    </ClCompile>
     <ClCompile Include="..\..\..\..\src\protocols\protocol_observer.cpp">
       <Filter>src\protocols</Filter>
     </ClCompile>

include/bitcoin/node/protocols/protocol_bitcoind_rpc.hpp

@@ -30,17 +30,22 @@ namespace node {
 
 class BCN_API protocol_bitcoind_rpc
   : public node::protocol_http,
+    public network::protocol_http,
     protected network::tracker<protocol_bitcoind_rpc>
 {
 public:
+    // Replace base class channel_t (network::channel_http). 
+    using channel_t = node::channel_http;
+
     typedef std::shared_ptr<protocol_bitcoind_rpc> ptr;
     using rpc_interface = interface::bitcoind_rpc;
     using rpc_dispatcher = network::rpc::dispatcher<rpc_interface>;
 
     inline protocol_bitcoind_rpc(const auto& session,
         const network::channel::ptr& channel,
         const options_t& options) NOEXCEPT
-      : node::protocol_http(session, channel, options),
+      : node::protocol_http(session, channel),
+        network::protocol_http(session, channel, options),
         network::tracker<protocol_bitcoind_rpc>(session->log)
     {
     }
@@ -59,10 +64,6 @@ class BCN_API protocol_bitcoind_rpc
     void handle_receive_post(const code& ec,
         const post::cptr& post) NOEXCEPT override;
 
-    // Provide the request for serialization, keeping it out of dispatch.
-    void set_request(const network::http::request_cptr& request) NOEXCEPT;
-    const network::http::request& get_request() const NOEXCEPT;
-
     /// Handlers.
     bool handle_get_best_block_hash(const code& ec,
         rpc_interface::get_best_block_hash) NOEXCEPT;
@@ -113,12 +114,8 @@ class BCN_API protocol_bitcoind_rpc
     // Send the response.
     void send_json(boost::json::value&& model, size_t size_hint) NOEXCEPT;
 
-    // This is thread safe.
-    ////const options_t& options_;
-
-    // These are protected by strand.
+    // This is protected by strand.
     rpc_dispatcher rpc_dispatcher_{};
-    network::http::request_cptr request_{};
 };
 
 } // namespace node

include/bitcoin/node/protocols/protocol_html.hpp

@@ -21,7 +21,7 @@
 
 #include <bitcoin/node/channels/channels.hpp>
 #include <bitcoin/node/define.hpp>
-#include <bitcoin/node/protocols/protocol.hpp>
+#include <bitcoin/node/protocols/protocol_http.hpp>
 #include <bitcoin/node/settings.hpp>
 
 namespace libbitcoin {
@@ -32,7 +32,7 @@ namespace node {
 /// derives from protocol_http (as required). So any html server is able to
 /// operate as a websocket server.
 class BCN_API protocol_html
-  : public node::protocol,
+  : public node::protocol_http,
     public network::protocol_ws,
     protected network::tracker<protocol_html>
 {
@@ -44,7 +44,7 @@ class BCN_API protocol_html
     inline protocol_html(const auto& session,
         const network::channel::ptr& channel,
         const options_t& options) NOEXCEPT
-      : node::protocol(session, channel),
+      : node::protocol_http(session, channel),
         network::protocol_ws(session, channel, options),
         options_(options),
         network::tracker<protocol_html>(session->log)

include/bitcoin/node/protocols/protocol_http.hpp

@@ -24,38 +24,29 @@
 #include <bitcoin/node/define.hpp>
 #include <bitcoin/node/protocols/protocol.hpp>
 
- // Only session.hpp.
-#include <bitcoin/node/sessions/session.hpp>
-
 namespace libbitcoin {
 namespace node {
 
 /// Abstract base for HTTP protocols, thread safe.
 class BCN_API protocol_http
-  : public node::protocol,
-    public network::protocol_http
+  : public node::protocol
 {
-public:
-    // Replace base class channel_t (network::channel_http). 
-    using channel_t = node::channel_http;
-
 protected:
     inline protocol_http(const auto& session,
-        const network::channel::ptr& channel,
-        const options_t& options) NOEXCEPT
-      : node::protocol(session, channel),
-        network::protocol_http(session, channel, options),
-        channel_(std::static_pointer_cast<node::channel_tcp>(channel)),
-        session_(session)
+        const network::channel::ptr& channel) NOEXCEPT
+      : node::protocol(session, channel)
     {
     }
 
-private:
-    // This derived channel requires stranded calls, base is thread safe.
-    const node::channel_tcp::ptr channel_;
+    /// Cache request for serialization (requires strand).
+    void set_request(const network::http::request_cptr& request) NOEXCEPT;
 
-    // This is thread safe.
-    const node::session::ptr session_;
+    /// Obtain cached request and clear cache (requires strand).
+    network::http::request_cptr reset_request() NOEXCEPT;
+
+private:
+    // This is protected by strand.
+    network::http::request_cptr request_{};
 };
 
 } // namespace node

src/protocols/protocol_bitcoind_rpc.cpp

@@ -67,14 +67,14 @@ void protocol_bitcoind_rpc::start() NOEXCEPT
     SUBSCRIBE_BITCOIND(handle_scan_tx_out_set, _1, _2, _3, _4);
     SUBSCRIBE_BITCOIND(handle_verify_chain, _1, _2, _3, _4);
     SUBSCRIBE_BITCOIND(handle_verify_tx_out_set, _1, _2, _3);
-    protocol_http::start();
+    network::protocol_http::start();
 }
 
 void protocol_bitcoind_rpc::stopping(const code& ec) NOEXCEPT
 {
     BC_ASSERT(stranded());
     rpc_dispatcher_.stop(ec);
-    protocol_http::stopping(ec);
+    network::protocol_http::stopping(ec);
 }
 
 // Dispatch.
@@ -299,29 +299,17 @@ void protocol_bitcoind_rpc::send_json(boost::json::value&& model,
     size_t size_hint) NOEXCEPT
 {
     BC_ASSERT(stranded());
-    const auto& request = get_request();
+    const auto request = reset_request();
     constexpr auto json = media_type::application_json;
-    response response{ status::ok, request.version() };
-    add_common_headers(response, request);
-    add_access_control_headers(response, request);
+    response response{ status::ok, request->version() };
+    add_common_headers(response, *request);
+    add_access_control_headers(response, *request);
     response.set(field::content_type, from_media_type(json));
     response.body() = { std::move(model), size_hint };
     response.prepare_payload();
     SEND(std::move(response), handle_complete, _1, error::success);
 }
 
-void protocol_bitcoind_rpc::set_request(const request_cptr& request) NOEXCEPT
-{
-    BC_ASSERT(request);
-    request_ = request;
-}
-
-const request& protocol_bitcoind_rpc::get_request() const NOEXCEPT
-{
-    BC_ASSERT(request_);
-    return *request_;
-}
-
 BC_POP_WARNING()
 BC_POP_WARNING()
 BC_POP_WARNING()

src/protocols/protocol_http.cpp

@@ -0,0 +1,53 @@
+/**
+ * Copyright (c) 2011-2025 libbitcoin developers (see AUTHORS)
+ *
+ * This file is part of libbitcoin.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include <bitcoin/node/protocols/protocol_http.hpp>
+
+#include <bitcoin/node/define.hpp>
+
+namespace libbitcoin {
+namespace node {
+
+using namespace network::http;
+
+// Cache request for serialization, keeping it out of dispatch.
+void protocol_http::set_request(const request_cptr& request) NOEXCEPT
+{
+    ////BC_ASSERT(stranded());
+    BC_ASSERT(request);
+    request_ = request;
+}
+
+// Returns default if not set, for safety (asserts correctness).
+request_cptr protocol_http::reset_request() NOEXCEPT
+{
+    ////BC_ASSERT(stranded());
+    BC_ASSERT(request_);
+
+    if (request_)
+    {
+        auto copy = request_;
+        request_.reset();
+        return copy;
+    }
+
+    return system::to_shared<request>();
+}
+
+} // namespace node
+} // namespace libbitcoin