RTI Connext .Net APIs  Version 5.0.0
DDS::KeyedStringDataWriter Class Reference

<<interface>> Instantiates DataWriter < DDS::KeyedString >. More...

#include <managed_keyedstringSupport.h>

Inheritance diagram for DDS::KeyedStringDataWriter:
DDS::TypedDataWriter< T > DDS::DataWriter DDS::DomainEntity DDS::Entity

Public Member Functions

InstanceHandle_t register_instance (System::String^ key)
 <<eXtension>> Informs RTI Connext that the application will be modifying a particular instance.
 
InstanceHandle_t register_instance_w_timestamp (System::String^ key, DDS::Time_t% source_timestamp)
 <<eXtension>> Performs the same functions as DDS::KeyedStringDataWriter::register_instance except that the application provides the value for the source_timestamp.
 
void unregister_instance (System::String^ key, DDS::InstanceHandle_t% handle)
 <<eXtension>> Reverses the action of DDS::KeyedStringDataWriter::register_instance.
 
void unregister_instance_w_timestamp (System::String^ key, DDS::InstanceHandle_t% handle, DDS::Time_t% source_timestamp)
 <<eXtension>> Performs the same function as DDS::KeyedStringDataWriter::unregister_instance except that it also provides the value for the source_timestamp.
 
void write (System::String^ key, System::String^ str, DDS::InstanceHandle_t% handle)
 <<eXtension>> Modifies the value of a DDS::KeyedString data instance.
 
void write_w_timestamp (System::String^ key, System::String^ str, DDS::InstanceHandle_t% handle, DDS::Time_t% source_timestamp)
 <<eXtension>> Performs the same function as DDS::KeyedStringDataWriter::write except that it also provides the value for the source_timestamp.
 
void dispose (System::String^ key, DDS::InstanceHandle_t% instance_handle)
 <<eXtension>> Requests the middleware to delete the data.
 
void dispose_w_timestamp (System::String^ key, DDS::InstanceHandle_t% instance_handle, DDS::Time_t% source_timestamp)
 <<eXtension>> Performs the same functions as DDS::KeyedStringDataWriter::dispose except that the application provides the value for the source_timestamp that is made available to DDS::DataReader objects by means of the source_timestamp attribute inside the DDS::SampleInfo.
 
System::String^ get_key_value (DDS::InstanceHandle_t% handle)
 <<eXtension>> Retrieve the instance key that corresponds to an instance handle.
 
InstanceHandle_t lookup_instance (System::String^ key)
 <<eXtension>> Retrieve the instance handle that corresponds to an instance key.
 
- Public Member Functions inherited from DDS::TypedDataWriter< T >
InstanceHandle_t register_instance (T instance_data)
 Informs RTI Connext that the application will be modifying a particular instance.
 
InstanceHandle_t register_instance_w_timestamp (T instance_data, DDS::Time_t% source_timestamp)
 Performs the same functions as register_instance except that the application provides the value for the source_timestamp.
 
InstanceHandle_t register_instance_w_params (T instance_data, DDS::WriteParams_t^ params)
 Performs the same function as DDS::TypedDataWriter::register_instance and DDS::TypedDataWriter::register_instance_w_timestamp except that it also provides the values contained in params.
 
void unregister_instance (T instance_data, DDS::InstanceHandle_t% handle)
 Reverses the action of DDS::TypedDataWriter::register_instance.
 
void unregister_instance_w_timestamp (T instance_data, DDS::InstanceHandle_t% handle, DDS::Time_t% source_timestamp)
 Performs the same function as DDS::TypedDataWriter::unregister_instance except that it also provides the value for the source_timestamp.
 
void unregister_instance_w_params (T instance_data, DDS::WriteParams_t^ params)
 Performs the same function as DDS::TypedDataWriter::unregister_instance and DDS::TypedDataWriter::unregister_instance_w_timestamp except that it also provides the values contained in params.
 
void write (T instance_data, DDS::InstanceHandle_t% handle)
 Modifies the value of a data instance.
 
void write_w_timestamp (T instance_data, DDS::InstanceHandle_t% handle, DDS::Time_t% source_timestamp)
 Performs the same function as DDS::TypedDataWriter::write except that it also provides the value for the source_timestamp.
 
void write_w_params (T instance_data, DDS::WriteParams_t^ params)
 Performs the same function as DDS::TypedDataWriter::write and DDS::TypedDataWriter::write_w_timestamp except that it also provides the values contained in params.
 
void dispose (T instance_data, DDS::InstanceHandle_t% instance_handle)
 Requests the middleware to delete the data.
 
void dispose_w_timestamp (T instance_data, DDS::InstanceHandle_t% instance_handle, DDS::Time_t% source_timestamp)
 Performs the same functions as dispose except that the application provides the value for the source_timestamp that is made available to DDS::DataReader objects by means of the source_timestamp attribute inside the DDS::SampleInfo.
 
