carb::thread::fRelayFlagBlocking

Defined in carb/thread/IThreadUtil.h

constexpr RelayFlags carb::thread::fRelayFlagBlocking = 0x8000000000000000ull

Flag to indicate that a relay task should block until the task completes.

When not used, the default behavior is to run the task as a fire-and-forget operation. In this case, the task descriptor will be shallow copied. It is the task’s responsibility to clean up any resources used in the descriptor’s context value before returning. When this flag is used, the runRelayTask() call will block until the task completes. In this case, either the task function itself or the caller can handle any resource clean up.

Note that using this flag will effectively cause the task queue to be flushed. Any pending non-blocking calls will be completed before the new task is run.