feed::impl::ProposedTransactionFeed Class Reference

Feed that publishes the Proposed Transactions. More...

#include <ProposedTransactionFeed.hpp>

Public Member Functions
	ProposedTransactionFeed (util::async::AnyExecutionContext &executionCtx)
	Construct a Proposed Transaction Feed object.
void	sub (SubscriberSharedPtr const &subscriber)
	Subscribe to the proposed transaction feed.
void	sub (ripple::AccountID const &account, SubscriberSharedPtr const &subscriber)
	Subscribe to the proposed transaction feed, only receive the feed when particular account is affected.
void	unsub (SubscriberSharedPtr const &subscriber)
	Unsubscribe to the proposed transaction feed.
void	unsub (ripple::AccountID const &account, SubscriberSharedPtr const &subscriber)
	Unsubscribe to the proposed transaction feed for particular account.
void	pub (boost::json::object const &receivedTxJson)
	Publishes the proposed transaction feed.
std::uint64_t	transactionSubcount () const
	Get the number of subscribers of the proposed transaction feed.
std::uint64_t	accountSubCount () const
	Get the number of accounts subscribers.

Detailed Description

Feed that publishes the Proposed Transactions.

Note

Be aware that the Clio only forwards this stream, not respect api_version.

Constructor & Destructor Documentation

ProposedTransactionFeed()

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

inline

Construct a Proposed Transaction Feed object.

Parameters

executionCtx

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

Member Function Documentation

pub()

void feed::impl::ProposedTransactionFeed::pub

(

boost::json::object const &

receivedTxJson

)

Publishes the proposed transaction feed.

Parameters

receivedTxJson

The proposed transaction json.

sub() [1/2]

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

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

Parameters

subscriber
account	The account to watch.

sub() [2/2]

void feed::impl::ProposedTransactionFeed::sub

(

SubscriberSharedPtr const &

subscriber

)

Subscribe to the proposed transaction feed.

Parameters

subscriber

unsub() [1/2]

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

Unsubscribe to the proposed transaction feed for particular account.

Parameters

subscriber
account	The account to unsubscribe.

unsub() [2/2]

void feed::impl::ProposedTransactionFeed::unsub

(

SubscriberSharedPtr const &

subscriber

)

Unsubscribe to the proposed transaction feed.

Parameters

subscriber

---

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

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