Struct Participant 

pub struct Participant<'domain> { /* private fields */ }

A domain participant.

A participant is the entry point for all DDS communication within a Domain. All other entities, including topics, readers, writers, publishers, and subscribers, are created under a participant and are scoped to its lifetime.

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

Implementations

impl<'d> Participant<'d>

pub fn new(domain: &'d Domain) -> Result<Self>

Creates a new participant in the given Domain with default QoS and no listener.

Errors

Returns an Error if the participant fails to create.

Examples

use cyclonedds::{Domain, Participant};

let domain = Domain::default();
let participant = Participant::new(&domain)?;

pub const fn builder<'q>(domain: &'d Domain) -> ParticipantBuilder<'d, 'q>

Returns a ParticipantBuilder for constructing a participant with custom QoS or a listener.

Examples

use cyclonedds::{Domain, Participant};

let domain = Domain::default();
let participant = Participant::builder(&domain).build()?;

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

where L: AsRef<Listener>,

Sets the Listener on this participant, replacing any previously set listener.

Errors

Returns an Error if the listener fails to set.

Examples

use cyclonedds::{Domain, Listener, Participant, listener::SubscriberListener};

let domain = Domain::default();
let mut participant = Participant::new(&domain)?;
let listener =
    Listener::new().with_subscriber(|s| s.with_data_on_readers(|_| println!("data available")));
participant.set_listener(listener)?;

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

Removes the listener from this participant.

Errors

Returns an Error if the listener fails to unset.

Examples

use cyclonedds::{Domain, Participant};

let domain = Domain::default();
let mut participant = Participant::new(&domain)?;
participant.unset_listener()?;

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

where L: AsRef<Listener>,

Sets the Listener on this participant, consuming and returning self.

Useful for chaining participant construction with listener configuration.

Errors

Returns an Error if the listener fails to set.

Examples

use cyclonedds::{Domain, Listener, Participant};

let domain = Domain::default();
let participant = Participant::new(&domain)?.with_listener(Listener::new())?;

Trait Implementations

impl<'domain> Debug for Participant<'domain>

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

Formats the value using the given formatter.

impl Drop for Participant<'_>

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 Participant<'_>

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.