ripple::FlowOfferStream< TIn, TOut > Class Template Reference

Presents and consumes the offers in an order book. More...

#include <OfferStream.h>

Inheritance diagram for ripple::FlowOfferStream< TIn, TOut >:

Collaboration diagram for ripple::FlowOfferStream< TIn, TOut >:

Public Member Functions
void	permRmOffer (uint256 const &offerIndex) override
boost::container::flat_set< uint256 > const &	permToRemove () const
TOffer< TIn, TOut > &	tip () const
	Returns the offer at the tip of the order book.
bool	step ()
	Advance to the next valid offer.
TOut	ownerFunds () const

Protected Member Functions
void	erase (ApplyView &view)
template<class TTakerPays , class TTakerGets >
bool	shouldRmSmallIncreasedQOffer () const

Protected Attributes
beast::Journal const	j_
ApplyView &	view_
ApplyView &	cancelView_
Book	book_
bool	validBook_
NetClock::time_point const	expire_
BookTip	tip_
TOffer< TIn, TOut >	offer_
std::optional< TOut >	ownerFunds_
StepCounter &	counter_

Private Attributes
boost::container::flat_set< uint256 >	permToRemove_

Detailed Description

template<class TIn, class TOut>
class ripple::FlowOfferStream< TIn, TOut >

Presents and consumes the offers in an order book.

The ‘view_’ ApplyViewaccumulates changes to the ledger. ThecancelView_is used to determine if an offer is found unfunded or became unfunded. ThepermToRemove` collection identifies offers that should be removed even if the strand associated with this OfferStream is not applied.

Certain invalid offers are added to the permToRemove collection:

• Offers with missing ledger entries
• Offers that expired
• Offers found unfunded: An offer is found unfunded when the corresponding balance is zero and the caller has not modified the balance. This is accomplished by also looking up the balance in the cancel view.

Definition at line 156 of file OfferStream.h.

Member Function Documentation

permRmOffer()

template<class TIn , class TOut >

void ripple::FlowOfferStream< TIn, TOut >::permRmOffer ( uint256 const &  offerIndex )

overridevirtual

Implements ripple::TOfferStreamBase< TIn, TOut >.

Definition at line 392 of file OfferStream.cpp.

permToRemove()

template<class TIn , class TOut >

boost::container::flat_set< uint256 > const & ripple::FlowOfferStream< TIn, TOut >::permToRemove

(

)

const

Definition at line 172 of file OfferStream.h.

erase()

template<class TIn , class TOut >

void ripple::TOfferStreamBase< TIn, TOut >::erase ( ApplyView &  view )

protectedinherited

Definition at line 47 of file OfferStream.cpp.

shouldRmSmallIncreasedQOffer()

template<class TIn , class TOut >

template<class TTakerPays , class TTakerGets >

bool ripple::TOfferStreamBase< TIn, TOut >::shouldRmSmallIncreasedQOffer ( ) const

protectedinherited

Definition at line 125 of file OfferStream.cpp.

tip()

template<class TIn , class TOut >

TOffer< TIn, TOut > & ripple::TOfferStreamBase< TIn, TOut >::tip ( ) const

inherited

Returns the offer at the tip of the order book.

Offers are always presented in decreasing quality. Only valid if step() returned true.

Definition at line 89 of file OfferStream.h.

step()

template<class TIn , class TOut >

bool ripple::TOfferStreamBase< TIn, TOut >::step ( )

inherited

Advance to the next valid offer.

This automatically removes:

• Offers with missing ledger entries
• Offers found unfunded
• expired offers

  Returns

  true if there is a valid offer.

Definition at line 196 of file OfferStream.cpp.

ownerFunds()

template<class TIn , class TOut >

TOut ripple::TOfferStreamBase< TIn, TOut >::ownerFunds ( ) const

inherited

Definition at line 105 of file OfferStream.h.

Member Data Documentation

permToRemove_

template<class TIn , class TOut >

boost::container::flat_set<uint256> ripple::FlowOfferStream< TIn, TOut >::permToRemove_

private

Definition at line 159 of file OfferStream.h.

j_

template<class TIn , class TOut >

beast::Journal const ripple::TOfferStreamBase< TIn, TOut >::j_

protectedinherited

Definition at line 52 of file OfferStream.h.

view_

template<class TIn , class TOut >

ApplyView& ripple::TOfferStreamBase< TIn, TOut >::view_

protectedinherited

Definition at line 53 of file OfferStream.h.

cancelView_

template<class TIn , class TOut >

ApplyView& ripple::TOfferStreamBase< TIn, TOut >::cancelView_

protectedinherited

Definition at line 54 of file OfferStream.h.

book_

template<class TIn , class TOut >

Book ripple::TOfferStreamBase< TIn, TOut >::book_

protectedinherited

Definition at line 55 of file OfferStream.h.

validBook_

template<class TIn , class TOut >

bool ripple::TOfferStreamBase< TIn, TOut >::validBook_

protectedinherited

Definition at line 56 of file OfferStream.h.

expire_

template<class TIn , class TOut >

NetClock::time_point const ripple::TOfferStreamBase< TIn, TOut >::expire_

protectedinherited

Definition at line 57 of file OfferStream.h.

tip_

template<class TIn , class TOut >

BookTip ripple::TOfferStreamBase< TIn, TOut >::tip_

protectedinherited

Definition at line 58 of file OfferStream.h.

offer_

template<class TIn , class TOut >

TOffer<TIn, TOut> ripple::TOfferStreamBase< TIn, TOut >::offer_

protectedinherited

Definition at line 59 of file OfferStream.h.

ownerFunds_

template<class TIn , class TOut >

std::optional<TOut> ripple::TOfferStreamBase< TIn, TOut >::ownerFunds_

protectedinherited

Definition at line 60 of file OfferStream.h.

counter_

template<class TIn , class TOut >

StepCounter& ripple::TOfferStreamBase< TIn, TOut >::counter_

protectedinherited

Definition at line 61 of file OfferStream.h.