LLDB mainline
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
lldb_private::MainLoopBase Class Referenceabstract

#include <MainLoopBase.h>

Inheritance diagram for lldb_private::MainLoopBase:
[legend]

Classes

class  ReadHandle

Public Types

using TimePoint
typedef std::unique_ptr< ReadHandle > ReadHandleUP
typedef std::function< void(MainLoopBase &)> Callback

Public Member Functions

 MainLoopBase ()
virtual ~MainLoopBase ()=default
virtual ReadHandleUP RegisterReadObject (const lldb::IOObjectSP &object_sp, const Callback &callback, Status &error)=0
bool AddPendingCallback (const Callback &callback)
bool AddCallback (const Callback &callback, std::chrono::nanoseconds delay)
bool AddCallback (const Callback &callback, TimePoint point)
virtual Status Run ()
virtual void RequestTermination ()

Protected Member Functions

ReadHandleUP CreateReadHandle (const lldb::IOObjectSP &object_sp)
virtual void UnregisterReadObject (IOObject::WaitableHandle handle)=0
virtual bool Interrupt ()=0
 Interrupt the loop that is currently waiting for events.
void ProcessCallbacks ()
std::optional< TimePoint > GetNextWakeupTime ()

Protected Attributes

std::mutex m_callback_mutex
std::priority_queue< std::pair< TimePoint, Callback >, std::vector< std::pair< TimePoint, Callback > >, llvm::on_first< std::greater< TimePoint > > > m_callbacks
bool m_terminate_request: 1

Private Member Functions

 MainLoopBase (const MainLoopBase &)=delete
const MainLoopBase & operator= (const MainLoopBase &)=delete

Detailed Description

Definition at line 38 of file MainLoopBase.h.

Member Typedef Documentation

◆ Callback

typedef std::function<void(MainLoopBase &)> lldb_private::MainLoopBase::Callback

Definition at line 51 of file MainLoopBase.h.

◆ ReadHandleUP

typedef std::unique_ptr<ReadHandle> lldb_private::MainLoopBase::ReadHandleUP

Definition at line 49 of file MainLoopBase.h.

◆ TimePoint

using lldb_private::MainLoopBase::TimePoint
Initial value:
std::chrono::time_point<std::chrono::steady_clock,
std::chrono::nanoseconds>

Definition at line 43 of file MainLoopBase.h.

Constructor & Destructor Documentation

◆ MainLoopBase() [1/2]

lldb_private::MainLoopBase::MainLoopBase ( )
inline

Definition at line 46 of file MainLoopBase.h.

References m_terminate_request.

Referenced by MainLoopBase(), lldb_private::MainLoopPosix::MainLoopPosix(), and operator=().

◆ ~MainLoopBase()

virtual lldb_private::MainLoopBase::~MainLoopBase ( )
virtualdefault

◆ MainLoopBase() [2/2]

lldb_private::MainLoopBase::MainLoopBase ( const MainLoopBase & )
privatedelete

References MainLoopBase().

Member Function Documentation

◆ AddCallback() [1/2]

bool lldb_private::MainLoopBase::AddCallback ( const Callback & callback,
std::chrono::nanoseconds delay )
inline

Definition at line 70 of file MainLoopBase.h.

References AddCallback().

Referenced by lldb_private::Socket::Accept(), AddCallback(), and AddPendingCallback().

◆ AddCallback() [2/2]

bool MainLoopBase::AddCallback ( const Callback & callback,
TimePoint point )

Definition at line 15 of file MainLoopBase.cpp.

References Interrupt(), m_callback_mutex, and m_callbacks.

◆ AddPendingCallback()

bool lldb_private::MainLoopBase::AddPendingCallback ( const Callback & callback)
inline

Definition at line 64 of file MainLoopBase.h.

References AddCallback().

◆ CreateReadHandle()

ReadHandleUP lldb_private::MainLoopBase::CreateReadHandle ( const lldb::IOObjectSP & object_sp)
inlineprotected