void dispose_w_params (T instance_data, DDS::WriteParams_t^ params)
 Performs the same function as DDS::TypedDataWriter::dispose and DDS::TypedDataWriter::dispose_w_timestamp except that it also provides the values contained in params.
 
void get_key_value (T key_holder, DDS::InstanceHandle_t% handle)
 Retrieve the instance key that corresponds to an instance handle.
 
InstanceHandle_t lookup_instance (T key_holder)
 Retrieve the instance handle that corresponds to an instance key_holder.
 
- Public Member Functions inherited from DDS::DataWriter
void get_liveliness_lost_status (LivelinessLostStatus% status)
 Accesses the ::DDS::StatusKind::LIVELINESS_LOST_STATUS communication status.
 
void get_offered_deadline_missed_status (OfferedDeadlineMissedStatus% status)
 Accesses the ::DDS::StatusKind::OFFERED_DEADLINE_MISSED_STATUS communication status.
 
void get_offered_incompatible_qos_status (OfferedIncompatibleQosStatus^ status)
 Accesses the ::DDS::StatusKind::OFFERED_INCOMPATIBLE_QOS_STATUS communication status.
 
void get_publication_matched_status (PublicationMatchedStatus% status)
 Accesses the ::DDS::StatusKind::PUBLICATION_MATCHED_STATUS communication status.
 
void get_reliable_writer_cache_changed_status (ReliableWriterCacheChangedStatus% status)
 <<eXtension>> Get the reliable cache status for this writer.
 
void get_reliable_reader_activity_changed_status (ReliableReaderActivityChangedStatus% status)
 <<eXtension>> Get the reliable reader activity changed status for this writer.
 
virtual void get_datawriter_cache_status (DataWriterCacheStatus% status)
 <<eXtension>> Get the datawriter cache status for this writer.
 
virtual void get_datawriter_protocol_status (DataWriterProtocolStatus% status)
 <<eXtension>> Get the datawriter protocol status for this writer.
 
virtual void get_matched_subscription_datawriter_protocol_status (DataWriterProtocolStatus% status, InstanceHandle_t% subscription_handle)
 <<eXtension>> Get the datawriter protocol status for this writer, per matched subscription identified by the subscription_handle.
 
virtual void get_matched_subscription_datawriter_protocol_status_by_locator (DataWriterProtocolStatus% status, Locator_t^ locator)
 <<eXtension>> Get the datawriter protocol status for this writer, per matched subscription identified by the locator.
 
void assert_liveliness ()
 This operation manually asserts the liveliness of this DDS::DataWriter.
 
virtual void get_matched_subscription_locators (LocatorSeq^ locators)
 <<eXtension>> Retrieve the list of locators for subscriptions currently "associated" with this DDS::DataWriter.
 
void get_matched_subscriptions (InstanceHandleSeq^ subscription_handles)
 Retrieve the list of subscriptions currently "associated" with this DDS::DataWriter.
 
void get_matched_subscription_data (SubscriptionBuiltinTopicData^ subscription_data, InstanceHandle_t% subscription_handle)
 This operation retrieves the information on a subscription that is currently "associated" with the DDS::DataWriter.
 
Topicget_topic ()
 This operation returns the DDS::Topic associated with the DDS::DataWriter.
 
Publisherget_publisher ()
 This operation returns the DDS::Publisher to which the DDS::DataWriter belongs.
 
void wait_for_acknowledgments (Duration_t max_wait)
 Blocks the calling thread until all data written by reliable DDS::DataWriter entity is acknowledged, or until timeout expires.
 
void wait_for_asynchronous_publishing (Duration_t max_wait)
 <<eXtension>> Blocks the calling thread until asynchronous sending is complete.
 
void set_qos (DataWriterQos^ qos)
 Sets the writer QoS.
 
void set_qos_with_profile (System::String^ library_name, System::String^ profile_name)
 <<eXtension>> Change the QoS of this writer using the input XML QoS profile.
 
void get_qos (DataWriterQos^ qos)
 Gets the writer QoS.
 
void set_listener (DataWriterListener^ l, StatusMask mask)
 Sets the writer listener.
 
DataWriterListenerget_listener ()
 Get the writer listener.
 
void flush ()
 <<eXtension>> Flushes the batch in progress in the context of the calling thread.
 
InstanceHandle_t register_instance_untyped (System::Object^ instance_data)
 Register a new instance with this writer.
 
InstanceHandle_t register_instance_w_timestamp_untyped (System::Object^ instance_data, DDS::Time_t% source_timestamp)
 Register a new instance with this writer using the given time instead of the current time.
 
void unregister_instance_untyped (System::Object^ instance_data, DDS::InstanceHandle_t% handle)
 Unregister a new instance from this writer.
 
