RTI Connext Modern C++ API Version 7.7.0
rti::core::policy::DiscoveryConfigBuiltinChannelKindMask Class Reference

<<extension>> A mask that selects the built-in channels to be used More...

#include <PolicyKind.hpp>

Inherits std::bitset< 16 >.

Public Types

typedef std::bitset< 16 > MaskType
 The base type, std::bitset. More...
 

Public Member Functions

 DiscoveryConfigBuiltinChannelKindMask ()=default
 Creates an empty mask. More...
 
 DiscoveryConfigBuiltinChannelKindMask (uint64_t mask)
 Creates a mask from the bits in an integer. More...
 
 DiscoveryConfigBuiltinChannelKindMask (const MaskType &mask)
 Creates a mask from a std::bitset. More...
 

Static Public Member Functions

static DiscoveryConfigBuiltinChannelKindMask all ()
 All the bits are set, indicating that all channels are enabled. More...
 
static DiscoveryConfigBuiltinChannelKindMask none ()
 No bits are set, indicating that all channels are disabled. More...
 
static DiscoveryConfigBuiltinChannelKindMask service_request ()
 Set the bits to enable the service request channel (which is the default setting). More...
 
static DiscoveryConfigBuiltinChannelKindMask type_lookup_service ()
 Set the bits to enable the typelookup service channel. More...
 
static DiscoveryConfigBuiltinChannelKindMask type_lookup_service_request ()
 Set the bits to enable the typelookup service request channel. More...
 
static DiscoveryConfigBuiltinChannelKindMask type_lookup_service_reply ()
 Set the bits to enable the typelookup service reply channel. More...
 

Detailed Description

<<extension>> A mask that selects the built-in channels to be used

Member Typedef Documentation

◆ MaskType

The base type, std::bitset.

Constructor & Destructor Documentation

◆ DiscoveryConfigBuiltinChannelKindMask() [1/3]

rti::core::policy::DiscoveryConfigBuiltinChannelKindMask::DiscoveryConfigBuiltinChannelKindMask ( )
default

◆ DiscoveryConfigBuiltinChannelKindMask() [2/3]

rti::core::policy::DiscoveryConfigBuiltinChannelKindMask::DiscoveryConfigBuiltinChannelKindMask ( uint64_t  mask)
inlineexplicit

Creates a mask from the bits in an integer.

◆ DiscoveryConfigBuiltinChannelKindMask() [3/3]

rti::core::policy::DiscoveryConfigBuiltinChannelKindMask::DiscoveryConfigBuiltinChannelKindMask ( const MaskType &  mask)
inlineexplicit

Creates a mask from a std::bitset.

Member Function Documentation

◆ service_request()

static DiscoveryConfigBuiltinChannelKindMask rti::core::policy::DiscoveryConfigBuiltinChannelKindMask::service_request ( )
inlinestatic

Set the bits to enable the service request channel (which is the default setting).

Enables the ServiceRequest channel, which is required by the TopicQuery and locator reachability features. Disabling the ServiceRequest channel reduces resource consumption including network bandwidth, CPU utilization, and memory.

References DiscoveryConfigBuiltinChannelKindMask().

◆ type_lookup_service()

static DiscoveryConfigBuiltinChannelKindMask rti::core::policy::DiscoveryConfigBuiltinChannelKindMask::type_lookup_service ( )
inlinestatic

Set the bits to enable the typelookup service channel.

Enables both the Type Lookup Service Request channel and Type Lookup Service Reply channel.

References DiscoveryConfigBuiltinChannelKindMask().

◆ type_lookup_service_request()

static DiscoveryConfigBuiltinChannelKindMask rti::core::policy::DiscoveryConfigBuiltinChannelKindMask::type_lookup_service_request ( )
inlinestatic

Set the bits to enable the typelookup service request channel.

Enables the Type Lookup Service Request channel.

References DiscoveryConfigBuiltinChannelKindMask().

◆ type_lookup_service_reply()

static DiscoveryConfigBuiltinChannelKindMask rti::core::policy::DiscoveryConfigBuiltinChannelKindMask::type_lookup_service_reply ( )
inlinestatic

Set the bits to enable the typelookup service reply channel.

Enables the Type Lookup Service Reply channel.

References DiscoveryConfigBuiltinChannelKindMask().