ripple::InfoSub::Source Class Reference

Abstracts the source of subscription data. More...

#include <InfoSub.h>

Inheritance diagram for ripple::InfoSub::Source:

Public Member Functions
virtual	~Source ()=default
virtual void	subAccount (ref ispListener, hash_set< AccountID > const &vnaAccountIDs, bool realTime)=0
virtual void	unsubAccount (ref isplistener, hash_set< AccountID > const &vnaAccountIDs, bool realTime)=0
virtual void	unsubAccountInternal (std::uint64_t uListener, hash_set< AccountID > const &vnaAccountIDs, bool realTime)=0
virtual error_code_i	subAccountHistory (ref ispListener, AccountID const &account)=0
	subscribe an account's new transactions and retrieve the account's historical transactions
virtual void	unsubAccountHistory (ref ispListener, AccountID const &account, bool historyOnly)=0
	unsubscribe an account's transactions
virtual void	unsubAccountHistoryInternal (std::uint64_t uListener, AccountID const &account, bool historyOnly)=0
virtual bool	subLedger (ref ispListener, Json::Value &jvResult)=0
virtual bool	unsubLedger (std::uint64_t uListener)=0
virtual bool	subBookChanges (ref ispListener)=0
virtual bool	unsubBookChanges (std::uint64_t uListener)=0
virtual bool	subManifests (ref ispListener)=0
virtual bool	unsubManifests (std::uint64_t uListener)=0
virtual void	pubManifest (Manifest const &)=0
virtual bool	subServer (ref ispListener, Json::Value &jvResult, bool admin)=0
virtual bool	unsubServer (std::uint64_t uListener)=0
virtual bool	subBook (ref ispListener, Book const &)=0
virtual bool	unsubBook (std::uint64_t uListener, Book const &)=0
virtual bool	subTransactions (ref ispListener)=0
virtual bool	unsubTransactions (std::uint64_t uListener)=0
virtual bool	subRTTransactions (ref ispListener)=0
virtual bool	unsubRTTransactions (std::uint64_t uListener)=0
virtual bool	subValidations (ref ispListener)=0
virtual bool	unsubValidations (std::uint64_t uListener)=0
virtual bool	subPeerStatus (ref ispListener)=0
virtual bool	unsubPeerStatus (std::uint64_t uListener)=0
virtual void	pubPeerStatus (std::function< Json::Value(void)> const &)=0
virtual bool	subConsensus (ref ispListener)=0
virtual bool	unsubConsensus (std::uint64_t uListener)=0
virtual pointer	findRpcSub (std::string const &strUrl)=0
virtual pointer	addRpcSub (std::string const &strUrl, ref rspEntry)=0
virtual bool	tryRemoveRpcSub (std::string const &strUrl)=0

Detailed Description

Abstracts the source of subscription data.

Definition at line 67 of file InfoSub.h.

Constructor & Destructor Documentation

~Source()

virtual ripple::InfoSub::Source::~Source ( )

virtualdefault

Member Function Documentation

subAccount()

virtual void ripple::InfoSub::Source::subAccount ( ref  ispListener, hash_set< AccountID > const &  vnaAccountIDs, bool  realTime  )

pure virtual

Implemented in ripple::NetworkOPsImp.

unsubAccount()

virtual void ripple::InfoSub::Source::unsubAccount ( ref  isplistener, hash_set< AccountID > const &  vnaAccountIDs, bool  realTime  )

pure virtual

Implemented in ripple::NetworkOPsImp.

unsubAccountInternal()

virtual void ripple::InfoSub::Source::unsubAccountInternal ( std::uint64_t  uListener, hash_set< AccountID > const &  vnaAccountIDs, bool  realTime  )

pure virtual

Implemented in ripple::NetworkOPsImp.

subAccountHistory()

virtual error_code_i ripple::InfoSub::Source::subAccountHistory ( ref  ispListener, AccountID const &  account  )

pure virtual

subscribe an account's new transactions and retrieve the account's historical transactions

Returns

rpcSUCCESS if successful, otherwise an error code

Implemented in ripple::NetworkOPsImp.

unsubAccountHistory()

virtual void ripple::InfoSub::Source::unsubAccountHistory ( ref  ispListener, AccountID const &  account, bool  historyOnly  )

