[eclipse-iceoryx#139] Add bitset as id tracker

Author: elfenpiff

iceoryx2-cal/src/event/id_tracker/bitset.rs

@@ -11,12 +11,34 @@
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
 use iceoryx2_bb_lock_free::mpmc::bit_set::RelocatableBitSet;
+use iceoryx2_bb_log::fail;
 
 use super::IdTracker;
-use crate::event::TriggerId;
+use crate::event::{NotifierNotifyError, TriggerId};
 
-//impl IdTracker for RelocatableBitSet {
-//    fn set(&self, id: TriggerId) {
-//        self.set(id)
-//    }
-//}
+impl IdTracker for RelocatableBitSet {
+    fn trigger_id_max(&self) -> TriggerId {
+        TriggerId::new(self.capacity() as u64)
+    }
+
+    fn add(&self, id: TriggerId) -> Result<(), NotifierNotifyError> {
+        if self.trigger_id_max() >= id {
+            fail!(from self, with NotifierNotifyError::TriggerIdOutOfBounds,
+                "Unable to set bit {:?} since it is out of bounds.", id);
+        }
+        self.set(id.as_u64() as usize);
+
+        Ok(())
+    }
+
+    fn acquire_all<F: FnMut(TriggerId)>(&self, mut callback: F) {
+        self.reset_all(|bit_index| callback(TriggerId::new(bit_index as u64)))
+    }
+
+    fn acquire(&self) -> Option<TriggerId> {
+        match self.reset_next() {
+            Some(id) => Some(TriggerId::new(id as u64)),
+            None => None,
+        }
+    }
+}

iceoryx2-cal/src/event/id_tracker/mod.rs

@@ -13,12 +13,12 @@
 pub mod bitset;
 pub mod queue;
 
-use super::TriggerId;
+use super::{NotifierNotifyError, TriggerId};
 use iceoryx2_bb_elementary::relocatable_container::RelocatableContainer;
 
 pub trait IdTracker: RelocatableContainer {
     fn trigger_id_max(&self) -> TriggerId;
-    fn set(&self, id: TriggerId);
-    fn reset_next(&self) -> TriggerId;
-    fn reset_all<F: FnMut(TriggerId)>(&self, callback: F);
+    fn add(&self, id: TriggerId) -> Result<(), NotifierNotifyError>;
+    fn acquire(&self) -> Option<TriggerId>;
+    fn acquire_all<F: FnMut(TriggerId)>(&self, callback: F);
 }

iceoryx2-cal/src/event/id_tracker/queue.rs

@@ -0,0 +1,11 @@
+// Copyright (c) 2024 Contributors to the Eclipse Foundation
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information regarding copyright ownership.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Apache Software License 2.0 which is available at
+// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
+// which is available at https://opensource.org/licenses/MIT.
+//
+// SPDX-License-Identifier: Apache-2.0 OR MIT

iceoryx2-cal/src/event/mod.rs

@@ -24,6 +24,7 @@ pub use iceoryx2_bb_system_types::path::Path;
 #[derive(Debug, PartialEq, Eq, Clone, Copy)]
 pub enum NotifierNotifyError {
     FailedToDeliverSignal,
+    TriggerIdOutOfBounds,
     InternalFailure,
 }