Data Writers

DDSDataWriter entity and associated elements More...

Classes
struct	DDS_OfferedDeadlineMissedStatus
	DDS_OFFERED_DEADLINE_MISSED_STATUS More...
struct	DDS_LivelinessLostStatus
	DDS_LIVELINESS_LOST_STATUS More...
struct	DDS_OfferedIncompatibleQosStatus
	DDS_OFFERED_INCOMPATIBLE_QOS_STATUS More...
struct	DDS_PublicationMatchedStatus
	DDS_PUBLICATION_MATCHED_STATUS More...
struct	DDS_ServiceRequestAcceptedStatus
	DDS_SERVICE_REQUEST_ACCEPTED_STATUS More...
struct	DDS_ReliableWriterCacheEventCount
	<<extension>> The number of times the number of unacknowledged samples in the cache of a reliable writer hit a certain well-defined threshold. More...
struct	DDS_ReliableWriterCacheChangedStatus
	<<extension>> A summary of the state of a data writer's cache of unacknowledged samples written. More...
struct	DDS_ReliableReaderActivityChangedStatus
	<<extension>> Describes the activity (i.e. are acknowledgements forthcoming) of reliable readers matched to a reliable writer. More...
struct	DDS_DataWriterCacheStatus
	<<extension>> The status of the DataWriter's cache. Provides information on cache related metrics such as the number of samples and instances in the DataWriter queue. More...
struct	DDS_DataWriterProtocolStatus
	<<extension>> The status of a writer's internal protocol related metrics, like the number of samples pushed, pulled, filtered; and status of wire protocol traffic. More...
struct	DDS_AcknowledgmentInfo
	Information about an application-level acknowledged sample. More...
struct	DDS_DataWriterQos
	QoS policies supported by a DDSDataWriter entity. More...
class	FooDataWriter
	<<interface>> <<generic>> User data type specific data writer. More...
class	DDSDataWriterListener
	<<interface>> DDSListener for writer status. More...
class	DDSDataWriter
	<<interface>> Allows an application to set the value of the data to be published under a given DDSTopic. More...

Functions
DDS_Boolean	DDS_DataWriterQos_equals (const struct DDS_DataWriterQos *self, const struct DDS_DataWriterQos *other)
	Compares two DDS_DataWriterQos for equality. More...
DDS_ReturnCode_t	DDS_DataWriterQos::print () const
	Prints this DDS_DataWriterQos to stdout. More...
DDS_ReturnCode_t	DDS_DataWriterQos::to_string (char *string, DDS_UnsignedLong &string_size) const
	Obtains a string representation of this DDS_DataWriterQos. More...
DDS_ReturnCode_t	DDS_DataWriterQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_DataWriterQos &base) const
	Obtains a string representation of this DDS_DataWriterQos. More...
DDS_ReturnCode_t	DDS_DataWriterQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintFormat &format) const
	Obtains a string representation of this DDS_DataWriterQos. More...
DDS_ReturnCode_t	DDS_DataWriterQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_DataWriterQos &base, const DDS_QosPrintFormat &format) const
	Obtains a string representation of this DDS_DataWriterQos. More...
DDS_ReturnCode_t	DDS_DataWriterQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintAll_t &) const
	Obtains a string representation of this DDS_DataWriterQos. More...
DDS_ReturnCode_t	DDS_DataWriterQos::to_string (char *string, DDS_UnsignedLong &string_size, const DDS_QosPrintAll_t &, const DDS_QosPrintFormat &format) const
	Obtains a string representation of this DDS_DataWriterQos. More...

Detailed Description

DDSDataWriter entity and associated elements

Function Documentation

DDS_DataWriterQos_equals()

DDS_Boolean DDS_DataWriterQos_equals	(	const struct DDS_DataWriterQos *	self,
		const struct DDS_DataWriterQos *	other
	)

Compares two DDS_DataWriterQos for equality.

Parameters

self	<<in>> This DataWriterQos.
other	<<in>> The other DataWriterQos to be compared with this DataWriterQos.

Returns

DDS_BOOLEAN_TRUE if the two Qos objects are equal or DDS_BOOLEAN_FALSE otherwise.

Referenced by DDS_DataWriterQos::operator!=(), and DDS_DataWriterQos::operator==().

print()

DDS_ReturnCode_t DDS_DataWriterQos::print ( ) const

inline

Prints this DDS_DataWriterQos to stdout.

Only the differences between this DDS_DataWriterQos and the documented default are printed. If you wish to print everything regardless, see DDS_DataWriterQos::to_string(char*, DDS_UnsignedLong&, const DDS_DataWriterQos&, const DDS_QosPrintFormat&) const. The output is formatted according to the default values for DDS_QosPrintFormat.

Returns

DDS_RETCODE_OK if no error was encountered.

to_string() [1/6]

DDS_ReturnCode_t DDS_DataWriterQos::to_string ( char *  string, DDS_UnsignedLong &  string_size  ) const

inline

Obtains a string representation of this DDS_DataWriterQos.

Only the differences between this DDS_DataWriterQos and the documented default are printed to the string. If you wish to print everything regardless, see DDS_DataWriterQos::to_string(char*, DDS_UnsignedLong&, const DDS_DataWriterQos&, const DDS_QosPrintFormat&) const. The output is formatted according to the default values for DDS_QosPrintFormat.

