The purpose of this QoS is to allow the application to attach additional information to the created Entity objects such that when a remote application discovers their existence it can access that information and use it for its own purposes. More...

Public Member Functions
	UserData ()
	Create a `UserData` instance with an empty user data.

	UserData (const dds::core::ByteSeq &seq)
	Create a `UserData` instance. More...

UserData &	value (const dds::core::ByteSeq &seq)
	Set the value for the user data. More...

template<typename OCTET_ITER >
UserData &	value (OCTET_ITER begin, OCTET_ITER end)
	Set the value for the user data.

const dds::core::ByteSeq	value () const
	Get the user data. More...

Detailed Description

The purpose of this QoS is to allow the application to attach additional information to the created Entity objects such that when a remote application discovers their existence it can access that information and use it for its own purposes.

One possible use of this QoS is to attach security credentials or some other information that can be used by the remote application to authenticate the source. In combination with operations such as ignore_participant, ignore_publication, ignore_subscription, and ignore_topic these QoS can assist an application to define and enforce its own security policies. The use of this QoS is not limited to security, rather it offers a simple, yet flexible extensibility mechanism.

Constructor & Destructor Documentation

◆ UserData()

dds::core::policy::UserData::UserData ( const dds::core::ByteSeq & seq )

explicit

Create a UserData instance.

Parameters

seq	the sequence of octet representing the user data

Member Function Documentation

◆ value() [1/2]

UserData& dds::core::policy::UserData::value ( const dds::core::ByteSeq & seq )

Set the value for the user data.

Parameters

seq	a sequence of bytes representing the user data.

◆ value() [2/2]

const dds::core::ByteSeq dds::core::policy::UserData::value ( ) const

Get the user data.