aboutsummaryrefslogtreecommitdiff
path: root/src/validationinterface.h
diff options
context:
space:
mode:
authorAlex Morcos <morcos@chaincode.com>2016-12-16 14:17:13 -0500
committerAlex Morcos <morcos@chaincode.com>2017-01-23 15:43:22 -0500
commit094e4b33839404d9c18200fc30d9a993a3dc106f (patch)
tree7a85d9479cb849c407a7b7c4a4d4aaf0e607cea7 /src/validationinterface.h
parent4afbde6028708541c4da8732a1bd12fb8735fdae (diff)
Better document usage of SyncTransaction
Diffstat (limited to 'src/validationinterface.h')
-rw-r--r--src/validationinterface.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/src/validationinterface.h b/src/validationinterface.h
index 594072719c..a2e76f2036 100644
--- a/src/validationinterface.h
+++ b/src/validationinterface.h
@@ -50,9 +50,16 @@ protected:
struct CMainSignals {
/** Notifies listeners of updated block chain tip */
boost::signals2::signal<void (const CBlockIndex *, const CBlockIndex *, bool fInitialDownload)> UpdatedBlockTip;
- /** A posInBlock value for SyncTransaction which indicates the transaction was conflicted, disconnected, or not in a block */
+ /** A posInBlock value for SyncTransaction calls for tranactions not
+ * included in connected blocks such as transactions removed from mempool,
+ * accepted to mempool or appearing in disconnected blocks.*/
static const int SYNC_TRANSACTION_NOT_IN_BLOCK = -1;
- /** Notifies listeners of updated transaction data (transaction, and optionally the block it is found in. */
+ /** Notifies listeners of updated transaction data (transaction, and
+ * optionally the block it is found in). Called with block data when
+ * transaction is included in a connected block, and without block data when
+ * transaction was accepted to mempool, removed from mempool (only when
+ * removal was due to conflict from connected block), or appeared in a
+ * disconnected block.*/
boost::signals2::signal<void (const CTransaction &, const CBlockIndex *pindex, int posInBlock)> SyncTransaction;
/** Notifies listeners of an updated transaction without new data (for now: a coinbase potentially becoming visible). */
boost::signals2::signal<void (const uint256 &)> UpdatedTransaction;