Manages a client's subscription to data feeds. More...

#include <InfoSub.h>

Inheritance diagram for xrpl::InfoSub:

[legend]

Collaboration diagram for xrpl::InfoSub:

[legend]

Classes
class	Source
	Abstracts the source of subscription data. More...

Public Types
using	pointer = std::shared_ptr<InfoSub>
using	wptr = std::weak_ptr<InfoSub>
using	ref = std::shared_ptr<InfoSub> const&
using	Consumer = resource::Consumer

Public Member Functions
	InfoSub (Source &source)
	InfoSub (Source &source, Consumer consumer)
virtual	~InfoSub ()
Consumer &	getConsumer ()
virtual void	send (json::Value const &jvObj, bool broadcast)=0
std::uint64_t	getSeq () const
std::size_t	totalSubscriptionCount () const
	Return the number of subscriptions currently tracked on this connection.
bool	tryReserveAccountSubscriptions (hash_set< AccountID > const &proposedAccounts, hash_set< AccountID > const &normalAccounts, std::size_t cap)
	Enforce the cap and reserve a request's net-new accounts, atomically.
bool	hasAccountHistorySubscription (AccountID const &account) const
	Whether this connection already tracks an account-history for `account`.
void	onSendEmpty ()
void	insertSubAccountInfo (AccountID const &account, bool rt)
void	deleteSubAccountInfo (AccountID const &account, bool rt)
void	insertBookSubscription (Book const &book)
	Record that this subscriber is following `book`.
void	deleteBookSubscription (Book const &book)
	Stop tracking `book` for this subscriber.
bool	insertSubAccountHistory (AccountID const &account)
void	deleteSubAccountHistory (AccountID const &account)
void	clearRequest ()
void	setRequest (std::shared_ptr< InfoSubRequest > const &req)
std::shared_ptr< InfoSubRequest > const &	getRequest ()
void	setApiVersion (unsigned int apiVersion)
unsigned int	getApiVersion () const noexcept

Public Attributes
friend	Object

Protected Attributes
std::mutex	lock_

Static Private Member Functions
static int	assignId ()
static auto &	getCounter () noexcept

Private Attributes
Consumer	consumer_
Source &	source_
hash_set< AccountID >	realTimeSubscriptions_
hash_set< AccountID >	normalSubscriptions_
std::shared_ptr< InfoSubRequest >	request_
std::uint64_t	seq_
hash_set< AccountID >	accountHistorySubscriptions_
hash_set< Book >	bookSubscriptions_
unsigned int	apiVersion_ = 0

Detailed Description

Manages a client's subscription to data feeds.

An InfoSub holds a non-owning reference to its Source (typically the process-wide NetworkOPsImp). The destructor reaches back into the Source to remove this subscriber from every server-side subscription map.

Note: Lifetime contract: every InfoSub instance MUST be destroyed before the backing Source. NetworkOPsImp shutdown drops all subscriber strong refs before its own teardown to satisfy this.; Thread-safety: per-instance state is guarded by lock_. The destructor reads tracking sets without taking lock_ because the strong-pointer ref-count is zero at destruction time, so no other thread can be calling the public mutators.

Definition at line 88 of file InfoSub.h.

Member Typedef Documentation

◆ pointer

using xrpl::InfoSub::pointer = std::shared_ptr<InfoSub>

Definition at line 91 of file InfoSub.h.

◆ wptr

using xrpl::InfoSub::wptr = std::weak_ptr<InfoSub>

Definition at line 95 of file InfoSub.h.

◆ ref

using xrpl::InfoSub::ref = std::shared_ptr<InfoSub> const&

Definition at line 97 of file InfoSub.h.

◆ Consumer

using xrpl::InfoSub::Consumer = resource::Consumer

Definition at line 99 of file InfoSub.h.

Constructor & Destructor Documentation

◆ InfoSub() [1/2]

xrpl::InfoSub::InfoSub ( Source & source )

Definition at line 58 of file libxrpl/server/InfoSub.cpp.

◆ InfoSub() [2/2]

xrpl::InfoSub::InfoSub	(	Source &	source,
		Consumer	consumer )

Definition at line 62 of file libxrpl/server/InfoSub.cpp.

◆ ~InfoSub()

xrpl::InfoSub::~InfoSub ( )

virtual

Definition at line 67 of file libxrpl/server/InfoSub.cpp.

