feat!: make session an arc-like object

The refactoring is quite deep, so this is the first (dirty) iteration which passes the tests.
eclipse-zenoh · Sep 3, 2024 · 4b541f8 · 4b541f8
1 parent 3043977
commit 4b541f8
Show file tree

Hide file tree

Showing 38 changed files with 642 additions and 1,141 deletions.
diff --git a/examples/examples/z_forward.rs b/examples/examples/z_forward.rs
@@ -12,7 +12,7 @@
 //   ZettaScale Zenoh Team, <[email protected]>
 //
 use clap::Parser;
-use zenoh::{key_expr::KeyExpr, prelude::*, Config};
+use zenoh::{key_expr::KeyExpr, Config};
 use zenoh_examples::CommonArgs;
 use zenoh_ext::SubscriberForward;
 

diff --git a/examples/examples/z_get_liveliness.rs b/examples/examples/z_get_liveliness.rs
@@ -14,7 +14,7 @@
 use std::time::Duration;
 
 use clap::Parser;
-use zenoh::{key_expr::KeyExpr, prelude::*, Config};
+use zenoh::{key_expr::KeyExpr, Config};
 use zenoh_examples::CommonArgs;
 
 #[tokio::main]

diff --git a/examples/examples/z_info.rs b/examples/examples/z_info.rs
@@ -12,7 +12,7 @@
 //   ZettaScale Zenoh Team, <[email protected]>
 //
 use clap::Parser;
-use zenoh::{prelude::*, session::ZenohId};
+use zenoh::session::ZenohId;
 use zenoh_examples::CommonArgs;
 
 #[tokio::main]

diff --git a/examples/examples/z_liveliness.rs b/examples/examples/z_liveliness.rs
@@ -12,7 +12,7 @@
 //   ZettaScale Zenoh Team, <[email protected]>
 //
 use clap::Parser;
-use zenoh::{key_expr::KeyExpr, prelude::*, Config};
+use zenoh::{key_expr::KeyExpr, Config};
 use zenoh_examples::CommonArgs;
 
 #[tokio::main]

