Struct rustdds::dds::no_key::DataWriter

pub struct DataWriter<D: Serialize, SA: SerializerAdapter<D> = CDRSerializerAdapter<D>> { /* fields omitted */ }

DDS DataWriter for no key topics

Examples

use serde::{Serialize, Deserialize};
use rustdds::dds::DomainParticipant;
use rustdds::dds::qos::QosPolicyBuilder;
use rustdds::dds::data_types::TopicKind;
use rustdds::dds::No_Key_DataWriter as DataWriter;
use rustdds::serialization::CDRSerializerAdapter;

let domain_participant = DomainParticipant::new(0);
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

#[derive(Serialize, Deserialize)]
struct SomeType {}

// NoKey is important
let topic = domain_participant.create_topic("some_topic", "SomeType", &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(None, topic, None);

Implementations

impl<D, SA> DataWriter<D, SA> where
    D: Serialize,
    SA: SerializerAdapter<D>, 

pub fn write(&self, data: D, source_timestamp: Option<Timestamp>) -> Result<()>

Writes single data instance to a topic.

Examples

let domain_participant = DomainParticipant::new(0);
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic", "SomeType", &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(None, topic, None).unwrap();

let some_data = SomeType {};
data_writer.write(some_data, None).unwrap();

pub fn wait_for_acknowledgments(&self, max_wait: Duration) -> Result<()>

Waits for all acknowledgements to finish

Examples

let domain_participant = DomainParticipant::new(0);
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic", "SomeType", &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(None, topic, None).unwrap();

data_writer.wait_for_acknowledgments(Duration::from_millis(100));

pub fn get_liveliness_lost_status(&self) -> Result<LivelinessLostStatus>

Unimplemented. Do not use.

Examples

let domain_participant = DomainParticipant::new(0);
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic", "SomeType", &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(None, topic, None).unwrap();

if let Ok(status) = data_writer.get_liveliness_lost_status() {
  // Do something
}

pub fn get_offered_deadline_missed_status(
    &self
) -> Result<OfferedDeadlineMissedStatus>

Should get latest offered deadline missed status. Do not use yet use get_status_lister instead for the moment.

Examples

let domain_participant = DomainParticipant::new(0);
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic", "SomeType", &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(None, topic, None).unwrap();

if let Ok(odl_status) = data_writer.get_offered_deadline_missed_status() {
  // Do something
}

pub fn get_offered_incompatible_qos_status(
    &self
) -> Result<OfferedIncompatibleQosStatus>

Unimplemented. Do not use.

Examples

let domain_participant = DomainParticipant::new(0);
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic", "SomeType", &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(None, topic, None).unwrap();

if let Ok(status) = data_writer.get_offered_incompatible_qos_status() {
  // Do something
}

pub fn get_publication_matched_status(&self) -> Result<PublicationMatchedStatus>

Unimplemented. Do not use.

Examples

let domain_participant = DomainParticipant::new(0);
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic", "SomeType", &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(None, topic, None).unwrap();

if let Ok(status) = data_writer.get_publication_matched_status() {
  // Do something
}

pub fn get_topic(&self) -> &Topic

Topic this DataWriter is connected to.

Examples

let domain_participant = DomainParticipant::new(0);
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic", "SomeType", &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(None, topic.clone(), None).unwrap();

assert_eq!(&topic, data_writer.get_topic());

pub fn get_publisher(&self) -> &Publisher

Publisher this DataWriter is connected to.

Examples

let domain_participant = DomainParticipant::new(0);
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic", "SomeType", &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(None, topic, None).unwrap();

assert_eq!(&publisher, data_writer.get_publisher());

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

Manually asserts liveliness if QoS agrees

Examples

let domain_participant = DomainParticipant::new(0);
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic", "SomeType", &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(None, topic, None).unwrap();

data_writer.assert_liveliness();

pub fn get_matched_subscriptions(&self) -> Vec<SubscriptionBuiltinTopicData>

Unimplemented. Do not use.

Examples

let domain_participant = DomainParticipant::new(0);
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic", "SomeType", &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(None, topic, None).unwrap();

for sub in data_writer.get_matched_subscriptions().iter() {
  // handle subscriptions
}

pub fn get_status_listener(&self) -> &Receiver<StatusChange>

Gets mio receiver for all implemented Status changes

Examples

let domain_participant = DomainParticipant::new(0);
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic", "SomeType", &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(None, topic, None).unwrap();

// Some status has changed

if let Ok(status) = data_writer.get_status_listener().try_recv() {
  // handle status change
}

Trait Implementations

impl<D: Serialize, SA: SerializerAdapter<D>> DDSEntity for DataWriter<D, SA>

impl<D: Serialize, SA: SerializerAdapter<D>> HasQoSPolicy for DataWriter<D, SA>

pub fn get_qos(&self) -> QosPolicies

impl<D: Serialize, SA: SerializerAdapter<D>> RTPSEntity for DataWriter<D, SA>

pub fn get_guid(&self) -> GUID

pub fn get_entity_id(&self) -> EntityId

pub fn get_guid_prefix(&self) -> GuidPrefix