RTI Connext Traditional C++ API  Version 6.0.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
DDSOctetsDataWriter Class Reference

<<interface>> Instantiates DataWriter < DDS_Octets >. More...

Inheritance diagram for DDSOctetsDataWriter:
DDSDataWriter DDSDomainEntity DDSEntity

Public Member Functions

virtual DDS_Octetscreate_data (const DDS_TypeAllocationParams_t &alloc_params)
 Creates an octet data sequence.
 
virtual DDS_Boolean delete_data (DDS_Octets *sample, const DDS_TypeDeallocationParams_t &dealloc_params)
 Destroys a octet data sequence created by DDSOctetsDataWriter::create_data.
 
virtual DDS_ReturnCode_t write (const DDS_Octets &instance_data, const DDS_InstanceHandle_t &handle)
 Modifies the value of a DDS_Octets data instance.
 
virtual DDS_ReturnCode_t write (const unsigned char *octets, int length, const DDS_InstanceHandle_t &handle)
 <<extension>> Modifies the value of a DDS_Octets data instance.
 
virtual DDS_ReturnCode_t write (const DDS_OctetSeq &octets, const DDS_InstanceHandle_t &handle)
 <<extension>> Modifies the value of a DDS_Octets data instance.
 
virtual DDS_ReturnCode_t write_w_timestamp (const DDS_Octets &instance_data, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
 Performs the same function as DDSOctetsDataWriter::write except that it also provides the value for the source_timestamp.
 
virtual DDS_ReturnCode_t write_w_timestamp (const unsigned char *octets, int length, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
 <<extension>> Performs the same function as DDSOctetsDataWriter::write except that it also provides the value for the source_timestamp.
 
virtual DDS_ReturnCode_t write_w_timestamp (const DDS_OctetSeq &octets, const DDS_InstanceHandle_t &handle, const DDS_Time_t &source_timestamp)
 <<extension>> Performs the same function as DDSOctetsDataWriter::write except that it also provides the value for the source_timestamp.
 
virtual DDS_ReturnCode_t write_w_params (const DDS_Octets &instance_data, DDS_WriteParams_t &params)
 Performs the same function as DDSOctetsDataWriter::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 unsigned char *octets, int length, DDS_WriteParams_t &params)
 <<extension>> Performs the same function as DDSOctetsDataWriter::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 DDS_OctetSeq &octets, DDS_WriteParams_t &params)
 <<extension>> Performs the same function as DDSOctetsDataWriter::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 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 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 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 DDSOctetsDataWriternarrow (DDSDataWriter *writer)
 Narrow the given DDSDataWriter pointer to a DDSOctetsDataWriter pointer.
 

Detailed Description

<<interface>> Instantiates DataWriter < DDS_Octets >.

See Also
FooDataWriter
DDSDataWriter

Member Function Documentation

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

Narrow the given DDSDataWriter pointer to a DDSOctetsDataWriter pointer.

See Also
FooDataWriter::narrow
virtual DDS_Octets* DDSOctetsDataWriter::create_data ( const DDS_TypeAllocationParams_t alloc_params)
virtual

Creates an octet data sequence.

The size of the instance is determined by the DataWriter property dds.builtin_type.octets.alloc_size.

Default size: dds.builtin_type.octets.max_size property of DomainParticipant if defined. Otherwise 2048.

Created instances must be deleted with DDSOctetsDataWriter::delete_data.

Returns
Newly created octet sequence data, or NULL on failure.
See Also
BuiltinTypeMemoryManagement section of Built-in Types.
virtual DDS_Boolean DDSOctetsDataWriter::delete_data ( DDS_Octets sample,
const DDS_TypeDeallocationParams_t dealloc_params 
)
virtual

Destroys a octet data sequence created by DDSOctetsDataWriter::create_data.

Returns
DDS_BOOLEAN_TRUE upon successful deletion.
virtual DDS_ReturnCode_t DDSOctetsDataWriter::write ( const DDS_Octets instance_data,
const DDS_InstanceHandle_t handle 
)
virtual

Modifies the value of a DDS_Octets data instance.

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

<<extension>> Modifies the value of a DDS_Octets data instance.

Parameters
octets<<in>> Array of octets to be published.
length<<in>> Number of octets to be published.
handle<<in>> The special value DDS_HANDLE_NIL should be used always.
See Also
FooDataWriter::write
virtual DDS_ReturnCode_t DDSOctetsDataWriter::write ( const DDS_OctetSeq octets,
const DDS_InstanceHandle_t handle 
)
virtual

<<extension>> Modifies the value of a DDS_Octets data instance.

Parameters
octets<<in>> Sequence of octets to be published.
handle<<in>> The special value DDS_HANDLE_NIL should be used always.
See Also
FooDataWriter::write
virtual DDS_ReturnCode_t DDSOctetsDataWriter::write_w_timestamp ( const DDS_Octets instance_data,
const DDS_InstanceHandle_t handle,
const DDS_Time_t source_timestamp 
)
virtual

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

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

<<extension>> Performs the same function as DDSOctetsDataWriter::write except that it also provides the value for the source_timestamp.

Parameters
octets<<in>> Array of octets to be published.
length<<in>> Number of octets to be published.
handle<<in>> The special value DDS_HANDLE_NIL should be used always.
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_w_timestamp
virtual DDS_ReturnCode_t DDSOctetsDataWriter::write_w_timestamp ( const DDS_OctetSeq octets,
const DDS_InstanceHandle_t handle,
const DDS_Time_t source_timestamp 
)
virtual

<<extension>> Performs the same function as DDSOctetsDataWriter::write except that it also provides the value for the source_timestamp.

Parameters
octets<<in>> Sequence of octets to be published.
handle<<in>> The special value DDS_HANDLE_NIL should be used always.
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_w_timestamp
virtual DDS_ReturnCode_t DDSOctetsDataWriter::write_w_params ( const DDS_Octets instance_data,
DDS_WriteParams_t params 
)
virtual

Performs the same function as DDSOctetsDataWriter::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 DDSOctetsDataWriter::write_w_params ( const unsigned char *  octets,
int  length,
DDS_WriteParams_t params 
)
virtual

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

Parameters
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 DDSOctetsDataWriter::write_w_params ( const DDS_OctetSeq octets,
DDS_WriteParams_t params 
)
virtual

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

Parameters
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

RTI Connext Traditional C++ API Version 6.0.1 Copyright © Sat Nov 23 2019 Real-Time Innovations, Inc