OpenSplice ISO C++ 2 DCPS  v7.x
ISO C++ 2 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
Public Member Functions | List of all members
org::opensplice::core::policy::WatchdogScheduling Class Reference

This QosPolicy specifies the scheduling parameters that will be used for the Watchdog thread that is spawned by the DomainParticipant. More...

#include "ProprietaryApi.hpp"

Inheritance diagram for org::opensplice::core::policy::WatchdogScheduling:
Inheritance graph

Public Member Functions

 WatchdogScheduling ()
 
 WatchdogScheduling (const org::opensplice::core::policy::SchedulingKind::Type &scheduling_kind, const org::opensplice::core::policy::SchedulingPriorityKind::Type &scheduling_priority_kind, int32_t scheduling_priority)
 
 WatchdogScheduling (const WatchdogScheduling &other)
 
bool operator!= (const Value &other) const
 
D * operator-> ()
 
const D * operator-> () const
 
bool operator== (const Value &other) const
 
Scheduling & scheduling_kind (const org::opensplice::core::policy::SchedulingKind::Type &scheduling_kind)
 
org::opensplice::core::policy::SchedulingKind::Type scheduling_kind () const
 
Scheduling & scheduling_kind (const org::opensplice::core::policy::SchedulingPriorityKind::Type &scheduling_priority_kind)
 
Scheduling & scheduling_priority (int32_t scheduling_priority)
 
int32_t scheduling_priority () const
 
org::opensplice::core::policy::SchedulingPriorityKind::Type scheduling_priority_kind () const
 

Detailed Description

This QosPolicy specifies the scheduling parameters that will be used for the Watchdog thread that is spawned by the DomainParticipant.

See also
org::opensplice::core::policy::Scheduling for scheduling information.

Definition at line 1139 of file ProprietaryApi.hpp.

Constructor & Destructor Documentation

◆ WatchdogScheduling() [1/3]

org::opensplice::core::policy::WatchdogScheduling::WatchdogScheduling ( )

Creates a WatchdogScheduling QoS instance

◆ WatchdogScheduling() [2/3]

org::opensplice::core::policy::WatchdogScheduling::WatchdogScheduling ( const org::opensplice::core::policy::SchedulingKind::Type &  scheduling_kind,
const org::opensplice::core::policy::SchedulingPriorityKind::Type &  scheduling_priority_kind,
int32_t  scheduling_priority 
)
explicit

Creates a WatchdogScheduling QoS instance

Parameters
scheduling_kindSpecifies the scheduling class used by the Operating System, which may be SCHEDULE_DEFAULT, SCHEDULE_TIMESHARING or SCHEDULE_REALTIME. Threads can only be spawned within the scheduling classes that are supported by the underlying Operating System.
scheduling_priority_kindSpecifies the priority type, which may be either PRIORITY_RELATIVE or PRIORITY_ABSOLUTE.
scheduling_prioritySpecifies the priority that will be assigned to threads spawned by the DomainParticipant. Threads can only be spawned with priorities that are supported by the underlying Operating System.

◆ WatchdogScheduling() [3/3]

org::opensplice::core::policy::WatchdogScheduling::WatchdogScheduling ( const WatchdogScheduling &  other)

Copies a WatchdogScheduling QoS instance

Parameters
otherthe WatchdogScheduling QoS instance to copy

Member Function Documentation

◆ operator!=()

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

Compare this Value with another Value

Parameters
otherValue
Returns
true if not equal

Definition at line 99 of file Value.hpp.

◆ 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.

Definition at line 111 of file Value.hpp.

◆ 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.

Definition at line 105 of file Value.hpp.

◆ operator==()

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

Compare this Value with another Value

Parameters
otherValue
Returns
true if equal

Definition at line 93 of file Value.hpp.

◆ scheduling_kind() [1/3]

Scheduling& org::opensplice::core::policy::Scheduling::scheduling_kind ( const org::opensplice::core::policy::SchedulingKind::Type &  scheduling_kind)
inherited

Sets the scheduling kind

Parameters
scheduling_kindthe scheduling_kind

◆ scheduling_kind() [2/3]

org::opensplice::core::policy::SchedulingKind::Type org::opensplice::core::policy::Scheduling::scheduling_kind ( ) const
inherited

Gets the scheduling kind

Returns
the scheduling_kind

◆ scheduling_kind() [3/3]

Scheduling& org::opensplice::core::policy::Scheduling::scheduling_kind ( const org::opensplice::core::policy::SchedulingPriorityKind::Type &  scheduling_priority_kind)
inherited

Sets the scheduling priority kind

Parameters
scheduling_priority_kindthe scheduling_priority_kind

◆ scheduling_priority() [1/2]

Scheduling& org::opensplice::core::policy::Scheduling::scheduling_priority ( int32_t  scheduling_priority)
inherited

Sets the scheduling priority

Parameters
scheduling_prioritythe scheduling_priority

◆ scheduling_priority() [2/2]

int32_t org::opensplice::core::policy::Scheduling::scheduling_priority ( ) const
inherited

Gets the scheduling priority

Returns
the scheduling_priority

◆ scheduling_priority_kind()

org::opensplice::core::policy::SchedulingPriorityKind::Type org::opensplice::core::policy::Scheduling::scheduling_priority_kind ( ) const
inherited

Gets the scheduling priority kind

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