fl::task Namespace Reference

Namespaces
namespace	anonymous_namespace{task.cpp.hpp}
namespace	detail

Classes
class	Coroutine
struct	CoroutineConfig
	Function and platform tuning for an OS-level coroutine task. More...
class	CoroutineTask
struct	Error
	Error type for promises. More...
class	Executor
	Task executor (singleton) — manages registered runners. More...
class	Handle
	Task Handle with fluent API (was class fl::task, renamed to avoid namespace collision) More...
class	ITaskImpl
class	Promise
	Promise class that provides fluent .then() and .catch_() semantics This is a lightweight wrapper around a shared PromiseImpl for easy copying/sharing. More...
class	PromiseResult
	Result type for promise operations. More...
class	Runner
	Generic task runner interface. More...
class	Scheduler
class	TimeTask

Enumerations
enum class	ExecFlags : u8 { TASKS = 1 << 0 , COROUTINES = 1 << 1 , SYSTEM = 1 << 2 , ALL = (1 << 0) | (1 << 1) | (1 << 2) }
	Flags controlling which subsystems run() pumps. More...
enum class	TaskType {   kEveryMs , kAtFramerate , kBeforeFrame , kAfterFrame ,   kCoroutine }
	Identifies how a scheduled task is triggered. More...

Functions
size_t	active_tasks () FL_NO_EXCEPT
	Get the number of active tasks across all systems.
Handle	after_frame () FL_NO_EXCEPT
	Creates a task that runs after every FastLED frame until canceled.
Handle	after_frame (const TracePoint &trace) FL_NO_EXCEPT
	Creates a traced task that runs after every FastLED frame until canceled.
Handle	after_frame (function< void()> on_then) FL_NO_EXCEPT
	Creates an after-frame task, running until canceled, with its success callback already configured.
Handle	after_frame (function< void()> on_then, const TracePoint &trace) FL_NO_EXCEPT
	Creates a traced after-frame task, running until canceled, with its success callback already configured.
Handle	at_framerate (int fps) FL_NO_EXCEPT
	Creates a task that runs at a fixed frame rate.
Handle	at_framerate (int fps, const TracePoint &trace) FL_NO_EXCEPT
	Creates a traced task that runs at a fixed frame rate.
template<typename T>
PromiseResult< T >	await (Promise< T > p, fl::u32 timeout_ms=fl::platforms::kAwaitDefaultTimeoutMs) FL_NO_EXCEPT
	Await promise completion in a coroutine (Trampoline to platform implementation)
template<typename T>
PromiseResult< T >	await_top_level (Promise< T > p) FL_NO_EXCEPT
	Synchronously wait for a promise to complete (ONLY safe in top-level contexts)
Handle	before_frame () FL_NO_EXCEPT
	Frame tasks recur: every overload below schedules a task that runs once per FastLED frame and keeps doing so until Handle::cancel() is called on it, so keep the returned handle whenever the task will need to be canceled.
Handle	before_frame (const TracePoint &trace) FL_NO_EXCEPT
	Creates a traced task that runs before every FastLED frame until canceled.
Handle	coroutine (const CoroutineConfig &config) FL_NO_EXCEPT
	Creates and starts an OS-level coroutine task.
Handle	every_ms (int interval_ms) FL_NO_EXCEPT
	Creates a task that runs at a fixed millisecond interval.
Handle	every_ms (int interval_ms, const TracePoint &trace) FL_NO_EXCEPT
	Creates a traced task that runs at a fixed millisecond interval.
void	exit_current () FL_NO_EXCEPT
	Terminates the currently executing coroutine.
bool	has_tasks () FL_NO_EXCEPT
	Check if any systems have active tasks.
template<typename T>
PromiseResult< T >	make_error (const char *message) FL_NO_EXCEPT
	Helper function to create an error result from C-string.
template<typename T>
PromiseResult< T >	make_error (const Error &error) FL_NO_EXCEPT
	Helper function to create an error result.
template<typename T>
PromiseResult< T >	make_error (const fl::string &message) FL_NO_EXCEPT
	Helper function to create an error result from string.
template<typename T>
PromiseResult< T >	make_error (Error &&error) FL_NO_EXCEPT
	Helper function to create an error result (move)
template<typename T>
Promise< T >	make_rejected_promise (const char *error_message) FL_NO_EXCEPT
	Convenience function to create a rejected Promise (const char* overload)
template<typename T>
Promise< T >	make_rejected_promise (const fl::string &error_message) FL_NO_EXCEPT
	Convenience function to create a rejected Promise.
template<typename T>
Promise< T >	make_resolved_promise (T value) FL_NO_EXCEPT
	Convenience function to create a resolved Promise.
template<typename T>
PromiseResult< T >	make_success (const T &value) FL_NO_EXCEPT
	Helper function to create a successful result.
template<typename T>
PromiseResult< T >	make_success (T &&value) FL_NO_EXCEPT
	Helper function to create a successful result (move)
bool	operator& (ExecFlags a, ExecFlags b) FL_NO_EXCEPT
ExecFlags	operator| (ExecFlags a, ExecFlags b) FL_NO_EXCEPT
void	run (fl::u32 microseconds=1000, ExecFlags flags=ExecFlags::ALL) FL_NO_EXCEPT
	Run selected task subsystems.
void	yield_system (fl::u32 microseconds) FL_NO_EXCEPT
	OS-level yield only: same behavior as run(us, ExecFlags::SYSTEM).

Only ESP32 honors it; a value outside [0, FL_CPU_CORES) is silently downgraded to no affinity, and single-core or non-RTOS platforms ignore the field.

function< void()> func Function executed by the coroutine, copied at creation time.

An empty function is legal: the coroutine starts, does nothing, and exits.

string name = "task" Diagnostic name reported by the platform. Defaults to "task". u8 priority = 5 Platform task priority relative to the platform idle priority, default 5.

On ESP32 the FreeRTOS priority becomes tskIDLE_PRIORITY + priority. FastLED does not clamp this against the platform maximum.

size_t stack_size = 4096 Requested stack size in bytes, default 4096.

A platform may raise a smaller request to its own floor (ESP32 clamps up to 2048) and platforms that emulate coroutines may ignore the field entirely.

optional< TracePoint > trace Optional location where the task was created, reported by Handle::trace_label().

Unset by default, in which case the label is empty.