Member Function Documentation

◆ getConsumer()

resource::Consumer & xrpl::InfoSub::getConsumer ( )

Definition at line 132 of file libxrpl/server/InfoSub.cpp.

◆ send()

virtual void xrpl::InfoSub::send	(	json::Value const &	jvObj,
		bool	broadcast )

pure virtual

Implemented in xrpl::RPCSubImp, and xrpl::WSInfoSub.

◆ getSeq()

std::uint64_t xrpl::InfoSub::getSeq ( ) const

nodiscard

Definition at line 138 of file libxrpl/server/InfoSub.cpp.

◆ totalSubscriptionCount()

std::size_t xrpl::InfoSub::totalSubscriptionCount ( ) const

nodiscard

Return the number of subscriptions currently tracked on this connection.

The combined size of the per-connection account, real-time account, and account-history subscription sets. doSubscribe reads this to enforce the per-connection subscription cap before admitting more.

Returns: The total tracked subscription count for this connection.

Note: Thread-safe: takes lock_ for the read; read-only.

Definition at line 149 of file libxrpl/server/InfoSub.cpp.

◆ tryReserveAccountSubscriptions()

bool xrpl::InfoSub::tryReserveAccountSubscriptions	(	hash_set< AccountID > const &	proposedAccounts,
		hash_set< AccountID > const &	normalAccounts,
		std::size_t	cap )

nodiscard

Enforce the cap and reserve a request's net-new accounts, atomically.

Under one hold of lock_: count the net-new entries in the two sets, check the total against cap, and insert them only if it fits. All-or-nothing. Doing check and insert together stops two concurrent requests sharing an InfoSub (the admin subscribe-by-url path) from both passing the check before either records its accounts. The server-side maps are populated afterwards by subAccount, whose re-insert is a no-op.

Parameters

proposedAccounts	Real-time (accounts_proposed) ids to reserve.
normalAccounts	Normal (accounts) ids to reserve.
cap	The effective per-connection cap.

Returns: true if reserved; false if the request must be rejected.

Note: Thread-safe: takes lock_.

Definition at line 161 of file libxrpl/server/InfoSub.cpp.

◆ hasAccountHistorySubscription()

bool xrpl::InfoSub::hasAccountHistorySubscription ( AccountID const & account ) const

nodiscard

Whether this connection already tracks an account-history for account.

doSubscribe reads this to charge the cap for an account_history_tx_stream only when it is net-new, matching the account branches.

Parameters

account The account an account_history_tx_stream would add.

Returns: true if account is already in the account-history set.

Note: Thread-safe: takes lock_; read-only.

Definition at line 240 of file libxrpl/server/InfoSub.cpp.

◆ onSendEmpty()

void xrpl::InfoSub::onSendEmpty ( )

Definition at line 144 of file libxrpl/server/InfoSub.cpp.

◆ insertSubAccountInfo()

void xrpl::InfoSub::insertSubAccountInfo	(	AccountID const &	account,
		bool	rt )

Definition at line 196 of file libxrpl/server/InfoSub.cpp.

◆ deleteSubAccountInfo()

void xrpl::InfoSub::deleteSubAccountInfo	(	AccountID const &	account,
		bool	rt )

Definition at line 211 of file libxrpl/server/InfoSub.cpp.

◆ insertBookSubscription()

void xrpl::InfoSub::insertBookSubscription ( Book const & book )

Record that this subscriber is following book.

Called by NetworkOPsImp::subBook so that ~InfoSub() can issue a matching unsubBook for every book this subscriber is tracking, keeping per-subscriber state symmetric with the server-side map.

Parameters

book	The order book this subscriber has just subscribed to.

Note: Idempotent: re-inserting an already-tracked book is a no-op.; Thread-safe: takes InfoSub::lock_.

Definition at line 247 of file libxrpl/server/InfoSub.cpp.

◆ deleteBookSubscription()

void xrpl::InfoSub::deleteBookSubscription ( Book const & book )

Stop tracking book for this subscriber.

Called by the unsubscribe RPC handler so that the book is not re-unsubscribed by ~InfoSub(). Pairs with insertBookSubscription.

Parameters

book	The order book to forget.

Note: No-op if book was not previously inserted.; Thread-safe: takes InfoSub::lock_.

Definition at line 254 of file libxrpl/server/InfoSub.cpp.

◆ insertSubAccountHistory()

