Files
rippled/src/ripple_app/ledger/OrderBookDB.h
2013-11-12 19:30:07 -08:00

147 lines
5.3 KiB
C++

//------------------------------------------------------------------------------
/*
This file is part of rippled: https://github.com/ripple/rippled
Copyright (c) 2012, 2013 Ripple Labs Inc.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
#ifndef RIPPLE_ORDERBOOKDB_H_INCLUDED
#define RIPPLE_ORDERBOOKDB_H_INCLUDED
/*
TODO
----
- Add typedefs (in src/ripple/types) for usage of the following primitives:
* uint64
* uint160
* uint256
Each typedef should make it clear what the semantics of the value are,
and have a javadoc comment. Examples:
RippleCurrencyHash
RippleIssuerHash
- Add a new struct OrderBookKey with these fields:
* issuerPays
* issuerGets
* currencyPays
* currencyGets
Use this struct as the key to map order books to the book listeners,
instead of passing the four parameters around everywhere. Change
all function signatures and container types to use this key instead
of the four parameters.
- Add typedefs for all containers, choose a descriptive name that follows
the coding style, add a Javadoc comment explaining what it holds.
- Rename currencyIssuer_ct to follow the coding style. e.g. CurrencyPair
- Replace C11X with a suitable Beast macro
- Move BookListeners to its own header file
- Add documentation explaining what each class does
*/
// VFALCO TODO Rename this type and give the key and value typedefs.
typedef std::pair<uint160, uint160> currencyIssuer_t;
// VFALCO TODO Replace C11X with a suitable Beast macro
#ifdef C11X
typedef std::pair<const uint160&, const uint160&> currencyIssuer_ct;
#else
typedef std::pair<uint160, uint160> currencyIssuer_ct; // C++ defect 106
#endif
//------------------------------------------------------------------------------
// VFALCO TODO Add Javadoc comment explaining what this class does
class BookListeners
{
public:
typedef boost::shared_ptr<BookListeners> pointer;
BookListeners ();
void addSubscriber (InfoSub::ref sub);
void removeSubscriber (uint64 sub);
void publish (Json::Value& jvObj);
private:
typedef RippleRecursiveMutex LockType;
typedef LockType::ScopedLockType ScopedLockType;
LockType mLock;
// VFALCO TODO Use a typedef for the uint64
// Use a typedef for the container
boost::unordered_map<uint64, InfoSub::wptr> mListeners;
};
//------------------------------------------------------------------------------
// VFALCO TODO Add Javadoc comment explaining what this class does
class OrderBookDB
: public Stoppable
, public LeakChecked <OrderBookDB>
{
public:
explicit OrderBookDB (Stoppable& parent);
void setup (Ledger::ref ledger);
void update (Ledger::pointer ledger);
void invalidate ();
void addOrderBook(const uint160& takerPaysCurrency, const uint160& takerGetsCurrency,
const uint160& takerPaysIssuer, const uint160& takerGetsIssuer);
// return list of all orderbooks that want this issuerID and currencyID
void getBooksByTakerPays (const uint160& issuerID, const uint160& currencyID,
std::vector<OrderBook::pointer>& bookRet);
void getBooksByTakerGets (const uint160& issuerID, const uint160& currencyID,
std::vector<OrderBook::pointer>& bookRet);
bool isBookToXRP (const uint160& issuerID, const uint160& currencyID);
BookListeners::pointer getBookListeners (const uint160& currencyPays, const uint160& currencyGets,
const uint160& issuerPays, const uint160& issuerGets);
BookListeners::pointer makeBookListeners (const uint160& currencyPays, const uint160& currencyGets,
const uint160& issuerPays, const uint160& issuerGets);
// see if this txn effects any orderbook
void processTxn (Ledger::ref ledger, const AcceptedLedgerTx& alTx, Json::Value& jvObj);
private:
boost::unordered_map< currencyIssuer_t, std::vector<OrderBook::pointer> > mSourceMap; // by ci/ii
boost::unordered_map< currencyIssuer_t, std::vector<OrderBook::pointer> > mDestMap; // by co/io
boost::unordered_set< currencyIssuer_t > mXRPBooks; // does an order book to XRP exist
typedef RippleRecursiveMutex LockType;
typedef LockType::ScopedLockType ScopedLockType;
LockType mLock;
// VFALCO TODO Replace with just one map / unordered_map with a struct for the key
// issuerPays, issuerGets, currencyPays, currencyGets
std::map<uint160, std::map<uint160, std::map<uint160, std::map<uint160, BookListeners::pointer> > > > mListeners;
uint32 mSeq;
};
#endif
// vim:ts=4