Subscribers

DDSSubscriber entity and associated elements More...

Classes
struct	DDS_SubscriberQos
	QoS policies supported by a DDSSubscriber entity. More...
class	DDSSubscriberListener
	<<interface>> DDSListener for status about a subscriber. More...
class	DDSSubscriberSeq
	Declares IDL sequence < DDSSubscriber > . More...
class	DDSSubscriber
	<<interface>> A subscriber is the object responsible for actually receiving data from a subscription. More...

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

Variables
const struct DDS_DataReaderQos	DDS_DATAREADER_QOS_DEFAULT
	Special value for creating data reader with default QoS. More...
const struct DDS_DataReaderQos	DDS_DATAREADER_QOS_USE_TOPIC_QOS
	Special value for creating DDSDataReader with a combination of the default DDS_DataReaderQos and the DDS_TopicQos. More...

Detailed Description

DDSSubscriber entity and associated elements

Function Documentation

DDS_SubscriberQos_equals()

DDS_Boolean DDS_SubscriberQos_equals	(	const struct DDS_SubscriberQos *	self,
		const struct DDS_SubscriberQos *	other
	)

Compares two DDS_SubscriberQos for equality.

Parameters

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

Returns

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

Referenced by DDS_SubscriberQos::operator!=(), DDS_SubscriberQos::operator==(), and DDS_DataReaderQos::to_string().

print()

DDS_ReturnCode_t DDS_SubscriberQos::print ( ) const

inline

Prints this DDS_SubscriberQos to stdout.

Only the differences between this DDS_SubscriberQos and the documented default are printed. If you wish to print everything regardless, see DDS_SubscriberQos::to_string(char*, DDS_UnsignedLong&, const DDS_SubscriberQos&, 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_SubscriberQos::to_string ( char *  string, DDS_UnsignedLong &  string_size  ) const

inline

Obtains a string representation of this DDS_SubscriberQos.

Only the differences between this DDS_SubscriberQos and the documented default are printed to the string. If you wish to print everything regardless, see DDS_SubscriberQos::to_string(char*, DDS_UnsignedLong&, const DDS_SubscriberQos&, 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_SubscriberQos is written to the buffer.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_SubscriberQos. 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_SubscriberQos::to_string(char*, DDS_UnsignedLong&, const DDS_SubscriberQos&, const DDS_QosPrintFormat&) const

to_string() [2/6]

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

inline

Obtains a string representation of this DDS_SubscriberQos.

This overload behaves the same as DDS_SubscriberQos::to_string but allows the caller to specify the DDS_SubscriberQos, 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_SubscriberQos. 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_SubscriberQos 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_SubscriberQos::to_string(char*, DDS_UnsignedLong&, const DDS_SubscriberQos&, const DDS_QosPrintFormat&) const

References DDS_QosPrintFormat_INITIALIZER.

to_string() [3/6]

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

inline

Obtains a string representation of this DDS_SubscriberQos.

This overload behaves the same as DDS_SubscriberQos::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_SubscriberQos. 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_SubscriberQos::to_string(char*, DDS_UnsignedLong&, const DDS_SubscriberQos&, const DDS_QosPrintFormat&) const

References DDS_RETCODE_ERROR, and DDS_RETCODE_OK.

to_string() [4/6]

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

inline

Obtains a string representation of this DDS_SubscriberQos.

Only the differences between this DDS_SubscriberQos and the DDS_SubscriberQos 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_SubscriberQos is written to the buffer.

Parameters

string	<<out>> The char buffer that will be used to store the string representation of this DDS_SubscriberQos. 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_SubscriberQos 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_SubscriberQos::to_string ( char *  string, DDS_UnsignedLong &  string_size, const DDS_QosPrintAll_t &    ) const

inline

Obtains a string representation of this DDS_SubscriberQos.

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

For example

SubscriberQos 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_SubscriberQos. 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_SubscriberQos::to_string(char*, DDS_UnsignedLong&, const DDS_SubscriberQos&, const DDS_QosPrintFormat&) const

References DDS_QosPrintFormat_INITIALIZER.

to_string() [6/6]

DDS_ReturnCode_t DDS_SubscriberQos::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_SubscriberQos.

This overload behaves the same as the DDS_SubscriberQos::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_SubscriberQos. 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_SubscriberQos::to_string(char*, DDS_UnsignedLong&, const DDS_SubscriberQos&, const DDS_QosPrintFormat&) const

Variable Documentation

DDS_DATAREADER_QOS_DEFAULT

const struct DDS_DataReaderQos DDS_DATAREADER_QOS_DEFAULT

Special value for creating data reader with default QoS.

When used in DDSSubscriber::create_datareader, this special value is used to indicate that the DDSDataReader should be created with the default DDSDataReader QoS by means of the operation get_default_datareader_qos and using the resulting QoS to create the DDSDataReader.

When used in DDSSubscriber::set_default_datareader_qos, this special value is used to indicate that the default QoS should be reset back to the initial value that would be used if the DDSSubscriber::set_default_datareader_qos operation had never been called.

When used in DDSDataReader::set_qos, this special value is used to indicate that the QoS of the DDSDataReader should be changed to match the current default QoS set in the DDSSubscriber that the DDSDataReader belongs to.

Warning

This value is a constant and should never be modified. You cannot use this value to get the default QoS values for a DataReader; for this purpose, use DDSDomainParticipant::get_default_datareader_qos.

See also

DDSSubscriber::create_datareader

DDSSubscriber::set_default_datareader_qos

DDSDataReader::set_qos

Examples:

HelloWorld_subscriber.cxx.

DDS_DATAREADER_QOS_USE_TOPIC_QOS

const struct DDS_DataReaderQos DDS_DATAREADER_QOS_USE_TOPIC_QOS

Special value for creating DDSDataReader with a combination of the default DDS_DataReaderQos and the DDS_TopicQos.

The use of this value is equivalent to the application obtaining the default DDS_DataReaderQos and the DDS_TopicQos (by means of the operation DDSTopic::get_qos) and then combining these two QoS using the operation DDSSubscriber::copy_from_topic_qos whereby any policy that is set on the DDS_TopicQos "overrides" the corresponding policy on the default QoS. The resulting QoS is then applied to the creation of the DDSDataReader.

This value should only be used in DDSSubscriber::create_datareader.

See also

DDSSubscriber::create_datareader

DDSSubscriber::get_default_datareader_qos

DDSTopic::get_qos

DDSSubscriber::copy_from_topic_qos