opentxs::OTDB Namespace Reference

Namespaces
	details

Classes
class	InitOTDBDetails
class	Storable
class	PackedBuffer
class	OTPacker
class	PackerSubclass
class	Storage
class	OTDBString
class	Blob
class	StringMap
class	Displayable
class	MarketData
class	MarketList
class	OfferDataMarket
class	BidData
class	AskData
class	OfferListMarket
class	TradeDataMarket
class	TradeListMarket
class	OfferDataNym
class	OfferListNym
class	TradeDataNym
class	TradeListNym
class	Acct
class	BitcoinAcct
class	ServerInfo
class	Server
class	BitcoinServer
class	RippleServer
class	LoomServer
class	ContactNym
class	WalletData
class	ContactAcct
class	Contact
class	AddressBook
class	StorageFS

Typedefs
typedef Storable *(	InstantiateFunc )()
typedef std::pair< PackType, StoredObjectType >	InstantiateFuncKey
typedef std::map < InstantiateFuncKey, InstantiateFunc * >	mapOfFunctions

Enumerations
enum	PackType { PACK_MESSAGE_PACK = 0, PACK_PROTOCOL_BUFFERS, PACK_TYPE_ERROR }
enum	StorageType { STORE_FILESYSTEM = 0, STORE_TYPE_SUBCLASS }
enum	StoredObjectType {   STORED_OBJ_STRING = 0, STORED_OBJ_BLOB, STORED_OBJ_STRING_MAP, STORED_OBJ_WALLET_DATA,   STORED_OBJ_BITCOIN_ACCT, STORED_OBJ_BITCOIN_SERVER, STORED_OBJ_RIPPLE_SERVER, STORED_OBJ_LOOM_SERVER,   STORED_OBJ_SERVER_INFO, STORED_OBJ_CONTACT_NYM, STORED_OBJ_CONTACT_ACCT, STORED_OBJ_CONTACT,   STORED_OBJ_ADDRESS_BOOK, STORED_OBJ_MARKET_DATA, STORED_OBJ_MARKET_LIST, STORED_OBJ_BID_DATA,   STORED_OBJ_ASK_DATA, STORED_OBJ_OFFER_LIST_MARKET, STORED_OBJ_TRADE_DATA_MARKET, STORED_OBJ_TRADE_LIST_MARKET,   STORED_OBJ_OFFER_DATA_NYM, STORED_OBJ_OFFER_LIST_NYM, STORED_OBJ_TRADE_DATA_NYM, STORED_OBJ_TRADE_LIST_NYM,   STORED_OBJ_ERROR }

