sensors_lib/
client.rs

1// Copyright 2024 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.
4use fidl_fuchsia_sensors::ManagerControlHandle;
5use std::hash::{Hash, Hasher};
6use std::sync::atomic::AtomicUsize;
7use std::sync::atomic::Ordering::SeqCst;
8
9static CLIENT_ID_COUNT: AtomicUsize = AtomicUsize::new(0);
10
11// TODO(375043170): Remove this when sensors have a better IPC mechanism.
12//
13// There is no way to compare control handles, so instead this helper struct will assign a unique
14// id to each new instance. This will only be used until sensors no longer need to use
15// send_on_sensor_event.
16#[derive(Debug, Clone)]
17pub struct Client {
18    id: usize,
19    pub(crate) control_handle: ManagerControlHandle,
20}
21
22impl Client {
23    pub fn new(control_handle: ManagerControlHandle) -> Self {
24        Self { id: CLIENT_ID_COUNT.fetch_add(1, SeqCst), control_handle }
25    }
26}
27
28impl PartialEq for Client {
29    fn eq(&self, other: &Self) -> bool {
30        self.id == other.id
31    }
32}
33
34impl Eq for Client {}
35
36impl Hash for Client {
37    fn hash<H: Hasher>(&self, state: &mut H) {
38        self.id.hash(state);
39    }
40}
41
42#[cfg(test)]
43mod tests {
44    use super::*;
45    use fidl::endpoints::*;
46    use fidl_fuchsia_sensors::*;
47
48    #[fuchsia::test]
49    async fn test_unique_client_ids() {
50        let (_, stream) = create_proxy_and_stream::<ManagerMarker>();
51        let client1 = Client::new(stream.control_handle().clone());
52        let client2 = Client::new(stream.control_handle().clone());
53        assert_ne!(client1.id, client2.id);
54        // IDs should start at 0 and monotonically increase.
55        assert_eq!(client1.id, 0);
56        assert_eq!(client2.id, 1);
57    }
58
59    #[fuchsia::test]
60    async fn test_client_partial_eq() {
61        let (_, stream) = create_proxy_and_stream::<ManagerMarker>();
62        let client1 = Client::new(stream.control_handle().clone());
63        let client2 = Client::new(stream.control_handle().clone());
64        assert_ne!(client1, client2);
65        assert_eq!(client1, client1.clone());
66    }
67}