DDSStringDataWriter Class Reference

<<interface>> Instantiates DataWriter < char* >. More...

Inheritance diagram for DDSStringDataWriter:

Public Member Functions
virtual char *	create_data (const DDS_TypeAllocationParams_t &alloc_params)
	Creates a string data instance.
virtual DDS_Boolean	delete_data (char *sample, const DDS_TypeDeallocationParams_t &dealloc_params)
	Destroys a string data instance created by DDSStringDataWriter::create_data.
virtual DDS_ReturnCode_t	write (const char *instance_data, const DDS_InstanceHandle_t &handle)
	Modifies the value of a string data instance.
virtual DDS_ReturnCode_t	write_w_timestamp (const char *instance_data, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
	Performs the same function as DDSStringDataWriter::write except that it also provides the value for the source_timestamp.
virtual DDS_ReturnCode_t	write_w_params (const char *instance_data, DDS_WriteParams_t &params)
	Performs the same function as DDSStringDataWriter::write except that it also allows specification of the instance handle, source timestamp, publication priority, and cookie.
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_service_request_accepted_status (DDS_ServiceRequestAcceptedStatus &status)
	Accesses the DDS_SERVICE_REQUEST_ACCEPTED_STATUS communication status.
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 DDSTopic *	get_topic ()
	This operation returns the DDSTopic associated with the DDSDataWriter.
virtual DDSPublisher *	get_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	is_sample_app_acknowledged (DDS_Boolean &is_app_ack, const struct DDS_SampleIdentity_t &identity)
	This method can be used to see if a sample has been application acknowledged.
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 DDSDataWriterListener *	get_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 DDSStatusCondition *	get_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 DDSStringDataWriter *	narrow (DDSDataWriter *writer)
	Narrow the given DDSDataWriter pointer to a DDSStringDataWriter pointer.

Detailed Description

<<interface>> Instantiates DataWriter < char* >.

See Also

FooDataWriter

DDSDataWriter

String Support

Member Function Documentation

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

static

Narrow the given DDSDataWriter pointer to a DDSStringDataWriter pointer.

See Also

FooDataWriter::narrow

virtual char* DDSStringDataWriter::create_data ( const DDS_TypeAllocationParams_t &  alloc_params )

virtual

Creates a string data instance.

The size of the instance including the NULL terminated character is determined by the DataWriter property dds.builtin_type.string.alloc_size.

Default size: dds.builtin_type.string.max_size property of DomainParticipant if defined. Otherwise 1024.

Created instances must be deleted with DDSStringDataWriter::delete_data.

Returns

Newly created string data, or NULL on failure.

See Also

BuiltinTypeMemoryManagement section of Built-in Types

virtual DDS_Boolean DDSStringDataWriter::delete_data ( char *  sample, const DDS_TypeDeallocationParams_t &  dealloc_params  )

virtual

Destroys a string data instance created by DDSStringDataWriter::create_data.

Returns

DDS_BOOLEAN_TRUE upon successful deletion.

virtual DDS_ReturnCode_t DDSStringDataWriter::write ( const char *  instance_data, const DDS_InstanceHandle_t &  handle  )

virtual

Modifies the value of a string data instance.

See Also

FooDataWriter::write

virtual DDS_ReturnCode_t DDSStringDataWriter::write_w_timestamp ( const char *  instance_data, const DDS_InstanceHandle_t &  handle, const DDS_Time_t &  source_timestamp  )

virtual

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

See Also

FooDataWriter::write_w_timestamp

virtual DDS_ReturnCode_t DDSStringDataWriter::write_w_params ( const char *  instance_data, DDS_WriteParams_t &  params  )

virtual

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

See Also

FooDataWriter::write_w_params