Upstream/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2024-11-05 09:16:46 +01:00
Code Issues Projects Releases Wiki Activity

Component::set_retry updates (#3305)

Browse Source
This commit is contained in:
Dan Jackson 2022-12-21 23:48:15 -08:00 committed by GitHub
parent 33b1a853b9
commit ff4fd497c4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
esphome/core/component.h
View File

@ -185,19 +185,29 @@ class Component {
/** Set an retry function with a unique name. Empty name means no cancelling possible. /** Set an retry function with a unique name. Empty name means no cancelling possible.
* *
* This will call f. If f returns RetryResult::RETRY f is called again after initial_wait_time ms. * This will call the retry function f on the next scheduler loop. f should return RetryResult::DONE if
* f should return RetryResult::DONE if no repeat is required. The initial wait time will be increased * it is successful and no repeat is required. Otherwise, returning RetryResult::RETRY will call f
* by backoff_increase_factor for each iteration. Default is doubling the time between iterations * again in the future.
* Can be cancelled via cancel_retry(). *
* The first retry of f happens after `initial_wait_time` milliseconds. The delay between retries is
* increased by multipling by `backoff_increase_factor` each time. If no backoff_increase_factor is
* supplied (default = 1.0), the wait time will stay constant.
*
* This retry function can also be cancelled by name via cancel_retry().
* *
* IMPORTANT: Do not rely on this having correct timing. This is only called from * IMPORTANT: Do not rely on this having correct timing. This is only called from
* loop() and therefore can be significantly delayed. * loop() and therefore can be significantly delayed.
* *
* REMARK: It is an error to supply a negative or zero `backoff_increase_factor`, and 1.0 will be used instead.
*
* REMARK: The interval between retries is stored into a `uint32_t`, so this doesn't behave correctly
* if `initial_wait_time * (backoff_increase_factor ** (max_attempts - 2))` overflows.
*
* @param name The identifier for this retry function. * @param name The identifier for this retry function.
* @param initial_wait_time The time in ms before f is called again * @param initial_wait_time The time in ms before f is called again
* @param max_attempts The maximum number of retries * @param max_attempts The maximum number of executions
* @param f The function (or lambda) that should be called * @param f The function (or lambda) that should be called
* @param backoff_increase_factor time between retries is increased by this factor on every retry * @param backoff_increase_factor time between retries is multiplied by this factor on every retry after the first
* @see cancel_retry() * @see cancel_retry()
*/ */
void set_retry(const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, // NOLINT void set_retry(const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, // NOLINT

14
esphome/core/scheduler.cpp
View File

@ -87,8 +87,10 @@ static void retry_handler(const std::shared_ptr<RetryArgs> &args) {
RetryResult retry_result = args->func(); RetryResult retry_result = args->func();
if (retry_result == RetryResult::DONE || --args->retry_countdown <= 0) if (retry_result == RetryResult::DONE || --args->retry_countdown <= 0)
return; return;
args->current_interval *= args->backoff_increase_factor; // second execution of `func` hapens after `initial_wait_time`
args->scheduler->set_timeout(args->component, args->name, args->current_interval, [args]() { retry_handler(args); }); args->scheduler->set_timeout(args->component, args->name, args->current_interval, [args]() { retry_handler(args); });
// backoff_increase_factor applied to third & later executions
args->current_interval *= args->backoff_increase_factor;
} }
void HOT Scheduler::set_retry(Component *component, const std::string &name, uint32_t initial_wait_time, void HOT Scheduler::set_retry(Component *component, const std::string &name, uint32_t initial_wait_time,
@ -102,6 +104,13 @@ void HOT Scheduler::set_retry(Component *component, const std::string &name, uin
ESP_LOGVV(TAG, "set_retry(name='%s', initial_wait_time=%u, max_attempts=%u, backoff_factor=%0.1f)", name.c_str(), ESP_LOGVV(TAG, "set_retry(name='%s', initial_wait_time=%u, max_attempts=%u, backoff_factor=%0.1f)", name.c_str(),
initial_wait_time, max_attempts, backoff_increase_factor); initial_wait_time, max_attempts, backoff_increase_factor);
if (backoff_increase_factor < 0.0001) {
ESP_LOGE(TAG,
"set_retry(name='%s'): backoff_factor cannot be close to zero nor negative (%0.1f). Using 1.0 instead",
name.c_str(), backoff_increase_factor);
backoff_increase_factor = 1;
}
auto args = std::make_shared<RetryArgs>(); auto args = std::make_shared<RetryArgs>();
args->func = std::move(func); args->func = std::move(func);
args->retry_countdown = max_attempts; args->retry_countdown = max_attempts;
@ -111,7 +120,8 @@ void HOT Scheduler::set_retry(Component *component, const std::string &name, uin
args->backoff_increase_factor = backoff_increase_factor; args->backoff_increase_factor = backoff_increase_factor;
args->scheduler = this; args->scheduler = this;
this->set_timeout(component, args->name, initial_wait_time, [args]() { retry_handler(args); }); // First exectuion of `func` immediately
this->set_timeout(component, args->name, 0, [args]() { retry_handler(args); });
} }
bool HOT Scheduler::cancel_retry(Component *component, const std::string &name) { bool HOT Scheduler::cancel_retry(Component *component, const std::string &name) {
return this->cancel_timeout(component, "retry$" + name); return this->cancel_timeout(component, "retry$" + name);