ConnectionBase.hpp

//------------------------------------------------------------------------------
/*
    This file is part of clio: https://github.com/XRPLF/clio
    Copyright (c) 2023, 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/SubscriptionContextInterface.hpp"
 
#include <boost/beast/http.hpp>
#include <boost/beast/http/status.hpp>
#include <boost/signals2.hpp>
#include <boost/signals2/variadic_signal.hpp>
 
#include <memory>
#include <stdexcept>
#include <string>
#include <utility>
 
namespace web {
 
namespace http = boost::beast::http;
 
struct ConnectionBase : public util::Taggable {
protected:
    boost::system::error_code ec_;
    bool isAdmin_ = false;
 
public:
    std::string const clientIp;
    bool upgraded = false;
 
    ConnectionBase(util::TagDecoratorFactory const& tagFactory, std::string ip)
        : Taggable(tagFactory), clientIp(std::move(ip))
    {
    }
 
    virtual void
    send(std::string&& msg, http::status status = http::status::ok) = 0;
 
    virtual void
    send([[maybe_unused]] std::shared_ptr<std::string> msg)
    {
        throw std::logic_error("web server can not send the shared payload");
    }
 
    virtual void
    sendSlowDown(std::string const& request) = 0;
    virtual SubscriptionContextPtr
    makeSubscriptionContext(util::TagDecoratorFactory const& factory) = 0;
 
    bool
    dead()
    {
        return ec_ != boost::system::error_code{};
    }
 
    [[nodiscard]] bool
    isAdmin() const
    {
        return isAdmin_;
    }
};
}  // namespace web