rte_event_timer(3)

💖 rte_event_timer(3) — Library Functions Manual 💖

okay bestie, come sit with me, because today we're learning about the generic event timer struct and honestly? she's serving. this is rte_event_timer, straight out of DPDK, and she's here to hold all the event timer attributes you need for arm and cancel operations. no cap.

---

✨ NAME ✨

rte_event_timer — the generic event timer structure 💅

---

🎀 SYNOPSIS 🎀

#include <rte_event_timer_adapter.h>

🌸 Data Fields 🌸

struct rte_event ev
uint64_t timeout_ticks
uint64_t impl_opaque [2]
enum rte_event_timer_state state
uint8_t user_meta []

---

🦋 Detailed Description 🦋

The generic rte_event_timer structure to hold the event timer attributes for arm and cancel operations. periodt.

fr fr, this is the definition at line 476 of file rte_event_timer_adapter.h.

---

👑 Field Documentation 👑

---

💜 struct rte_event ev

Expiry event attributes. The way that this works is: on a successful event timer timeout, the following attributes get used to inject the expiry event to the eventdev. it's giving very intentional:

• event_queue_id — Targeted event queue id for expiry events.
• event_priority — Event priority of the event expiry event in the event queue relative to other events.
• sched_type — Scheduling type of the expiry event.
• flow_id — Flow id of the expiry event.
• op — RTE_EVENT_OP_NEW
• event_type — RTE_EVENT_TYPE_TIMER

Definition at line 477 of file rte_event_timer_adapter.h. ✨

---

💜 uint64_t timeout_ticks

Expiry timer ticks — expressed in number of timer_ticks_ns from now. so basically "how many ticks until we pop off" 🎀

See also

struct rte_event_timer_adapter_info::adapter_conf::timer_tick_ns

Definition at line 490 of file rte_event_timer_adapter.h. 🫶

---

💜 uint64_t impl_opaque[2]

Implementation-specific opaque data. An event timer adapter implementation uses this field to hold implementation specific values so it can share stuff between the arm and cancel operations.

bestie, do NOT touch this one. The application should not modify this field. it's not yours, it's the implementation's. hands off. 🙈

Definition at line 495 of file rte_event_timer_adapter.h. 💅

---

💜 enum rte_event_timer_state state

State of the event timer. that's it, that's the field, she's simple and she ate. ⭐

Definition at line 501 of file rte_event_timer_adapter.h. 🌈

---

💜 uint8_t user_meta[]

Memory to store user specific metadata. and listen — the event timer adapter implementation should not modify this area. it's your little corner of the struct, you're the main character here, decorate accordingly. 💖

Definition at line 503 of file rte_event_timer_adapter.h. 🧚

---

🌸 Author 🌸

Generated automatically by Doxygen for DPDK from the source code. yes, a robot wrote my homework and honestly? slay. 🤖✨

---

okay and for the cute little sign-off: this whole thing is DPDK, Version 25.11.3, rte_event_timer(3), and that's the vibe check — passed with flying colors. go arm some timers, bestie, i believe in you 🫶🎀💜