9 stable releases

Uses old Rust 2015

1.6.0 Mar 21, 2024
1.5.0 Jun 8, 2023
1.4.1 Mar 30, 2023
1.4.0 Nov 29, 2022
0.2.0 Nov 30, 2016

#79 in Unix APIs

Download history 12390/week @ 2024-02-28 15153/week @ 2024-03-06 18670/week @ 2024-03-13 18676/week @ 2024-03-20 11892/week @ 2024-03-27 14684/week @ 2024-04-03 9419/week @ 2024-04-10 12240/week @ 2024-04-17 11797/week @ 2024-04-24 9541/week @ 2024-05-01 11092/week @ 2024-05-08 9685/week @ 2024-05-15 9382/week @ 2024-05-22 10693/week @ 2024-05-29 13890/week @ 2024-06-05 11125/week @ 2024-06-12

47,282 downloads per month
Used in 29 crates (8 directly)

MIT license

17KB
267 lines

rust-timerfd

A rust interface to the Linux kernel's timerfd API.

Documentation Crates.io


lib.rs:

A rust interface to the Linux kernel's timerfd API.

Example

use timerfd::{TimerFd, TimerState, SetTimeFlags};
use std::time::Duration;

// Create a new timerfd
// (unwrap is actually fine here for most usecases)
let mut tfd = TimerFd::new().unwrap();

// The timer is initially disarmed
assert_eq!(tfd.get_state(), TimerState::Disarmed);

// Set the timer
tfd.set_state(TimerState::Oneshot(Duration::new(1, 0)), SetTimeFlags::Default);

// Observe that the timer is now set
match tfd.get_state() {
    TimerState::Oneshot(d) => println!("Remaining: {:?}", d),
    _ => unreachable!(),
}

// Wait for the remaining time
tfd.read();

// It was a oneshot timer, so it's now disarmed
assert_eq!(tfd.get_state(), TimerState::Disarmed);

Usage

Unfortunately, this example can't show why you would use timerfd in the first place: Because it creates a file descriptor that you can monitor with select(2), poll(2) and epoll(2).

In other words, the primary advantage this offers over any other timer implementation is that it implements the AsFd/AsRawFd traits.

The file descriptor becomes ready/readable whenever the timer expires.

Dependencies

~1–10MB
~107K SLoC