RTI Connext Java API  Version 5.2.0
 All Classes Namespaces Functions Variables Groups Pages
ChannelSettings_t Class Reference

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

Inheritance diagram for ChannelSettings_t:
PublicationPriority

Public Member Functions

 ChannelSettings_t ()
 Constructor.
 
 ChannelSettings_t (ChannelSettings_t src)
 Constructor.
 
 ChannelSettings_t (TransportMulticastSettingsSeq multicast_settings, String filter_expression, int priority)
 Constructor.
 
- Public Member Functions inherited from Struct
abstract boolean equals (Object obj)
 
abstract int hashCode ()
 
String toString ()
 

Public Attributes

TransportMulticastSettingsSeq multicast_settings
 A sequence of com.rti.dds.infrastructure.TransportMulticastSettings_t used to configure the multicast addresses associated with a channel.
 
String filter_expression
 A logical expression used to determine the data that will be published in the channel.
 
int priority = UNDEFINED
 Publication priority.
 

Additional Inherited Members

- Static Public Attributes inherited from PublicationPriority
static final int UNDEFINED = 0
 
static final int AUTOMATIC = -1
 
- Protected Member Functions inherited from Struct
 Struct ()
 
abstract void pull_from_nativeI (long native_status)
 
abstract void push_to_nativeI (long native_status)
 

Detailed Description

Type used to configure the properties of a channel.

QoS:
com.rti.dds.infrastructure.MultiChannelQosPolicy

Constructor & Destructor Documentation

Constructor.

Constructor.

Parameters
src<<in>> Settings used to initialized the new settings.
ChannelSettings_t ( TransportMulticastSettingsSeq  multicast_settings,
String  filter_expression,
int  priority 
)

Constructor.

Parameters
multicast_settings<<in>> Multicast settings.
filter_expression<<in>> Filter expression.

Member Data Documentation

TransportMulticastSettingsSeq multicast_settings
Initial value:
=
new TransportMulticastSettingsSeq()

A sequence of com.rti.dds.infrastructure.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 four (A locator is defined by a transport alias, a multicast address and a port)

[default] Empty sequence (invalid value)

String 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 com.rti.dds.infrastructure.MultiChannelQosPolicy.filter_name

The filter expression length (including NULL-terminated character) cannot be greater than com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.channel_filter_expression_max_length.

See Also
Queries and Filters Syntax

[default] NULL (invalid value)

int priority = UNDEFINED

Publication priority.

A positive integer value designating the relative priority of the com.rti.dds.publication.DataWriter, used to determine the transmission order of pending writes.

Use of publication priorities requires the asynchronous publisher (com.rti.dds.infrastructure.PublishModeQosPolicyKind.PublishModeQosPolicyKind.ASYNCHRONOUS_PUBLISH_MODE_QOS) with com.rti.dds.publication.FlowControllerProperty_t.scheduling_policy set to com.rti.dds.publication.FlowControllerSchedulingPolicy.FlowControllerSchedulingPolicy.HPF_FLOW_CONTROLLER_SCHED_POLICY.

Larger numbers have higher priority.

For multi-channel DataWriters, if the publication priority of any channel is set to any value other than com.rti.dds.infrastructure.PUBLICATION_PRIORITY_UNDEFINED, then the channel's priority will take precedence over that of the DataWriter.

For multi-channel DataWriters, if the publication priority of any channel is com.rti.dds.infrastructure.PUBLICATION_PRIORITY_UNDEFINED, then the channel will inherit the publication priority of the DataWriter.

If the publicaton priority of the DataWriter, and of any channel of a multi-channel DataWriter, are com.rti.dds.infrastructure.PUBLICATION_PRIORITY_UNDEFINED, then the priority of the DataWriter or DataWriter channel will be assigned the lowest priority value.

If the publication priority of the DataWriter is com.rti.dds.infrastructure.PUBLICATION_PRIORITY_AUTOMATIC, then the DataWriter will be assigned the priority of the largest publication priority of all samples in the DataWriter.

The publication priority of each sample can be set in the com.rti.dds.infrastructure.WriteParams_t of the com.rti.ndds.example.FooDataWriter.write_w_params function.

For dispose and unregister samples, use the com.rti.dds.infrastructure.WriteParams_t of com.rti.ndds.example.FooDataWriter.dispose_w_params and com.rti.ndds.example.FooDataWriter.unregister_instance_w_params.

[default] com.rti.dds.infrastructure.PUBLICATION_PRIORITY_UNDEFINED


RTI Connext Java API Version 5.2.0 Copyright © Sun Jun 21 2015 Real-Time Innovations, Inc