Kagome
Polkadot Runtime Engine in C++17
http_session.hpp
Go to the documentation of this file.
1 
6 #ifndef KAGOME_CORE_API_TRANSPORT_BEAST_HTTP_SESSION_HPP
7 #define KAGOME_CORE_API_TRANSPORT_BEAST_HTTP_SESSION_HPP
8 
9 #include <boost/asio/strand.hpp>
10 #include <boost/beast.hpp>
11 #include <chrono>
12 #include <cstdlib>
13 #include <memory>
14 
15 #include "api/transport/session.hpp"
16 #include "log/logger.hpp"
17 
18 namespace kagome::api {
22  class HttpSession : public Session,
23  public std::enable_shared_from_this<HttpSession> {
24  template <typename Body>
25  using Request = boost::beast::http::request<Body>;
26 
27  template <typename Body>
28  using Response = boost::beast::http::response<Body>;
29 
30  using StringBody = boost::beast::http::string_body;
31 
32  template <class Body>
33  using RequestParser = boost::beast::http::request_parser<Body>;
34 
35  using HttpField = boost::beast::http::field;
36 
37  using HttpError = boost::beast::http::error;
38 
39  public:
40  struct Configuration {
41  static constexpr size_t kDefaultRequestSize = 10000u;
42  static constexpr Duration kDefaultTimeout = std::chrono::seconds(30);
43 
44  size_t max_request_size{kDefaultRequestSize};
45  Duration operation_timeout{kDefaultTimeout};
46  };
47 
48  ~HttpSession() override = default;
49 
55  HttpSession(Context &context, Configuration config);
56 
57  Socket &socket() override {
58  return stream_.socket();
59  }
60 
64  void start() override;
65 
70  void respond(std::string_view response) override;
71 
76  SessionId id() const override {
77  return 0ull;
78  }
79 
84  SessionType type() const override {
85  return SessionType::kHttp;
86  }
87 
88  private:
92  void stop();
93 
99  template <class Body>
100  void handleRequest(Request<Body> &&request);
101 
105  void asyncRead();
106 
112  template <class Message>
113  void asyncWrite(Message &&message);
114 
118  void onRead(boost::system::error_code ec, std::size_t size);
119 
123  void onWrite(boost::system::error_code ec, std::size_t, bool close);
124 
133  auto makeBadResponse(std::string_view message,
134  unsigned version,
135  bool keep_alive);
136 
142  void reportError(boost::system::error_code ec, std::string_view message);
143 
144  static constexpr boost::string_view kServerName = "Kagome";
145 
147  boost::asio::strand<boost::asio::io_context::executor_type> strand_;
148 
149  Configuration config_;
150  boost::beast::tcp_stream stream_;
151  boost::beast::flat_buffer buffer_;
152 
156  using Parser = RequestParser<StringBody>;
157 
158  std::unique_ptr<Parser> parser_;
159  log::Logger logger_ = log::createLogger("HttpSession", "rpc_transport");
160  };
161 
162 } // namespace kagome::api
163 
164 #endif // KAGOME_CORE_API_TRANSPORT_BEAST_HTTP_SESSION_HPP
kagome::api::HttpSession::onRead
void onRead(boost::system::error_code ec, std::size_t size)
read completion callback
Definition: http_session.cpp:99
kagome::api::HttpSession::Configuration::kDefaultTimeout
static constexpr Duration kDefaultTimeout
Definition: http_session.hpp:42
kagome::api::HttpSession::StringBody
boost::beast::http::string_body StringBody
Definition: http_session.hpp:30
kagome::api::Session::Duration
Timer::duration Duration
Definition: session.hpp:42
kagome::api::HttpSession::HttpField
boost::beast::http::field HttpField
Definition: http_session.hpp:35
kagome::api::HttpSession::stop
void stop()
stops session
Definition: http_session.cpp:23
kagome::api::HttpSession::config_
Configuration config_
session configuration
Definition: http_session.hpp:149
kagome::api::HttpSession::HttpError
boost::beast::http::error HttpError
Definition: http_session.hpp:37
kagome::api::HttpSession::kServerName
static constexpr boost::string_view kServerName
Definition: http_session.hpp:144
kagome::api::HttpSession::reportError
void reportError(boost::system::error_code ec, std::string_view message)
reports error code and message
Definition: http_session.cpp:128
kagome::api::Session::Socket
boost::asio::ip::tcp::socket Socket
Definition: session.hpp:37
kagome::api::HttpSession::strand_
boost::asio::strand< boost::asio::io_context::executor_type > strand_
Strand to ensure the connection&#39;s handlers are not called concurrently.
Definition: http_session.hpp:147
kagome::api::HttpSession::type
SessionType type() const override
method to get type of the session
Definition: http_session.hpp:84
kagome::api::HttpSession::makeBadResponse
auto makeBadResponse(std::string_view message, unsigned version, bool keep_alive)
composes bad request message
Definition: http_session.cpp:29
kagome::api::HttpSession::handleRequest
void handleRequest(Request< Body > &&request)
process http request, compose and execute response
kagome::api::HttpSession::socket
Socket & socket() override
Definition: http_session.hpp:57
kagome::api::HttpSession::Response
boost::beast::http::response< Body > Response
Definition: http_session.hpp:28
conf.version
string version
Definition: conf.py:16
kagome::api::HttpSession::onWrite
void onWrite(boost::system::error_code ec, std::size_t, bool close)
write completion callback
Definition: http_session.cpp:112
kagome::api::HttpSession::Request
boost::beast::http::request< Body > Request
Definition: http_session.hpp:25
kagome::api::HttpSession::stream_
boost::beast::tcp_stream stream_
stream
Definition: http_session.hpp:150
kagome::log::Logger
std::shared_ptr< soralog::Logger > Logger
Definition: logger.hpp:23
kagome::api::HttpSession::start
void start() override
starts session
Definition: http_session.cpp:19
kagome::api::HttpSession
HTTP session for api service.
Definition: http_session.hpp:22
kagome::api::HttpSession::buffer_
boost::beast::flat_buffer buffer_
read buffer
Definition: http_session.hpp:151
kagome::api::HttpSession::id
SessionId id() const override
method to get id of the session
Definition: http_session.hpp:76
kagome::api::Session
rpc session
Definition: session.hpp:27
kagome::api::HttpSession::HttpSession
HttpSession(Context &context, Configuration config)
constructor
Definition: http_session.cpp:14
kagome::api::HttpSession::asyncRead
void asyncRead()
asynchronously read http message
Definition: http_session.cpp:52
kagome::api::HttpSession::RequestParser
boost::beast::http::request_parser< Body > RequestParser
Definition: http_session.hpp:33
kagome::log::createLogger
Logger createLogger(const std::string &tag)
Definition: logger.cpp:112
kagome::api::Session::SessionId
uint64_t SessionId
Definition: session.hpp:43
kagome::api::HttpSession::asyncWrite
void asyncWrite(Message &&message)
sends http message
Definition: http_session.cpp:69
kagome::api::HttpSession::Parser
RequestParser< StringBody > Parser
request parser type
Definition: http_session.hpp:156
kagome::api::HttpSession::parser_
std::unique_ptr< Parser > parser_
http parser
Definition: http_session.hpp:158
kagome::api::HttpSession::Configuration::kDefaultRequestSize
static constexpr size_t kDefaultRequestSize
Definition: http_session.hpp:41
kagome::api::HttpSession::respond
void respond(std::string_view response) override
sends response wrapped by http message
Definition: http_session.cpp:82
kagome::api::HttpSession::~HttpSession
~HttpSession() override=default