Functions
	DeclareInterface (IStorable) virtual bool onPack(PackedBuffer &theBuffer
virtual bool	onUnpack (PackedBuffer &theBuffer, Storable &outObj)=0
virtual void	hookBeforePack ()
virtual void	hookAfterUnpack ()
EXPORT bool	InitDefaultStorage (StorageType eStoreType, PackType ePackType)
EXPORT Storage *	GetDefaultStorage ()
EXPORT Storage *	CreateStorageContext (StorageType eStoreType, PackType ePackType=OTDB_DEFAULT_PACKER)
EXPORT Storable *	CreateObject (StoredObjectType eType)
EXPORT bool	CheckStringsExistInOrder (std::string &strFolder, std::string &oneStr, std::string &twoStr, std::string &threeStr, const char *szFuncName=nullptr)
EXPORT bool	Exists (std::string strFolder, std::string oneStr="", std::string twoStr="", std::string threeStr="")
EXPORT int64_t	FormPathString (std::string &strOutput, std::string strFolder, std::string oneStr="", std::string twoStr="", std::string threeStr="")
EXPORT bool	StoreString (std::string strContents, std::string strFolder, std::string oneStr="", std::string twoStr="", std::string threeStr="")
EXPORT std::string	QueryString (std::string strFolder, std::string oneStr="", std::string twoStr="", std::string threeStr="")
EXPORT bool	StorePlainString (std::string strContents, std::string strFolder, std::string oneStr="", std::string twoStr="", std::string threeStr="")
EXPORT std::string	QueryPlainString (std::string strFolder, std::string oneStr="", std::string twoStr="", std::string threeStr="")
EXPORT bool	StoreObject (Storable &theContents, std::string strFolder, std::string oneStr="", std::string twoStr="", std::string threeStr="")
EXPORT Storable *	QueryObject (StoredObjectType theObjectType, std::string strFolder, std::string oneStr="", std::string twoStr="", std::string threeStr="")
EXPORT std::string	EncodeObject (Storable &theContents)
EXPORT Storable *	DecodeObject (StoredObjectType theObjectType, std::string strInput)
EXPORT bool	EraseValueByKey (std::string strFolder, std::string oneStr="", std::string twoStr="", std::string threeStr="")
	IMPLEMENT_GET_ADD_REMOVE (WalletData::, BitcoinServer) IMPLEMENT_GET_ADD_REMOVE(WalletData

Variables
const char *	StoredObjectTypeStrings []
Storable &	inObj = 0
InitOTDBDetails	theOTDBConstructor

Typedef Documentation

typedef Storable*( opentxs::OTDB::InstantiateFunc)()

Definition at line 327 of file OTStorage.hpp.

typedef std::pair<PackType, StoredObjectType> opentxs::OTDB::InstantiateFuncKey

Definition at line 329 of file OTStorage.hpp.

typedef std::map<InstantiateFuncKey, InstantiateFunc*> opentxs::OTDB::mapOfFunctions

Definition at line 340 of file OTStorage.hpp.

Enumeration Type Documentation

enum opentxs::OTDB::PackType

Enumerator
PACK_MESSAGE_PACK
PACK_PROTOCOL_BUFFERS
PACK_TYPE_ERROR

Definition at line 221 of file OTStorage.hpp.

{ PACK_MESSAGE_PACK = 0, // Using MessagePack as packer.
  PACK_PROTOCOL_BUFFERS, // Using Google Protocol Buffers as packer.
  PACK_TYPE_ERROR        // (Should never be.)
};

enum opentxs::OTDB::StorageType

Enumerator
STORE_FILESYSTEM
STORE_TYPE_SUBCLASS

Definition at line 229 of file OTStorage.hpp.

{ STORE_FILESYSTEM = 0, // Filesystem
  //        STORE_COUCH_DB,            // Couch DB (not yet supported)
  STORE_TYPE_SUBCLASS // (Subclass provided by API client via SWIG.)
};

enum opentxs::OTDB::StoredObjectType

Enumerator
STORED_OBJ_STRING
STORED_OBJ_BLOB
STORED_OBJ_STRING_MAP
STORED_OBJ_WALLET_DATA
STORED_OBJ_BITCOIN_ACCT
STORED_OBJ_BITCOIN_SERVER
STORED_OBJ_RIPPLE_SERVER
STORED_OBJ_LOOM_SERVER
STORED_OBJ_SERVER_INFO
STORED_OBJ_CONTACT_NYM
STORED_OBJ_CONTACT_ACCT
STORED_OBJ_CONTACT
STORED_OBJ_ADDRESS_BOOK
STORED_OBJ_MARKET_DATA
STORED_OBJ_MARKET_LIST
STORED_OBJ_BID_DATA
STORED_OBJ_ASK_DATA
STORED_OBJ_OFFER_LIST_MARKET
STORED_OBJ_TRADE_DATA_MARKET
STORED_OBJ_TRADE_LIST_MARKET
STORED_OBJ_OFFER_DATA_NYM
STORED_OBJ_OFFER_LIST_NYM
STORED_OBJ_TRADE_DATA_NYM
STORED_OBJ_TRADE_LIST_NYM
STORED_OBJ_ERROR

Definition at line 242 of file OTStorage.hpp.

                      {
    STORED_OBJ_STRING = 0, // Just a string.
    STORED_OBJ_BLOB, // Used for storing binary data. Bytes of arbitrary length.
    STORED_OBJ_STRING_MAP,   // A StringMap is a list of Key/Value pairs, useful
                             // for storing nearly anything.
    STORED_OBJ_WALLET_DATA,  // The GUI wallet's stored data
    STORED_OBJ_BITCOIN_ACCT, // The GUI wallet's stored data about a Bitcoin
                             // acct
    STORED_OBJ_BITCOIN_SERVER, // The GUI wallet's stored data about a Bitcoin
                               // RPC port.
    STORED_OBJ_RIPPLE_SERVER,  // The GUI wallet's stored data about a Ripple
                               // server.
    STORED_OBJ_LOOM_SERVER, // The GUI wallet's stored data about a Loom server.
    STORED_OBJ_SERVER_INFO, // A Nym has a list of these.
    STORED_OBJ_CONTACT_NYM, // This is a Nym record inside a contact of your
                            // address book.
    STORED_OBJ_CONTACT_ACCT, // This is an account record inside a contact of
                             // your address book.
    STORED_OBJ_CONTACT,      // Your address book has a list of these.
    STORED_OBJ_ADDRESS_BOOK, // Your address book.
    STORED_OBJ_MARKET_DATA,  // The description data for any given Market ID.
    STORED_OBJ_MARKET_LIST,  // A list of MarketDatas.
    STORED_OBJ_BID_DATA,     // Offer details (doesn't contain private details)
    STORED_OBJ_ASK_DATA,     // Offer details (doesn't contain private details)
    STORED_OBJ_OFFER_LIST_MARKET, // A list of offer details, for a specific
                                  // market.
    STORED_OBJ_TRADE_DATA_MARKET, // Trade details (doesn't contain private
                                  // data)
    STORED_OBJ_TRADE_LIST_MARKET, // A list of trade details, for a specific
                                  // market.
    STORED_OBJ_OFFER_DATA_NYM, // Private offer details for a particular Nym and
                               // Offer.
    STORED_OBJ_OFFER_LIST_NYM, // A list of private offer details for a
                               // particular Nym.
    STORED_OBJ_TRADE_DATA_NYM, // Private trade details for a particular Nym and
                               // Trade.
    STORED_OBJ_TRADE_LIST_NYM, // A list of private trade details for a
                               // particular Nym and Offer.
    STORED_OBJ_ERROR           // (Should never be.)
};

Function Documentation

bool opentxs::OTDB::CheckStringsExistInOrder	(	std::string &	strFolder,
		std::string &	oneStr,
		std::string &	twoStr,
		std::string &	threeStr,
		const char *	szFuncName = nullptr
	)

Definition at line 549 of file OTStorage.cpp.

{
    if (nullptr == szFuncName) szFuncName = __FUNCTION__;

    OTString ot_strFolder(strFolder), ot_oneStr(oneStr), ot_twoStr(twoStr),
        ot_threeStr(threeStr);

    if (ot_strFolder.Exists()) {
        if (!ot_oneStr.Exists()) {
            if ((!ot_twoStr.Exists()) && (!ot_threeStr.Exists())) {
                oneStr = strFolder;
                strFolder = ".";
            }
            else {
                otErr << szFuncName << ": ot_twoStr or ot_threeStr exist, when "
                                       "ot_oneStr doesn't exist! \n";
                OT_FAIL;
            }
        }
        else if ((!ot_twoStr.Exists()) && (ot_threeStr.Exists())) {
            otErr << szFuncName << ": ot_twoStr or ot_threeStr exist, when "
                                   "ot_oneStr doesn't exist! \n";
            OT_FAIL;
        }
    }
    else {
        otErr << szFuncName << ": ot_strFolder must always exist!\n";
        OT_FAIL;
    }
    return true;
}

Storable * opentxs::OTDB::CreateObject

(

StoredObjectType

eType

)

Definition at line 530 of file OTStorage.cpp.

{
    Storage* pStorage = details::s_pStorage;

    if (nullptr == pStorage) {
        return nullptr;
    }

    return pStorage->CreateObject(eType);
}

Storage * opentxs::OTDB::CreateStorageContext	(	StorageType	eStoreType,
		PackType	ePackType = OTDB_DEFAULT_PACKER
	)

Definition at line 522 of file OTStorage.cpp.

{
    Storage* pStorage = Storage::Create(eStoreType, ePackType);

    return pStorage; // caller responsible to delete
}

opentxs::OTDB::DeclareInterface

(

IStorable

)

Storable * opentxs::OTDB::DecodeObject	(	StoredObjectType	theObjectType,
		std::string	strInput
	)

Definition at line 830 of file OTStorage.cpp.

{
    Storage* pStorage = details::s_pStorage;

    if (nullptr == pStorage) {
        return nullptr;
    }

    return pStorage->DecodeObject(theObjectType, strInput);
}

std::string opentxs::OTDB::EncodeObject

(

Storable &

theContents

)

Definition at line 818 of file OTStorage.cpp.

{
    Storage* pStorage = details::s_pStorage;

    if (nullptr == pStorage) {
        otErr << "OTDB::EncodeObject: No Default Storage object allocated.\n";
        return "";
    }
    return pStorage->EncodeObject(theContents);
}

bool opentxs::OTDB::EraseValueByKey	(	std::string	strFolder,
		std::string	oneStr = "",
		std::string	twoStr = "",
		std::string	threeStr = ""
	)

Definition at line 843 of file OTStorage.cpp.

{
    Storage* pStorage = details::s_pStorage;

    if (nullptr == pStorage) {
        otErr
            << "OTDB::EraseValueByKey: No Default Storage object allocated.\n";
        return false;
    }

    return pStorage->EraseValueByKey(strFolder, oneStr, twoStr, threeStr);
}

bool opentxs::OTDB::Exists	(	std::string	strFolder,
		std::string	oneStr = "",
		std::string	twoStr = "",
		std::string	threeStr = ""
	)

Definition at line 584 of file OTStorage.cpp.

{
    {
        OTString ot_strFolder(strFolder), ot_oneStr(oneStr), ot_twoStr(twoStr),
            ot_threeStr(threeStr);
        OT_ASSERT_MSG(ot_strFolder.Exists(),
                      "OTDB::Exists: strFolder is empty.");

        if (!ot_oneStr.Exists()) {
            OT_ASSERT_MSG((!ot_twoStr.Exists() && !ot_threeStr.Exists()),
                          "Exists: bad options");
            oneStr = strFolder;
            strFolder = ".";
        }
    }

    Storage* pStorage = details::s_pStorage;

    if (nullptr == pStorage) {
        otOut << "OTDB::" << __FUNCTION__
              << ": details::s_pStorage is null. (Returning false.)\n";
        return false;
    }

    return pStorage->Exists(strFolder, oneStr, twoStr, threeStr);
}

int64_t opentxs::OTDB::FormPathString	(	std::string &	strOutput,
		std::string	strFolder,
		std::string	oneStr = "",
		std::string	twoStr = "",
		std::string	threeStr = ""
	)

Definition at line 612 of file OTStorage.cpp.

{
    {
        OTString ot_strFolder(strFolder), ot_oneStr(oneStr), ot_twoStr(twoStr),
            ot_threeStr(threeStr);
        OT_ASSERT_MSG(ot_strFolder.Exists(),
                      "OTDB::FormPathString: strFolder is empty.");

        if (!ot_oneStr.Exists()) {
            OT_ASSERT_MSG((!ot_twoStr.Exists() && !ot_threeStr.Exists()),
                          "FormPathString: bad options");
            oneStr = strFolder;
            strFolder = ".";
        }
    }

    Storage* pStorage = details::s_pStorage;

    if (nullptr == pStorage) {
        otOut << "OTDB::" << __FUNCTION__
              << ": details::s_pStorage is null. (Returning -1.)\n";
        return -1;
    }

    return pStorage->FormPathString(strOutput, strFolder, oneStr, twoStr,
                                    threeStr);
}

Storage * opentxs::OTDB::GetDefaultStorage

(

)

Definition at line 480 of file OTStorage.cpp.

{
    return OTDB::details::s_pStorage;
}

virtual void opentxs::OTDB::hookAfterUnpack ( )

virtual

Definition at line 384 of file OTStorage.hpp.

{
} // This is called just after unpacking a storable. (Opportunity to copy

virtual void opentxs::OTDB::hookBeforePack ( )

virtual

Definition at line 380 of file OTStorage.hpp.

{
} // This is called just before packing a storable. (Opportunity to copy

opentxs::OTDB::IMPLEMENT_GET_ADD_REMOVE	(	WalletData::	,
		BitcoinServer
	)

Definition at line 1061 of file OTStorage.cpp.

{
    //      while (GetServerInfoCount() > 0)
    //          RemoveServerInfo(0);
}

bool opentxs::OTDB::InitDefaultStorage	(	StorageType	eStoreType,
		PackType	ePackType
	)

Definition at line 491 of file OTStorage.cpp.

{
    // This allows you to call multiple times if you want to change the default
    // storage.
    //
    //        if (nullptr != details::s_pStorage)
    //        {
    //            otErr << "OTDB::InitDefaultStorage: Existing storage context
    // already exists. (Erasing / replacing it.)\n";
    //
    //            delete details::s_pStorage;
    //            details::s_pStorage = nullptr;
    //        }

    if (nullptr == details::s_pStorage) {
        otInfo << "OTDB::InitDefaultStorage: Existing storage context doesn't "
                  "already exist. (Creating it.)\n";

        details::s_pStorage = Storage::Create(eStoreType, ePackType);
    }

    if (nullptr == details::s_pStorage) {
        otErr << "OTDB::InitDefaultStorage: Failed while calling "
                 "OTDB::Storage::Create()\n";
        return false;
    }

    return true;
}

virtual bool opentxs::OTDB::onUnpack ( PackedBuffer &  theBuffer, Storable &  outObj  )

pure virtual

Storable * opentxs::OTDB::QueryObject	(	StoredObjectType	theObjectType,
		std::string	strFolder,
		std::string	oneStr = "",
		std::string	twoStr = "",
		std::string	threeStr = ""
	)

Definition at line 788 of file OTStorage.cpp.

{
    {
        OTString ot_strFolder(strFolder), ot_oneStr(oneStr), ot_twoStr(twoStr),
            ot_threeStr(threeStr);
        OT_ASSERT_MSG(ot_strFolder.Exists(),
                      "OTDB::QueryObject: strFolder is null");

        if (!ot_oneStr.Exists()) {
            OT_ASSERT_MSG((!ot_twoStr.Exists() && !ot_threeStr.Exists()),
                          "OTDB::QueryObject: bad options");
            oneStr = strFolder;
            strFolder = ".";
        }
    }

    Storage* pStorage = details::s_pStorage;

    if (nullptr == pStorage) {
        return nullptr;
    }

    return pStorage->QueryObject(theObjectType, strFolder, oneStr, twoStr,
                                 threeStr);
}

std::string opentxs::OTDB::QueryPlainString	(	std::string	strFolder,
		std::string	oneStr = "",
		std::string	twoStr = "",
		std::string	threeStr = ""
	)

Definition at line 728 of file OTStorage.cpp.

{
    {
        OTString ot_strFolder(strFolder), ot_oneStr(oneStr), ot_twoStr(twoStr),
            ot_threeStr(threeStr);
        OT_ASSERT_MSG(ot_strFolder.Exists(),
                      "OTDB::QueryPlainString: strFolder is null");

        if (!ot_oneStr.Exists()) {
            OT_ASSERT_MSG((!ot_twoStr.Exists() && !ot_threeStr.Exists()),
                          "OTDB::QueryPlainString: bad options");
            oneStr = strFolder;
            strFolder = ".";
        }
    }

    Storage* pStorage = details::s_pStorage;

    OT_ASSERT((strFolder.length() > 3) || (0 == strFolder.compare(0, 1, ".")));
    OT_ASSERT((oneStr.length() < 1) || (oneStr.length() > 3));

    if (nullptr == pStorage) {
        return std::string("");
    }

    return pStorage->QueryPlainString(strFolder, oneStr, twoStr, threeStr);
}

std::string opentxs::OTDB::QueryString	(	std::string	strFolder,
		std::string	oneStr = "",
		std::string	twoStr = "",
		std::string	threeStr = ""
	)

Definition at line 671 of file OTStorage.cpp.

{
    {
        OTString ot_strFolder(strFolder), ot_oneStr(oneStr), ot_twoStr(twoStr),
            ot_threeStr(threeStr);

        if (!CheckStringsExistInOrder(strFolder, oneStr, twoStr, threeStr,
                                      __FUNCTION__))
            return std::string("");

        if (!ot_oneStr.Exists()) {
            OT_ASSERT_MSG((!ot_twoStr.Exists() && !ot_threeStr.Exists()),
                          "Storage::StoreString: bad options");
            oneStr = strFolder;
            strFolder = ".";
        }
    }
    Storage* pStorage = details::s_pStorage;

    if (nullptr == pStorage) return std::string("");

    return pStorage->QueryString(strFolder, oneStr, twoStr, threeStr);
}

bool opentxs::OTDB::StoreObject	(	Storable &	theContents,
		std::string	strFolder,
		std::string	oneStr = "",
		std::string	twoStr = "",
		std::string	threeStr = ""
	)

Definition at line 759 of file OTStorage.cpp.

{
    {
        OTString ot_strFolder(strFolder), ot_oneStr(oneStr), ot_twoStr(twoStr),
            ot_threeStr(threeStr);
        OT_ASSERT_MSG(ot_strFolder.Exists(),
                      "OTDB:StoreObject: strFolder is null");

        if (!ot_oneStr.Exists()) {
            OT_ASSERT_MSG((!ot_twoStr.Exists() && !ot_threeStr.Exists()),
                          "OTDB:StoreObject: bad options");
            oneStr = strFolder;
            strFolder = ".";
        }
    }

    Storage* pStorage = details::s_pStorage;

    if (nullptr == pStorage) {
        otErr << "OTDB::StoreObject: No default storage object allocated.\n";
        return false;
    }

    return pStorage->StoreObject(theContents, strFolder, oneStr, twoStr,
                                 threeStr);
}

bool opentxs::OTDB::StorePlainString	(	std::string	strContents,
		std::string	strFolder,
		std::string	oneStr = "",
		std::string	twoStr = "",
		std::string	threeStr = ""
	)

Definition at line 698 of file OTStorage.cpp.

{
    {
        OTString ot_strFolder(strFolder), ot_oneStr(oneStr), ot_twoStr(twoStr),
            ot_threeStr(threeStr);
        OT_ASSERT_MSG(ot_strFolder.Exists(),
                      "OTDB::StorePlainString: strFolder is null");

        if (!ot_oneStr.Exists()) {
            OT_ASSERT_MSG((!ot_twoStr.Exists() && !ot_threeStr.Exists()),
                          "OTDB::StorePlainString: bad options");
            oneStr = strFolder;
            strFolder = ".";
        }
    }
    Storage* pStorage = details::s_pStorage;

    OT_ASSERT((strFolder.length() > 3) || (0 == strFolder.compare(0, 1, ".")));
    OT_ASSERT((oneStr.length() < 1) || (oneStr.length() > 3));

    if (nullptr == pStorage) {
        return false;
    }

    return pStorage->StorePlainString(strContents, strFolder, oneStr, twoStr,
                                      threeStr);
}

bool opentxs::OTDB::StoreString	(	std::string	strContents,
		std::string	strFolder,
		std::string	oneStr = "",
		std::string	twoStr = "",
		std::string	threeStr = ""
	)

Definition at line 644 of file OTStorage.cpp.

{
    {
        OTString ot_strFolder(strFolder), ot_oneStr(oneStr), ot_twoStr(twoStr),
            ot_threeStr(threeStr);
        OT_ASSERT_MSG(ot_strFolder.Exists(),
                      "OTDB::StoreString: strFolder is null");

        if (!ot_oneStr.Exists()) {
            OT_ASSERT_MSG((!ot_twoStr.Exists() && !ot_threeStr.Exists()),
                          "OTDB::StoreString: bad options");
            oneStr = strFolder;
            strFolder = ".";
        }
    }

    Storage* pStorage = details::s_pStorage;

    if (nullptr == pStorage) {
        return false;
    }

    return pStorage->StoreString(strContents, strFolder, oneStr, twoStr,
                                 threeStr);
}

Variable Documentation

Storable& opentxs::OTDB::inObj = 0

Definition at line 376 of file OTStorage.hpp.

const char * opentxs::OTDB::StoredObjectTypeStrings

Initial value:

= {
    "OTDBString", 
    "Blob",       
    "StringMap", 
                 
    "WalletData",    
    "BitcoinAcct",   
    "BitcoinServer", 
    "RippleServer",  
    "LoomServer",    
    "ServerInfo",    
    "ContactNym", 
    "ContactAcct", 
                   
    "Contact",     
    "AddressBook", 
    "MarketData",  
    "MarketList",  
    "BidData",     
    "AskData",     
    "OfferListMarket", 
    "TradeDataMarket", 
    "TradeListMarket", 
    "OfferDataNym",    
    "OfferListNym",    
    "TradeDataNym",    
    "TradeListNym",  
                     
    "StoredObjError" 
}

Definition at line 300 of file OTStorage.cpp.

InitOTDBDetails opentxs::OTDB::theOTDBConstructor

Definition at line 347 of file OTStorage.cpp.