/* Copyright (c) 2018-2025 Marcelo Zimbres Silva (mzimbres@gmail.com), * Ruben Perez Hidalgo (rubenperez038 at gmail dot com) * * Distributed under the Boost Software License, Version 1.0. (See * accompanying file LICENSE.txt) */ #ifndef BOOST_REDIS_REDIS_STREAM_HPP #define BOOST_REDIS_REDIS_STREAM_HPP #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace boost { namespace redis { namespace detail { template class redis_stream { asio::ssl::context ssl_ctx_; asio::ip::basic_resolver resolv_; asio::ssl::stream> stream_; #ifdef BOOST_ASIO_HAS_LOCAL_SOCKETS asio::basic_stream_socket unix_socket_; #endif typename asio::steady_timer::template rebind_executor::other timer_; redis_stream_state st_; void reset_stream() { stream_ = {resolv_.get_executor(), ssl_ctx_}; } struct connect_op { redis_stream& obj_; connect_fsm fsm_; template void execute_action(Self& self, connect_action act) { auto& obj = this->obj_; // prevent use-after-move errors const auto& cfg = fsm_.get_config(); switch (act.type) { case connect_action_type::unix_socket_close: #ifdef BOOST_ASIO_HAS_LOCAL_SOCKETS { system::error_code ec; obj.unix_socket_.close(ec); (*this)(self, ec); // This is a sync action } #else BOOST_ASSERT(false); #endif return; case connect_action_type::unix_socket_connect: #ifdef BOOST_ASIO_HAS_LOCAL_SOCKETS obj.unix_socket_.async_connect( cfg.unix_socket, asio::cancel_after(obj.timer_, cfg.connect_timeout, std::move(self))); #else BOOST_ASSERT(false); #endif return; case connect_action_type::tcp_resolve: obj.resolv_.async_resolve( cfg.addr.host, cfg.addr.port, asio::cancel_after(obj.timer_, cfg.resolve_timeout, std::move(self))); return; case connect_action_type::ssl_stream_reset: obj.reset_stream(); // this action does not require yielding. Execute the next action immediately (*this)(self); return; case connect_action_type::ssl_handshake: obj.stream_.async_handshake( asio::ssl::stream_base::client, asio::cancel_after(obj.timer_, cfg.ssl_handshake_timeout, std::move(self))); return; case connect_action_type::done: self.complete(act.ec); break; // Connect should use the specialized handler, where resolver results are available case connect_action_type::tcp_connect: default: BOOST_ASSERT(false); } } // This overload will be used for connects template void operator()( Self& self, system::error_code ec, const asio::ip::tcp::endpoint& selected_endpoint) { auto act = fsm_.resume( ec, selected_endpoint, obj_.st_, self.get_cancellation_state().cancelled()); execute_action(self, act); } // This overload will be used for resolves template void operator()( Self& self, system::error_code ec, asio::ip::tcp::resolver::results_type endpoints) { auto act = fsm_.resume(ec, endpoints, obj_.st_, self.get_cancellation_state().cancelled()); if (act.type == connect_action_type::tcp_connect) { auto& obj = this->obj_; // prevent use-after-free errors asio::async_connect( obj.stream_.next_layer(), std::move(endpoints), asio::cancel_after(obj.timer_, fsm_.get_config().connect_timeout, std::move(self))); } else { execute_action(self, act); } } template void operator()(Self& self, system::error_code ec = {}) { auto act = fsm_.resume(ec, obj_.st_, self.get_cancellation_state().cancelled()); execute_action(self, act); } }; public: explicit redis_stream(Executor ex, asio::ssl::context&& ssl_ctx) : ssl_ctx_{std::move(ssl_ctx)} , resolv_{ex} , stream_{ex, ssl_ctx_} #ifdef BOOST_ASIO_HAS_LOCAL_SOCKETS , unix_socket_{ex} #endif , timer_{std::move(ex)} { } // Executor. Required to satisfy the AsyncStream concept using executor_type = Executor; executor_type get_executor() noexcept { return resolv_.get_executor(); } // Accessors const auto& get_ssl_context() const noexcept { return ssl_ctx_; } bool is_open() const { #ifdef BOOST_ASIO_HAS_LOCAL_SOCKETS if (st_.type == transport_type::unix_socket) return unix_socket_.is_open(); #endif return stream_.next_layer().is_open(); } auto& next_layer() { return stream_; } const auto& next_layer() const { return stream_; } // I/O template auto async_connect(const config& cfg, buffered_logger& l, CompletionToken&& token) { return asio::async_compose( connect_op{*this, connect_fsm(cfg, l)}, token); } // These functions should only be used with callbacks (e.g. within async_compose function bodies) template void async_write_some(const ConstBufferSequence& buffers, CompletionToken&& token) { switch (st_.type) { case transport_type::tcp: { stream_.next_layer().async_write_some(buffers, std::forward(token)); break; } case transport_type::tcp_tls: { stream_.async_write_some(buffers, std::forward(token)); break; } #ifdef BOOST_ASIO_HAS_LOCAL_SOCKETS case transport_type::unix_socket: { unix_socket_.async_write_some(buffers, std::forward(token)); break; } #endif default: BOOST_ASSERT(false); } } template void async_read_some(const MutableBufferSequence& buffers, CompletionToken&& token) { switch (st_.type) { case transport_type::tcp: { return stream_.next_layer().async_read_some( buffers, std::forward(token)); break; } case transport_type::tcp_tls: { return stream_.async_read_some(buffers, std::forward(token)); break; } #ifdef BOOST_ASIO_HAS_LOCAL_SOCKETS case transport_type::unix_socket: { unix_socket_.async_read_some(buffers, std::forward(token)); break; } #endif default: BOOST_ASSERT(false); } } // Cancels resolve operations. Resolve operations don't support per-operation // cancellation, but resolvers have a cancel() function. Resolve operations are // in general blocking and run in a separate thread. cancel() has effect only // if the operation hasn't started yet. Still, trying is better than nothing void cancel_resolve() { resolv_.cancel(); } }; } // namespace detail } // namespace redis } // namespace boost #endif