MainSignalsImpl Class Reference

MainSignalsImpl manages a list of shared_ptr<CValidationInterface> callbacks. More...

Collaboration diagram for MainSignalsImpl:

Classes
struct	ListEntry
	List entries consist of a callback pointer and reference count. More...

Public Member Functions
	MainSignalsImpl (CScheduler &scheduler LIFETIMEBOUND)
void	Register (std::shared_ptr< CValidationInterface > callbacks) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
void	Unregister (CValidationInterface *callbacks) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
void	Clear () EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Clear unregisters every previously registered callback, erasing every map entry. More...
template<typename F >
void	Iterate (F &&f) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)

Public Attributes
SingleThreadedSchedulerClient	m_schedulerClient

Private Member Functions
std::list< ListEntry > m_list	GUARDED_BY (m_mutex)
std::unordered_map< CValidationInterface *, std::list< ListEntry >::iterator > m_map	GUARDED_BY (m_mutex)

Private Attributes
Mutex	m_mutex

Detailed Description

MainSignalsImpl manages a list of shared_ptr<CValidationInterface> callbacks.

A std::unordered_map is used to track what callbacks are currently registered, and a std::list is used to store the callbacks that are currently registered as well as any callbacks that are just unregistered and about to be deleted when they are done executing.

Definition at line 32 of file validationinterface.cpp.

Constructor & Destructor Documentation

MainSignalsImpl()

MainSignalsImpl::MainSignalsImpl ( CScheduler &scheduler  LIFETIMEBOUND )

inlineexplicit

Definition at line 53 of file validationinterface.cpp.

Member Function Documentation

Clear()

void MainSignalsImpl::Clear ( )

inline

Clear unregisters every previously registered callback, erasing every map entry.

After this call, the list may still contain callbacks that are currently executing, but it will be cleared when they are done executing.

Definition at line 82 of file validationinterface.cpp.

GUARDED_BY() [1/2]

std::list< ListEntry > m_list MainSignalsImpl::GUARDED_BY ( m_mutex  )

private

GUARDED_BY() [2/2]

std::unordered_map< CValidationInterface *, std::list< ListEntry >::iterator > m_map MainSignalsImpl::GUARDED_BY ( m_mutex  )

private

Iterate()

template<typename F >

void MainSignalsImpl::Iterate ( F &&  f )

inline

Definition at line 93 of file validationinterface.cpp.

Register()

void MainSignalsImpl::Register ( std::shared_ptr< CValidationInterface >  callbacks )

inline

Definition at line 56 of file validationinterface.cpp.

Unregister()

void MainSignalsImpl::Unregister ( CValidationInterface *  callbacks )

inline

Definition at line 66 of file validationinterface.cpp.

Member Data Documentation

m_mutex

Mutex MainSignalsImpl::m_mutex

private

Definition at line 34 of file validationinterface.cpp.

m_schedulerClient

SingleThreadedSchedulerClient MainSignalsImpl::m_schedulerClient

Definition at line 51 of file validationinterface.cpp.

---

The documentation for this class was generated from the following file:

• /work/src/validationinterface.cpp