odp_timer_start_t Struct Reference

Timer start parameters. More...

#include <timer_types.h>

Collaboration diagram for odp_timer_start_t:

Data Fields
odp_timer_tick_type_t	tick_type
	Tick type. More...
uint64_t	tick
	Expiration time in ticks. More...
odp_event_t	tmo_ev
	Timeout event. More...

Detailed Description

Timer start parameters.

Examples

odp_bench_timer.c, odp_debug.c, odp_sched_pktio.c, odp_stress.c, odp_timer_accuracy.c, odp_timer_perf.c, and odp_timer_simple.c.

Definition at line 405 of file api/spec/timer_types.h.

Field Documentation

tick_type

odp_timer_tick_type_t odp_timer_start_t::tick_type

Tick type.

Defines if expiration time ticks are absolute or relative.

Examples

odp_bench_timer.c, odp_debug.c, odp_sched_pktio.c, odp_stress.c, odp_timer_accuracy.c, odp_timer_perf.c, and odp_timer_simple.c.

Definition at line 410 of file api/spec/timer_types.h.

tick

uint64_t odp_timer_start_t::tick

Expiration time in ticks.

New expiration time for the timer to be started/restarted. When 'tick_type' is ODP_TIMER_TICK_REL, expiration time is odp_timer_current_tick() + 'tick'.

Examples

odp_bench_timer.c, odp_debug.c, odp_sched_pktio.c, odp_stress.c, odp_timer_accuracy.c, odp_timer_perf.c, and odp_timer_simple.c.

Definition at line 416 of file api/spec/timer_types.h.

tmo_ev

odp_event_t odp_timer_start_t::tmo_ev

Timeout event.

When the timer expires, this event is enqueued to the destination queue of the timer. The event type can be ODP_EVENT_BUFFER, ODP_EVENT_PACKET or ODP_EVENT_TIMEOUT. It is recommended to use ODP_EVENT_TIMEOUT type events. Those (odp_timeout_t) carry also timeout specific metadata.

This field is ignored by odp_timer_restart() calls.

Examples

odp_bench_timer.c, odp_debug.c, odp_sched_pktio.c, odp_stress.c, odp_timer_accuracy.c, odp_timer_perf.c, and odp_timer_simple.c.

Definition at line 427 of file api/spec/timer_types.h.

---

The documentation for this struct was generated from the following file:

• api/spec/timer_types.h