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

#70 in Unix APIs

Download history 6526/week @ 2024-08-02 7915/week @ 2024-08-09 6316/week @ 2024-08-16 5904/week @ 2024-08-23 7537/week @ 2024-08-30 6213/week @ 2024-09-06 7992/week @ 2024-09-13 6718/week @ 2024-09-20 7085/week @ 2024-09-27 9450/week @ 2024-10-04 14254/week @ 2024-10-11 15804/week @ 2024-10-18 13474/week @ 2024-10-25 11792/week @ 2024-11-01 11686/week @ 2024-11-08 6853/week @ 2024-11-15

46,868 downloads per month
Used in 30 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.5–10MB
~112K SLoC