feat: use builder method instead of handler type for undeclaration on…

… drop (#1377) * refactor: add comment for `Session` and `Session::close` * Update zenoh/src/api/session.rs Co-authored-by: Luca Cominardi <[email protected]> * Update zenoh/src/api/session.rs Co-authored-by: Luca Cominardi <[email protected]> * Update zenoh/src/api/session.rs Co-authored-by: Luca Cominardi <[email protected]> * fix: don't run `Session::close` example * fix: fix `Session` example * fix: fix `Session` doc * feat: use builder method instead of handler type for undeclaration on drop --------- Co-authored-by: Luca Cominardi <[email protected]>
eclipse-zenoh · Sep 9, 2024 · 2febb76 · 2febb76
1 parent 8f15a04
commit 2febb76
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 11 deletions.
diff --git a/zenoh/src/api/liveliness.rs b/zenoh/src/api/liveliness.rs
@@ -15,7 +15,6 @@
 use std::{
     convert::TryInto,
     future::{IntoFuture, Ready},
-    mem::size_of,
     sync::Arc,
     time::Duration,
 };
@@ -172,6 +171,7 @@ impl<'a> Liveliness<'a> {
             session: self.session,
             key_expr: TryIntoKeyExpr::try_into(key_expr).map_err(Into::into),
             handler: DefaultHandler::default(),
+            undeclare_on_drop: true,
         }
     }
 
@@ -435,6 +435,7 @@ pub struct LivelinessSubscriberBuilder<'a, 'b, Handler> {
     pub session: &'a Session,
     pub key_expr: ZResult<KeyExpr<'b>>,
     pub handler: Handler,
+    pub undeclare_on_drop: bool,
 }
 
 #[zenoh_macros::unstable]
@@ -469,11 +470,13 @@ impl<'a, 'b> LivelinessSubscriberBuilder<'a, 'b, DefaultHandler> {
             session,
             key_expr,
             handler: _,
+            undeclare_on_drop: _,
         } = self;
         LivelinessSubscriberBuilder {
             session,
             key_expr,
             handler: callback,
+            undeclare_on_drop: false,
         }
     }
 
@@ -540,11 +543,13 @@ impl<'a, 'b> LivelinessSubscriberBuilder<'a, 'b, DefaultHandler> {
             session,
             key_expr,
             handler: _,
+            undeclare_on_drop: _,
         } = self;
         LivelinessSubscriberBuilder {
             session,
             key_expr,
             handler,
+            undeclare_on_drop: true,
         }
     }
 }
@@ -581,8 +586,7 @@ where
                     session: self.session.downgrade(),
                     state: sub_state,
                     kind: SubscriberKind::LivelinessSubscriber,
-                    // `size_of::<Handler::Handler>() == 0` means callback-only subscriber
-                    undeclare_on_drop: size_of::<Handler::Handler>() > 0,
+                    undeclare_on_drop: self.undeclare_on_drop,
                 },
                 handler,
             })

diff --git a/zenoh/src/api/publisher.rs b/zenoh/src/api/publisher.rs
@@ -284,6 +284,7 @@ impl<'a> Publisher<'a> {
         MatchingListenerBuilder {
             publisher: self,
             handler: DefaultHandler::default(),
+            undeclare_on_drop: true,
         }
     }
 
@@ -639,6 +640,7 @@ impl MatchingStatus {
 pub struct MatchingListenerBuilder<'a, 'b, Handler> {
     pub(crate) publisher: &'a Publisher<'b>,
     pub handler: Handler,
+    pub undeclare_on_drop: bool,
 }
 
 #[zenoh_macros::unstable]
@@ -675,10 +677,12 @@ impl<'a, 'b> MatchingListenerBuilder<'a, 'b, DefaultHandler> {
         let MatchingListenerBuilder {
             publisher,
             handler: _,
+            undeclare_on_drop: _,
         } = self;
         MatchingListenerBuilder {
             publisher,
             handler: callback,
+            undeclare_on_drop: false,
         }
     }
 
@@ -745,8 +749,13 @@ impl<'a, 'b> MatchingListenerBuilder<'a, 'b, DefaultHandler> {
         let MatchingListenerBuilder {
             publisher,
             handler: _,
+            undeclare_on_drop: _,
         } = self;
-        MatchingListenerBuilder { publisher, handler }
+        MatchingListenerBuilder {
+            publisher,
+            handler,
+            undeclare_on_drop: true,
+        }
     }
 }
 
@@ -777,7 +786,7 @@ where
             inner: MatchingListenerInner {
                 publisher: self.publisher.clone(),
                 state,
-                undeclare_on_drop: size_of::<Handler::Handler>() > 0,
+                undeclare_on_drop: self.undeclare_on_drop,
             },
             handler,
         })

