privmx::endpoint::core::EventQueue Class Reference

#include <privmx/endpoint/core/EventQueue.hpp>

Public Member Functions
void	emitBreakEvent ()
EventHolder	waitEvent ()
std::optional< EventHolder >	getEvent ()

Static Public Member Functions
static EventQueue	getInstance ()

Detailed Description

'EventQueue' is a singleton class representing a queue for storing events.

Member Function Documentation

emitBreakEvent()

void privmx::endpoint::core::EventQueue::emitBreakEvent

(

)

Puts the break event on the events queue.

You can use it to break the waitEvent loop.

getEvent()

std::optional< EventHolder > privmx::endpoint::core::EventQueue::getEvent

(

)

Gets the first event from the events queue.

Returns

EventHolder object (optional)

getInstance()

EventQueue privmx::endpoint::core::EventQueue::getInstance ( )

static

Gets the EventQueue instance.

Returns

EventQueue object

waitEvent()

EventHolder privmx::endpoint::core::EventQueue::waitEvent

(

)

Starts a loop waiting for an Event.

Returns

EventHolder object

---

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

• privmx/endpoint/core/EventQueue.hpp