mirror of
https://github.com/XRPLF/clio.git
synced 2025-11-04 11:55:51 +00:00
94 lines
3.6 KiB
C++
94 lines
3.6 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of clio: https://github.com/XRPLF/clio
|
|
Copyright (c) 2022, 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 "data/Types.hpp"
|
|
#include "rpc/Errors.hpp"
|
|
#include "rpc/common/APIVersion.hpp"
|
|
#include "util/Taggable.hpp"
|
|
#include "web/Context.hpp"
|
|
#include "web/interface/ConnectionBase.hpp"
|
|
|
|
#include <boost/asio/spawn.hpp>
|
|
#include <boost/json.hpp>
|
|
#include <boost/json/object.hpp>
|
|
|
|
#include <expected>
|
|
#include <functional>
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
/*
|
|
* This file contains various classes necessary for executing RPC handlers.
|
|
* Context gives the handlers access to various other parts of the application Status is used to report errors.
|
|
* And lastly, there are various functions for making Contexts, Statuses and serializing Status to JSON.
|
|
* This file is meant to contain any class or function that code outside of the rpc folder needs to use.
|
|
* For helper functions or classes used within the rpc folder, use RPCHelpers.h.
|
|
*/
|
|
namespace rpc {
|
|
|
|
/**
|
|
* @brief A factory function that creates a Websocket context.
|
|
*
|
|
* @param yc The coroutine context
|
|
* @param request The request as JSON object
|
|
* @param session The connection
|
|
* @param tagFactory A factory that provides tags to track requests
|
|
* @param range The ledger range that is available at request time
|
|
* @param clientIp The IP address of the connected client
|
|
* @param apiVersionParser A parser that is used to parse out the "api_version" field
|
|
* @return A Websocket context or error Status
|
|
*/
|
|
std::expected<web::Context, Status>
|
|
make_WsContext(
|
|
boost::asio::yield_context yc,
|
|
boost::json::object const& request,
|
|
std::shared_ptr<web::ConnectionBase> const& session,
|
|
util::TagDecoratorFactory const& tagFactory,
|
|
data::LedgerRange const& range,
|
|
std::string const& clientIp,
|
|
std::reference_wrapper<APIVersionParser const> apiVersionParser
|
|
);
|
|
|
|
/**
|
|
* @brief A factory function that creates a HTTP context.
|
|
*
|
|
* @param yc The coroutine context
|
|
* @param request The request as JSON object
|
|
* @param tagFactory A factory that provides tags to track requests
|
|
* @param range The ledger range that is available at request time
|
|
* @param clientIp The IP address of the connected client
|
|
* @param apiVersionParser A parser that is used to parse out the "api_version" field
|
|
* @param isAdmin Whether the connection has admin privileges
|
|
* @return A HTTP context or error Status
|
|
*/
|
|
std::expected<web::Context, Status>
|
|
make_HttpContext(
|
|
boost::asio::yield_context yc,
|
|
boost::json::object const& request,
|
|
util::TagDecoratorFactory const& tagFactory,
|
|
data::LedgerRange const& range,
|
|
std::string const& clientIp,
|
|
std::reference_wrapper<APIVersionParser const> apiVersionParser,
|
|
bool isAdmin
|
|
);
|
|
|
|
} // namespace rpc
|