Skip to content

Commit 3be70a4

Browse files
committed
Specification for try_esp_delay added as code comment.
1 parent 3720ac0 commit 3be70a4

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

cores/esp8266/coredecls.h

+4
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ inline void esp_suspend(T&& blocked) {
5151
} while (blocked());
5252
}
5353

54+
// Try to delay for timeout_ms relative to start_ms. Returns false if the delayed task
55+
// is asynchronously resumed before the timeout is reached.
56+
// Also returns false if intvl_ms have expired during the active call.
57+
// Otherwise return true to indicate the timeout_ms have completely expired.
5458
bool try_esp_delay(const uint32_t start_ms, const uint32_t timeout_ms, const uint32_t intvl_ms);
5559

5660
// This overload of esp_delay() delays for a duration of at most timeout_ms milliseconds.

0 commit comments

Comments
 (0)