diff --git a/examples/examples/z_pong.rs b/examples/examples/z_pong.rs
@@ -21,7 +21,7 @@ fn main() {
 
     let (config, express) = parse_args();
 
-    let session = zenoh::open(config).wait().unwrap().into_arc();
+    let session = zenoh::open(config).wait().unwrap();
 
     // The key expression to read the data from
     let key_expr_ping = keyexpr::new("test/ping").unwrap();

diff --git a/examples/examples/z_pull.rs b/examples/examples/z_pull.rs
@@ -14,7 +14,7 @@
 use std::time::Duration;
 
 use clap::Parser;
-use zenoh::{handlers::RingChannel, key_expr::KeyExpr, prelude::*, Config};
+use zenoh::{handlers::RingChannel, key_expr::KeyExpr, Config};
 use zenoh_examples::CommonArgs;
 
 #[tokio::main]

diff --git a/examples/examples/z_queryable.rs b/examples/examples/z_queryable.rs
@@ -12,7 +12,7 @@
 //   ZettaScale Zenoh Team, <[email protected]>
 //
 use clap::Parser;
-use zenoh::{key_expr::KeyExpr, prelude::*, Config};
+use zenoh::{key_expr::KeyExpr, Config};
 use zenoh_examples::CommonArgs;
 
 #[tokio::main]

diff --git a/examples/examples/z_queryable_shm.rs b/examples/examples/z_queryable_shm.rs
@@ -15,7 +15,6 @@ use clap::Parser;
 use zenoh::{
     bytes::ZBytes,
     key_expr::KeyExpr,
-    prelude::*,
     shm::{
         zshm, BlockOn, GarbageCollect, PosixShmProviderBackend, ShmProviderBuilder,
         POSIX_PROTOCOL_ID,

diff --git a/examples/examples/z_storage.rs b/examples/examples/z_storage.rs
@@ -19,7 +19,6 @@ use clap::Parser;
 use futures::select;
 use zenoh::{
     key_expr::{keyexpr, KeyExpr},
-    prelude::*,
     sample::{Sample, SampleKind},
     Config,
 };

diff --git a/examples/examples/z_sub.rs b/examples/examples/z_sub.rs
@@ -12,7 +12,7 @@
 //   ZettaScale Zenoh Team, <[email protected]>
 //
 use clap::Parser;
-use zenoh::{key_expr::KeyExpr, prelude::*, Config};
+use zenoh::{key_expr::KeyExpr, Config};
 use zenoh_examples::CommonArgs;
 
 #[tokio::main]

diff --git a/examples/examples/z_sub_liveliness.rs b/examples/examples/z_sub_liveliness.rs
@@ -12,7 +12,7 @@
 //   ZettaScale Zenoh Team, <[email protected]>
 //
 use clap::Parser;
-use zenoh::{key_expr::KeyExpr, prelude::*, sample::SampleKind, Config};
+use zenoh::{key_expr::KeyExpr, sample::SampleKind, Config};
 use zenoh_examples::CommonArgs;
 
 #[tokio::main]

diff --git a/examples/examples/z_sub_shm.rs b/examples/examples/z_sub_shm.rs
@@ -14,7 +14,7 @@
 use clap::Parser;
 #[cfg(all(feature = "shared-memory", feature = "unstable"))]
 use zenoh::shm::zshm;
-use zenoh::{bytes::ZBytes, config::Config, key_expr::KeyExpr, prelude::*};
+use zenoh::{bytes::ZBytes, config::Config, key_expr::KeyExpr};
 use zenoh_examples::CommonArgs;
 
 #[tokio::main]

diff --git a/plugins/zenoh-plugin-example/src/lib.rs b/plugins/zenoh-plugin-example/src/lib.rs
@@ -36,7 +36,6 @@ use zenoh::{
     key_expr::{keyexpr, KeyExpr},
     prelude::ZResult,
     sample::Sample,
-    session::SessionDeclarations,
 };
 use zenoh_plugin_trait::{plugin_long_version, plugin_version, Plugin, PluginControl};
 

diff --git a/plugins/zenoh-plugin-rest/examples/z_serve_sse.rs b/plugins/zenoh-plugin-rest/examples/z_serve_sse.rs
@@ -18,7 +18,6 @@ use zenoh::{
     config::Config,
     key_expr::keyexpr,
     qos::{CongestionControl, QoSBuilderTrait},
-    session::SessionDeclarations,
 };
 
 const HTML: &str = r#"

diff --git a/plugins/zenoh-plugin-rest/src/lib.rs b/plugins/zenoh-plugin-rest/src/lib.rs
@@ -47,7 +47,7 @@ use zenoh::{
     prelude::*,
     query::{Parameters, QueryConsolidation, Reply, Selector, ZenohParameters},
     sample::{Sample, SampleKind},
-    session::{Session, SessionDeclarations},
+    session::Session,
 };
 use zenoh_plugin_trait::{plugin_long_version, plugin_version, Plugin, PluginControl};
 

diff --git a/plugins/zenoh-plugin-storage-manager/src/replica/mod.rs b/plugins/zenoh-plugin-storage-manager/src/replica/mod.rs
@@ -24,7 +24,7 @@ use std::{
 use flume::{Receiver, Sender};
 use futures::{pin_mut, select, FutureExt};
 use tokio::{sync::RwLock, time::interval};
-use zenoh::{key_expr::keyexpr, prelude::*};
+use zenoh::key_expr::keyexpr;
 use zenoh_backend_traits::config::{ReplicaConfig, StorageConfig};
 
 use crate::{backends_mgt::StoreIntercept, storages_mgt::StorageMessage};

diff --git a/plugins/zenoh-plugin-storage-manager/src/replica/storage.rs b/plugins/zenoh-plugin-storage-manager/src/replica/storage.rs
@@ -37,7 +37,7 @@ use zenoh::{
     },
     query::{ConsolidationMode, QueryTarget},
     sample::{Sample, SampleBuilder, SampleKind, TimestampBuilderTrait},
-    session::{Session, SessionDeclarations},
+    session::Session,
     time::{Timestamp, NTP64},
     Result as ZResult,
 };

diff --git a/zenoh-ext/examples/examples/z_query_sub.rs b/zenoh-ext/examples/examples/z_query_sub.rs
@@ -12,7 +12,7 @@
 //   ZettaScale Zenoh Team, <[email protected]>
 //
 use clap::{arg, Parser};
-use zenoh::{config::Config, prelude::*, query::ReplyKeyExpr};
+use zenoh::{config::Config, query::ReplyKeyExpr};
 use zenoh_ext::*;
 use zenoh_ext_examples::CommonArgs;
 

diff --git a/zenoh-ext/src/publication_cache.rs b/zenoh-ext/src/publication_cache.rs
@@ -25,14 +25,13 @@ use zenoh::{
     pubsub::FlumeSubscriber,
     query::{Query, Queryable, ZenohParameters},
     sample::{Locality, Sample},
-    session::{SessionDeclarations, SessionRef},
-    Error, Resolvable, Resolve, Result as ZResult,
+    Error, Resolvable, Resolve, Result as ZResult, Session,
 };
 
 /// The builder of PublicationCache, allowing to configure it.
 #[must_use = "Resolvables do nothing unless you resolve them using the `res` method from either `SyncResolve` or `AsyncResolve`"]
 pub struct PublicationCacheBuilder<'a, 'b, 'c> {
-    session: SessionRef<'a>,
+    session: &'a Session,
     pub_key_expr: ZResult<KeyExpr<'b>>,
     queryable_prefix: Option<ZResult<KeyExpr<'c>>>,
     queryable_origin: Option<Locality>,
@@ -43,7 +42,7 @@ pub struct PublicationCacheBuilder<'a, 'b, 'c> {
 
 impl<'a, 'b, 'c> PublicationCacheBuilder<'a, 'b, 'c> {
     pub(crate) fn new(
-        session: SessionRef<'a>,
+        session: &'a Session,
         pub_key_expr: ZResult<KeyExpr<'b>>,
     ) -> PublicationCacheBuilder<'a, 'b, 'c> {
         PublicationCacheBuilder {
@@ -95,8 +94,8 @@ impl<'a, 'b, 'c> PublicationCacheBuilder<'a, 'b, 'c> {
     }
 }
 
-impl<'a> Resolvable for PublicationCacheBuilder<'a, '_, '_> {
-    type To = ZResult<PublicationCache<'a>>;
+impl Resolvable for PublicationCacheBuilder<'_, '_, '_> {
+    type To = ZResult<PublicationCache>;
 }
 
 impl Wait for PublicationCacheBuilder<'_, '_, '_> {
@@ -105,7 +104,7 @@ impl Wait for PublicationCacheBuilder<'_, '_, '_> {
     }
 }
 
-impl<'a> IntoFuture for PublicationCacheBuilder<'a, '_, '_> {
+impl IntoFuture for PublicationCacheBuilder<'_, '_, '_> {
     type Output = <Self as Resolvable>::To;
     type IntoFuture = Ready<<Self as Resolvable>::To>;
 
@@ -114,14 +113,14 @@ impl<'a> IntoFuture for PublicationCacheBuilder<'a, '_, '_> {
     }
 }
 
-pub struct PublicationCache<'a> {
-    local_sub: FlumeSubscriber<'a>,
-    _queryable: Queryable<'a, flume::Receiver<Query>>,
+pub struct PublicationCache {
+    local_sub: FlumeSubscriber,
+    _queryable: Queryable<flume::Receiver<Query>>,
     task: TerminatableTask,
 }
 
-impl<'a> PublicationCache<'a> {
-    fn new(conf: PublicationCacheBuilder<'a, '_, '_>) -> ZResult<PublicationCache<'a>> {
+impl PublicationCache {
+    fn new(conf: PublicationCacheBuilder<'_, '_, '_>) -> ZResult<PublicationCache> {
         let key_expr = conf.pub_key_expr?;
         // the queryable_prefix (optional), and the key_expr for PublicationCache's queryable ("[<queryable_prefix>]/<pub_key_expr>")
         let (queryable_prefix, queryable_key_expr): (Option<OwnedKeyExpr>, KeyExpr) =
@@ -258,7 +257,7 @@ impl<'a> PublicationCache<'a> {
 
     /// Undeclare this [`PublicationCache`]`.
     #[inline]
-    pub fn undeclare(self) -> impl Resolve<ZResult<()>> + 'a {
+    pub fn undeclare(self) -> impl Resolve<ZResult<()>> {
         ResolveFuture::new(async move {
             let PublicationCache {
                 _queryable,

diff --git a/zenoh-ext/src/querying_subscriber.rs b/zenoh-ext/src/querying_subscriber.rs
@@ -28,17 +28,16 @@ use zenoh::{
     pubsub::{Reliability, Subscriber},
     query::{QueryConsolidation, QueryTarget, ReplyKeyExpr, Selector},
     sample::{Locality, Sample, SampleBuilder, TimestampBuilderTrait},
-    session::{SessionDeclarations, SessionRef},
     time::Timestamp,
-    Error, Resolvable, Resolve, Result as ZResult,
+    Error, Resolvable, Resolve, Result as ZResult, Session,
 };
 
 use crate::ExtractSample;
 
 /// The builder of [`FetchingSubscriber`], allowing to configure it.
 #[must_use = "Resolvables do nothing unless you resolve them using the `res` method from either `SyncResolve` or `AsyncResolve`"]
 pub struct QueryingSubscriberBuilder<'a, 'b, KeySpace, Handler> {
-    pub(crate) session: SessionRef<'a>,
+    pub(crate) session: &'a Session,
     pub(crate) key_expr: ZResult<KeyExpr<'b>>,
     pub(crate) key_space: KeySpace,
     pub(crate) reliability: Reliability,
@@ -224,7 +223,7 @@ where
     Handler: IntoHandler<'static, Sample>,
     Handler::Handler: Send,
 {
-    type To = ZResult<FetchingSubscriber<'a, Handler::Handler>>;
+    type To = ZResult<FetchingSubscriber<Handler::Handler>>;
 }
 
 impl<KeySpace, Handler> Wait for QueryingSubscriberBuilder<'_, '_, KeySpace, Handler>
@@ -362,7 +361,7 @@ pub struct FetchingSubscriberBuilder<
 > where
     TryIntoSample: ExtractSample,
 {
-    pub(crate) session: SessionRef<'a>,
+    pub(crate) session: &'a Session,
     pub(crate) key_expr: ZResult<KeyExpr<'b>>,
     pub(crate) key_space: KeySpace,
     pub(crate) reliability: Reliability,
@@ -548,7 +547,7 @@ where
     Handler::Handler: Send,
     TryIntoSample: ExtractSample,
 {
-    type To = ZResult<FetchingSubscriber<'a, Handler::Handler>>;
+    type To = ZResult<FetchingSubscriber<Handler::Handler>>;
 }
 
 impl<
@@ -620,28 +619,29 @@ where
 /// }
 /// # }
 /// ```
-pub struct FetchingSubscriber<'a, Handler> {
-    subscriber: Subscriber<'a, ()>,
+pub struct FetchingSubscriber<Handler> {
+    subscriber: Subscriber<()>,
     callback: Arc<dyn Fn(Sample) + Send + Sync + 'static>,
     state: Arc<Mutex<InnerState>>,
     handler: Handler,
 }
 
-impl<Handler> std::ops::Deref for FetchingSubscriber<'_, Handler> {
+impl<Handler> std::ops::Deref for FetchingSubscriber<Handler> {
     type Target = Handler;
     fn deref(&self) -> &Self::Target {
         &self.handler
     }
 }
 
-impl<Handler> std::ops::DerefMut for FetchingSubscriber<'_, Handler> {
+impl<Handler> std::ops::DerefMut for FetchingSubscriber<Handler> {
     fn deref_mut(&mut self) -> &mut Self::Target {
         &mut self.handler
     }
 }
 
-impl<'a, Handler> FetchingSubscriber<'a, Handler> {
+impl<Handler> FetchingSubscriber<Handler> {
     fn new<
+        'a,
         KeySpace,
         InputHandler,
         Fetch: FnOnce(Box<dyn Fn(TryIntoSample) + Send + Sync>) -> ZResult<()> + Send + Sync,
@@ -724,7 +724,7 @@ impl<'a, Handler> FetchingSubscriber<'a, Handler> {
 
     /// Undeclare this [`FetchingSubscriber`]`.
     #[inline]
-    pub fn undeclare(self) -> impl Resolve<ZResult<()>> + 'a {
+    pub fn undeclare(self) -> impl Resolve<ZResult<()>> {
         self.subscriber.undeclare()
     }