zx/
eventpair.rs

1// Copyright 2016 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5//! Type-safe bindings for Zircon event pairs.
6
7use crate::{ok, AsHandleRef, Handle, HandleBased, HandleRef, Peered};
8
9/// An object representing a Zircon
10/// [event_pair](https://fuchsia.dev/fuchsia-src/concepts/kernel/concepts#events_event_pairs)
11///
12/// As essentially a subtype of `Handle`, it can be freely interconverted.
13#[derive(Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
14#[repr(transparent)]
15pub struct EventPair(Handle);
16impl_handle_based!(EventPair);
17impl Peered for EventPair {}
18
19impl EventPair {
20    /// Create an event pair, a pair of objects which can signal each other. Wraps the
21    /// [zx_eventpair_create](https://fuchsia.dev/fuchsia-src/reference/syscalls/eventpair_create.md)
22    /// syscall.
23    ///
24    /// # Panics
25    ///
26    /// If the kernel reports no available memory to create an event pair or the process' job
27    /// policy disallows EventPair creation.
28    pub fn create() -> (Self, Self) {
29        let mut out0 = 0;
30        let mut out1 = 0;
31        let options = 0;
32        let status = unsafe { crate::sys::zx_eventpair_create(options, &mut out0, &mut out1) };
33        ok(status).expect(
34            "eventpair creation always succeeds except with OOM or when job policy denies it",
35        );
36        unsafe { (Self::from(Handle::from_raw(out0)), Self::from(Handle::from_raw(out1))) }
37    }
38}
39
40#[cfg(test)]
41mod tests {
42    use super::*;
43    use crate::{Duration, MonotonicInstant, Signals, WaitResult};
44
45    #[test]
46    fn wait_and_signal_peer() {
47        let (p1, p2) = EventPair::create();
48        let eighty_ms = Duration::from_millis(80);
49
50        // Waiting on one without setting any signal should time out.
51        assert_eq!(
52            p2.wait_handle(Signals::USER_0, MonotonicInstant::after(eighty_ms)),
53            WaitResult::TimedOut(Signals::empty())
54        );
55
56        // If we set a signal, we should be able to wait for it.
57        assert!(p1.signal_peer(Signals::NONE, Signals::USER_0).is_ok());
58        assert_eq!(
59            p2.wait_handle(Signals::USER_0, MonotonicInstant::after(eighty_ms)).unwrap(),
60            Signals::USER_0
61        );
62
63        // Should still work, signals aren't automatically cleared.
64        assert_eq!(
65            p2.wait_handle(Signals::USER_0, MonotonicInstant::after(eighty_ms)).unwrap(),
66            Signals::USER_0
67        );
68
69        // Now clear it, and waiting should time out again.
70        assert!(p1.signal_peer(Signals::USER_0, Signals::NONE).is_ok());
71        assert_eq!(
72            p2.wait_handle(Signals::USER_0, MonotonicInstant::after(eighty_ms)),
73            WaitResult::TimedOut(Signals::empty())
74        );
75    }
76}
zx/eventpair.rs

zx/
eventpair.rs
