ripple::InfoSub Class Reference

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

#include <InfoSub.h>

Inheritance diagram for ripple::InfoSub:

Collaboration diagram for ripple::InfoSub:

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 ()
void	onSendEmpty ()
void	insertSubAccountInfo (AccountID const &account, bool rt)
void	deleteSubAccountInfo (AccountID const &account, bool rt)
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

Protected Attributes
std::mutex	mLock

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

Private Attributes
Consumer	m_consumer
Source &	m_source
hash_set< AccountID >	realTimeSubscriptions_
hash_set< AccountID >	normalSubscriptions_
std::shared_ptr< InfoSubRequest >	request_
std::uint64_t	mSeq
hash_set< AccountID >	accountHistorySubscriptions_
unsigned int	apiVersion_ = 0

Detailed Description

Manages a client's subscription to data feeds.

Definition at line 51 of file InfoSub.h.

Member Typedef Documentation

pointer

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

Definition at line 54 of file InfoSub.h.

wptr

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

Definition at line 58 of file InfoSub.h.

ref

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

Definition at line 60 of file InfoSub.h.

Consumer

using ripple::InfoSub::Consumer = Resource::Consumer

Definition at line 62 of file InfoSub.h.

Constructor & Destructor Documentation

InfoSub() [1/2]

ripple::InfoSub::InfoSub

(

Source &

source

)

Definition at line 35 of file InfoSub.cpp.

InfoSub() [2/2]

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

Definition at line 39 of file InfoSub.cpp.

~InfoSub()

ripple::InfoSub::~InfoSub ( )

virtual

Definition at line 44 of file InfoSub.cpp.

Member Function Documentation

getConsumer()

Resource::Consumer & ripple::InfoSub::getConsumer

(

)

Definition at line 68 of file InfoSub.cpp.

send()

virtual void ripple::InfoSub::send ( Json::Value const &  jvObj, bool  broadcast  )

pure virtual

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

getSeq()

std::uint64_t ripple::InfoSub::getSeq

(

)

Definition at line 74 of file InfoSub.cpp.

onSendEmpty()

void ripple::InfoSub::onSendEmpty

(

)

Definition at line 80 of file InfoSub.cpp.

insertSubAccountInfo()

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

Definition at line 85 of file InfoSub.cpp.

deleteSubAccountInfo()

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

Definition at line 96 of file InfoSub.cpp.

insertSubAccountHistory()

bool ripple::InfoSub::insertSubAccountHistory

(

AccountID const &

account

)

Definition at line 107 of file InfoSub.cpp.

deleteSubAccountHistory()

void ripple::InfoSub::deleteSubAccountHistory

(

AccountID const &

account

)

Definition at line 114 of file InfoSub.cpp.

clearRequest()

void ripple::InfoSub::clearRequest

(

)

Definition at line 121 of file InfoSub.cpp.

setRequest()

void ripple::InfoSub::setRequest

(

std::shared_ptr< InfoSubRequest > const &

req

)

Definition at line 127 of file InfoSub.cpp.

getRequest()

std::shared_ptr< InfoSubRequest > const & ripple::InfoSub::getRequest

(

)

Definition at line 133 of file InfoSub.cpp.

setApiVersion()

void ripple::InfoSub::setApiVersion

(

unsigned int

apiVersion

)

Definition at line 139 of file InfoSub.cpp.

getApiVersion()

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

noexcept

Definition at line 145 of file InfoSub.cpp.

assign_id()

static int ripple::InfoSub::assign_id ( )

staticprivate

Definition at line 252 of file InfoSub.h.

getCounter()

static auto & ripple::CountedObject< InfoSub >::getCounter ( )

staticprivatenoexceptinherited

Definition at line 129 of file CountedObject.h.

Member Data Documentation

mLock

std::mutex ripple::InfoSub::mLock

protected

Definition at line 239 of file InfoSub.h.

m_consumer

Consumer ripple::InfoSub::m_consumer

private

Definition at line 242 of file InfoSub.h.

m_source

Source& ripple::InfoSub::m_source

private

Definition at line 243 of file InfoSub.h.

realTimeSubscriptions_

hash_set<AccountID> ripple::InfoSub::realTimeSubscriptions_

private

Definition at line 244 of file InfoSub.h.

normalSubscriptions_

hash_set<AccountID> ripple::InfoSub::normalSubscriptions_

private

Definition at line 245 of file InfoSub.h.

request_

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

private

Definition at line 246 of file InfoSub.h.

mSeq

std::uint64_t ripple::InfoSub::mSeq

private

Definition at line 247 of file InfoSub.h.

accountHistorySubscriptions_

hash_set<AccountID> ripple::InfoSub::accountHistorySubscriptions_

private

Definition at line 248 of file InfoSub.h.

apiVersion_

unsigned int ripple::InfoSub::apiVersion_ = 0

private

Definition at line 249 of file InfoSub.h.