Struct AdvancedPublisher

pub struct AdvancedPublisher<'a> { /* private fields */ }

AdvancedPublisher.

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

Implementations

impl<'a> AdvancedPublisher<'a>

pub fn id(&self) -> EntityGlobalId

Returns the EntityGlobalId of this Publisher.

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<'a>

Returns the KeyExpr of this Publisher.

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

pub fn encoding(&self) -> &Encoding

Get the Encoding used when publishing data.

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

pub fn congestion_control(&self) -> CongestionControl

Get the congestion_control applied when routing the data.

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

pub fn priority(&self) -> Priority

Get the priority of the written data.

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

pub fn put<IntoZBytes>( &self, payload: IntoZBytes, ) -> AdvancedPublisherPutBuilder<'_>

where IntoZBytes: Into<ZBytes>,

Put data.

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

Examples

use zenoh_ext::AdvancedPublisherBuilderExt;

let session = zenoh::open(zenoh::Config::default()).await.unwrap();
let publisher = session.declare_publisher("key/expression").advanced().await.unwrap();
publisher.put("value").await.unwrap();

pub fn delete(&self) -> AdvancedPublisherDeleteBuilder<'_>

Delete data.

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

Examples

use zenoh_ext::AdvancedPublisherBuilderExt;

let session = zenoh::open(zenoh::Config::default()).await.unwrap();
let publisher = session.declare_publisher("key/expression").advanced().await.unwrap();
publisher.delete().await.unwrap();

pub fn matching_status(&self) -> impl Resolve<ZResult<MatchingStatus>> + '_

Return the MatchingStatus of the publisher.

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

MatchingStatus::matching will return true if there exist Subscribers matching the Publisher’s key expression and false otherwise.

Examples

use zenoh_ext::AdvancedPublisherBuilderExt;

let session = zenoh::open(zenoh::Config::default()).await.unwrap();
let publisher = session.declare_publisher("key/expression").advanced().await.unwrap();
let matching_subscribers: bool = publisher
    .matching_status()
    .await
    .unwrap()
    .matching();

pub fn matching_listener(&self) -> MatchingListenerBuilder<'_, DefaultHandler>

Return a MatchingListener for this Publisher.

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

The MatchingListener that will send a notification each time the MatchingStatus of the Publisher changes.

Examples

use zenoh_ext::AdvancedPublisherBuilderExt;

let session = zenoh::open(zenoh::Config::default()).await.unwrap();
let publisher = session.declare_publisher("key/expression").advanced().await.unwrap();
let matching_listener = publisher.matching_listener().await.unwrap();
while let Ok(matching_status) = matching_listener.recv_async().await {
    if matching_status.matching() {
        println!("Publisher has matching subscribers.");
    } else {
        println!("Publisher has NO MORE matching subscribers.");
    }
}

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

Undeclares the Publisher, informing the network that it needn’t optimize publications for its key expression anymore.

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

Examples

use zenoh_ext::AdvancedPublisherBuilderExt;

let session = zenoh::open(zenoh::Config::default()).await.unwrap();
let publisher = session.declare_publisher("key/expression").advanced().await.unwrap();
publisher.undeclare().await.unwrap();