LBRYFoundation/lbcd
1
0
Fork 0
mirror of https://github.com/LBRYFoundation/lbcd.git synced 2025-09-01 01:35:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add comments to clarify interface function caching.

Browse source 
This commit attempts to clarify which functions in the Db interface may be
returning cached data that the InvalidateCache, InvalidateBlockCache, and
InvalidateTxCache functions are used to clear.
This commit is contained in:
Dave Collins 2013-05-31 13:40:38 -05:00
parent 7416e9a71d
commit fac055c24e
1 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
db.go
View file

@ -51,7 +51,7 @@ type Db interface {
ExistsSha(sha *btcwire.ShaHash) (exists bool) ExistsSha(sha *btcwire.ShaHash) (exists bool)
// FetchBlockBySha returns a btcutil Block. The implementation may // FetchBlockBySha returns a btcutil Block. The implementation may
// cache the underlying object if desired. // cache the underlying data if desired.
FetchBlockBySha(sha *btcwire.ShaHash) (blk *btcutil.Block, err error) FetchBlockBySha(sha *btcwire.ShaHash) (blk *btcutil.Block, err error)
// FetchBlockShaByHeight returns a block hash based on its height in the // FetchBlockShaByHeight returns a block hash based on its height in the
@ -65,18 +65,21 @@ type Db interface {
FetchHeightRange(startHeight, endHeight int64) (rshalist []btcwire.ShaHash, err error) FetchHeightRange(startHeight, endHeight int64) (rshalist []btcwire.ShaHash, err error)
// FetchTxAllBySha returns several pieces of data for a given // FetchTxAllBySha returns several pieces of data for a given
// transaction hash. // transaction hash. The implementation may cache the underlying data
// if desired.
FetchTxAllBySha(txsha *btcwire.ShaHash) (rtx *btcwire.MsgTx, rtxbuf []byte, rpver uint32, rblksha *btcwire.ShaHash, err error) FetchTxAllBySha(txsha *btcwire.ShaHash) (rtx *btcwire.MsgTx, rtxbuf []byte, rpver uint32, rblksha *btcwire.ShaHash, err error)
// FetchTxBufBySha returns the raw bytes and associated protocol version // FetchTxBufBySha returns the raw bytes and associated protocol version
// for the transaction with the requested hash. // for the transaction with the requested hash. The implementation may
// cache the underlying data if desired.
FetchTxBufBySha(txsha *btcwire.ShaHash) (txbuf []byte, rpver uint32, err error) FetchTxBufBySha(txsha *btcwire.ShaHash) (txbuf []byte, rpver uint32, err error)
// FetchTxBySha returns some data for the given transaction hash. // FetchTxBySha returns some data for the given transaction hash. The
// implementation may cache the underlying data if desired.
FetchTxBySha(txsha *btcwire.ShaHash) (rtx *btcwire.MsgTx, rpver uint32, blksha *btcwire.ShaHash, err error) FetchTxBySha(txsha *btcwire.ShaHash) (rtx *btcwire.MsgTx, rpver uint32, blksha *btcwire.ShaHash, err error)
// FetchTxByShaList returns a TxListReply given an array of transaction // FetchTxByShaList returns a TxListReply given an array of transaction
// hashes. // hashes. The implementation may cache the underlying data if desired.
FetchTxByShaList(txShaList []*btcwire.ShaHash) []*TxListReply FetchTxByShaList(txShaList []*btcwire.ShaHash) []*TxListReply
// FetchTxUsedBySha returns the used/spent buffer for a given // FetchTxUsedBySha returns the used/spent buffer for a given
@ -131,6 +134,7 @@ type BlockIterator interface {
// NextRow iterates thru all blocks in database. // NextRow iterates thru all blocks in database.
NextRow() bool NextRow() bool
// Row returns row data for block iterator. // Row returns row data for block iterator.
Row() (key *btcwire.ShaHash, pver uint32, buf []byte, err error) Row() (key *btcwire.ShaHash, pver uint32, buf []byte, err error)
} }