Struct AdvancedPublisherBuilder

pub struct AdvancedPublisherBuilder<'a, 'b, 'c> { /* private fields */ }

The builder of PublicationCache, allowing to configure it.

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

Implementations

impl<'a, 'b, 'c> AdvancedPublisherBuilder<'a, 'b, 'c>

pub fn allowed_destination(self, destination: Locality) -> Self

Changes the zenoh::sample::Locality 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.

This restricts the matching subscribers that will receive the published data to the ones that have the given zenoh::sample::Locality.

pub fn reliability(self, reliability: Reliability) -> Self

Changes the zenoh::qos::Reliability to apply when routing the data.

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

NOTE: Currently reliability does not trigger any data retransmission on the wire. It is rather used as a marker on the wire and it may be used to select the best link available (e.g. TCP for reliable data and UDP for best effort data).

pub fn sample_miss_detection(self, config: MissDetectionConfig) -> Self

Allow matching AdvancedSubscribers to detect lost samples and optionally ask for retransimission.

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

Retransmission can only be achieved if cache is enabled.

pub fn cache(self, config: CacheConfig) -> Self

Attach a cache to this AdvancedPublisher.

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

The cache can be used for history and/or recovery.

pub fn publisher_detection(self) -> Self

Allow this AdvancedPublisher to be detected by AdvancedSubscribers.

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

This allows AdvancedSubscribers to retrieve the local history.

pub fn publisher_detection_metadata<TryIntoKeyExpr>( self, meta: TryIntoKeyExpr, ) -> Self

where TryIntoKeyExpr: TryInto<KeyExpr<'c>>, <TryIntoKeyExpr as TryInto<KeyExpr<'c>>>::Error: Into<Error>,

A key expression added to the liveliness token key expression

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

and to the cache queryable key expression. It can be used to convey meta data.

impl AdvancedPublisherBuilder<'_, '_, '_>

pub fn encoding<T: Into<Encoding>>(self, encoding: T) -> Self

impl AdvancedPublisherBuilder<'_, '_, '_>

pub fn congestion_control(self, congestion_control: CongestionControl) -> Self

Changes the zenoh::qos::CongestionControl to apply 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: Priority) -> Self

Changes the zenoh::qos::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 express(self, is_express: bool) -> Self

Changes the Express policy to apply when routing the data.

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

When express is set to true, then the message will not be batched. This usually has a positive impact on latency but negative impact on throughput.

Trait Implementations

impl EncodingBuilderTrait for AdvancedPublisherBuilder<'_, '_, '_>

fn encoding<T: Into<Encoding>>(self, encoding: T) -> Self

Set the Encoding

impl IntoFuture for AdvancedPublisherBuilder<'_, '_, '_>

type Output = <AdvancedPublisherBuilder<'_, '_, '_> as Resolvable>::To

The output that the future will produce on completion.

type IntoFuture = Ready<<AdvancedPublisherBuilder<'_, '_, '_> as Resolvable>::To>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl QoSBuilderTrait for AdvancedPublisherBuilder<'_, '_, '_>

fn congestion_control(self, congestion_control: CongestionControl) -> Self

Changes the zenoh::qos::CongestionControl to apply when routing the data.

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

fn priority(self, priority: Priority) -> Self

Changes the zenoh::qos::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.

fn express(self, is_express: bool) -> Self

Changes the Express policy to apply when routing the data.

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

When express is set to true, then the message will not be batched. This usually has a positive impact on latency but negative impact on throughput.

impl<'b> Resolvable for AdvancedPublisherBuilder<'_, 'b, '_>

type To = Result<AdvancedPublisher<'b>, Box<dyn Error + Send + Sync>>

impl Wait for AdvancedPublisherBuilder<'_, '_, '_>

fn wait(self) -> <Self as Resolvable>::To

Synchronously execute and wait