diff options
| author | Matias Elo <matias.elo@nokia.com> | 2022-12-22 11:08:16 +0200 |
|---|---|---|
| committer | Petri Savolainen <petri.savolainen@nokia.com> | 2022-12-29 14:42:06 +0200 |
| commit | 50f60d94806d6dcaf15b6459642af2e48a431f71 (patch) | |
| tree | 4a8ddf430f0a939e65acd22d74e1aea6640423fd /doc/users-guide | |
| parent | 7bccb570bf6242f4bab409139dd10177629129f7 (diff) | |
doc: usersguide: update timer documentation
Remove references to deprecated odp_timer_set_abs() and odp_timer_set_rel()
functions from user's guide.
Signed-off-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 | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/users-guide/users-guide-timer.adoc b/doc/users-guide/users-guide-timer.adoc index 4a8bad74f..e854b5f2d 100644 --- a/doc/users-guide/users-guide-timer.adoc +++ b/doc/users-guide/users-guide-timer.adoc @@ -46,11 +46,11 @@ as an input parameter to enable the pool-specific conversion ratios to be used. Associated with each timer pool is a free running tick counter that can be -sampled at any time via the `odp_timer_current_tick()` API. Timers can be set -to an absolute future tick value via `odp_timer_set_abs()` or to a future tick -value relative to the current tick via `odp_timer_set_rel()`. Implementations -may impose minimum and maximum future values supported by a given timer pool -and timer set operations will fail if the requested value is outside of the +sampled at any time via the `odp_timer_current_tick()` API. Timers are started +with `odp_timer_start()` and the expiration time can be an absolute future tick +value or a future tick value relative to the current tick. Implementations may +impose minimum and maximum future values supported by a given timer pool and +timer start operations will fail if the requested value is outside of the supported range. Before a set timer expires, it can be canceled via the `odp_timer_cancel()` |