void unregister_instance_w_timestamp_untyped (System::Object^ instance_data, DDS::InstanceHandle_t% handle, DDS::Time_t% source_timestamp)
 Unregister a new instance from this writer using the given time instead of the current time.
 
void write_untyped (System::Object^ instance_data, DDS::InstanceHandle_t% handle)
 Publish a data sample.
 
void write_w_timestamp_untyped (System::Object^ instance_data, DDS::InstanceHandle_t% handle, DDS::Time_t% source_timestamp)
 Publish a data sample using the given time instead of the current time.
 
void dispose_untyped (System::Object^ instance_data, DDS::InstanceHandle_t% instance_handle)
 Dispose a data sample.
 
void dispose_w_timestamp_untyped (System::Object^ instance_data, DDS::InstanceHandle_t% instance_handle, DDS::Time_t% source_timestamp)
 Dispose a data sample using the given time instead of the current time.
 
void get_key_value_untyped (System::Object^ key_holder, DDS::InstanceHandle_t% handle)
 Fill in the key fields of the given data sample.
 
InstanceHandle_t lookup_instance_untyped (System::Object^ key_holder)
 Given a sample with the given key field values, return the handle corresponding to its instance.
 
virtual void enable () override
 Enables the DDS::Entity.
 
virtual StatusConditionget_statuscondition () override
 Allows access to the DDS::StatusCondition associated with the DDS::Entity.
 
virtual StatusMask get_status_changes () override
 Retrieves the list of communication statuses in the DDS::Entity that are triggered.
 
virtual InstanceHandle_t get_instance_handle () override
 Allows access to the DDS::InstanceHandle_t associated with the DDS::Entity.
 

Detailed Description

Member Function Documentation

InstanceHandle_t DDS::KeyedStringDataWriter::register_instance ( System::String^  key)

<<eXtension>> Informs RTI Connext that the application will be modifying a particular instance.

See Also
DDS::TypedDataWriter::register_instance
InstanceHandle_t DDS::KeyedStringDataWriter::register_instance_w_timestamp ( System::String^  key,
DDS::Time_t source_timestamp 
)

<<eXtension>> Performs the same functions as DDS::KeyedStringDataWriter::register_instance except that the application provides the value for the source_timestamp.

See Also
DDS::TypedDataWriter::register_instance_w_timestamp
void DDS::KeyedStringDataWriter::unregister_instance ( System::String^  key,
DDS::InstanceHandle_t handle 
)
void DDS::KeyedStringDataWriter::unregister_instance_w_timestamp ( System::String^  key,
DDS::InstanceHandle_t handle,
DDS::Time_t source_timestamp 
)

<<eXtension>> Performs the same function as DDS::KeyedStringDataWriter::unregister_instance except that it also provides the value for the source_timestamp.

See Also
DDS::TypedDataWriter::unregister_instance_w_timestamp
void DDS::KeyedStringDataWriter::write ( System::String^  key,
System::String^  str,
DDS::InstanceHandle_t handle 
)

<<eXtension>> Modifies the value of a DDS::KeyedString data instance.

See Also
DDS::TypedDataWriter::write
void DDS::KeyedStringDataWriter::write_w_timestamp ( System::String^  key,
System::String^  str,
DDS::InstanceHandle_t handle,
DDS::Time_t source_timestamp 
)

<<eXtension>> Performs the same function as DDS::KeyedStringDataWriter::write except that it also provides the value for the source_timestamp.

See Also
DDS::TypedDataWriter::write_w_timestamp
void DDS::KeyedStringDataWriter::dispose ( System::String^  key,
DDS::InstanceHandle_t instance_handle 
)

<<eXtension>> Requests the middleware to delete the data.

See Also
DDS::TypedDataWriter::dispose
void DDS::KeyedStringDataWriter::dispose_w_timestamp ( System::String^  key,
DDS::InstanceHandle_t instance_handle,
DDS::Time_t source_timestamp 
)

<<eXtension>> Performs the same functions as DDS::KeyedStringDataWriter::dispose except that the application provides the value for the source_timestamp that is made available to DDS::DataReader objects by means of the source_timestamp attribute inside the DDS::SampleInfo.

See Also
DDS::TypedDataWriter::dispose_w_timestamp
System::String ^ DDS::KeyedStringDataWriter::get_key_value ( DDS::InstanceHandle_t handle)

<<eXtension>> Retrieve the instance key that corresponds to an instance handle.

See Also
DDS::TypedDataWriter::get_key_value
InstanceHandle_t DDS::KeyedStringDataWriter::lookup_instance ( System::String^  key)

<<eXtension>> Retrieve the instance handle that corresponds to an instance key.

See Also
DDS::TypedDataWriter::lookup_instance

RTI Connext .Net APIs Version 5.0.0 Copyright © Thu Aug 30 2012 Real-Time Innovations, Inc