#include <WSInfoSub.h>

Inheritance diagram for xrpl::WSInfoSub:

[legend]

Collaboration diagram for xrpl::WSInfoSub:

[legend]

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
	WSInfoSub (Source &source, std::shared_ptr< WSSession > const &ws)
std::string_view	user () const
std::string_view	forwardedFor () const
void	send (json::Value const &jv, bool) override
Consumer &	getConsumer ()
std::uint64_t	getSeq () const
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
std::weak_ptr< WSSession >	ws_
std::string	user_
std::string	fwdfor_
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

Definition at line 15 of file WSInfoSub.h.

Member Typedef Documentation

◆ pointer

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

inherited

Definition at line 47 of file InfoSub.h.

◆ wptr

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

inherited

Definition at line 51 of file InfoSub.h.

◆ ref

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

inherited

Definition at line 53 of file InfoSub.h.

◆ Consumer

using xrpl::InfoSub::Consumer = Resource::Consumer

inherited

Definition at line 55 of file InfoSub.h.

Constructor & Destructor Documentation

◆ WSInfoSub()

xrpl::WSInfoSub::WSInfoSub	(	Source &	source,
		std::shared_ptr< WSSession > const &	ws )

Definition at line 22 of file WSInfoSub.h.

Member Function Documentation

◆ user()

std::string_view xrpl::WSInfoSub::user ( ) const

nodiscard

Definition at line 38 of file WSInfoSub.h.

◆ forwardedFor()

std::string_view xrpl::WSInfoSub::forwardedFor ( ) const

nodiscard

Definition at line 44 of file WSInfoSub.h.

◆ send()

void xrpl::WSInfoSub::send	(	json::Value const &	jv,
		bool	)

overridevirtual

Implements xrpl::InfoSub.

Definition at line 50 of file WSInfoSub.h.

◆ getConsumer()

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

inherited

Definition at line 108 of file InfoSub.cpp.

◆ getSeq()

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

nodiscardinherited

Definition at line 114 of file InfoSub.cpp.

◆ onSendEmpty()

void xrpl::InfoSub::onSendEmpty ( )

inherited

Definition at line 120 of file InfoSub.cpp.

◆ insertSubAccountInfo()

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

inherited

Definition at line 125 of file InfoSub.cpp.

◆ deleteSubAccountInfo()

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

inherited

Definition at line 140 of file InfoSub.cpp.

◆ insertBookSubscription()

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

inherited

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 169 of file InfoSub.cpp.

◆ deleteBookSubscription()

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

inherited

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 176 of file InfoSub.cpp.

◆ insertSubAccountHistory()

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

inherited

Definition at line 155 of file InfoSub.cpp.

◆ deleteSubAccountHistory()

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

inherited

Definition at line 162 of file InfoSub.cpp.

◆ clearRequest()

void xrpl::InfoSub::clearRequest ( )

inherited

Definition at line 183 of file InfoSub.cpp.

◆ setRequest()

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

inherited

Definition at line 189 of file InfoSub.cpp.

◆ getRequest()

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

inherited

Definition at line 195 of file InfoSub.cpp.

◆ setApiVersion()

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

inherited

Definition at line 201 of file InfoSub.cpp.

◆ getApiVersion()

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

nodiscardnoexceptinherited

Definition at line 207 of file InfoSub.cpp.

◆ assignId()

int xrpl::InfoSub::assignId ( )

staticprivateinherited

Definition at line 305 of file InfoSub.h.

◆ getCounter()

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

staticprivatenoexceptinherited

Definition at line 109 of file CountedObject.h.

Member Data Documentation

◆ ws_

std::weak_ptr<WSSession> xrpl::WSInfoSub::ws_

private

Definition at line 17 of file WSInfoSub.h.

◆ user_

std::string xrpl::WSInfoSub::user_

private

Definition at line 18 of file WSInfoSub.h.

◆ fwdfor_

std::string xrpl::WSInfoSub::fwdfor_

private

Definition at line 19 of file WSInfoSub.h.

◆ lock_

std::mutex xrpl::InfoSub::lock_

protectedinherited

Definition at line 291 of file InfoSub.h.

◆ consumer_

Consumer xrpl::InfoSub::consumer_

privateinherited

Definition at line 294 of file InfoSub.h.

◆ source_

Source& xrpl::InfoSub::source_

privateinherited

Definition at line 295 of file InfoSub.h.

◆ realTimeSubscriptions_

hash_set<AccountID> xrpl::InfoSub::realTimeSubscriptions_

privateinherited

Definition at line 296 of file InfoSub.h.

◆ normalSubscriptions_

hash_set<AccountID> xrpl::InfoSub::normalSubscriptions_

privateinherited

Definition at line 297 of file InfoSub.h.

◆ request_

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

privateinherited

Definition at line 298 of file InfoSub.h.

◆ seq_

std::uint64_t xrpl::InfoSub::seq_

privateinherited

Definition at line 299 of file InfoSub.h.

◆ accountHistorySubscriptions_

hash_set<AccountID> xrpl::InfoSub::accountHistorySubscriptions_

privateinherited

Definition at line 300 of file InfoSub.h.

◆ bookSubscriptions_

hash_set<Book> xrpl::InfoSub::bookSubscriptions_

privateinherited

Definition at line 301 of file InfoSub.h.

◆ apiVersion_

unsigned int xrpl::InfoSub::apiVersion_ = 0

privateinherited

Definition at line 302 of file InfoSub.h.

◆ Object

friend xrpl::CountedObject< InfoSub >::InfoSub

inherited

Definition at line 134 of file CountedObject.h.

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

◆ WSInfoSub()

Member Function Documentation

◆ user()

◆ forwardedFor()

◆ send()

◆ getConsumer()

◆ getSeq()

◆ onSendEmpty()

◆ insertSubAccountInfo()

◆ deleteSubAccountInfo()

◆ insertBookSubscription()

◆ deleteBookSubscription()

◆ insertSubAccountHistory()

◆ deleteSubAccountHistory()

◆ clearRequest()

◆ setRequest()

◆ getRequest()

◆ setApiVersion()

◆ getApiVersion()

◆ assignId()

◆ getCounter()

Member Data Documentation

◆ ws_

◆ user_

◆ fwdfor_

◆ lock_

◆ consumer_

◆ source_

◆ realTimeSubscriptions_

◆ normalSubscriptions_

◆ request_

◆ seq_

◆ accountHistorySubscriptions_

◆ bookSubscriptions_

◆ apiVersion_

◆ Object