Server.hpp

//------------------------------------------------------------------------------
/*
    This file is part of clio: https://github.com/XRPLF/clio
    Copyright (c) 2024, the clio developers.
 
    Permission to use, copy, modify, and distribute this software for any
    purpose with or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL,  DIRECT,  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#pragma once
 
#include "util/Taggable.hpp"
#include "util/config/ConfigDefinition.hpp"
#include "util/log/Logger.hpp"
#include "web/ProxyIpResolver.hpp"
#include "web/interface/Concepts.hpp"
#include "web/ng/Connection.hpp"
#include "web/ng/MessageHandler.hpp"
#include "web/ng/ProcessingPolicy.hpp"
#include "web/ng/Response.hpp"
#include "web/ng/impl/ConnectionHandler.hpp"
 
#include <boost/asio/io_context.hpp>
#include <boost/asio/ip/tcp.hpp>
#include <boost/asio/spawn.hpp>
#include <boost/asio/ssl/context.hpp>
 
#include <cstddef>
#include <functional>
#include <optional>
#include <string>
 
namespace web::ng {

class Server : public ServerTag {
public:
    using OnConnectCheck = std::function<std::expected<void, Response>(Connection const&)>;
 
    using OnIpChangeHook = impl::ConnectionHandler::OnIpChangeHook;

    using OnDisconnectHook = impl::ConnectionHandler::OnDisconnectHook;

    struct Hooks {
        OnConnectCheck onConnectCheck;
        OnIpChangeHook onIpChangeHook;
        OnDisconnectHook onDisconnectHook;
    };
 
private:
    util::Logger log_{"WebServer"};
    util::Logger perfLog_{"Performance"};
 
    std::reference_wrapper<boost::asio::io_context> ctx_;
    std::optional<boost::asio::ssl::context> sslContext_;
 
    util::TagDecoratorFactory tagDecoratorFactory_;
 
    impl::ConnectionHandler connectionHandler_;
    boost::asio::ip::tcp::endpoint endpoint_;
 
    OnConnectCheck onConnectCheck_;
 
    bool running_{false};
 
public:
    Server(
        boost::asio::io_context& ctx,
        boost::asio::ip::tcp::endpoint endpoint,
        std::optional<boost::asio::ssl::context> sslContext,
        ProcessingPolicy processingPolicy,
        std::optional<size_t> parallelRequestLimit,
        util::TagDecoratorFactory tagDecoratorFactory,
        ProxyIpResolver proxyIpResolver,
        std::optional<size_t> maxSubscriptionSendQueueSize,
        Hooks hooks
    );

    Server(Server const&) = delete;

    Server(Server&&) = delete;

    void
    onGet(std::string const& target, MessageHandler handler);

    void
    onPost(std::string const& target, MessageHandler handler);

    void
    onWs(MessageHandler handler);

    std::optional<std::string>
    run();

    void
    stop(boost::asio::yield_context yield);
 
private:
    void
    handleConnection(boost::asio::ip::tcp::socket socket, boost::asio::yield_context yield);
};

std::expected<Server, std::string>
makeServer(
    util::config::ClioConfigDefinition const& config,
    Server::OnConnectCheck onConnectCheck,
    Server::OnIpChangeHook onIpChangeHook,
    Server::OnDisconnectHook onDisconnectHook,
    boost::asio::io_context& context
);
 
}  // namespace web::ng