Connection.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 "web/ng/Error.hpp"
#include "web/ng/Request.hpp"
#include "web/ng/Response.hpp"
 
#include <boost/asio/spawn.hpp>
#include <boost/beast/core/flat_buffer.hpp>
 
#include <chrono>
#include <concepts>
#include <cstddef>
#include <expected>
#include <memory>
#include <optional>
#include <string>
 
namespace web::ng {
 
class ConnectionMetadata : public util::Taggable {
protected:
    std::string ip_;  // client ip
    std::optional<bool> isAdmin_;
 
public:
    ConnectionMetadata(std::string ip, util::TagDecoratorFactory const& tagDecoratorFactory);
 
    virtual bool
    wasUpgraded() const = 0;
 
    std::string const&
    ip() const;
 
    bool
    isAdmin() const;
 
    template <std::invocable T>
    void
    setIsAdmin(T&& setter)
    {
        if (not isAdmin_.has_value())
            isAdmin_ = setter();
    }
};
 
class Connection : public ConnectionMetadata {
protected:
    boost::beast::flat_buffer buffer_;
 
public:
    static constexpr std::chrono::steady_clock::duration kDEFAULT_TIMEOUT = std::chrono::seconds{11};
 
    Connection(std::string ip, boost::beast::flat_buffer buffer, util::TagDecoratorFactory const& tagDecoratorFactory);
 
    virtual void
    setTimeout(std::chrono::steady_clock::duration newTimeout) = 0;
 
    virtual std::optional<Error>
    send(Response response, boost::asio::yield_context yield) = 0;
 
    virtual std::expected<Request, Error>
    receive(boost::asio::yield_context yield) = 0;
 
    virtual void
    close(boost::asio::yield_context yield) = 0;
};
 
using ConnectionPtr = std::unique_ptr<Connection>;
 
}  // namespace web::ng