Clio develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
rpc::HandlerProvider Class Referenceabstract

Interface for the provider of RPC handlers. More...

#include <HandlerProvider.hpp>

Inheritance diagram for rpc::HandlerProvider:

Public Member Functions

virtual bool contains (std::string const &command) const =0
 Check if the provider contains a handler for a given method.
 
virtual std::optional< AnyHandlergetHandler (std::string const &command) const =0
 Get the handler for a given method.
 
virtual bool isClioOnly (std::string const &command) const =0
 Check if a given method is Clio-only.
 

Detailed Description

Interface for the provider of RPC handlers.

Member Function Documentation

◆ contains()

virtual bool rpc::HandlerProvider::contains ( std::string const & command) const
pure virtual

Check if the provider contains a handler for a given method.

Parameters
commandThe method to check for
Returns
true if the provider contains a handler for the method, false otherwise

Implemented in rpc::impl::ProductionHandlerProvider.

◆ getHandler()

virtual std::optional< AnyHandler > rpc::HandlerProvider::getHandler ( std::string const & command) const
pure virtual

Get the handler for a given method.

Parameters
commandThe method to get the handler for
Returns
The handler for the method, or std::nullopt if the method is not found

Implemented in rpc::impl::ProductionHandlerProvider.

◆ isClioOnly()

virtual bool rpc::HandlerProvider::isClioOnly ( std::string const & command) const
pure virtual

Check if a given method is Clio-only.

Parameters
commandThe method to check
Returns
true if the method is Clio-only, false otherwise

Implemented in rpc::impl::ProductionHandlerProvider.


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