Clio develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
rpc::BaseTxHandler< ETLServiceType > Class Template Reference

Contains common functionality for handling the tx command. More...

#include <Tx.hpp>

Classes

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

Public Types

using Result = HandlerReturnType<Output>
 

Public Member Functions

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

Static Public Member Functions

static RpcSpecConstRef spec (uint32_t apiVersion)
 Returns the API specification for the command.
 

Friends

void tag_invoke (boost::json::value_from_tag, boost::json::value &jv, Output const &output)
 
Input tag_invoke (boost::json::value_to_tag< Input >, boost::json::value const &jv)
 

Detailed Description

template<typename ETLServiceType>
class rpc::BaseTxHandler< ETLServiceType >

Contains common functionality for handling the tx command.

Template Parameters
ETLServiceTypeThe type of the ETL service to use

Constructor & Destructor Documentation

◆ BaseTxHandler()

template<typename ETLServiceType >
rpc::BaseTxHandler< ETLServiceType >::BaseTxHandler ( std::shared_ptr< BackendInterface > const & sharedPtrBackend,
std::shared_ptr< ETLServiceType const > const & etl )
inline

Construct a new BaseTxHandler object.

Parameters
sharedPtrBackendThe backend to use
etlThe ETL service to use

Member Function Documentation

◆ process()

template<typename ETLServiceType >
Result rpc::BaseTxHandler< ETLServiceType >::process ( Input input,
Context const & ctx ) const
inline

Process the Tx command.

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

◆ spec()

template<typename ETLServiceType >
static RpcSpecConstRef rpc::BaseTxHandler< ETLServiceType >::spec ( uint32_t apiVersion)
inlinestatic

Returns the API specification for the command.

Parameters
apiVersionThe api version to return the spec for
Returns
The spec for the given apiVersion

The documentation for this class was generated from the following file: