Struct AdvancedSubscriber 

pub struct AdvancedSubscriber<Receiver> { /* private fields */ }

The extension to Subscriber that provides advanced functionalities

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

The AdvancedSubscriber is constructed over a regular Subscriber through advanced method or by using any other method of AdvancedSubscriberBuilder.

The AdvancedSubscriber works with AdvancedPublisher to provide additional functionalities such as:

• missing samples detection using periodic queries or heartbeat subscription configurable with recovery method
• recovering missing samples, configured with history method (max age and sample count, late joiner detection and requesting)
• liveliness-based subscriber detection with subscriber_detection method

Examples

use zenoh_ext::{AdvancedSubscriberBuilderExt, HistoryConfig, RecoveryConfig};
let session = zenoh::open(zenoh::Config::default()).await.unwrap();
let subscriber = session
    .declare_subscriber("key/expression")
    .history(HistoryConfig::default().detect_late_publishers())
    .recovery(RecoveryConfig::default().heartbeat())
    .subscriber_detection()
    .await
    .unwrap();
let miss_listener = subscriber.sample_miss_listener().await.unwrap();
loop {
    tokio::select! {
        sample = subscriber.recv_async() => {
            if let Ok(sample) = sample {
                // ...
            }
        },
        miss = miss_listener.recv_async() => {
            if let Ok(miss) = miss {
                // ...
            }
        },
    }
}

Implementations

impl<Handler> AdvancedSubscriber<Handler>

pub fn id(&self) -> EntityGlobalId

Returns the EntityGlobalId of this AdvancedSubscriber.

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

pub fn key_expr(&self) -> &KeyExpr<'static>

Returns the KeyExpr this subscriber subscribes to.

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

pub fn handler(&self) -> &Handler

Returns a reference to this subscriber’s handler.

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

An handler is anything that implements [`zenoh::handlers::IntoHandler`]. The default handler is [`zenoh::handlers::DefaultHandler`].

pub fn handler_mut(&mut self) -> &mut Handler

Returns a mutable reference to this subscriber’s handler.

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

An handler is anything that implements [`zenoh::handlers::IntoHandler`]. The default handler is [`zenoh::handlers::DefaultHandler`].

pub fn sample_miss_listener( &self, ) -> SampleMissListenerBuilder<'_, DefaultHandler>

Declares a listener to detect missed samples.

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

Missed samples can only be detected from AdvancedPublisher that enable sample_miss_detection.

pub fn detect_publishers( &self, ) -> LivelinessSubscriberBuilder<'_, '_, DefaultHandler>

Declares a listener to detect matching publishers.

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

Only AdvancedPublisher that enable publisher_detection can be detected.

pub fn undeclare(self) -> impl Resolve<ZResult<()>>

Undeclares this AdvancedSubscriber

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

Trait Implementations

impl<Receiver> Deref for AdvancedSubscriber<Receiver>

Available on crate feature unstable only.

type Target = Receiver

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<Receiver> DerefMut for AdvancedSubscriber<Receiver>

Available on crate feature unstable only.

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.