feed::impl::TransactionFeed Class Reference

Public Member Functions
	TransactionFeed (util::async::AnyExecutionContext &executionCtx)
	Construct a new Transaction Feed object.
	TransactionFeed (TransactionFeed &&)=delete
	Move constructor is deleted because TransactionSlot takes TransactionFeed by reference.
void	sub (SubscriberSharedPtr const &subscriber)
	Subscribe to the transaction feed.
void	sub (ripple::AccountID const &account, SubscriberSharedPtr const &subscriber)
	Subscribe to the transaction feed, only receive the feed when particular account is affected.
void	sub (ripple::Book const &book, SubscriberSharedPtr const &subscriber)
	Subscribe to the transaction feed, only receive the feed when particular order book is affected.
void	subProposed (SubscriberSharedPtr const &subscriber)
	Subscribe to the transaction feed for proposed transaction stream.
void	subProposed (ripple::AccountID const &account, SubscriberSharedPtr const &subscriber)
	Subscribe to the transaction feed for proposed account, only receive the feed when particular account is affected.
void	unsub (SubscriberSharedPtr const &subscriber)
	Unsubscribe to the transaction feed.
void	unsub (ripple::AccountID const &account, SubscriberSharedPtr const &subscriber)
	Unsubscribe to the transaction for particular account.
void	unsubProposed (SubscriberSharedPtr const &subscriber)
	Unsubscribe to the transaction feed for proposed transaction stream.
void	unsubProposed (ripple::AccountID const &account, SubscriberSharedPtr const &subscriber)
	Unsubscribe to the transaction for particular proposed account.
void	unsub (ripple::Book const &book, SubscriberSharedPtr const &subscriber)
	Unsubscribe to the transaction feed for particular order book.
void	pub (data::TransactionAndMetadata const &txMeta, ripple::LedgerHeader const &lgrInfo, std::shared_ptr< data::BackendInterface const > const &backend, std::shared_ptr< data::AmendmentCenterInterface const > const &amendmentCenter, uint32_t networkID)
	Publishes the transaction feed.
std::uint64_t	transactionSubCount () const
	Get the number of subscribers of the transaction feed.
std::uint64_t	accountSubCount () const
	Get the number of accounts subscribers.
std::uint64_t	bookSubCount () const
	Get the number of books subscribers.

Constructor & Destructor Documentation

TransactionFeed()

feed::impl::TransactionFeed::TransactionFeed ( util::async::AnyExecutionContext & executionCtx )

inline

Construct a new Transaction Feed object.

Parameters

executionCtx

The actual publish will be called in the strand of this.

Member Function Documentation

pub()

void feed::impl::TransactionFeed::pub	(	data::TransactionAndMetadata const &	txMeta,
		ripple::LedgerHeader const &	lgrInfo,
		std::shared_ptr< data::BackendInterface const > const &	backend,
		std::shared_ptr< data::AmendmentCenterInterface const > const &	amendmentCenter,
		uint32_t	networkID )

Publishes the transaction feed.

Parameters

txMeta	The transaction and metadata.
lgrInfo	The ledger header.
backend	The backend.
networkID	The network ID.

sub() [1/3]

void feed::impl::TransactionFeed::sub	(	ripple::AccountID const &	account,
		SubscriberSharedPtr const &	subscriber )

Subscribe to the transaction feed, only receive the feed when particular account is affected.

Parameters

subscriber
account	The account to watch.

sub() [2/3]

void feed::impl::TransactionFeed::sub	(	ripple::Book const &	book,
		SubscriberSharedPtr const &	subscriber )

Subscribe to the transaction feed, only receive the feed when particular order book is affected.

Parameters

subscriber
book	The order book to watch.

sub() [3/3]

void feed::impl::TransactionFeed::sub

(

SubscriberSharedPtr const &

subscriber

)

Subscribe to the transaction feed.

Parameters

subscriber

subProposed() [1/2]

void feed::impl::TransactionFeed::subProposed	(	ripple::AccountID const &	account,
		SubscriberSharedPtr const &	subscriber )

Subscribe to the transaction feed for proposed account, only receive the feed when particular account is affected.

Parameters

subscriber
account	The account to watch.

subProposed() [2/2]

void feed::impl::TransactionFeed::subProposed

(

SubscriberSharedPtr const &

subscriber

)

Subscribe to the transaction feed for proposed transaction stream.

Parameters

subscriber

unsub() [1/3]

void feed::impl::TransactionFeed::unsub	(	ripple::AccountID const &	account,
		SubscriberSharedPtr const &	subscriber )

Unsubscribe to the transaction for particular account.

Parameters

subscriber
account	The account to unsubscribe.

unsub() [2/3]

void feed::impl::TransactionFeed::unsub	(	ripple::Book const &	book,
		SubscriberSharedPtr const &	subscriber )

Unsubscribe to the transaction feed for particular order book.

Parameters

subscriber
book	The book to unsubscribe.

unsub() [3/3]

void feed::impl::TransactionFeed::unsub

(

SubscriberSharedPtr const &

subscriber

)

Unsubscribe to the transaction feed.

Parameters

subscriber

unsubProposed() [1/2]

void feed::impl::TransactionFeed::unsubProposed	(	ripple::AccountID const &	account,
		SubscriberSharedPtr const &	subscriber )

Unsubscribe to the transaction for particular proposed account.

Parameters

subscriber
account	The account to unsubscribe.

unsubProposed() [2/2]

void feed::impl::TransactionFeed::unsubProposed

(

SubscriberSharedPtr const &

subscriber

)

Unsubscribe to the transaction feed for proposed transaction stream.

Parameters

subscriber

---

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

• /__w/clio/clio/src/feed/impl/TransactionFeed.hpp
• /__w/clio/clio/src/feed/impl/TransactionFeed.cpp