RTI Connext C++ API  Version 5.1.0
DDSKeyedOctetsDataWriter Class Reference

<<interface>> Instantiates DataWriter < DDS_KeyedOctets >. More...

Inheritance diagram for DDSKeyedOctetsDataWriter:
DDSDataWriter DDSDomainEntity DDSEntity

Public Member Functions

virtual DDS_InstanceHandle_t register_instance (const DDS_KeyedOctets &instance_data)
 Informs RTI Connext that the application will be modifying a particular instance.
 
virtual DDS_InstanceHandle_t register_instance (const char *key)
 <<eXtension>> Informs RTI Connext that the application will be modifying a particular instance.
 
virtual DDS_InstanceHandle_t register_instance_w_timestamp (const DDS_KeyedOctets &instance_data, const DDS_Time_t &source_timestamp)
 Performs the same functions as DDSKeyedOctetsDataWriter::register_instance except that the application provides the value for the source_timestamp.
 
virtual DDS_InstanceHandle_t register_instance_w_timestamp (const char *key, const DDS_Time_t &source_timestamp)
 <<eXtension>> Performs the same functions as DDSKeyedOctetsDataWriter::register_instance except that the application provides the value for the source_timestamp.
 
virtual DDS_ReturnCode_t unregister_instance (const DDS_KeyedOctets &instance_data, const DDS_InstanceHandle_t &handle)
 Reverses the action of DDSKeyedOctetsDataWriter::register_instance.
 
virtual DDS_ReturnCode_t unregister_instance (const char *key, const DDS_InstanceHandle_t &handle)
 <<eXtension>> Reverses the action of DDSKeyedOctetsDataWriter::register_instance.
 
