dds::core::policy::Liveliness Class Reference

More...

#include "CorePolicy.hpp"

Inherits dds::core::Value< D >.

Public Member Functions
	Liveliness (const Liveliness &other)
	Liveliness (dds::core::policy::LivelinessKind::Type kind=dds::core::policy::LivelinessKind::AUTOMATIC, const dds::core::Duration &lease_duration=dds::core::Duration::infinite())
dds::core::policy::LivelinessKind::Type	kind () const
Liveliness &	kind (dds::core::policy::LivelinessKind::Type kind)
const dds::core::Duration	lease_duration () const
Liveliness &	lease_duration (const dds::core::Duration &lease_duration)
bool	operator!= (const Value &other) const
D *	operator-> ()
const D *	operator-> () const
bool	operator== (const Value &other) const

Static Public Member Functions
static Liveliness	Automatic ()
static Liveliness	ManualByParticipant (const dds::core::Duration &lease_duration=dds::core::Duration::infinite())
static Liveliness	ManualByTopic (const dds::core::Duration &lease_duration=dds::core::Duration::infinite())

Detailed Description

Definition at line 1230 of file CorePolicy.hpp.

Constructor & Destructor Documentation

Liveliness() [1/2]

dds::core::policy::Liveliness::Liveliness	(	dds::core::policy::LivelinessKind::Type	kind = dds::core::policy::LivelinessKind::AUTOMATIC,
		const dds::core::Duration &	lease_duration = dds::core::Duration::infinite()
	)

Creates a Liveliness QoS instance

Parameters

kind	the kind
lease_duration	the lease_duration

Liveliness() [2/2]

dds::core::policy::Liveliness::Liveliness

(

const Liveliness &

other

)

Copies a Liveliness QoS instance

Parameters

other

the Liveliness QoS instance to copy

Member Function Documentation

Automatic()

static Liveliness dds::core::policy::Liveliness::Automatic ( )

static

Returns

a Liveliness QoS instance with the kind set to AUTOMATIC

kind() [1/2]

dds::core::policy::LivelinessKind::Type dds::core::policy::Liveliness::kind

(

)

const

Gets the kind

Returns

the kind

kind() [2/2]

Liveliness& dds::core::policy::Liveliness::kind

(

dds::core::policy::LivelinessKind::Type

kind

)

Sets the kind

Parameters

kind

the kind

lease_duration() [1/2]

const dds::core::Duration dds::core::policy::Liveliness::lease_duration

(

)

const

Gets the lease_duration

Returns

the lease_duration

lease_duration() [2/2]

Liveliness& dds::core::policy::Liveliness::lease_duration

(

const dds::core::Duration &

lease_duration

)

Sets the lease_duration

Returns

the lease_duration

ManualByParticipant()

static Liveliness dds::core::policy::Liveliness::ManualByParticipant ( const dds::core::Duration &  lease_duration = dds::core::Duration::infinite() )

static

Returns

a Liveliness QoS instance with the kind set to MANUAL_BY_PARTICIPANT and the lease_duration set to the supplied value

ManualByTopic()

static Liveliness dds::core::policy::Liveliness::ManualByTopic ( const dds::core::Duration &  lease_duration = dds::core::Duration::infinite() )

static

Returns

a Liveliness QoS instance with the kind set to MANUAL_BY_TOPIC and the lease_duration set to the supplied value

operator!=()

template<typename D >

bool dds::core::Value< D >::operator!= ( const Value< D > &  other ) const

inherited

Compare this Value with another Value

Parameters

other

Value

Returns

true if not equal

operator->() [1/2]

template<typename D >

D* dds::core::Value< D >::operator-> ( )

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();

Returns

a reference to delegate.

operator->() [2/2]

template<typename D >

const D* dds::core::Value< D >::operator-> ( ) const

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();

Returns

a reference to delegate.

operator==()

template<typename D >

bool dds::core::Value< D >::operator== ( const Value< D > &  other ) const

inherited

Compare this Value with another Value

Parameters

other

Value

Returns

true if equal

---

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

• dds/core/policy/CorePolicy.hpp