highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-06-24 07:51:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

validationinterface: Rework documentation, Rename pwalletIn to callbacks

Browse Source
This commit is contained in:
MarcoFalke 2020-04-27 10:21:19 -04:00
parent fab6d060ce
commit fa770ce7fe
No known key found for this signature in database
GPG Key ID: CE2B75697E69A548
2 changed files with 29 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
src/validationinterface.cpp
View File

@ -89,22 +89,26 @@ public:
static CMainSignals g_signals; static CMainSignals g_signals;
void CMainSignals::RegisterBackgroundSignalScheduler(CScheduler& scheduler) { void CMainSignals::RegisterBackgroundSignalScheduler(CScheduler& scheduler)
{
assert(!m_internals); assert(!m_internals);
m_internals.reset(new MainSignalsInstance(&scheduler)); m_internals.reset(new MainSignalsInstance(&scheduler));
} }
void CMainSignals::UnregisterBackgroundSignalScheduler() { void CMainSignals::UnregisterBackgroundSignalScheduler()
{
m_internals.reset(nullptr); m_internals.reset(nullptr);
} }
void CMainSignals::FlushBackgroundCallbacks() { void CMainSignals::FlushBackgroundCallbacks()
{
if (m_internals) { if (m_internals) {
m_internals->m_schedulerClient.EmptyQueue(); m_internals->m_schedulerClient.EmptyQueue();
} }
} }
size_t CMainSignals::CallbacksPending() { size_t CMainSignals::CallbacksPending()
{
if (!m_internals) return 0; if (!m_internals) return 0;
return m_internals->m_schedulerClient.CallbacksPending(); return m_internals->m_schedulerClient.CallbacksPending();
} }
@ -114,10 +118,11 @@ CMainSignals& GetMainSignals()
return g_signals; return g_signals;
} }
void RegisterSharedValidationInterface(std::shared_ptr<CValidationInterface> pwalletIn) { void RegisterSharedValidationInterface(std::shared_ptr<CValidationInterface> callbacks)
// Each connection captures pwalletIn to ensure that each callback is {
// executed before pwalletIn is destroyed. For more details see #18338. // Each connection captures the shared_ptr to ensure that each callback is
g_signals.m_internals->Register(std::move(pwalletIn)); // executed before the subscriber is destroyed. For more details see #18338.
g_signals.m_internals->Register(std::move(callbacks));
} }
void RegisterValidationInterface(CValidationInterface* callbacks) void RegisterValidationInterface(CValidationInterface* callbacks)
@ -132,24 +137,28 @@ void UnregisterSharedValidationInterface(std::shared_ptr<CValidationInterface> c
UnregisterValidationInterface(callbacks.get()); UnregisterValidationInterface(callbacks.get());
} }
void UnregisterValidationInterface(CValidationInterface* pwalletIn) { void UnregisterValidationInterface(CValidationInterface* callbacks)
{
if (g_signals.m_internals) { if (g_signals.m_internals) {
g_signals.m_internals->Unregister(pwalletIn); g_signals.m_internals->Unregister(callbacks);
} }
} }
void UnregisterAllValidationInterfaces() { void UnregisterAllValidationInterfaces()
{
if (!g_signals.m_internals) { if (!g_signals.m_internals) {
return; return;
} }
g_signals.m_internals->Clear(); g_signals.m_internals->Clear();
} }
void CallFunctionInValidationInterfaceQueue(std::function<void ()> func) { void CallFunctionInValidationInterfaceQueue(std::function<void()> func)
{
g_signals.m_internals->m_schedulerClient.AddToProcessQueue(std::move(func)); g_signals.m_internals->m_schedulerClient.AddToProcessQueue(std::move(func));
} }
void SyncWithValidationInterfaceQueue() { void SyncWithValidationInterfaceQueue()
{
AssertLockNotHeld(cs_main); AssertLockNotHeld(cs_main);
// Block until the validation queue drains // Block until the validation queue drains
std::promise<void> promise; std::promise<void> promise;

14
src/validationinterface.h
View File

@ -22,20 +22,20 @@ class CValidationInterface;
class uint256; class uint256;
class CScheduler; class CScheduler;
// These functions dispatch to one or all registered wallets /** Register subscriber */
void RegisterValidationInterface(CValidationInterface* callbacks);
/** Register a wallet to receive updates from core */ /** Unregister subscriber. DEPRECATED. This is not safe to use when the RPC server or main message handler thread is running. */
void RegisterValidationInterface(CValidationInterface* pwalletIn); void UnregisterValidationInterface(CValidationInterface* callbacks);
/** Unregister a wallet from core */ /** Unregister all subscribers */
void UnregisterValidationInterface(CValidationInterface* pwalletIn);
/** Unregister all wallets from core */
void UnregisterAllValidationInterfaces(); void UnregisterAllValidationInterfaces();
// Alternate registration functions that release a shared_ptr after the last // Alternate registration functions that release a shared_ptr after the last
// notification is sent. These are useful for race-free cleanup, since // notification is sent. These are useful for race-free cleanup, since
// unregistration is nonblocking and can return before the last notification is // unregistration is nonblocking and can return before the last notification is
// processed. // processed.
/** Register subscriber */
void RegisterSharedValidationInterface(std::shared_ptr<CValidationInterface> callbacks); void RegisterSharedValidationInterface(std::shared_ptr<CValidationInterface> callbacks);
/** Unregister subscriber */
void UnregisterSharedValidationInterface(std::shared_ptr<CValidationInterface> callbacks); void UnregisterSharedValidationInterface(std::shared_ptr<CValidationInterface> callbacks);
/** /**