RTI Connext .Net APIs  Version 6.0.1
DDS::ChannelSettings_t Class Reference

Type used to configure the properties of a channel. More...

#include <managed_infrastructure.h>

Public Attributes

TransportMulticastSettingsSeqmulticast_settings
 A sequence of DDS::TransportMulticastSettings_t used to configure the multicast addresses associated with a channel. More...
 
System::String ^ filter_expression
 A logical expression used to determine the data that will be published in the channel. More...
 
System::Int32 priority
 Publication priority. More...
 

Detailed Description

Type used to configure the properties of a channel.

QoS:
DDS::MultiChannelQosPolicy

Member Data Documentation

◆ multicast_settings

TransportMulticastSettingsSeq ^ DDS::ChannelSettings_t::multicast_settings

A sequence of DDS::TransportMulticastSettings_t used to configure the multicast addresses associated with a channel.

The sequence cannot be empty.

The maximum number of multicast locators in a channel is limited to 16 (a locator is defined by a transport alias, a multicast address and a port). Note that this is a hard limit that cannot be increased. However, this limit can be decreased by configuring the 'dds.domain_participant.max_announced_locator_list_size' property in the DDS::PropertyQosPolicy associated with the DDS::DomainParticipantQos.

[default] Empty sequence (invalid value)

◆ filter_expression

System::String ^ DDS::ChannelSettings_t::filter_expression

A logical expression used to determine the data that will be published in the channel.

If the expression evaluates to TRUE, a sample will be published on the channel.

An empty string always evaluates the expression to TRUE.

A NULL value is not allowed.

The syntax of the expression will depend on the value of DDS::MultiChannelQosPolicy::filter_name

The filter expression length (including NULL-terminated character) cannot be greater than DDS::DomainParticipantResourceLimitsQosPolicy::channel_filter_expression_max_length.

See also
Queries and Filters Syntax

[default] NULL (invalid value)

◆ priority

System::Int32 DDS::ChannelSettings_t::priority

Publication priority.

A positive integer value designating the relative priority of the channel, used to determine the transmission order of pending writes.

Use of publication priorities requires the asynchronous publisher (DDS::PublishModeQosPolicyKind::ASYNCHRONOUS_PUBLISH_MODE_QOS) with DDS::FlowControllerProperty_t::scheduling_policy set to DDS_HPF_FLOW_CONTROLLER_SCHED_POLICY.

Larger numbers have higher priority.

If the publication priority of the channel is any value other than DDS::PublicationPriority::UNDEFINED, then the channel's priority will take precedence over the data writer's priority.

If the publication priority of the channel is set to DDS::PublicationPriority::UNDEFINED, then the channel's priority will be set to the value of the data writer's priority.

If the publicaton priority of both the data writer and the channel are DDS::PublicationPriority::UNDEFINED, the channel will be assigned the lowest priority value.

If the publication priority of the channel is DDS::PublicationPriority::AUTOMATIC, then the channel will be assigned the priority of the largest publication priority of all samples in the channel. The publication priority of each sample can be set in the DDS::WriteParams_t of the DDS::TypedDataWriter::write_w_params function.

[default] DDS::PublicationPriority::UNDEFINED


RTI Connext .Net APIs Version 6.0.1 Copyright © Sat Nov 23 2019 Real-Time Innovations, Inc