task.h

Go to the documentation of this file.

#pragma once

 
// allow-include-after-namespace
 
#include "fl/stl/functional.h"  // IWYU pragma: keep
#include "fl/stl/string.h"
#include "fl/system/trace.h"
#include "fl/task/promise.h"  // IWYU pragma: keep
#include "fl/stl/shared_ptr.h"
#include "fl/stl/cstddef.h"
#include "fl/stl/noexcept.h"
 
namespace fl {
namespace task {

enum class TaskType {
    kEveryMs,      
    kAtFramerate, 
    kBeforeFrame, 
    kAfterFrame,  
    kCoroutine    
};
 
// Forward declarations
class ITaskImpl;
class Coroutine;  // IWYU pragma: keep

struct CoroutineConfig {
    optional<TracePoint> trace;
    function<void()> func;
    string name = "task";
    size_t stack_size = 4096;
    u8 priority = 5;
    optional<int> core_id;
};

class Handle {
public:

    Handle() FL_NO_EXCEPT = default;

    Handle(const Handle&) FL_NO_EXCEPT = default;
    Handle& operator=(const Handle&) FL_NO_EXCEPT = default;
    Handle(Handle&&) FL_NO_EXCEPT = default;
    Handle& operator=(Handle&&) FL_NO_EXCEPT = default;

    explicit Handle(shared_ptr<ITaskImpl> impl) FL_NO_EXCEPT;

    Handle& then(function<void()> on_then) FL_NO_EXCEPT;
    Handle& catch_(function<void(const Error&)> on_catch) FL_NO_EXCEPT;
    Handle& cancel() FL_NO_EXCEPT;

    int id() const FL_NO_EXCEPT;
    bool has_then() const FL_NO_EXCEPT;
    bool has_catch() const FL_NO_EXCEPT;
    string trace_label() const FL_NO_EXCEPT;
    TaskType type() const FL_NO_EXCEPT;
    int interval_ms() const FL_NO_EXCEPT;
    void set_interval_ms(int interval_ms) FL_NO_EXCEPT;
    u32 last_run_time() const FL_NO_EXCEPT;
    void set_last_run_time(u32 time) FL_NO_EXCEPT;
    bool ready_to_run(u32 current_time) const FL_NO_EXCEPT;
    bool is_valid() const FL_NO_EXCEPT;
    bool isCoroutine() const FL_NO_EXCEPT;

    void stop() FL_NO_EXCEPT;
    bool isRunning() const FL_NO_EXCEPT;
 
private:
    friend class Scheduler;
 
    // Internal methods for Scheduler (friend access only)
    void _set_id(int id) FL_NO_EXCEPT;
    int _id() const FL_NO_EXCEPT;
    bool _is_canceled() const FL_NO_EXCEPT;
    bool _ready_to_run(u32 current_time) const FL_NO_EXCEPT;
    bool _ready_to_run_frame_task(u32 current_time) const FL_NO_EXCEPT;
    void _set_last_run_time(u32 time) FL_NO_EXCEPT;
    bool _has_then() const FL_NO_EXCEPT;
    void _execute_then() FL_NO_EXCEPT;
    void _execute_catch(const Error& error) FL_NO_EXCEPT;
    TaskType _type() const FL_NO_EXCEPT;
    string _trace_label() const FL_NO_EXCEPT;
 
    shared_ptr<ITaskImpl> mImpl;
};

Handle every_ms(int interval_ms) FL_NO_EXCEPT;
Handle every_ms(int interval_ms, const TracePoint& trace) FL_NO_EXCEPT;

Handle at_framerate(int fps) FL_NO_EXCEPT;
Handle at_framerate(int fps, const TracePoint& trace) FL_NO_EXCEPT;


Handle before_frame() FL_NO_EXCEPT;
Handle before_frame(const TracePoint& trace) FL_NO_EXCEPT;

Handle after_frame() FL_NO_EXCEPT;
Handle after_frame(const TracePoint& trace) FL_NO_EXCEPT;
Handle after_frame(function<void()> on_then) FL_NO_EXCEPT;
Handle after_frame(function<void()> on_then, const TracePoint& trace) FL_NO_EXCEPT;
Handle coroutine(const CoroutineConfig& config) FL_NO_EXCEPT;

void exit_current() FL_NO_EXCEPT;

class Coroutine;  // IWYU pragma: keep
 
} // namespace task
} // namespace fl