cpp-esphome-api/executor_8hpp_source.html

#pragma once


#include <chrono>

#include <cstdint>

#include <functional>


namespace esphome::api {


using TimerId = std::uint64_t;

inline constexpr TimerId invalid_timer = 0;


class Executor {

public:

    virtual ~Executor() = default;


    virtual void post(std::function<void()> fn) = 0;


    virtual TimerId schedule_after(std::chrono::milliseconds delay, std::function<void()> fn) = 0;


    virtual void cancel(TimerId id) = 0;

};


}  // namespace esphome::api

esphome::api::Executor
Minimal executor: deferred execution plus one-shot timers.
Definition executor.hpp:20

esphome::api::Executor::schedule_after
virtual TimerId schedule_after(std::chrono::milliseconds delay, std::function< void()> fn)=0
Run fn once after delay. Returns a handle usable with cancel.

esphome::api::Executor::~Executor
virtual ~Executor()=default

esphome::api::Executor::post
virtual void post(std::function< void()> fn)=0
Run fn soon, on the executor (never inline / re-entrantly).

esphome::api::Executor::cancel
virtual void cancel(TimerId id)=0
Cancel a pending timer (no-op if it already fired or was cancelled).

esphome::api
Definition bytes.hpp:10

esphome::api::TimerId
std::uint64_t TimerId
Opaque handle to a scheduled timer; invalid_timer means "no timer".
Definition executor.hpp:14

esphome::api::invalid_timer
constexpr TimerId invalid_timer
Definition executor.hpp:15