ProxyEventLoop Class Reference

#include <ProxyEventLoop.h>

Inheritance diagram for ProxyEventLoop:

Public Member Functions
	ProxyEventLoop (PlatformEventLoop *base=nullptr)
virtual	~ProxyEventLoop ()=default
virtual void	exec (PlatformEventHandler *eventHandler) override
virtual void	quit () override
virtual void	processMessages (PlatformEventHandler *eventHandler, int count=-1) override
virtual void	waitForMessages () override
Public Member Functions inherited from ProxyBase< PlatformEventLoop >
	ProxyBase (PlatformEventLoop *base)
PlatformEventLoop *	base () const
void	setBase (PlatformEventLoop *base)
Public Member Functions inherited from PlatformEventLoop
virtual	~PlatformEventLoop ()=default
virtual void	exec (PlatformEventHandler *eventHandler)=0
virtual void	quit ()=0
virtual void	processMessages (PlatformEventHandler *eventHandler, int count=-1)=0
virtual void	waitForMessages ()=0

Additional Inherited Members
Protected Member Functions inherited from ProxyBase< PlatformEventLoop >
PlatformEventLoop *	nonNullBase () const

Constructor & Destructor Documentation

ProxyEventLoop()

ProxyEventLoop::ProxyEventLoop ( PlatformEventLoop *  base = nullptr )

explicit

~ProxyEventLoop()

virtual ProxyEventLoop::~ProxyEventLoop ( )

virtualdefault

Member Function Documentation

exec()

void ProxyEventLoop::exec ( PlatformEventHandler *  eventHandler )

overridevirtual

Starts this event loop.

This function blocks until either quit is called from inside the event handler code, or an application is closed by the user (e.g. after the last window is closed, or Command+Q is pressed on Mac).

Parameters

eventHandler

Callback for event processing.

Implements PlatformEventLoop.

Reimplemented in EngineControlComponent.

processMessages()

void ProxyEventLoop::processMessages ( PlatformEventHandler *  eventHandler, int  count = -1  )

overridevirtual

Processes the messages that are currently in the message queue, and returns. Returns immediately if there are no messages in the message queue.

Parameters

eventHandler	Callback for event processing.
count	Maximum number of messages to process, -1 means unlimited.

Implements PlatformEventLoop.

Reimplemented in EngineControlComponent.

quit()

void ProxyEventLoop::quit ( )

overridevirtual

Tells this event loop to exit. Does nothing if the event loop is not running.

Implements PlatformEventLoop.

waitForMessages()

void ProxyEventLoop::waitForMessages ( )

overridevirtual

Blocks until at least one message is delivered to the queue, and returns.

Implements PlatformEventLoop.

Reimplemented in EngineControlComponent.

---

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

• src/Library/Platform/Proxy/ProxyEventLoop.h
• src/Library/Platform/Proxy/ProxyEventLoop.cpp