diff options
author | Petri Savolainen <petri.savolainen@nokia.com> | 2023-11-28 16:51:05 +0200 |
---|---|---|
committer | Petri Savolainen <petri.savolainen@nokia.com> | 2023-12-20 10:38:47 +0200 |
commit | 8892ab3b135f9213d6e2cb7c81f740a2556baf64 (patch) | |
tree | 2f3e6f43e05ebbfd4fa9383fc474c094f5463c70 /doc/users-guide | |
parent | 9e8bed5058d9cfbd1147d1fc3b4807339ffc74d5 (diff) |
doc: timer: remove timeout fresh text
Removed odp_timeout_fresh() references from user guide.
Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com>
Reviewed-by: Matias Elo <matias.elo@nokia.com>
Reviewed-by: Jere Leppänen <jere.leppanen@nokia.com>
Diffstat (limited to 'doc/users-guide')
-rw-r--r-- | doc/users-guide/users-guide-timer.adoc | 18 |
1 files changed, 0 insertions, 18 deletions
diff --git a/doc/users-guide/users-guide-timer.adoc b/doc/users-guide/users-guide-timer.adoc index 71c66cd93..45507a872 100644 --- a/doc/users-guide/users-guide-timer.adoc +++ b/doc/users-guide/users-guide-timer.adoc @@ -113,11 +113,6 @@ while (1) { void *userptr = odp_timeout_user_ptr(timeout); uint64_t expiration = odp_timeout_tick(timeout); - if (!odp_timeout_fresh(timeout)) { - odp_timeout_free(timeout); - continue; - } - ...process the timeout event break; @@ -125,16 +120,3 @@ while (1) { } } ----- -When a worker thread receives a timeout event via `odp_schedule()`, it needs -to determine whether the event is still relevant. A timeout event that is still -relevant is said to be _fresh_ while one that is no longer relevant is said to -be _stale_. Timeouts may be stale for any number of reasons, most of which are -known only to the application itself. However, there are a few cases where the -ODP implementation may be able to assist in this determination and for those -cases the `odp_timeout_fresh()` API is provided. - -ODP defines a fresh timeout simply as one that has not been reset or -canceled since it expired. So if `odp_timeout_fresh()` returns 0 then it is -likely that the application should ignore this event, however if it returns 1 -then it remains an application responsibility to handle the event appropriate -to its needs. |