Clio  develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
rpc::BookChangesHandler Class Reference

BookChangesHandler returns the order book changes for a given ledger. More...

#include <BookChanges.hpp>

Inheritance diagram for rpc::BookChangesHandler:
Collaboration diagram for rpc::BookChangesHandler:

Classes

struct  Output
 A struct to hold the output data of the command. More...

Public Types

using Result = HandlerReturnType<Output>

Public Member Functions

 BookChangesHandler (std::shared_ptr< BackendInterface > sharedPtrBackend)
 Construct a new BookChangesHandler object.
Result process (Input const &input, Context const &ctx) const
 Process the BookChanges command.

Friends

void tag_invoke (boost::json::value_from_tag, boost::json::value &jv, BookChangesHandler::Output const &output)
 Convert the Output to a JSON object.

Detailed Description

BookChangesHandler returns the order book changes for a given ledger.

This API is not documented in the rippled API documentation.

Constructor & Destructor Documentation

◆ BookChangesHandler()

rpc::BookChangesHandler::BookChangesHandler ( std::shared_ptr< BackendInterface > sharedPtrBackend)
inline

Construct a new BookChangesHandler object.

Parameters
sharedPtrBackendThe backend to use

Member Function Documentation

◆ process()

BookChangesHandler::Result rpc::BookChangesHandler::process ( Input const & input,
Context const & ctx ) const
nodiscard

Process the BookChanges command.

Parameters
inputThe input data for the command
ctxThe context of the request
Returns
The result of the operation

◆ tag_invoke

void tag_invoke ( boost::json::value_from_tag ,
boost::json::value & jv,
BookChangesHandler::Output const & output )
friend

Convert the Output to a JSON object.

Parameters
[out]jvThe JSON object to convert to
outputThe output to convert

The documentation for this class was generated from the following files:
  • /__w/clio/clio/src/rpc/handlers/BookChanges.hpp
  • /__w/clio/clio/src/rpc/handlers/BookChanges.cpp