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

Interface for filtering transactions. More...

#include <TransactionFilter.hpp>

Inheritance diagram for rpc::TransactionFilter:

Classes

struct  CheckResult
 The result of a filter check that matched a transaction. More...

Public Member Functions

virtual std::optional< CheckResultcheck (data::TransactionAndMetadata const &txnPlusMeta) const =0
 Check if a transaction blob matches the filter criteria.

Detailed Description

Interface for filtering transactions.

Member Function Documentation

◆ check()

virtual std::optional< CheckResult > rpc::TransactionFilter::check ( data::TransactionAndMetadata const & txnPlusMeta) const
nodiscardpure virtual

Check if a transaction blob matches the filter criteria.

Parameters
txnPlusMetaThe transaction and metadata blob from the backend.
Returns
The relevant account and role to report for this txn if it should be included in the output Json, or std::nullopt if the txn should be excluded

Implemented in rpc::DelegateTransactionFilter.


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