ripple::BookTip Class Reference

Iterates and consumes raw offers in an order book. More...

#include <BookTip.h>

Collaboration diagram for ripple::BookTip:

Public Member Functions
	BookTip (ApplyView &view, Book const &book)
	Create the iterator.
uint256 const &	dir () const noexcept
uint256 const &	index () const noexcept
Quality const &	quality () const noexcept
SLE::pointer const &	entry () const noexcept
bool	step (beast::Journal j)
	Erases the current offer and advance to the next offer.

Private Attributes
ApplyView &	view_
bool	m_valid
uint256	m_book
uint256	m_end
uint256	m_dir
uint256	m_index
std::shared_ptr< SLE >	m_entry
Quality	m_quality

Detailed Description

Iterates and consumes raw offers in an order book.

Offers are presented from highest quality to lowest quality. This will return all offers present including missing, invalid, unfunded, etc.

Definition at line 35 of file BookTip.h.

Constructor & Destructor Documentation

BookTip()

ripple::BookTip::BookTip	(	ApplyView &	view,
		Book const &	book
	)

Create the iterator.

Definition at line 24 of file BookTip.cpp.

Member Function Documentation

dir()

uint256 const & ripple::BookTip::dir ( ) const

noexcept

Definition at line 52 of file BookTip.h.

index()

uint256 const & ripple::BookTip::index ( ) const

noexcept

Definition at line 58 of file BookTip.h.

quality()

Quality const & ripple::BookTip::quality ( ) const

noexcept

Definition at line 64 of file BookTip.h.

entry()

SLE::pointer const & ripple::BookTip::entry ( ) const

noexcept

Definition at line 70 of file BookTip.h.

step()

bool ripple::BookTip::step

(

beast::Journal

j

)

Erases the current offer and advance to the next offer.

Complexity: Constant

Returns

true if there is a next offer

Definition at line 33 of file BookTip.cpp.

Member Data Documentation

view_

ApplyView& ripple::BookTip::view_

private

Definition at line 38 of file BookTip.h.

m_valid

bool ripple::BookTip::m_valid

private

Definition at line 39 of file BookTip.h.

m_book

uint256 ripple::BookTip::m_book

private

Definition at line 40 of file BookTip.h.

m_end

uint256 ripple::BookTip::m_end

private

Definition at line 41 of file BookTip.h.

m_dir

uint256 ripple::BookTip::m_dir

private

Definition at line 42 of file BookTip.h.

m_index

uint256 ripple::BookTip::m_index

private

Definition at line 43 of file BookTip.h.

m_entry

std::shared_ptr<SLE> ripple::BookTip::m_entry

private

Definition at line 44 of file BookTip.h.

m_quality

Quality ripple::BookTip::m_quality

private

Definition at line 45 of file BookTip.h.