queueEventToRunLoop#

Fully qualified name: omni::kit::queueEventToRunLoop

Defined in omni/kit/AppUtils.h

template<class ...Args>
bool omni::kit::queueEventToRunLoop(
carb::RString deferredEventName,
carb::RString immediateEventName,
const carb::cpp::string_view runloopName,
Args&&... payload,
)#

Immediately dispatches an Event and then queues it to the given RunLoop.

Parameters:

  • deferredEventName – The event name to defer. This is the “normal” event name.

  • immediateEventName – The event name to dispatch immediately. This is typically deferredEventName with a string suffix :immediate.

  • runloopName – The name of the RunLoop to queue the deferred event to. If empty, kRunLoopDefault is inferred.

  • payload – Zero or more key/value std::pair objects of type std::pair<carb::RStringKey, T> where the first parameter is the key and the second is the value. The value must be of a type understood by a carb::variant::Translator specialization.

Returns:

true if the message was both dispatched immediately and deferred; false if an error occurred.

On this page