Definition at line 87 of file MainLoopBase.h.

Referenced by lldb_private::MainLoopPosix::RegisterReadObject(), and lldb_private::MainLoopWindows::RegisterReadObject().

◆ GetNextWakeupTime()

std::optional< MainLoopBase::TimePoint > MainLoopBase::GetNextWakeupTime ( )
protected

Definition at line 46 of file MainLoopBase.cpp.

References m_callback_mutex, and m_callbacks.

Referenced by lldb_private::MainLoopWindows::Poll().

◆ Interrupt()

virtual bool lldb_private::MainLoopBase::Interrupt ( )
protectedpure virtual

Interrupt the loop that is currently waiting for events.

Return true if the interrupt succeeded, false if it failed.

Implemented in lldb_private::MainLoopPosix, and lldb_private::MainLoopWindows.

Referenced by AddCallback().

◆ operator=()

const MainLoopBase & lldb_private::MainLoopBase::operator= ( const MainLoopBase & )
privatedelete

References MainLoopBase().

◆ ProcessCallbacks()

void MainLoopBase::ProcessCallbacks ( )
protected

Definition at line 30 of file MainLoopBase.cpp.

References m_callback_mutex, and m_callbacks.

Referenced by lldb_private::MainLoopPosix::Run(), and lldb_private::MainLoopWindows::Run().

◆ RegisterReadObject()

virtual ReadHandleUP lldb_private::MainLoopBase::RegisterReadObject ( const lldb::IOObjectSP & object_sp,
const Callback & callback,
Status & error )
pure virtual

Implemented in lldb_private::MainLoopPosix, and lldb_private::MainLoopWindows.

References error().

Referenced by lldb_private::DomainSocket::Accept(), and lldb_private::TCPSocket::Accept().

◆ RequestTermination()

virtual void lldb_private::MainLoopBase::RequestTermination ( )
inlinevirtual

Definition at line 84 of file MainLoopBase.h.

References m_terminate_request.

Referenced by lldb_private::Socket::Accept(), lldb_private::process_gdb_remote::GDBRemoteCommunicationServerLLGS::HandleInferiorState_Exited(), and lldb_private::mcp::ProtocolServerMCP::Stop().

◆ Run()

virtual Status lldb_private::MainLoopBase::Run ( )
inlinevirtual

Reimplemented in lldb_private::MainLoopPosix, and lldb_private::MainLoopWindows.

Definition at line 80 of file MainLoopBase.h.

◆ UnregisterReadObject()

virtual void lldb_private::MainLoopBase::UnregisterReadObject ( IOObject::WaitableHandle handle)
protectedpure virtual

Implemented in lldb_private::MainLoopPosix, and lldb_private::MainLoopWindows.

Member Data Documentation

◆ m_callback_mutex

std::mutex lldb_private::MainLoopBase::m_callback_mutex
protected

Definition at line 101 of file MainLoopBase.h.

Referenced by AddCallback(), GetNextWakeupTime(), and ProcessCallbacks().

◆ m_callbacks

std::priority_queue<std::pair<TimePoint, Callback>, std::vector<std::pair<TimePoint, Callback> >, llvm::on_first<std::greater<TimePoint> > > lldb_private::MainLoopBase::m_callbacks
protected

Definition at line 105 of file MainLoopBase.h.

Referenced by AddCallback(), GetNextWakeupTime(), and ProcessCallbacks().

◆ m_terminate_request

bool lldb_private::MainLoopBase::m_terminate_request
protected

Definition at line 106 of file MainLoopBase.h.

Referenced by MainLoopBase(), lldb_private::MainLoopPosix::ProcessSignals(), RequestTermination(), lldb_private::MainLoopPosix::Run(), and lldb_private::MainLoopWindows::Run().

The documentation for this class was generated from the following files:
Generated on for LLDB by doxygen 1.14.0