pure virtual

unsubscribe an account's transactions

Parameters

historyOnly

if true, only stop historical transactions

Note

once a client receives enough historical transactions, it should unsubscribe with historyOnly == true to stop receiving more historical transactions. It will continue to receive new transactions.

Implemented in ripple::NetworkOPsImp.

unsubAccountHistoryInternal()

virtual void ripple::InfoSub::Source::unsubAccountHistoryInternal ( std::uint64_t  uListener, AccountID const &  account, bool  historyOnly  )

pure virtual

Implemented in ripple::NetworkOPsImp.

subLedger()

virtual bool ripple::InfoSub::Source::subLedger ( ref  ispListener, Json::Value &  jvResult  )

pure virtual

Implemented in ripple::NetworkOPsImp.

unsubLedger()

virtual bool ripple::InfoSub::Source::unsubLedger ( std::uint64_t  uListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

subBookChanges()

virtual bool ripple::InfoSub::Source::subBookChanges ( ref  ispListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

unsubBookChanges()

virtual bool ripple::InfoSub::Source::unsubBookChanges ( std::uint64_t  uListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

subManifests()

virtual bool ripple::InfoSub::Source::subManifests ( ref  ispListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

unsubManifests()

virtual bool ripple::InfoSub::Source::unsubManifests ( std::uint64_t  uListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

pubManifest()

virtual void ripple::InfoSub::Source::pubManifest ( Manifest const &  )

pure virtual

Implemented in ripple::NetworkOPsImp.

subServer()

virtual bool ripple::InfoSub::Source::subServer ( ref  ispListener, Json::Value &  jvResult, bool  admin  )

pure virtual

Implemented in ripple::NetworkOPsImp.

unsubServer()

virtual bool ripple::InfoSub::Source::unsubServer ( std::uint64_t  uListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

subBook()

virtual bool ripple::InfoSub::Source::subBook ( ref  ispListener, Book const &    )

pure virtual

Implemented in ripple::NetworkOPsImp.

unsubBook()

virtual bool ripple::InfoSub::Source::unsubBook ( std::uint64_t  uListener, Book const &    )

pure virtual

Implemented in ripple::NetworkOPsImp.

subTransactions()

virtual bool ripple::InfoSub::Source::subTransactions ( ref  ispListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

unsubTransactions()

virtual bool ripple::InfoSub::Source::unsubTransactions ( std::uint64_t  uListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

subRTTransactions()

virtual bool ripple::InfoSub::Source::subRTTransactions ( ref  ispListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

unsubRTTransactions()

virtual bool ripple::InfoSub::Source::unsubRTTransactions ( std::uint64_t  uListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

subValidations()

virtual bool ripple::InfoSub::Source::subValidations ( ref  ispListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

unsubValidations()

virtual bool ripple::InfoSub::Source::unsubValidations ( std::uint64_t  uListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

subPeerStatus()

virtual bool ripple::InfoSub::Source::subPeerStatus ( ref  ispListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

unsubPeerStatus()

virtual bool ripple::InfoSub::Source::unsubPeerStatus ( std::uint64_t  uListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

pubPeerStatus()

virtual void ripple::InfoSub::Source::pubPeerStatus ( std::function< Json::Value(void)> const &  )

pure virtual

Implemented in ripple::NetworkOPsImp.

subConsensus()

virtual bool ripple::InfoSub::Source::subConsensus ( ref  ispListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

unsubConsensus()

virtual bool ripple::InfoSub::Source::unsubConsensus ( std::uint64_t  uListener )

pure virtual

Implemented in ripple::NetworkOPsImp.

findRpcSub()

virtual pointer ripple::InfoSub::Source::findRpcSub ( std::string const &  strUrl )

pure virtual

Implemented in ripple::NetworkOPsImp.

addRpcSub()

virtual pointer ripple::InfoSub::Source::addRpcSub ( std::string const &  strUrl, ref  rspEntry  )

pure virtual

Implemented in ripple::NetworkOPsImp.

tryRemoveRpcSub()

virtual bool ripple::InfoSub::Source::tryRemoveRpcSub ( std::string const &  strUrl )

pure virtual

Implemented in ripple::NetworkOPsImp.