dtact-util 0.2.0

Async utilities for Dtact: I/O, filesystem, process, signal, stream and timer primitives with lock-free native (io_uring/IOCP/kqueue) and tokio backends. Designed for hardware-level control and non-blocking heterogeneous orchestration.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

//! C FFI for [`crate::timer`]: blocking sleep and a blocking interval.
//!
//! `timeout` from the Rust API is intentionally **not** exposed here: it
//! wraps an arbitrary `Future`, which has no representation in a synchronous
//! C ABI (there is no C "future" to time out). Callers who need a deadline
//! on a C-side blocking operation should use their own platform timeout on
//! the blocking call, or poll an interval.

use crate::ffi::{block_on, clear_last_error};
use crate::timer::{DtactInterval, sleep};
use std::time::Duration;

/// Block the calling thread for `millis` milliseconds using the native
/// timer wheel.
///
/// # Safety
///
/// See the [`crate::ffi`] module-level Safety contract. Takes no pointers.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn dtact_util_timer_sleep_ms(millis: u64) {
    clear_last_error();
    block_on(sleep(Duration::from_millis(millis)));
}

/// Create a repeating interval timer with the given period in milliseconds.
///
/// Returns an owning handle, or null if `period_millis` is 0 (an error is
/// recorded). Free with [`dtact_util_timer_interval_free`].
///
/// # Safety
///
/// See the [`crate::ffi`] module-level Safety contract. Takes no pointers.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn dtact_util_timer_interval_create(
    period_millis: u64,
) -> *mut DtactInterval {
    clear_last_error();
    if period_millis == 0 {
        crate::ffi::set_last_error("interval period must be > 0");
        return std::ptr::null_mut();
    }
    Box::into_raw(Box::new(DtactInterval::new(Duration::from_millis(
        period_millis,
    ))))
}

/// Block until this interval's next tick fires.
///
/// # Safety
///
/// See the [`crate::ffi`] module-level Safety contract. `interval` must be a
/// live handle from [`dtact_util_timer_interval_create`].
#[unsafe(no_mangle)]
pub unsafe extern "C" fn dtact_util_timer_interval_tick(interval: *mut DtactInterval) {
    clear_last_error();
    if interval.is_null() {
        crate::ffi::set_last_error("null interval handle");
        return;
    }
    let interval = unsafe { &mut *interval };
    block_on(interval.tick());
}

/// Free an interval handle. Passing null is a no-op.
///
/// # Safety
///
/// See the [`crate::ffi`] module-level Safety contract. `interval` must have
/// come from [`dtact_util_timer_interval_create`] and must not be used
/// afterwards.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn dtact_util_timer_interval_free(interval: *mut DtactInterval) {
    if !interval.is_null() {
        drop(unsafe { Box::from_raw(interval) });
    }
}