diff --git a/zenoh/src/api/queryable.rs b/zenoh/src/api/queryable.rs
@@ -14,7 +14,6 @@
 use std::{
     fmt,
     future::{IntoFuture, Ready},
-    mem::size_of,
     ops::{Deref, DerefMut},
     sync::Arc,
 };
@@ -604,6 +603,7 @@ pub struct QueryableBuilder<'a, 'b, Handler> {
     pub(crate) complete: bool,
     pub(crate) origin: Locality,
     pub(crate) handler: Handler,
+    pub(crate) undeclare_on_drop: bool,
 }
 
 impl<'a, 'b> QueryableBuilder<'a, 'b, DefaultHandler> {
@@ -634,13 +634,15 @@ impl<'a, 'b> QueryableBuilder<'a, 'b, DefaultHandler> {
             complete,
             origin,
             handler: _,
+            undeclare_on_drop: _,
         } = self;
         QueryableBuilder {
             session,
             key_expr,
             complete,
             origin,
             handler: callback,
+            undeclare_on_drop: false,
         }
     }
 
@@ -705,13 +707,15 @@ impl<'a, 'b> QueryableBuilder<'a, 'b, DefaultHandler> {
             complete,
             origin,
             handler: _,
+            undeclare_on_drop: _,
         } = self;
         QueryableBuilder {
             session,
             key_expr,
             complete,
             origin,
             handler,
+            undeclare_on_drop: true,
         }
     }
 
@@ -927,8 +931,7 @@ where
                     session_id: session.zid(),
                     session: self.session.downgrade(),
                     state: qable_state,
-                    // `size_of::<Handler::Handler>() == 0` means callback-only queryable
-                    undeclare_on_drop: size_of::<Handler::Handler>() > 0,
+                    undeclare_on_drop: self.undeclare_on_drop,
                 },
                 handler: receiver,
             })

diff --git a/zenoh/src/api/session.rs b/zenoh/src/api/session.rs
@@ -740,6 +740,7 @@ impl Session {
             reliability: Reliability::DEFAULT,
             origin: Locality::default(),
             handler: DefaultHandler::default(),
+            undeclare_on_drop: true,
         }
     }
 
@@ -784,6 +785,7 @@ impl Session {
             complete: false,
             origin: Locality::default(),
             handler: DefaultHandler::default(),
+            undeclare_on_drop: true,
         }
     }
 

diff --git a/zenoh/src/api/subscriber.rs b/zenoh/src/api/subscriber.rs
@@ -15,7 +15,6 @@
 use std::{
     fmt,
     future::{IntoFuture, Ready},
-    mem::size_of,
     ops::{Deref, DerefMut},
     sync::Arc,
 };
@@ -150,6 +149,11 @@ pub struct SubscriberBuilder<'a, 'b, Handler> {
     pub handler: Handler,
     #[cfg(not(feature = "unstable"))]
     pub(crate) handler: Handler,
+
+    #[cfg(feature = "unstable")]
+    pub undeclare_on_drop: bool,
+    #[cfg(not(feature = "unstable"))]
+    pub(crate) undeclare_on_drop: bool,
 }
 
 impl<'a, 'b> SubscriberBuilder<'a, 'b, DefaultHandler> {
@@ -181,6 +185,7 @@ impl<'a, 'b> SubscriberBuilder<'a, 'b, DefaultHandler> {
             reliability,
             origin,
             handler: _,
+            undeclare_on_drop: _,
         } = self;
         SubscriberBuilder {
             session,
@@ -189,6 +194,7 @@ impl<'a, 'b> SubscriberBuilder<'a, 'b, DefaultHandler> {
             reliability,
             origin,
             handler: callback,
+            undeclare_on_drop: false,
         }
     }
 
@@ -254,6 +260,7 @@ impl<'a, 'b> SubscriberBuilder<'a, 'b, DefaultHandler> {
             reliability,
             origin,
             handler: _,
+            undeclare_on_drop: _,
         } = self;
         SubscriberBuilder {
             session,
@@ -262,6 +269,7 @@ impl<'a, 'b> SubscriberBuilder<'a, 'b, DefaultHandler> {
             reliability,
             origin,
             handler,
+            undeclare_on_drop: true,
         }
     }
 }
@@ -339,8 +347,7 @@ where
                     session: session.downgrade(),
                     state: sub_state,
                     kind: SubscriberKind::Subscriber,
-                    // `size_of::<Handler::Handler>() == 0` means callback-only subscriber
-                    undeclare_on_drop: size_of::<Handler::Handler>() > 0,
+                    undeclare_on_drop: self.undeclare_on_drop,
                 },
                 handler: receiver,
             })