dds::core::policy::TUserData< D > Class Template Reference

#include <TCorePolicy.hpp>

Inheritance diagram for dds::core::policy::TUserData< D >:

Public Member Functions
TUserData()	TUserData (const dds::core::ByteSeq &seq)
	TUserData (const uint8_t *value_begin, const uint8_t *value_end)
	TUserData (const TUserData &other)
const uint8_t *	begin () const
const uint8_t *	end () const
TUserData &	value (const dds::core::ByteSeq &seq)
template<typename OCTET_ITER >
TUserData &	value (OCTET_ITER begin, OCTET_ITER end)
const dds::core::ByteSeq	value () const
Public Member Functions inherited from dds::core::Value< D >
template<typename ARG >
	Value (const ARG &arg)
template<typename ARG1 , typename ARG2 >
	Value (const ARG1 &arg1, const ARG2 &arg2)
template<typename ARG1 , typename ARG2 , typename ARG3 >
	Value (const ARG1 &arg1, const ARG2 &arg2, const ARG3 &arg3)
template<typename ARG1 , typename ARG2 , typename ARG3 , typename ARG4 >
	Value (const ARG1 &arg1, const ARG2 &arg2, const ARG3 &arg3, const ARG4 &arg4)
template<typename ARG1 , typename ARG2 , typename ARG3 , typename ARG4 , typename ARG5 >
	Value (const ARG1 &arg1, const ARG2 &arg2, const ARG3 &arg3, const ARG4 &arg4, const ARG5 &arg5)
template<typename ARG1 , typename ARG2 , typename ARG3 , typename ARG4 , typename ARG5 , typename ARG6 >
	Value (const ARG1 &arg1, const ARG2 &arg2, const ARG3 &arg3, const ARG4 &arg4, const ARG5 &arg5, const ARG6 &arg6)
	~Value ()
const D &	delegate () const
D &	delegate ()
	operator const D & () const
	operator D & ()
bool	operator!= (const Value &other) const
const D *	operator-> () const
D *	operator-> ()
Value &	operator= (const Value &other)
bool	operator== (const Value &other) const

Additional Inherited Members
Protected Member Functions inherited from dds::core::Value< D >
	Value ()
	Value (const Value &p)
Protected Attributes inherited from dds::core::Value< D >
D	d_

Detailed Description

template<typename D>
class dds::core::policy::TUserData< D >

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.

Definition at line 45 of file TCorePolicy.hpp.

Constructor & Destructor Documentation

template<typename D >

TUserData () dds::core::policy::TUserData< D >::TUserData ( const dds::core::ByteSeq &  seq )

explicit

Create a UserData instance with an empty user data. Create a UserData instance.

Parameters

seq	the sequence of octet representing the user data

template<typename D >

dds::core::policy::TUserData< D >::TUserData	(	const uint8_t *	value_begin,
		const uint8_t *	value_end
	)

template<typename D >

dds::core::policy::TUserData< D >::TUserData

(

const TUserData< D > &

other

)

Member Function Documentation

template<typename D >

const uint8_t* dds::core::policy::TUserData< D >::begin

(

)

const

template<typename D >

const uint8_t* dds::core::policy::TUserData< D >::end

(

)

const

template<typename D >

TUserData& dds::core::policy::TUserData< D >::value

(

const dds::core::ByteSeq &

seq

)

Set the value for the user data.

Parameters

seq	a sequence of bytes representing the user data.

template<typename D >

template<typename OCTET_ITER >

TUserData& dds::core::policy::TUserData< D >::value	(	OCTET_ITER	begin,
		OCTET_ITER	end
	)

Set the value for the user data.

template<typename D >

const dds::core::ByteSeq dds::core::policy::TUserData< D >::value

(

)

const

Get the user data.

Returns

the sequence of bytes representing the user data

---

The documentation for this class was generated from the following file:

• src/hpp/dds/core/policy/TCorePolicy.hpp