bool xrpl::InfoSub::insertSubAccountHistory ( AccountID const & account )

Definition at line 226 of file libxrpl/server/InfoSub.cpp.

◆ deleteSubAccountHistory()

void xrpl::InfoSub::deleteSubAccountHistory ( AccountID const & account )

Definition at line 233 of file libxrpl/server/InfoSub.cpp.

◆ clearRequest()

void xrpl::InfoSub::clearRequest ( )

Definition at line 261 of file libxrpl/server/InfoSub.cpp.

◆ setRequest()

void xrpl::InfoSub::setRequest ( std::shared_ptr< InfoSubRequest > const & req )

Definition at line 267 of file libxrpl/server/InfoSub.cpp.

◆ getRequest()

std::shared_ptr< InfoSubRequest > const & xrpl::InfoSub::getRequest ( )

Definition at line 273 of file libxrpl/server/InfoSub.cpp.

◆ setApiVersion()

void xrpl::InfoSub::setApiVersion ( unsigned int apiVersion )

Definition at line 279 of file libxrpl/server/InfoSub.cpp.

◆ getApiVersion()

unsigned int xrpl::InfoSub::getApiVersion ( ) const

nodiscardnoexcept

Definition at line 285 of file libxrpl/server/InfoSub.cpp.

◆ assignId()

int xrpl::InfoSub::assignId ( )

staticprivate

Definition at line 433 of file InfoSub.h.

◆ getCounter()

auto & xrpl::CountedObject< InfoSub >::getCounter ( )

staticprivatenoexceptinherited

Definition at line 113 of file CountedObject.h.

Member Data Documentation

◆ lock_

std::mutex xrpl::InfoSub::lock_

mutableprotected

Definition at line 419 of file InfoSub.h.

◆ consumer_

Consumer xrpl::InfoSub::consumer_

private

Definition at line 422 of file InfoSub.h.

◆ source_

Source& xrpl::InfoSub::source_

private

Definition at line 423 of file InfoSub.h.

◆ realTimeSubscriptions_

hash_set<AccountID> xrpl::InfoSub::realTimeSubscriptions_

private

Definition at line 424 of file InfoSub.h.

◆ normalSubscriptions_

hash_set<AccountID> xrpl::InfoSub::normalSubscriptions_

private

Definition at line 425 of file InfoSub.h.

◆ request_

std::shared_ptr<InfoSubRequest> xrpl::InfoSub::request_

private

Definition at line 426 of file InfoSub.h.

◆ seq_

std::uint64_t xrpl::InfoSub::seq_

private

Definition at line 427 of file InfoSub.h.

◆ accountHistorySubscriptions_

hash_set<AccountID> xrpl::InfoSub::accountHistorySubscriptions_

private

Definition at line 428 of file InfoSub.h.

◆ bookSubscriptions_

hash_set<Book> xrpl::InfoSub::bookSubscriptions_

private

Definition at line 429 of file InfoSub.h.

◆ apiVersion_

unsigned int xrpl::InfoSub::apiVersion_ = 0

private

Definition at line 430 of file InfoSub.h.

◆ Object

friend xrpl::CountedObject< InfoSub >::InfoSub

inherited

Definition at line 138 of file CountedObject.h.

Classes

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ pointer

◆ wptr

◆ ref

◆ Consumer

Constructor & Destructor Documentation

◆ InfoSub() [1/2]

◆ InfoSub() [2/2]

◆ ~InfoSub()

Member Function Documentation

◆ getConsumer()

◆ send()

◆ getSeq()

◆ totalSubscriptionCount()

◆ tryReserveAccountSubscriptions()

◆ hasAccountHistorySubscription()

◆ onSendEmpty()

◆ insertSubAccountInfo()

◆ deleteSubAccountInfo()

◆ insertBookSubscription()

◆ deleteBookSubscription()

◆ insertSubAccountHistory()

◆ deleteSubAccountHistory()

◆ clearRequest()

◆ setRequest()

◆ getRequest()

◆ setApiVersion()

◆ getApiVersion()

◆ assignId()

◆ getCounter()

Member Data Documentation

◆ lock_

◆ consumer_

◆ source_

◆ realTimeSubscriptions_

◆ normalSubscriptions_

◆ request_

◆ seq_

◆ accountHistorySubscriptions_

◆ bookSubscriptions_

◆ apiVersion_

◆ Object