[#390] Rename event_from -> has_event_from, deadline_from -> has_missed_deadline

Author: elfenpiff

iceoryx2-ffi/cxx/include/iox2/waitset.hpp

@@ -25,7 +25,8 @@ namespace iox2 {
 /// The [`WaitSetGuard`] is returned by [`WaitSet::attach_deadline()`], [`WaitSet::attach_notification()`]
 /// or [`WaitSet::attach_interval()`]. As soon as it goes out-of-scope it detaches the attachment.
 /// It can also be used to determine the origin of an event in [`WaitSet::run()`] or
-/// [`WaitSet::run_once()`] via [`WaitSetAttachmentId::event_from()`] or [`WaitSetAttachmentId::deadline_from()`].
+/// [`WaitSet::run_once()`] via [`WaitSetAttachmentId::has_event_from()`] or
+/// [`WaitSetAttachmentId::has_missed_deadline()`].
 template <ServiceType S>
 class WaitSetGuard {
   public:
@@ -66,10 +67,10 @@ class WaitSetAttachmentId {
 
     /// Returns true if an event was emitted from a notification or deadline attachment
     /// corresponding to [`WaitSetGuard`].
-    auto event_from(const WaitSetGuard<S>& guard) const -> bool;
+    auto has_event_from(const WaitSetGuard<S>& guard) const -> bool;
 
     /// Returns true if the deadline for the attachment corresponding to [`WaitSetGuard`] was missed.
-    auto deadline_from(const WaitSetGuard<S>& guard) const -> bool;
+    auto has_missed_deadline(const WaitSetGuard<S>& guard) const -> bool;
 
   private:
     explicit WaitSetAttachmentId(iox2_waitset_attachment_id_h handle);

iceoryx2-ffi/cxx/src/waitset.cpp

@@ -51,13 +51,13 @@ auto WaitSetAttachmentId<S>::from_guard(const WaitSetGuard<S>& guard) -> WaitSet
 }
 
 template <ServiceType S>
-auto WaitSetAttachmentId<S>::event_from(const WaitSetGuard<S>& guard) const -> bool {
-    return iox2_waitset_attachment_id_event_from(&m_handle, &guard.m_handle);
+auto WaitSetAttachmentId<S>::has_event_from(const WaitSetGuard<S>& guard) const -> bool {
+    return iox2_waitset_attachment_id_has_event_from(&m_handle, &guard.m_handle);
 }
 
 template <ServiceType S>
-auto WaitSetAttachmentId<S>::deadline_from(const WaitSetGuard<S>& guard) const -> bool {
-    return iox2_waitset_attachment_id_deadline_from(&m_handle, &guard.m_handle);
+auto WaitSetAttachmentId<S>::has_missed_deadline(const WaitSetGuard<S>& guard) const -> bool {
+    return iox2_waitset_attachment_id_has_missed_deadline(&m_handle, &guard.m_handle);
 }
 
 template <ServiceType S>

iceoryx2-ffi/cxx/tests/src/waitset_tests.cpp

@@ -156,8 +156,8 @@ TYPED_TEST(WaitSetTest, interval_attachment_blocks_for_at_least_timeout) {
     auto result = sut.run([&](auto attachment_id) {
         callback_called = true;
         sut.stop();
-        ASSERT_THAT(attachment_id.event_from(guard), Eq(true));
-        ASSERT_THAT(attachment_id.deadline_from(guard), Eq(false));
+        ASSERT_THAT(attachment_id.has_event_from(guard), Eq(true));
+        ASSERT_THAT(attachment_id.has_missed_deadline(guard), Eq(false));
     });
 
     auto end = std::chrono::steady_clock::now();
@@ -178,8 +178,8 @@ TYPED_TEST(WaitSetTest, deadline_attachment_blocks_for_at_least_timeout) {
     auto result = sut.run([&](auto attachment_id) {
         callback_called = true;
         sut.stop();
-        ASSERT_THAT(attachment_id.event_from(guard), Eq(false));
-        ASSERT_THAT(attachment_id.deadline_from(guard), Eq(true));
+        ASSERT_THAT(attachment_id.has_event_from(guard), Eq(false));
+        ASSERT_THAT(attachment_id.has_missed_deadline(guard), Eq(true));
     });
 
     auto end = std::chrono::steady_clock::now();
@@ -204,8 +204,8 @@ TYPED_TEST(WaitSetTest, deadline_attachment_wakes_up_when_notified) {
     auto result = sut.run([&](auto attachment_id) {
         callback_called = true;
         sut.stop();
-        ASSERT_THAT(attachment_id.event_from(guard), Eq(true));
-        ASSERT_THAT(attachment_id.deadline_from(guard), Eq(false));
+        ASSERT_THAT(attachment_id.has_event_from(guard), Eq(true));
+        ASSERT_THAT(attachment_id.has_missed_deadline(guard), Eq(false));
     });
 
     notifier_thread.join();
@@ -227,8 +227,8 @@ TYPED_TEST(WaitSetTest, notification_attachment_wakes_up_when_notified) {
     auto result = sut.run([&](auto attachment_id) {
         callback_called = true;
         sut.stop();
-        ASSERT_THAT(attachment_id.event_from(guard), Eq(true));
-        ASSERT_THAT(attachment_id.deadline_from(guard), Eq(false));
+        ASSERT_THAT(attachment_id.has_event_from(guard), Eq(true));
+        ASSERT_THAT(attachment_id.has_missed_deadline(guard), Eq(false));
     });
 
     notifier_thread.join();
@@ -268,7 +268,7 @@ TYPED_TEST(WaitSetTest, triggering_everything_works) {
 
     sut.run_once([&](auto attachment_id) {
            for (uint64_t idx = 0; idx < guards.size(); ++idx) {
-               if (attachment_id.event_from(guards[idx])) {
+               if (attachment_id.has_event_from(guards[idx])) {
                    was_triggered[idx] = true;
                    break;
                }

iceoryx2-ffi/ffi/src/api/waitset.rs

@@ -307,7 +307,7 @@ pub unsafe extern "C" fn iox2_waitset_stop(handle: iox2_waitset_h_ref) {
 /// [`iox2_waitset_h`]. As soon as the attachment receives data, the WaitSet
 /// wakes up in [`iox2_waitset_run()`] and informs the user.
 ///
-/// With [`iox2_waitset_attachment_id_event_from()`](crate::iox2_waitset_attachment_id_event_from())
+/// With [`iox2_waitset_attachment_id_has_event_from()`](crate::iox2_waitset_attachment_id_has_event_from())
 /// the origin of the event can be determined from its corresponding
 /// [`iox2_waitset_guard_h`].
 ///
@@ -383,11 +383,11 @@ pub unsafe extern "C" fn iox2_waitset_attach_notification(
 /// [`iox2_waitset_h`]. As soon as the attachment receives data or the deadline
 /// was missed, the WaitSet wakes up in [`iox2_waitset_run()`] and informs the user.
 ///
-/// With [`iox2_waitset_attachment_id_event_from()`](crate::iox2_waitset_attachment_id_event_from())
+/// With [`iox2_waitset_attachment_id_has_event_from()`](crate::iox2_waitset_attachment_id_has_event_from())
 /// the origin of the event can be determined from its corresponding
 /// [`iox2_waitset_guard_h`].
 /// If the deadline was hit the function
-/// [`iox2_waitset_attachment_id_deadline_from()`](crate::iox2_waitset_attachment_id_deadline_from())
+/// [`iox2_waitset_attachment_id_has_missed_deadline()`](crate::iox2_waitset_attachment_id_has_missed_deadline())
 /// can be used to identify it.
 ///
 /// # Return
@@ -471,7 +471,7 @@ pub unsafe extern "C" fn iox2_waitset_attach_deadline(
 /// Attaches an interval to the [`iox2_waitset_h`]. As soon as the interval has passed
 /// the WaitSet wakes up in [`iox2_waitset_run()`] and informs the user.
 ///
-/// With [`iox2_waitset_attachment_id_event_from()`](crate::iox2_waitset_attachment_id_event_from())
+/// With [`iox2_waitset_attachment_id_has_event_from()`](crate::iox2_waitset_attachment_id_has_event_from())
 /// the origin of the event can be determined from its corresponding
 /// [`iox2_waitset_guard_h`].
 ///
@@ -550,11 +550,11 @@ pub unsafe extern "C" fn iox2_waitset_attach_interval(
 /// for every events that was received and the corresponding owning [`iox2_waitset_attachment_id_h`]
 /// is provided as input argument, as well as the `callback_ctx`.
 ///
-/// With [`iox2_waitset_attachment_id_event_from()`](crate::iox2_waitset_attachment_id_event_from())
+/// With [`iox2_waitset_attachment_id_has_event_from()`](crate::iox2_waitset_attachment_id_has_event_from())
 /// the origin of the event can be determined from its corresponding
 /// [`iox2_waitset_guard_h`].
 /// If the deadline was hit the function
-/// [`iox2_waitset_attachment_id_deadline_from()`](crate::iox2_waitset_attachment_id_deadline_from())
+/// [`iox2_waitset_attachment_id_has_missed_deadline()`](crate::iox2_waitset_attachment_id_has_missed_deadline())
 /// can be used to identify it.
 ///
 /// # Return
@@ -613,11 +613,11 @@ pub unsafe extern "C" fn iox2_waitset_run_once(
 /// The infinite loop is interrupted either by a `SIGINT` or `SIGTERM` signal or
 /// when the user has called [`iox2_waitset_stop()`].
 ///
-/// With [`iox2_waitset_attachment_id_event_from()`](crate::iox2_waitset_attachment_id_event_from())
+/// With [`iox2_waitset_attachment_id_has_event_from()`](crate::iox2_waitset_attachment_id_has_event_from())
 /// the origin of the event can be determined from its corresponding
 /// [`iox2_waitset_guard_h`].
 /// If the deadline was hit the function
-/// [`iox2_waitset_attachment_id_deadline_from()`](crate::iox2_waitset_attachment_id_deadline_from())
+/// [`iox2_waitset_attachment_id_has_missed_deadline()`](crate::iox2_waitset_attachment_id_has_missed_deadline())
 /// can be used to identify it.
 ///
 /// # Return

iceoryx2-ffi/ffi/src/api/waitset_attachment_id.rs

@@ -197,7 +197,7 @@ pub unsafe extern "C" fn iox2_waitset_attachment_id_less(
 ///  * `handle` must be valid and non-null.
 ///  * `guard` must be valid and non-null.
 #[no_mangle]
-pub unsafe extern "C" fn iox2_waitset_attachment_id_event_from(
+pub unsafe extern "C" fn iox2_waitset_attachment_id_has_event_from(
     handle: iox2_waitset_attachment_id_h_ref,
     guard: iox2_waitset_guard_h_ref,
 ) -> bool {
@@ -212,12 +212,12 @@ pub unsafe extern "C" fn iox2_waitset_attachment_id_event_from(
             .value
             .as_ref()
             .ipc
-            .event_from(&*guard.value.as_ref().ipc),
+            .has_event_from(&*guard.value.as_ref().ipc),
         iox2_service_type_e::LOCAL => attachment_id
             .value
             .as_ref()
             .local
-            .event_from(&*guard.value.as_ref().local),
+            .has_event_from(&*guard.value.as_ref().local),
     }
 }
 
@@ -228,7 +228,7 @@ pub unsafe extern "C" fn iox2_waitset_attachment_id_event_from(
 ///  * `handle` must be valid and non-null.
 ///  * `guard` must be valid and non-null.
 #[no_mangle]
-pub unsafe extern "C" fn iox2_waitset_attachment_id_deadline_from(
+pub unsafe extern "C" fn iox2_waitset_attachment_id_has_missed_deadline(
     handle: iox2_waitset_attachment_id_h_ref,
     guard: iox2_waitset_guard_h_ref,
 ) -> bool {
@@ -243,12 +243,12 @@ pub unsafe extern "C" fn iox2_waitset_attachment_id_deadline_from(
             .value
             .as_ref()
             .ipc
-            .deadline_from(&*guard.value.as_ref().ipc),
+            .has_missed_deadline(&*guard.value.as_ref().ipc),
         iox2_service_type_e::LOCAL => attachment_id
             .value
             .as_ref()
             .local
-            .deadline_from(&*guard.value.as_ref().local),
+            .has_missed_deadline(&*guard.value.as_ref().local),
     }
 }
 

iceoryx2/src/port/waitset.rs

@@ -58,7 +58,7 @@
 //! let guard = waitset.attach_notification(&listener)?;
 //!
 //! let on_event = |attachment_id: WaitSetAttachmentId<ipc::Service>| {
-//!     if attachment_id.event_from(&guard) {
+//!     if attachment_id.has_event_from(&guard) {
 //!         while let Ok(Some(event_id)) = listener.try_wait_one() {
 //!             println!("received notification {:?}", event_id);
 //!         }
@@ -89,11 +89,11 @@
 //! let guard = waitset.attach_deadline(&listener, listener_deadline)?;
 //!
 //! let on_event = |attachment_id: WaitSetAttachmentId<ipc::Service>| {
-//!     if attachment_id.event_from(&guard) {
+//!     if attachment_id.has_event_from(&guard) {
 //!         while let Ok(Some(event_id)) = listener.try_wait_one() {
 //!             println!("received notification {:?}", event_id);
 //!         }
-//!     } else if attachment_id.deadline_from(&guard) {
+//!     } else if attachment_id.has_missed_deadline(&guard) {
 //!         println!("Oh no, we hit the deadline without receiving any kind of event");
 //!     }
 //! };
@@ -126,9 +126,9 @@
 //! let guard_2 = waitset.attach_interval(pub_2_period)?;
 //!
 //! let on_event = |attachment_id: WaitSetAttachmentId<ipc::Service>| {
-//!     if attachment_id.event_from(&guard_1) {
+//!     if attachment_id.has_event_from(&guard_1) {
 //!         publisher_1.send_copy(123);
-//!     } else if attachment_id.event_from(&guard_2) {
+//!     } else if attachment_id.has_event_from(&guard_2) {
 //!         publisher_2.send_copy(456);
 //!     }
 //! };
@@ -365,7 +365,7 @@ impl<Service: crate::service::Service> WaitSetAttachmentId<Service> {
 
     /// Returns true if an event was emitted from a notification or deadline attachment
     /// corresponding to [`WaitSetGuard`].
-    pub fn event_from(&self, other: &WaitSetGuard<Service>) -> bool {
+    pub fn has_event_from(&self, other: &WaitSetGuard<Service>) -> bool {
         let other_attachment = WaitSetAttachmentId::from_guard(other);
         if let AttachmentIdType::Deadline(other_waitset, other_reactor_idx, _) =
             other_attachment.attachment_type
@@ -381,7 +381,7 @@ impl<Service: crate::service::Service> WaitSetAttachmentId<Service> {
     }
 
     /// Returns true if the deadline for the attachment corresponding to [`WaitSetGuard`] was missed.
-    pub fn deadline_from(&self, other: &WaitSetGuard<Service>) -> bool {
+    pub fn has_missed_deadline(&self, other: &WaitSetGuard<Service>) -> bool {
         if let AttachmentIdType::Deadline(..) = self.attachment_type {
             self.attachment_type == WaitSetAttachmentId::from_guard(other).attachment_type
         } else {

iceoryx2/tests/waitset_tests.rs

@@ -198,13 +198,13 @@ mod waitset {
         let mut receiver_2_triggered = false;
 
         sut.run_once(|attachment_id| {
-            if attachment_id.event_from(&listener_1_guard) {
+            if attachment_id.has_event_from(&listener_1_guard) {
                 listener_1_triggered = true;
-            } else if attachment_id.event_from(&listener_2_guard) {
+            } else if attachment_id.has_event_from(&listener_2_guard) {
                 listener_2_triggered = true;
-            } else if attachment_id.event_from(&receiver_1_guard) {
+            } else if attachment_id.has_event_from(&receiver_1_guard) {
                 receiver_1_triggered = true;
-            } else if attachment_id.event_from(&receiver_2_guard) {
+            } else if attachment_id.has_event_from(&receiver_2_guard) {
                 receiver_2_triggered = true;
             } else {
                 test_fail!("only attachments shall trigger");
@@ -233,8 +233,8 @@ mod waitset {
         let start = Instant::now();
         sut.run_once(|id| {
             callback_called = true;
-            assert_that!(id.event_from(&tick_guard), eq true);
-            assert_that!(id.deadline_from(&tick_guard), eq false);
+            assert_that!(id.has_event_from(&tick_guard), eq true);
+            assert_that!(id.has_missed_deadline(&tick_guard), eq false);
         })
         .unwrap();
 
@@ -256,7 +256,7 @@ mod waitset {
 
         let start = Instant::now();
         sut.run_once(|id| {
-            assert_that!(id.deadline_from(&guard), eq true);
+            assert_that!(id.has_missed_deadline(&guard), eq true);
         })
         .unwrap();
 
@@ -296,13 +296,13 @@ mod waitset {
         let mut receiver_2_triggered = false;
 
         sut.run_once(|attachment_id| {
-            if attachment_id.event_from(&listener_1_guard) {
+            if attachment_id.has_event_from(&listener_1_guard) {
                 listener_1_triggered = true;
-            } else if attachment_id.deadline_from(&listener_2_guard) {
+            } else if attachment_id.has_missed_deadline(&listener_2_guard) {
                 listener_2_triggered = true;
-            } else if attachment_id.event_from(&receiver_1_guard) {
+            } else if attachment_id.has_event_from(&receiver_1_guard) {
                 receiver_1_triggered = true;
-            } else if attachment_id.deadline_from(&receiver_2_guard) {
+            } else if attachment_id.has_missed_deadline(&receiver_2_guard) {
                 receiver_2_triggered = true;
             } else {
                 test_fail!("only attachments shall trigger");
@@ -336,13 +336,13 @@ mod waitset {
         let mut tick_4_triggered = false;
 
         sut.run_once(|attachment_id| {
-            if attachment_id.event_from(&tick_1_guard) {
+            if attachment_id.has_event_from(&tick_1_guard) {
                 tick_1_triggered = true;
-            } else if attachment_id.event_from(&tick_2_guard) {
+            } else if attachment_id.has_event_from(&tick_2_guard) {
                 tick_2_triggered = true;
-            } else if attachment_id.event_from(&tick_3_guard) {
+            } else if attachment_id.has_event_from(&tick_3_guard) {
                 tick_3_triggered = true;
-            } else if attachment_id.event_from(&tick_4_guard) {
+            } else if attachment_id.has_event_from(&tick_4_guard) {
                 tick_4_triggered = true;
             } else {
                 test_fail!("only attachments shall trigger");
@@ -393,21 +393,21 @@ mod waitset {
         let mut deadline_2_missed = false;
 
         sut.run_once(|attachment_id| {
-            if attachment_id.event_from(&tick_1_guard) {
+            if attachment_id.has_event_from(&tick_1_guard) {
                 tick_1_triggered = true;
-            } else if attachment_id.event_from(&tick_2_guard) {
+            } else if attachment_id.has_event_from(&tick_2_guard) {
                 tick_2_triggered = true;
-            } else if attachment_id.event_from(&notification_1_guard) {
+            } else if attachment_id.has_event_from(&notification_1_guard) {
                 notification_1_triggered = true;
-            } else if attachment_id.event_from(&notification_2_guard) {
+            } else if attachment_id.has_event_from(&notification_2_guard) {
                 notification_2_triggered = true;
-            } else if attachment_id.event_from(&deadline_1_guard) {
+            } else if attachment_id.has_event_from(&deadline_1_guard) {
                 deadline_1_triggered = true;
-            } else if attachment_id.event_from(&deadline_2_guard) {
+            } else if attachment_id.has_event_from(&deadline_2_guard) {
                 deadline_2_triggered = true;
-            } else if attachment_id.deadline_from(&deadline_1_guard) {
+            } else if attachment_id.has_missed_deadline(&deadline_1_guard) {
                 deadline_1_missed = true;
-            } else if attachment_id.deadline_from(&deadline_2_guard) {
+            } else if attachment_id.has_missed_deadline(&deadline_2_guard) {
                 deadline_2_missed = true;
             } else {
                 test_fail!("only attachments shall trigger");
@@ -445,9 +445,9 @@ mod waitset {
         let mut received_event = false;
 
         sut.run_once(|attachment_id| {
-            if attachment_id.event_from(&deadline_1_guard) {
+            if attachment_id.has_event_from(&deadline_1_guard) {
                 received_event = true;
-            } else if attachment_id.deadline_from(&deadline_1_guard) {
+            } else if attachment_id.has_missed_deadline(&deadline_1_guard) {
                 missed_deadline = true;
             } else {
                 test_fail!("only attachments shall trigger");