virtual DDS_ReturnCode_t unregister_instance_w_timestamp (const DDS_KeyedOctets &instance_data, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
 Performs the same function as DDSKeyedOctetsDataWriter::unregister_instance except that it also provides the value for the source_timestamp.
 
virtual DDS_ReturnCode_t unregister_instance_w_timestamp (const char *key, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
 Performs the same function as DDSKeyedOctetsDataWriter::unregister_instance except that it also provides the value for the source_timestamp.
 
virtual DDS_ReturnCode_t write (const DDS_KeyedOctets &instance_data, const DDS_InstanceHandle_t &handle)
 Modifies the value of a DDS_KeyedOctets data instance.
 
virtual DDS_ReturnCode_t write (const char *key, const unsigned char *octets, int length, const DDS_InstanceHandle_t &handle)
 <<eXtension>> Modifies the value of a DDS_KeyedOctets data instance.
 
virtual DDS_ReturnCode_t write (const char *key, const DDS_OctetSeq &octets, const DDS_InstanceHandle_t &handle)
 <<eXtension>> Modifies the value of a DDS_KeyedOctets data instance.
 
virtual DDS_ReturnCode_t write_w_timestamp (const DDS_KeyedOctets &instance_data, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
 Performs the same function as DDSKeyedOctetsDataWriter::write except that it also provides the value for the source_timestamp.
 
virtual DDS_ReturnCode_t write_w_timestamp (const char *key, const unsigned char *octets, int length, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
 Performs the same function as DDSKeyedOctetsDataWriter::write except that it also provides the value for the source_timestamp.
 
virtual DDS_ReturnCode_t write_w_timestamp (const char *key, const DDS_OctetSeq &octets, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
 Performs the same function as DDSKeyedOctetsDataWriter::write except that it also provides the value for the source_timestamp.
 
virtual DDS_ReturnCode_t write_w_params (const DDS_KeyedOctets &instance_data, DDS_WriteParams_t &params)
 Performs the same function as DDSKeyedOctetsDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.
 
virtual DDS_ReturnCode_t write_w_params (const char *key, const unsigned char *octets, int length, DDS_WriteParams_t &params)
 Performs the same function as DDSKeyedOctetsDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.
 
virtual DDS_ReturnCode_t write_w_params (const char *key, const DDS_OctetSeq &octets, DDS_WriteParams_t &params)
 Performs the same function as DDSKeyedOctetsDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.
 
virtual DDS_ReturnCode_t dispose (const DDS_KeyedOctets &instance_data, const DDS_InstanceHandle_t &handle)
 Requests the middleware to delete the data.
 
virtual DDS_ReturnCode_t dispose (const char *key, const DDS_InstanceHandle_t &instance_handle)
 <<eXtension>> Requests the middleware to delete the data.
 
virtual DDS_ReturnCode_t dispose_w_timestamp (const DDS_KeyedOctets &instance_data, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
 Performs the same functions as DDSKeyedOctetsDataWriter::dispose except that the application provides the value for the source_timestamp that is made available to DDSDataReader objects by means of the source_timestamp attribute inside the DDS_SampleInfo.
 
virtual DDS_ReturnCode_t dispose_w_timestamp (const char *key, const DDS_InstanceHandle_t &instance_handle, const DDS_Time_t &source_timestamp)
 <<eXtension>> Performs the same functions as DDSKeyedOctetsDataWriter::dispose except that the application provides the value for the source_timestamp that is made available to DDSDataReader objects by means of the source_timestamp attribute inside the DDS_SampleInfo.
 
virtual DDS_ReturnCode_t get_key_value (DDS_KeyedOctets &key_holder, const DDS_InstanceHandle_t &handle)
 Retrieve the instance key that corresponds to an instance handle.
 
virtual DDS_ReturnCode_t get_key_value (char *key, const DDS_InstanceHandle_t &handle)
 <<eXtension>> Retrieve the instance key that corresponds to an instance handle.
 
virtual DDS_InstanceHandle_t lookup_instance (const DDS_KeyedOctets &key_holder)
 Retrieve the instance handle that corresponds to an instance key_holder.
 
virtual DDS_InstanceHandle_t lookup_instance (const char *key)
 <<eXtension>> Retrieve the instance handle that corresponds to an instance key.
 
- Public Member Functions inherited from DDSDataWriter
virtual DDS_ReturnCode_t get_liveliness_lost_status (DDS_LivelinessLostStatus &status)
 Accesses the DDS_LIVELINESS_LOST_STATUS communication status.
 
virtual DDS_ReturnCode_t get_offered_deadline_missed_status (DDS_OfferedDeadlineMissedStatus &status)
 Accesses the DDS_OFFERED_DEADLINE_MISSED_STATUS communication status.
 
virtual DDS_ReturnCode_t get_offered_incompatible_qos_status (DDS_OfferedIncompatibleQosStatus &status)
 Accesses the DDS_OFFERED_INCOMPATIBLE_QOS_STATUS communication status.
 
virtual DDS_ReturnCode_t get_publication_matched_status (DDS_PublicationMatchedStatus &status)
 Accesses the DDS_PUBLICATION_MATCHED_STATUS communication status.
 
virtual DDS_ReturnCode_t get_reliable_writer_cache_changed_status (DDS_ReliableWriterCacheChangedStatus &status)
 <<eXtension>> Get the reliable cache status for this writer.
 
virtual DDS_ReturnCode_t get_reliable_reader_activity_changed_status (DDS_ReliableReaderActivityChangedStatus &status)
 <<eXtension>> Get the reliable reader activity changed status for this writer.
 
virtual DDS_ReturnCode_t get_datawriter_cache_status (DDS_DataWriterCacheStatus &status)
 <<eXtension>> Get the datawriter cache status for this writer.
 
virtual DDS_ReturnCode_t get_datawriter_protocol_status (DDS_DataWriterProtocolStatus &status)
 <<eXtension>> Get the datawriter protocol status for this writer.
 
virtual DDS_ReturnCode_t get_matched_subscription_datawriter_protocol_status (DDS_DataWriterProtocolStatus &status, const DDS_InstanceHandle_t &subscription_handle)
 <<eXtension>> Get the datawriter protocol status for this writer, per matched subscription identified by the subscription_handle.
 
virtual DDS_ReturnCode_t get_matched_subscription_datawriter_protocol_status_by_locator (DDS_DataWriterProtocolStatus &status, const DDS_Locator_t &locator)
 <<eXtension>> Get the datawriter protocol status for this writer, per matched subscription identified by the locator.
 
virtual DDS_ReturnCode_t assert_liveliness ()
 This operation manually asserts the liveliness of this DDSDataWriter.
 
virtual DDS_ReturnCode_t get_matched_subscription_locators (DDS_LocatorSeq &locators)
 <<eXtension>> Retrieve the list of locators for subscriptions currently "associated" with this DDSDataWriter.
 
virtual DDS_ReturnCode_t get_matched_subscriptions (DDS_InstanceHandleSeq &subscription_handles)
 Retrieve the list of subscriptions currently "associated" with this DDSDataWriter.
 
virtual DDS_ReturnCode_t get_matched_subscription_data (DDS_SubscriptionBuiltinTopicData &subscription_data, const DDS_InstanceHandle_t &subscription_handle)
 This operation retrieves the information on a subscription that is currently "associated" with the DDSDataWriter.
 
virtual DDS_ReturnCode_t get_matched_subscription_participant_data (DDS_ParticipantBuiltinTopicData &participant_data, const DDS_InstanceHandle_t &subscription_handle)
 This operation retrieves the information on the discovered DDSDomainParticipant associated with the subscription that is currently matching with the DDSDataWriter.
 
virtual DDSTopicget_topic ()
 This operation returns the DDSTopic associated with the DDSDataWriter.
 
virtual DDSPublisherget_publisher ()
 This operation returns the DDSPublisher to which the DDSDataWriter belongs.
 
virtual DDS_ReturnCode_t wait_for_acknowledgments (const DDS_Duration_t &max_wait)
 Blocks the calling thread until all data written by reliable DDSDataWriter entity is acknowledged, or until timeout expires.
 
virtual DDS_ReturnCode_t wait_for_asynchronous_publishing (const DDS_Duration_t &max_wait)
 <<eXtension>> Blocks the calling thread until asynchronous sending is complete.
 
virtual DDS_ReturnCode_t set_qos (const DDS_DataWriterQos &qos)
 Sets the writer QoS.
 
virtual DDS_ReturnCode_t set_qos_with_profile (const char *library_name, const char *profile_name)
 <<eXtension>> Change the QoS of this writer using the input XML QoS profile.
 
virtual DDS_ReturnCode_t get_qos (DDS_DataWriterQos &qos)
 Gets the writer QoS.
 
virtual DDS_ReturnCode_t set_listener (DDSDataWriterListener *l, DDS_StatusMask mask=DDS_STATUS_MASK_ALL)
 Sets the writer listener.
 
virtual DDSDataWriterListenerget_listener ()
 Get the writer listener.
 
virtual DDS_ReturnCode_t flush ()
 <<eXtension>> Flushes the batch in progress in the context of the calling thread.
 
virtual DDS_ReturnCode_t enable ()
 Enables the DDSEntity.
 
virtual DDSStatusConditionget_statuscondition ()
 Allows access to the DDSStatusCondition associated with the DDSEntity.
 
virtual DDS_StatusMask get_status_changes ()
 Retrieves the list of communication statuses in the DDSEntity that are triggered.
 
virtual DDS_InstanceHandle_t get_instance_handle ()
 Allows access to the DDS_InstanceHandle_t associated with the DDSEntity.
 

Static Public Member Functions

static DDSKeyedOctetsDataWriternarrow (DDSDataWriter *writer)
 Narrow the given DDSDataWriter pointer to a DDSKeyedOctetsDataWriter pointer.
 

Detailed Description

<<interface>> Instantiates DataWriter < DDS_KeyedOctets >.

See Also
FooDataWriter
DDSDataWriter

Member Function Documentation

static DDSKeyedOctetsDataWriter* DDSKeyedOctetsDataWriter::narrow ( DDSDataWriter writer)
static

Narrow the given DDSDataWriter pointer to a DDSKeyedOctetsDataWriter pointer.

See Also
FooDataWriter::narrow
virtual DDS_InstanceHandle_t DDSKeyedOctetsDataWriter::register_instance ( const DDS_KeyedOctets instance_data)
virtual

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

See Also
FooDataWriter::register_instance
virtual DDS_InstanceHandle_t DDSKeyedOctetsDataWriter::register_instance ( const char *  key)
virtual

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

See Also
FooDataWriter::register_instance
virtual DDS_InstanceHandle_t DDSKeyedOctetsDataWriter::register_instance_w_timestamp ( const DDS_KeyedOctets instance_data,
const DDS_Time_t source_timestamp 
)
virtual

Performs the same functions as DDSKeyedOctetsDataWriter::register_instance except that the application provides the value for the source_timestamp.

See Also
FooDataWriter::register_instance_w_timestamp
virtual DDS_InstanceHandle_t DDSKeyedOctetsDataWriter::register_instance_w_timestamp ( const char *  key,
const DDS_Time_t source_timestamp 
)
virtual

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

See Also
FooDataWriter::register_instance_w_timestamp
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::unregister_instance ( const DDS_KeyedOctets instance_data,
const DDS_InstanceHandle_t handle 
)
virtual
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::unregister_instance ( const char *  key,
const DDS_InstanceHandle_t handle 
)
virtual
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::unregister_instance_w_timestamp ( const DDS_KeyedOctets instance_data,
const DDS_InstanceHandle_t handle,
const DDS_Time_t source_timestamp 
)
virtual

Performs the same function as DDSKeyedOctetsDataWriter::unregister_instance except that it also provides the value for the source_timestamp.

See Also
FooDataWriter::unregister_instance_w_timestamp
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::unregister_instance_w_timestamp ( const char *  key,
const DDS_InstanceHandle_t handle,
const DDS_Time_t source_timestamp 
)
virtual

Performs the same function as DDSKeyedOctetsDataWriter::unregister_instance except that it also provides the value for the source_timestamp.

See Also
FooDataWriter::unregister_instance_w_timestamp
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::write ( const DDS_KeyedOctets instance_data,
const DDS_InstanceHandle_t handle 
)
virtual

Modifies the value of a DDS_KeyedOctets data instance.

See Also
FooDataWriter::write
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::write ( const char *  key,
const unsigned char *  octets,
int  length,
const DDS_InstanceHandle_t handle 
)
virtual

<<eXtension>> Modifies the value of a DDS_KeyedOctets data instance.

Parameters
key<<in>> Instance key.
octets<<in>> Array of octets to be published.
length<<in>> Number of octets to be published.
handle<<in>> Either the handle returned by a previous call to DDSKeyedOctetsDataWriter::register_instance, or else the special value DDS_HANDLE_NIL. See FooDataWriter::write.
See Also
FooDataWriter::write
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::write ( const char *  key,
const DDS_OctetSeq octets,
const DDS_InstanceHandle_t handle 
)
virtual

<<eXtension>> Modifies the value of a DDS_KeyedOctets data instance.

Parameters
key<<in>> Instance key.
octets<<in>> Sequence of octets to be published.
handle<<in>> Either the handle returned by a previous call to DDSKeyedOctetsDataWriter::register_instance, or else the special value DDS_HANDLE_NIL. See FooDataWriter::write.
See Also
FooDataWriter::write
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::write_w_timestamp ( const DDS_KeyedOctets instance_data,
const DDS_InstanceHandle_t handle,
const DDS_Time_t source_timestamp 
)
virtual

Performs the same function as DDSKeyedOctetsDataWriter::write except that it also provides the value for the source_timestamp.

See Also
FooDataWriter::write_w_timestamp
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::write_w_timestamp ( const char *  key,
const unsigned char *  octets,
int  length,
const DDS_InstanceHandle_t handle,
const DDS_Time_t source_timestamp 
)
virtual

Performs the same function as DDSKeyedOctetsDataWriter::write except that it also provides the value for the source_timestamp.

Parameters
key<<in>> Instance key.
octets<<in>> Array of octets to be published.
length<<in>> Number of octets to be published.
handle<<in>> Either the handle returned by a previous call to DDSKeyedOctetsDataWriter::register_instance, or else the special value DDS_HANDLE_NIL. See FooDataWriter::write.
source_timestamp<<in>> The timestamp value must be greater than or equal to the timestamp value used in the last writer operation. See FooDataWriter::write_w_timestamp.
See Also
FooDataWriter::write
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::write_w_timestamp ( const char *  key,
const DDS_OctetSeq octets,
const DDS_InstanceHandle_t handle,
const DDS_Time_t source_timestamp 
)
virtual

Performs the same function as DDSKeyedOctetsDataWriter::write except that it also provides the value for the source_timestamp.

Parameters
key<<in>> Instance key.
octets<<in>> Sequence of octets to be published.
handle<<in>> Either the handle returned by a previous call to DDSKeyedOctetsDataWriter::register_instance, or else the special value DDS_HANDLE_NIL. See FooDataWriter::write.
source_timestamp<<in>> The timestamp value must be greater than or equal to the timestamp value used in the last writer operation. See FooDataWriter::write_w_timestamp.
See Also
FooDataWriter::write
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::write_w_params ( const DDS_KeyedOctets instance_data,
DDS_WriteParams_t params 
)
virtual

Performs the same function as DDSKeyedOctetsDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.

See Also
FooDataWriter::write_w_params
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::write_w_params ( const char *  key,
const unsigned char *  octets,
int  length,
DDS_WriteParams_t params 
)
virtual

Performs the same function as DDSKeyedOctetsDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.

Parameters
key<<in>> Instance key.
octets<<in>> Array of octets to be published.
length<<in>> Number of octets to be published.
params<<in>> The DDS_WriteParams_t parameter containing the instance handle, source timestamp, publication priority, and cookie to be used in write operation. See FooDataWriter::write_w_params.
See Also
FooDataWriter::write_w_params
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::write_w_params ( const char *  key,
const DDS_OctetSeq octets,
DDS_WriteParams_t params 
)
virtual

Performs the same function as DDSKeyedOctetsDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.

Parameters
key<<in>> Instance key.
octets<<in>> Sequence of octets to be published.
params<<in>> The DDS_WriteParams_t parameter containing the instance handle, source timestamp, publication priority, and cookie to be used in write operation. See FooDataWriter::write_w_params.
See Also
FooDataWriter::write_w_params
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::dispose ( const DDS_KeyedOctets instance_data,
const DDS_InstanceHandle_t handle 
)
virtual

Requests the middleware to delete the data.

See Also
FooDataWriter::dispose
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::dispose ( const char *  key,
const DDS_InstanceHandle_t instance_handle 
)
virtual

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

See Also
FooDataWriter::dispose
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::dispose_w_timestamp ( const DDS_KeyedOctets instance_data,
const DDS_InstanceHandle_t handle,
const DDS_Time_t source_timestamp 
)
virtual

Performs the same functions as DDSKeyedOctetsDataWriter::dispose except that the application provides the value for the source_timestamp that is made available to DDSDataReader objects by means of the source_timestamp attribute inside the DDS_SampleInfo.

See Also
FooDataWriter::dispose_w_timestamp
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::dispose_w_timestamp ( const char *  key,
const DDS_InstanceHandle_t instance_handle,
const DDS_Time_t source_timestamp 
)
virtual

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

See Also
FooDataWriter::dispose_w_timestamp
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::get_key_value ( DDS_KeyedOctets key_holder,
const DDS_InstanceHandle_t handle 
)
virtual

Retrieve the instance key that corresponds to an instance handle.

See Also
FooDataWriter::get_key_value
virtual DDS_ReturnCode_t DDSKeyedOctetsDataWriter::get_key_value ( char *  key,
const DDS_InstanceHandle_t handle 
)
virtual

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

See Also
FooDataWriter::get_key_value
virtual DDS_InstanceHandle_t DDSKeyedOctetsDataWriter::lookup_instance ( const DDS_KeyedOctets key_holder)
virtual

Retrieve the instance handle that corresponds to an instance key_holder.

See Also
FooDataWriter::lookup_instance
virtual DDS_InstanceHandle_t DDSKeyedOctetsDataWriter::lookup_instance ( const char *  key)
virtual

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

See Also
FooDataWriter::lookup_instance

RTI Connext C++ API Version 5.1.0 Copyright © Mon Feb 3 2014 Real-Time Innovations, Inc