carb/tasking/TaskingHelpers.h

↰ Parent directory: carb/tasking/

carb::tasking helper functions

Source: carb/tasking/TaskingHelpers.h

Included By

• carb/assets/IAssets.h: Interface definition for carb.assets.plugin

• carb/tasking/ITasking.h: carb::tasking interface definition file.

Namespaces

• carb: The main Carbonite namespace.

• carb::tasking: Namespace for carb.tasking.plugin and related utilities.

Classes

• carb::tasking::All: Specifies an “all” grouping of RequiredObject(s).

• carb::tasking::Any: Specifies an “any” grouping of RequiredObject(s).

• carb::tasking::RequiredObject: Helper class to ensure correct compliance with the requiredObject parameter of ITasking::add[Throttled]SubTask() and carb::thread::futex::wait functions.

• carb::tasking::Tracker: Helper class to provide correct types to the carb::tasking::Trackers class.

• carb::tasking::Trackers: Helper class to ensure correct compliance with trackers parameter of ITasking::addTask() variants.

Defines

• CARB_ASSERT_ASYNC: A macro that is used to assert that a scope is running in task context in debug builds only.

• CARB_ASYNC: A macro that can be used to mark a function as async, that is, it always executes in the context of a task.

• CARB_CHECK_ASYNC: A macro that is used to assert that a scope is running in task context in debug and checked builds.

• CARB_FATAL_UNLESS_ASYNC: A macro that is used to assert that a scope is running in task context.

• CARB_IS_ASYNC: Helper macro that results in a boolean expression which is true if the current thread is running in task context.

• CARB_MAYBE_ASYNC: A macro that can be used to mark a function as possibly async, that is, it may execute in the context of a task.