dds::core::WeakReference< T > Class Template Reference

The WeakReference class enables you to maintain a weak reference to a DDS reference type. More...

#include "WeakReference.hpp"

Public Types
typedef T	ReferenceType

Public Member Functions
	WeakReference ()
	WeakReference (const T &t)
bool	expired ()
T	lock ()

Detailed Description

template<typename T>
class dds::core::WeakReference< T >

The WeakReference class enables you to maintain a weak reference to a DDS reference type.

The existence of a weak link will not prevent the garbage collection of the reference type.

Definition at line 29 of file WeakReference.hpp.

Member Typedef Documentation

ReferenceType

template<typename T >

typedef T dds::core::WeakReference< T >::ReferenceType

Definition at line 44 of file WeakReference.hpp.

Constructor & Destructor Documentation

WeakReference() [1/2]

template<typename T >

dds::core::WeakReference< T >::WeakReference

(

)

Creates a weak reference without an referenced dds object.

Definition at line 42 of file WeakReferenceImpl.hpp.

WeakReference() [2/2]

template<typename T >

dds::core::WeakReference< T >::WeakReference

(

const T &

t

)

Creates a weak reference for the reference type passed as argument.

Template Parameters

t	dds object the new weak reference will refer to

Definition at line 45 of file WeakReferenceImpl.hpp.

Member Function Documentation

expired()

template<typename T >

bool dds::core::WeakReference< T >::expired

(

)

Checks whether the underlying reference has been deleted.

Returns

true if the underlying reference has expired, false otherwise

Definition at line 57 of file WeakReferenceImpl.hpp.

lock()

template<typename T >

T dds::core::WeakReference< T >::lock

(

)

Gives access to the underlying shared reference.

If the reference has expired the returned object will be referencing 'dds::core::null'.

Returns

referenced dds object

Definition at line 63 of file WeakReferenceImpl.hpp.

---

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

• include/dcps/C++/isocpp2/dds/core/WeakReference.hpp
• include/dcps/C++/isocpp2/dds/core/detail/WeakReferenceImpl.hpp