Clio develop
The XRP Ledger API server.
Loading...
Searching...
No Matches
feed::impl::BookChangesFeed Struct Reference

Feed that publishes book changes. This feed will be published every ledger, even if there are no changes. Example : {'type': 'bookChanges', 'ledger_index': 2647936, 'ledger_hash': '0A5010342D8AAFABDCA58A68F6F588E1C6E58C21B63ED6CA8DB2478F58F3ECD5', 'ledger_time': 756395682, 'changes': []}. More...

#include <BookChangesFeed.hpp>

Inheritance diagram for feed::impl::BookChangesFeed:
Collaboration diagram for feed::impl::BookChangesFeed:

Public Member Functions

 BookChangesFeed (util::async::AnyExecutionContext &executionCtx)
 
void pub (ripple::LedgerHeader const &lgrInfo, std::vector< data::TransactionAndMetadata > const &transactions)
 Publishes the book changes.
 
- Public Member Functions inherited from feed::impl::SingleFeedBase
 SingleFeedBase (util::async::AnyExecutionContext &executionCtx, std::string const &name)
 Construct a new Single Feed Base object.
 
void sub (SubscriberSharedPtr const &subscriber)
 Subscribe the feed.
 
void unsub (SubscriberSharedPtr const &subscriber)
 Unsubscribe the feed.
 
void pub (std::string msg)
 Publishes the feed in strand.
 
std::uint64_t count () const
 Get the count of subscribers.
 

Detailed Description

Feed that publishes book changes. This feed will be published every ledger, even if there are no changes. Example : {'type': 'bookChanges', 'ledger_index': 2647936, 'ledger_hash': '0A5010342D8AAFABDCA58A68F6F588E1C6E58C21B63ED6CA8DB2478F58F3ECD5', 'ledger_time': 756395682, 'changes': []}.

Member Function Documentation

◆ pub()

void feed::impl::BookChangesFeed::pub ( ripple::LedgerHeader const & lgrInfo,
std::vector< data::TransactionAndMetadata > const & transactions )
inline

Publishes the book changes.

Parameters
lgrInfoThe ledger header.
transactionsThe transactions that were included in the ledger.

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