Struct Subscriber 

pub struct Subscriber<'domain, 'participant> { /* private fields */ }

A Subscriber groups Readers and controls their shared QoS. Readers created under a subscriber inherit its QoS where applicable.

Use Subscriber::new for simple construction or Subscriber::builder for QoS and listener configuration.

In most applications a subscriber is created implicitly when constructing a Reader directly. Use an explicit subscriber when you need coordinated reads across multiple readers.

Implementations

impl<'d, 'p> Subscriber<'d, 'p>

pub fn new(participant: &'p Participant<'d>) -> Result<Self>

Creates a new Subscriber under participant with default QoS and no listener.

Errors

Returns an Error if the subscriber fails to create.

Examples

use cyclonedds::Subscriber;

let subscriber = Subscriber::new(&participant)?;
Ok::<_, cyclonedds::Error>(())

pub const fn builder<'q>( participant: &'p Participant<'d>, ) -> SubscriberBuilder<'d, 'p, 'q>

Returns a SubscriberBuilder for constructing a subscriber with custom QoS or a listener.

Examples

use cyclonedds::{
    QoS, Subscriber,
    qos::policy::{Durability, Presentation},
};

let qos = QoS::new().with_presentation(Presentation::Topic {
    coherent_access: true,
    ordered_access: true,
});
let subscriber = Subscriber::builder(&participant).with_qos(&qos).build()?;
Ok::<_, cyclonedds::Error>(())

pub fn notify_readers(&self) -> Result<()>

(WARN: unimplemented in C lib): Notifies all readers belonging to this subscriber that data is available.

This function is currently not implemented by the underlying C library and will thus always return an unsupported error.

Triggers the DataOnReaders callback on the subscriber’s listener and the DataAvailable callback on each reader’s listener.

Errors

Returns an Error if the subscriber fails to notify the readers.

Examples

use cyclonedds::Subscriber;

let subscriber = Subscriber::new(&participant)?;
subscriber.notify_readers()?;

pub fn set_listener<L>(&mut self, listener: L) -> Result<()>

where L: AsRef<SubscriberListener>,

Sets the SubscriberListener on this subscriber, replacing any previously set listener.

Errors

Returns an Error if the subscriber fails to set the listener.

Examples

use cyclonedds::SubscriberListener;

let mut subscriber = Subscriber::new(&participant)?;
subscriber.set_listener(SubscriberListener::new())?;

pub fn unset_listener(&mut self) -> Result<()>

Removes the listener from this subscriber.

Errors

Returns an Error if the subscriber fails to unset the listener.

Examples

let mut subscriber = Subscriber::new(&participant)?;
subscriber.unset_listener()?;

pub fn with_listener<L>(self, listener: L) -> Result<Self>

where L: AsRef<SubscriberListener>,

Sets the SubscriberListener on this subscriber, consuming and returning self.

Errors

Returns an Error if the subscriber fails to set the listener.

Examples

use cyclonedds::SubscriberListener;

let subscriber = Subscriber::new(&participant)?.with_listener(SubscriberListener::new())?;

Trait Implementations

impl<'domain, 'participant> Debug for Subscriber<'domain, 'participant>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Subscriber<'_, '_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Entity for Subscriber<'_, '_>

fn id(&self) -> EntityId

Returns the EntityId of this entity.

fn instance_handle(&self) -> Result<InstanceHandle>

Returns the InstanceHandle of this entity.

fn status_changes(&self) -> Result<Status>

Returns the set of status flags that have changed since they were last read or taken.

fn take_status(&self, mask: Option<Status>) -> Result<Status>

Takes and clears the status flags matching mask, or all flags if mask is None.

fn read_status(&self, mask: Option<Status>) -> Result<Status>

Reads the status flags matching mask without clearing them, or all flags if mask is None.

fn status_mask(&self) -> Result<Status>

Returns the status mask enabled on the entity.

fn set_status_mask(&self, mask: Status) -> Result<()>

Sets and enables a status mask on the entity.