xrpl::OfferStream Class Reference

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

#include <OfferStream.h>

Inheritance diagram for xrpl::OfferStream:

Collaboration diagram for xrpl::OfferStream:

Public Member Functions
TOffer< STAmount, STAmount > &	tip () const
	Returns the offer at the tip of the order book.
bool	step ()
	Advance to the next valid offer.
STAmount	ownerFunds () const

Protected Member Functions
void	permRmOffer (uint256 const &offerIndex) override
void	erase (ApplyView &view)
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< STAmount, STAmount >	offer_
std::optional< STAmount >	ownerFunds_
StepCounter &	counter_

Detailed Description

Presents and consumes the offers in an order book.

Two ApplyView objects accumulate changes to the ledger. view is applied when the calling transaction succeeds. If the calling transaction fails, then view_cancel is applied.

Certain invalid offers are automatically removed:

• 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.

When an offer is removed, it is removed from both views. This grooms the order book regardless of whether or not the transaction is successful.

Definition at line 126 of file OfferStream.h.

Member Function Documentation

permRmOffer()

void xrpl::OfferStream::permRmOffer ( uint256 const &  offerIndex )

overrideprotectedvirtual

Implements xrpl::TOfferStreamBase< STAmount, STAmount >.

Definition at line 341 of file OfferStream.cpp.

erase()

void xrpl::TOfferStreamBase< STAmount , STAmount >::erase ( ApplyView &  view )

protectedinherited

Definition at line 62 of file OfferStream.cpp.

shouldRmSmallIncreasedQOffer()

bool xrpl::TOfferStreamBase< STAmount , STAmount >::shouldRmSmallIncreasedQOffer ( ) const

protectedinherited

Definition at line 69 of file OfferStream.cpp.

tip()

TOffer< STAmount , STAmount > & xrpl::TOfferStreamBase< STAmount , STAmount >::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 87 of file OfferStream.h.

step()

bool xrpl::TOfferStreamBase< STAmount , STAmount >::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 100 of file OfferStream.cpp.

ownerFunds()

STAmount xrpl::TOfferStreamBase< STAmount , STAmount >::ownerFunds ( ) const

inherited

Definition at line 103 of file OfferStream.h.

Member Data Documentation

j_

beast::Journal const xrpl::TOfferStreamBase< STAmount , STAmount >::j_

protectedinherited

Definition at line 50 of file OfferStream.h.

view_

ApplyView& xrpl::TOfferStreamBase< STAmount , STAmount >::view_

protectedinherited

Definition at line 51 of file OfferStream.h.

cancelView_

ApplyView& xrpl::TOfferStreamBase< STAmount , STAmount >::cancelView_

protectedinherited

Definition at line 52 of file OfferStream.h.

book_

Book xrpl::TOfferStreamBase< STAmount , STAmount >::book_

protectedinherited

Definition at line 53 of file OfferStream.h.

validBook_

bool xrpl::TOfferStreamBase< STAmount , STAmount >::validBook_

protectedinherited

Definition at line 54 of file OfferStream.h.

expire_

NetClock::time_point const xrpl::TOfferStreamBase< STAmount , STAmount >::expire_

protectedinherited

Definition at line 55 of file OfferStream.h.

tip_

BookTip xrpl::TOfferStreamBase< STAmount , STAmount >::tip_

protectedinherited

Definition at line 56 of file OfferStream.h.

offer_

TOffer<STAmount , STAmount > xrpl::TOfferStreamBase< STAmount , STAmount >::offer_

protectedinherited

Definition at line 57 of file OfferStream.h.

ownerFunds_

std::optional<STAmount > xrpl::TOfferStreamBase< STAmount , STAmount >::ownerFunds_

protectedinherited

Definition at line 58 of file OfferStream.h.

counter_

StepCounter& xrpl::TOfferStreamBase< STAmount , STAmount >::counter_

protectedinherited

Definition at line 59 of file OfferStream.h.