Bitcoin Core  24.99.0
P2P Digital Currency
Public Member Functions | Private Member Functions | Private Attributes | List of all members
SingleThreadedSchedulerClient Class Reference

Class used by CScheduler clients which may schedule multiple jobs which are required to be run serially. More...

#include <scheduler.h>

Collaboration diagram for SingleThreadedSchedulerClient:
[legend]

Public Member Functions

 SingleThreadedSchedulerClient (CScheduler &scheduler LIFETIMEBOUND)
 
void AddToProcessQueue (std::function< void()> func) EXCLUSIVE_LOCKS_REQUIRED(!m_callbacks_mutex)
 Add a callback to be executed. More...
 
void EmptyQueue () EXCLUSIVE_LOCKS_REQUIRED(!m_callbacks_mutex)
 Processes all remaining queue members on the calling thread, blocking until queue is empty Must be called after the CScheduler has no remaining processing threads! More...
 
size_t CallbacksPending () EXCLUSIVE_LOCKS_REQUIRED(!m_callbacks_mutex)
 

Private Member Functions

std::list< std::function< void()> > m_callbacks_pending GUARDED_BY (m_callbacks_mutex)
 
bool m_are_callbacks_running GUARDED_BY (m_callbacks_mutex)
 
void MaybeScheduleProcessQueue () EXCLUSIVE_LOCKS_REQUIRED(!m_callbacks_mutex)
 
void ProcessQueue () EXCLUSIVE_LOCKS_REQUIRED(!m_callbacks_mutex)
 

Private Attributes

CSchedulerm_scheduler
 
Mutex m_callbacks_mutex
 

Detailed Description

Class used by CScheduler clients which may schedule multiple jobs which are required to be run serially.

Jobs may not be run on the same thread, but no two jobs will be executed at the same time and memory will be release-acquire consistent (the scheduler will internally do an acquire before invoking a callback as well as a release at the end). In practice this means that a callback B() will be able to observe all of the effects of callback A() which executed before it.

Definition at line 123 of file scheduler.h.

Constructor & Destructor Documentation

◆ SingleThreadedSchedulerClient()

SingleThreadedSchedulerClient::SingleThreadedSchedulerClient ( CScheduler &scheduler  LIFETIMEBOUND)
inlineexplicit

Definition at line 136 of file scheduler.h.

Member Function Documentation

◆ AddToProcessQueue()

void SingleThreadedSchedulerClient::AddToProcessQueue ( std::function< void()>  func)

Add a callback to be executed.

Callbacks are executed serially and memory is release-acquire consistent between callback executions. Practically, this means that callbacks can behave as if they are executed in order by a single thread.

Definition at line 178 of file scheduler.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ CallbacksPending()

size_t SingleThreadedSchedulerClient::CallbacksPending ( )

Definition at line 198 of file scheduler.cpp.

◆ EmptyQueue()

void SingleThreadedSchedulerClient::EmptyQueue ( )

Processes all remaining queue members on the calling thread, blocking until queue is empty Must be called after the CScheduler has no remaining processing threads!

Definition at line 187 of file scheduler.cpp.

Here is the call graph for this function:

◆ GUARDED_BY() [1/2]

std::list<std::function<void()> > m_callbacks_pending SingleThreadedSchedulerClient::GUARDED_BY ( m_callbacks_mutex  )
private

◆ GUARDED_BY() [2/2]

bool m_are_callbacks_running SingleThreadedSchedulerClient::GUARDED_BY ( m_callbacks_mutex  )
private

◆ MaybeScheduleProcessQueue()

void SingleThreadedSchedulerClient::MaybeScheduleProcessQueue ( )
private

Definition at line 134 of file scheduler.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ProcessQueue()

void SingleThreadedSchedulerClient::ProcessQueue ( )
private

Definition at line 147 of file scheduler.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ m_callbacks_mutex

Mutex SingleThreadedSchedulerClient::m_callbacks_mutex
private

Definition at line 128 of file scheduler.h.

◆ m_scheduler

CScheduler& SingleThreadedSchedulerClient::m_scheduler
private

Definition at line 126 of file scheduler.h.


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