If the supplied buffer is NULL, the required length of the string is returned via the string_size parameter.

If the supplied buffer is not NULL, the string representation of the DDS_DataWriterQos is written to the buffer.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_DataWriterQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.

Returns

DDS_RETCODE_OK if no error was encountered.

See also

DDS_DataWriterQos::to_string(char*, DDS_UnsignedLong&, const DDS_DataWriterQos&, const DDS_QosPrintFormat&) const

to_string() [2/6]

DDS_ReturnCode_t DDS_DataWriterQos::to_string ( char *  string, DDS_UnsignedLong &  string_size, const DDS_DataWriterQos &  base  ) const

inline

Obtains a string representation of this DDS_DataWriterQos.

This overload behaves the same as DDS_DataWriterQos::to_string but allows the caller to specify the DDS_DataWriterQos, which is used as the base profile. Only the differences between the QoS and the base profile are included in the output string.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_DataWriterQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.
base	<<in>> The DDS_DataWriterQos to be used as the base QoS profile. Only the differences with respect to this base profile will be included in the output string.

Returns

DDS_RETCODE_OK if no error was encountered.

See also

DDS_DataWriterQos::to_string(char*, DDS_UnsignedLong&, const DDS_DataWriterQos&, const DDS_QosPrintFormat&) const

References DDS_QosPrintFormat_INITIALIZER.

to_string() [3/6]

DDS_ReturnCode_t DDS_DataWriterQos::to_string ( char *  string, DDS_UnsignedLong &  string_size, const DDS_QosPrintFormat &  format  ) const

inline

Obtains a string representation of this DDS_DataWriterQos.

This overload behaves the same as DDS_DataWriterQos::to_string but allows the caller to specify the DDS_QosPrintFormat which is used to format the output.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_DataWriterQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.
format	<<in>> The DDS_QosPrintFormat to be used to format the output string.

Returns

DDS_RETCODE_OK if no error was encountered.

See also

DDS_DataWriterQos::to_string(char*, DDS_UnsignedLong&, const DDS_DataWriterQos&, const DDS_QosPrintFormat&) const

References DDS_RETCODE_ERROR, and DDS_RETCODE_OK.

to_string() [4/6]

DDS_ReturnCode_t DDS_DataWriterQos::to_string ( char *  string, DDS_UnsignedLong &  string_size, const DDS_DataWriterQos &  base, const DDS_QosPrintFormat &  format  ) const

inline

Obtains a string representation of this DDS_DataWriterQos.

Only the differences between this DDS_DataWriterQos and the DDS_DataWriterQos supplied as the base are printed to the string.

If the supplied buffer is NULL, the required length of the string is returned via the string_size parameter.

If the supplied buffer is not NULL, the string representation of the DDS_DataWriterQos is written to the buffer.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_DataWriterQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.
base	<<in>> The DDS_DataWriterQos to be used as the base QoS profile. Only the differences with respect to this base profile will be included in the output string.
format	<<in>> The DDS_QosPrintFormat to be used to format the output string.

Returns

DDS_RETCODE_OK if no error was encountered.

to_string() [5/6]

DDS_ReturnCode_t DDS_DataWriterQos::to_string ( char *  string, DDS_UnsignedLong &  string_size, const DDS_QosPrintAll_t &    ) const

inline

Obtains a string representation of this DDS_DataWriterQos.

This overload behaves the same as DDS_DataWriterQos::to_string but prints the entire DDS_DataWriterQos object. The only valid value for the argument of type DDS_QosPrintAll_t is DDS_QOS_PRINT_ALL.

For example

DataWriterQos qos; 
 
char *str = NULL; 
 
DDS_UnsignedLong str_size = 0; 
 
qos.to_string(str, str_size, QOS_PRINT_ALL); 

The resultant string is formatted according to the default value for DDS_QosPrintFormat.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_DataWriterQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.

Returns

DDS_RETCODE_OK if no error was encountered.

See also

DDS_DataWriterQos::to_string(char*, DDS_UnsignedLong&, const DDS_DataWriterQos&, const DDS_QosPrintFormat&) const

References DDS_QosPrintFormat_INITIALIZER.

to_string() [6/6]

DDS_ReturnCode_t DDS_DataWriterQos::to_string ( char *  string, DDS_UnsignedLong &  string_size, const DDS_QosPrintAll_t &  , const DDS_QosPrintFormat &  format  ) const

inline

Obtains a string representation of this DDS_DataWriterQos.

This overload behaves the same as the DDS_DataWriterQos::to_string(char*, DDS_UnsignedLong&, const DDS_QosPrintAll_t&) const overload. The only difference is that it allows the caller to specify the DDS_QosPrintFormat which is used to format the resultant string.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_DataWriterQos. If NULL, this function will return the required length of this buffer through the string_size parameter.
string_size	<<inout>> Cannot be NULL. The size of the supplied buffer. If the supplied buffer is NULL, or if the supplied buffer is not large enough, this value will be updated with the required length of the buffer.
format	<<in>> The DDS_QosPrintFormat to be used to format the output string.

Returns

DDS_RETCODE_OK if no error was encountered.

See also

DDS_DataWriterQos::to_string(char*, DDS_UnsignedLong&, const DDS_DataWriterQos&, const DDS_QosPrintFormat&) const