Pop-side functions#

Unless otherwise specified, may be called by owning thread only if the message queue is configured with a single owning thread.

Functions#

omni::expected< void, omni::core::Result > carb::eventdispatcher::IMessageQueue::awaitMessage() const: Blocks the current thread or task until a message is available in the queue.
omni::expected< void, omni::core::Result > carb::eventdispatcher::IMessageQueue::awaitMessageFor(const std::chrono::duration< Rep, Period > &duration) const: Blocks the current thread or task until a message is available in the queue, or a timeout duration expires.
omni::expected< void, omni::core::Result > carb::eventdispatcher::IMessageQueue::awaitMessageUntil(const std::chrono::time_point< Clock, Duration > &when) const: Blocks the current thread or task until a message is available in the queue, or a timeout time arrives.
bool carb::eventdispatcher::IMessageQueue::hasMessages() const =0: Returns whether this message queue has pending messages.
ExpectedType carb::eventdispatcher::IMessageQueue::peek(Func &&func) const: Inspects the message at the front of the queue, if any, without removing it.
ExpectedType carb::eventdispatcher::IMessageQueue::pop(Func &&func): Pops the message at the front of the queue and calls a function with the message.
ExpectedType carb::eventdispatcher::IMessageQueue::stop(): Stops the message queue before destruction.