RTI Connext Java API v5.0.0

RTI Connext Java API
Version 5.0.0
Generated by Doxygen 1.5.5
Mon Aug 13 09:02:20 2012
Contents
1 RTI Connext
1.1
Feedback and Support for this Release. . . . . . . . . . . . . . . .
1.2
Available Documentation. . . . . . . . . . . . . . . . . . . . . . .
2 Module Index
2.1
Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3 Namespace Index
3.1
Package List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4 Class Index
4.1
Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5 Class Index
5.1
Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6 Module Documentation
5
5
9
9
13
13
21
21
41
6.1
ASYNCHRONOUS PUBLISHER . . . . . . . . . . . . . . . . . .
41
6.2
AVAILABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . .
43
6.3
BATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
44
6.4
Conditions and WaitSets . . . . . . . . . . . . . . . . . . . . . . .
45
6.5
DATABASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
46
6.6
DATA READER PROTOCOL . . . . . . . . . . . . . . . . . . .
47
6.7
DATA READER RESOURCE LIMITS . . . . . . . . . . . . . .
48
6.8
DATA WRITER PROTOCOL . . . . . . . . . . . . . . . . . . .
50
ii
CONTENTS
6.9
DATA WRITER RESOURCE LIMITS . . . . . . . . . . . . . .
51
6.10 DEADLINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
52
6.11 DESTINATION ORDER . . . . . . . . . . . . . . . . . . . . . .
53
6.12 DISCOVERY CONFIG . . . . . . . . . . . . . . . . . . . . . . .
54
6.13 DISCOVERY . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
56
6.14 NDDS DISCOVERY PEERS . . . . . . . . . . . . . . . . . . . .
57
6.15 DOMAIN PARTICIPANT RESOURCE LIMITS . . . . . . . . .
66
6.16 DURABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . .
68
6.17 DURABILITY SERVICE . . . . . . . . . . . . . . . . . . . . . .
69
6.18 Time Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
71
6.19 Entity Support . . . . . . . . . . . . . . . . . . . . . . . . . . . .
72
6.20 ENTITY FACTORY . . . . . . . . . . . . . . . . . . . . . . . . .
73
6.21 ENTITY NAME . . . . . . . . . . . . . . . . . . . . . . . . . . .
74
6.22 EVENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
75
6.23 EXCLUSIVE AREA . . . . . . . . . . . . . . . . . . . . . . . . .
76
6.24 GROUP DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . .
77
6.25 GUID Support . . . . . . . . . . . . . . . . . . . . . . . . . . . .
78
6.26 HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
79
6.27 LATENCY BUDGET . . . . . . . . . . . . . . . . . . . . . . . .
80
6.28 LIFESPAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
81
6.29 LIVELINESS . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
82
6.30 LOCATORFILTER . . . . . . . . . . . . . . . . . . . . . . . . .
83
6.31 LOGGING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
84
6.32 MULTICHANNEL . . . . . . . . . . . . . . . . . . . . . . . . . .
85
6.33 Object Support . . . . . . . . . . . . . . . . . . . . . . . . . . . .
86
6.34 OWNERSHIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
87
6.35 OWNERSHIP STRENGTH . . . . . . . . . . . . . . . . . . . . .
88
6.36 PARTITION . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
89
6.37 PRESENTATION . . . . . . . . . . . . . . . . . . . . . . . . . .
90
6.38 PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
91
6.39 PROPERTY . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
92
Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
CONTENTS
iii
6.40 PUBLISH MODE . . . . . . . . . . . . . . . . . . . . . . . . . .
93
6.41 QoS Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
94
6.42 READER DATA LIFECYCLE . . . . . . . . . . . . . . . . . . . 103

6.43 RECEIVER POOL . . . . . . . . . . . . . . . . . . . . . . . . . . 104
6.44 RELIABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
6.45 RESOURCE LIMITS . . . . . . . . . . . . . . . . . . . . . . . . 106
6.46 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
6.47 Sequence Number Support . . . . . . . . . . . . . . . . . . . . . . 109
6.48 Status Kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
6.49 SYSTEM RESOURCE LIMITS . . . . . . . . . . . . . . . . . . . 115
6.50 Thread Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
6.51 TIME BASED FILTER . . . . . . . . . . . . . . . . . . . . . . . 117
6.52 TOPIC DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
6.53 TRANSPORT BUILTIN . . . . . . . . . . . . . . . . . . . . . . . 119
6.54 TRANSPORT MULTICAST MAPPING . . . . . . . . . . . . . 122
6.55 TRANSPORT MULTICAST . . . . . . . . . . . . . . . . . . . . 123
6.56 TRANSPORT PRIORITY . . . . . . . . . . . . . . . . . . . . . 126
6.57 TRANSPORT SELECTION . . . . . . . . . . . . . . . . . . . . 127
6.58 TRANSPORT UNICAST . . . . . . . . . . . . . . . . . . . . . . 128
6.59 TYPE CONSISTENCY ENFORCEMENT . . . . . . . . . . . . 129
6.60 TYPESUPPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
6.61 USER DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
6.62 Exception Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
6.63 WIRE PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . . . 134
6.64 WRITER DATA LIFECYCLE . . . . . . . . . . . . . . . . . . . 140
6.65 KeyedString Built-in Type . . . . . . . . . . . . . . . . . . . . . . 141
6.66 Octets Built-in Type . . . . . . . . . . . . . . . . . . . . . . . . . 142
6.67 KeyedOctets Built-in Type . . . . . . . . . . . . . . . . . . . . . 143
6.68 Sequence Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
6.69 Clock Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
6.70 Domain Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
iv
CONTENTS
6.71 DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . . 149
6.72 DomainParticipants . . . . . . . . . . . . . . . . . . . . . . . . . 151
6.73 Built-in Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
6.74 Topic Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
6.75 Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
6.76 User Data Type Support . . . . . . . . . . . . . . . . . . . . . . . 164
6.77 Type Code Support . . . . . . . . . . . . . . . . . . . . . . . . . 165
6.78 Built-in Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
6.79 Dynamic Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
6.80 Publication Module . . . . . . . . . . . . . . . . . . . . . . . . . . 180
6.81 Publishers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
6.82 Data Writers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
6.83 Flow Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
6.84 Subscription Module . . . . . . . . . . . . . . . . . . . . . . . . . 192
6.85 Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
6.86 DataReaders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
6.87 Read Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
6.88 Query Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
6.89 Data Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
6.90 Sample States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
6.91 View States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
6.92 Instance States . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
6.93 Infrastructure Module . . . . . . . . . . . . . . . . . . . . . . . . 206
6.94 Built-in Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . 208
6.95 Multi-channel DataWriters
. . . . . . . . . . . . . . . . . . . . . 210
6.96 Pluggable Transports . . . . . . . . . . . . . . . . . . . . . . . . . 213

6.97 Using Transport Plugins . . . . . . . . . . . . . . . . . . . . . . . 219
6.98 Built-in Transport Plugins . . . . . . . . . . . . . . . . . . . . . . 222
6.99 Configuration Utilities . . . . . . . . . . . . . . . . . . . . . . . . 224
6.100Durability and Persistence . . . . . . . . . . . . . . . . . . . . . . 225
6.101System Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 231
CONTENTS
6.102Configuring QoS Profiles with XML . . . . . . . . . . . . . . . . 233

6.103Publication Example . . . . . . . . . . . . . . . . . . . . . . . . . 237
6.104Subscription Example . . . . . . . . . . . . . . . . . . . . . . . . 238
6.105Participant Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 239
6.106Topic Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
6.107FlowController Use Cases . . . . . . . . . . . . . . . . . . . . . . 243
6.108Publisher Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 247
6.109DataWriter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 248
6.110Subscriber Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 250
6.111DataReader Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 253
6.112Entity Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
6.113Waitset Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 261
6.114Transport Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 263
6.115Filter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
6.116Creating Custom Content Filters . . . . . . . . . . . . . . . . . . 271
6.117Large Data Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 275
6.118Documentation Roadmap . . . . . . . . . . . . . . . . . . . . . . 277
6.119Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
6.120DDS API Reference . . . . . . . . . . . . . . . . . . . . . . . . . 280
6.121Queries and Filters Syntax . . . . . . . . . . . . . . . . . . . . . . 286
6.122RTI Connext API Reference . . . . . . . . . . . . . . . . . . . . . 294
6.123Programming How-Tos . . . . . . . . . . . . . . . . . . . . . . . 295
6.124Programming Tools . . . . . . . . . . . . . . . . . . . . . . . . . . 297
6.125rtiddsgen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
6.126rtiddsping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
6.127rtiddsspy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
7 Namespace Documentation
325
7.1
Package com.rti . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
7.2
Package com.rti.dds . . . . . . . . . . . . . . . . . . . . . . . . . 326
7.3
Package com.rti.dds.domain . . . . . . . . . . . . . . . . . . . . . 328
vi
CONTENTS
7.4
Package com.rti.dds.domain.builtin . . . . . . . . . . . . . . . . . 330
7.5
Package com.rti.dds.dynamicdata . . . . . . . . . . . . . . . . . . 331
7.6
Package com.rti.dds.infrastructure . . . . . . . . . . . . . . . . . 334
7.7
Package com.rti.dds.publication . . . . . . . . . . . . . . . . . . . 349
7.8
Package com.rti.dds.publication.builtin . . . . . . . . . . . . . . . 352
7.9
Package com.rti.dds.subscription . . . . . . . . . . . . . . . . . . 353
7.10 Package com.rti.dds.subscription.builtin . . . . . . . . . . . . . . 358

7.11 Package com.rti.dds.topic . . . . . . . . . . . . . . . . . . . . . . 359
7.12 Package com.rti.dds.topic.builtin . . . . . . . . . . . . . . . . . . 361
7.13 Package com.rti.dds.type.builtin . . . . . . . . . . . . . . . . . . . 362
7.14 Package com.rti.dds.typecode . . . . . . . . . . . . . . . . . . . . 368
7.15 Package com.rti.dds.util . . . . . . . . . . . . . . . . . . . . . . . 372
7.16 Package com.rti.ndds . . . . . . . . . . . . . . . . . . . . . . . . . 373
7.17 Package com.rti.ndds.config . . . . . . . . . . . . . . . . . . . . . 374
7.18 Package com.rti.ndds.example . . . . . . . . . . . . . . . . . . . . 375
7.19 Package com.rti.ndds.transport . . . . . . . . . . . . . . . . . . . 376
8 Class Documentation
383
8.1
AbstractBuiltinTopicDataTypeSupport Class Reference . . . . . 383
8.2
AbstractPrimitiveSequence Class Reference . . . . . . . . . . . . 385
8.3
AbstractSequence Class Reference . . . . . . . . . . . . . . . . . 390
8.4
AcknowledgmentInfo Class Reference . . . . . . . . . . . . . . . . 393
8.5
AckResponseData t Class Reference . . . . . . . . . . . . . . . . 394
8.6
AllocationSettings t Class Reference . . . . . . . . . . . . . . . . 395
8.7
AsynchronousPublisherQosPolicy Class Reference . . . . . . . . . 397
8.8
AvailabilityQosPolicy Class Reference . . . . . . . . . . . . . . . 402
8.9
BAD PARAM Class Reference . . . . . . . . . . . . . . . . . . . 407
8.10 BAD TYPECODE Class Reference . . . . . . . . . . . . . . . . . 408

8.11 BadKind Class Reference . . . . . . . . . . . . . . . . . . . . . . 409
8.12 BadMemberId Class Reference . . . . . . . . . . . . . . . . . . . 410
8.13 BadMemberName Class Reference . . . . . . . . . . . . . . . . . 411
CONTENTS
8.14 BatchQosPolicy Class Reference
vii
. . . . . . . . . . . . . . . . . . 412
8.15 BooleanSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 417

8.16 Bounds Class Reference . . . . . . . . . . . . . . . . . . . . . . . 423
8.17 BuiltinTopicKey t Class Reference . . . . . . . . . . . . . . . . . 424
8.18 BuiltinTopicReaderResourceLimits t Class Reference . . . . . . . 426
8.19 Bytes Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 430
8.20 BytesDataReader Class Reference . . . . . . . . . . . . . . . . . . 433
8.21 BytesDataWriter Class Reference . . . . . . . . . . . . . . . . . . 437
8.22 ByteSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 441
8.23 BytesSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 447
8.24 BytesTypeSupport Class Reference . . . . . . . . . . . . . . . . . 450
8.25 ChannelSettings t Class Reference . . . . . . . . . . . . . . . . . 454
8.26 ChannelSettingsSeq Class Reference . . . . . . . . . . . . . . . . 457
8.27 CharSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 458
8.28 Condition Interface Reference . . . . . . . . . . . . . . . . . . . . 464
8.29 ConditionSeq Class Reference . . . . . . . . . . . . . . . . . . . . 465
8.30 ContentFilter Interface Reference . . . . . . . . . . . . . . . . . . 467
8.31 ContentFilteredTopic Interface Reference . . . . . . . . . . . . . 471
8.32 ContentFilterProperty t Class Reference . . . . . . . . . . . . . . 476
8.33 Cookie t Class Reference . . . . . . . . . . . . . . . . . . . . . . . 478
8.34 CookieSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 479
8.35 Copyable Interface Reference . . . . . . . . . . . . . . . . . . . . 480
8.36 DatabaseQosPolicy Class Reference . . . . . . . . . . . . . . . . . 482
8.37 DataReader Interface Reference . . . . . . . . . . . . . . . . . . . 487
8.38 DataReaderAdapter Class Reference . . . . . . . . . . . . . . . . 514
8.39 DataReaderCacheStatus Class Reference . . . . . . . . . . . . . . 517
8.40 DataReaderListener Interface Reference . . . . . . . . . . . . . . 518
8.41 DataReaderProtocolQosPolicy Class Reference . . . . . . . . . . 521
8.42 DataReaderProtocolStatus Class Reference . . . . . . . . . . . . 526
8.43 DataReaderQos Class Reference . . . . . . . . . . . . . . . . . . . 536
8.44 DataReaderResourceLimitsQosPolicy Class Reference . . . . . . 542
viii
CONTENTS
8.45 DataReaderSeq Class Reference . . . . . . . . . . . . . . . . . . . 555

8.46 DataWriter Interface Reference . . . . . . . . . . . . . . . . . . . 557
8.47 DataWriterAdapter Class Reference . . . . . . . . . . . . . . . . 580
8.48 DataWriterCacheStatus Class Reference . . . . . . . . . . . . . . 585
8.49 DataWriterListener Interface Reference
. . . . . . . . . . . . . . 586
8.50 DataWriterProtocolQosPolicy Class Reference . . . . . . . . . . . 592

8.51 DataWriterProtocolStatus Class Reference . . . . . . . . . . . . . 598
8.52 DataWriterQos Class Reference . . . . . . . . . . . . . . . . . . . 610
8.53 DataWriterResourceLimitsInstanceReplacementKind Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
8.54 DataWriterResourceLimitsQosPolicy Class Reference . . . . . . . 621
8.55 DeadlineQosPolicy Class Reference . . . . . . . . . . . . . . . . . 628
8.56 DestinationOrderQosPolicy Class Reference . . . . . . . . . . . . 631
8.57 DestinationOrderQosPolicyKind Class Reference . . . . . . . . . 634
8.58 DiscoveryBuiltinReaderFragmentationResourceLimits t
Class
Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
8.59 DiscoveryConfigBuiltinPluginKind Class Reference . . . . . . . . 638
8.60 DiscoveryConfigQosPolicy Class Reference . . . . . . . . . . . . . 639
8.61 DiscoveryPluginPromiscuityKind Class Reference . . . . . . . . . 648
8.62 DiscoveryQosPolicy Class Reference . . . . . . . . . . . . . . . . 649
8.63 DomainEntity Interface Reference
. . . . . . . . . . . . . . . . . 653
8.64 DomainParticipant Interface Reference . . . . . . . . . . . . . . . 654

8.65 DomainParticipantAdapter Class Reference . . . . . . . . . . . . 736
8.66 DomainParticipantFactory Class Reference . . . . . . . . . . . . 742
8.67 DomainParticipantFactoryQos Class Reference . . . . . . . . . . 769
8.68 DomainParticipantListener Interface Reference . . . . . . . . . . 771
8.69 DomainParticipantQos Class Reference . . . . . . . . . . . . . . . 773
8.70 DomainParticipantResourceLimitsQosPolicy Class Reference . . 778
8.71 DoubleSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 796
8.72 DurabilityQosPolicy Class Reference . . . . . . . . . . . . . . . . 802
8.73 DurabilityQosPolicyKind Class Reference . . . . . . . . . . . . . 807
8.74 DurabilityServiceQosPolicy Class Reference . . . . . . . . . . . . 810
CONTENTS
ix
8.75 Duration t Class Reference . . . . . . . . . . . . . . . . . . . . . 813

8.76 DynamicData Class Reference . . . . . . . . . . . . . . . . . . . . 817
8.77 DynamicDataInfo Class Reference . . . . . . . . . . . . . . . . . 885
8.78 DynamicDataMemberInfo Class Reference . . . . . . . . . . . . . 887
8.79 DynamicDataProperty t Class Reference . . . . . . . . . . . . . . 890
8.80 DynamicDataReader Class Reference . . . . . . . . . . . . . . . . 892
8.81 DynamicDataSeq Class Reference . . . . . . . . . . . . . . . . . . 895
8.82 DynamicDataTypeProperty t Class Reference . . . . . . . . . . . 897
8.83 DynamicDataTypeSerializationProperty t Class Reference . . . . 899
8.84 DynamicDataTypeSupport Class Reference . . . . . . . . . . . . 901
8.85 DynamicDataWriter Class Reference . . . . . . . . . . . . . . . . 907
8.86 EndpointGroup t Class Reference . . . . . . . . . . . . . . . . . . 928
8.87 EndpointGroupSeq Class Reference . . . . . . . . . . . . . . . . . 930
8.88 Entity Interface Reference . . . . . . . . . . . . . . . . . . . . . . 931
8.89 EntityFactoryQosPolicy Class Reference . . . . . . . . . . . . . . 938
8.90 EntityHowTo.MyEntityListener Class Reference . . . . . . . . . . 941
8.91 EntityNameQosPolicy Class Reference . . . . . . . . . . . . . . . 942
8.92 Enum Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 944
8.93 EnumMember Class Reference . . . . . . . . . . . . . . . . . . . 947
8.94 EventQosPolicy Class Reference . . . . . . . . . . . . . . . . . . . 949
8.95 ExclusiveAreaQosPolicy Class Reference . . . . . . . . . . . . . . 952
8.96 ExpressionProperty Class Reference . . . . . . . . . . . . . . . . 955
8.97 ExtensibilityKind Class Reference
. . . . . . . . . . . . . . . . . 956
8.98 FilterSampleInfo Class Reference . . . . . . . . . . . . . . . . . . 957

8.99 FloatSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 958
8.100FlowController Interface Reference . . . . . . . . . . . . . . . . . 964
8.101FlowControllerProperty t Class Reference . . . . . . . . . . . . . 968
8.102FlowControllerSchedulingPolicy Class Reference
. . . . . . . . . 970
8.103FlowControllerTokenBucketProperty t Class Reference . . . . . . 973

8.104Foo Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . 977
8.105FooDataReader Class Reference . . . . . . . . . . . . . . . . . . . 979
CONTENTS
8.106FooDataWriter Class Reference . . . . . . . . . . . . . . . . . . . 1012
8.107FooSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1034
8.108FooTypeSupport Class Reference . . . . . . . . . . . . . . . . . . 1036
8.109GroupDataQosPolicy Class Reference . . . . . . . . . . . . . . . 1039
8.110GuardCondition Class Reference . . . . . . . . . . . . . . . . . . 1041
8.111GUID t Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1044
8.112HistoryQosPolicy Class Reference . . . . . . . . . . . . . . . . . . 1046
8.113HistoryQosPolicyKind Class Reference . . . . . . . . . . . . . . . 1050
8.114InconsistentTopicStatus Class Reference . . . . . . . . . . . . . . 1052
8.115InetAddressSeq Class Reference . . . . . . . . . . . . . . . . . . . 1054
8.116InstanceHandle t Class Reference . . . . . . . . . . . . . . . . . . 1055
8.117InstanceHandleSeq Class Reference . . . . . . . . . . . . . . . . . 1058
8.118InstanceStateKind Class Reference . . . . . . . . . . . . . . . . . 1061
8.119IntSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 1064
8.120KeyedBytes Class Reference . . . . . . . . . . . . . . . . . . . . . 1070
8.121KeyedBytesDataReader Class Reference . . . . . . . . . . . . . . 1073
8.122KeyedBytesDataWriter Class Reference . . . . . . . . . . . . . . 1081
8.123KeyedBytesSeq Class Reference . . . . . . . . . . . . . . . . . . . 1091
8.124KeyedBytesTypeSupport Class Reference . . . . . . . . . . . . . 1094
8.125KeyedString Class Reference
. . . . . . . . . . . . . . . . . . . . 1098
8.126KeyedStringDataReader Class Reference . . . . . . . . . . . . . . 1101

8.127KeyedStringDataWriter Class Reference . . . . . . . . . . . . . . 1109
8.128KeyedStringSeq Class Reference . . . . . . . . . . . . . . . . . . . 1117
8.129KeyedStringTypeSupport Class Reference . . . . . . . . . . . . . 1120
8.130LatencyBudgetQosPolicy Class Reference . . . . . . . . . . . . . 1124
8.131LibraryVersion t Class Reference . . . . . . . . . . . . . . . . . . 1126
8.132LifespanQosPolicy Class Reference . . . . . . . . . . . . . . . . . 1128
8.133Listener Interface Reference . . . . . . . . . . . . . . . . . . . . . 1130
8.134LivelinessChangedStatus Class Reference . . . . . . . . . . . . . . 1135
8.135LivelinessLostStatus Class Reference . . . . . . . . . . . . . . . . 1138
8.136LivelinessQosPolicy Class Reference . . . . . . . . . . . . . . . . 1140
CONTENTS
xi
8.137LivelinessQosPolicyKind Class Reference . . . . . . . . . . . . . . 1144

8.138LoanableSequence Class Reference . . . . . . . . . . . . . . . . . 1146
8.139Locator t Class Reference . . . . . . . . . . . . . . . . . . . . . . 1150
8.140LocatorFilter t Class Reference . . . . . . . . . . . . . . . . . . . 1154
8.141LocatorFilterQosPolicy Class Reference . . . . . . . . . . . . . . 1157
8.142LocatorFilterSeq Class Reference . . . . . . . . . . . . . . . . . . 1159
8.143LocatorSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 1160
8.144LogCategory Class Reference . . . . . . . . . . . . . . . . . . . . 1161
8.145Logger Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 1163
8.146LoggerDevice Interface Reference . . . . . . . . . . . . . . . . . . 1167
8.147LoggingQosPolicy Class Reference . . . . . . . . . . . . . . . . . 1169
8.148LogLevel Class Reference . . . . . . . . . . . . . . . . . . . . . . 1171
8.149LogMessage Class Reference . . . . . . . . . . . . . . . . . . . . . 1173
8.150LogPrintFormat Class Reference . . . . . . . . . . . . . . . . . . 1174
8.151LogVerbosity Class Reference . . . . . . . . . . . . . . . . . . . . 1177
8.152LongDoubleSeq Class Reference . . . . . . . . . . . . . . . . . . . 1179
8.153LongSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1181
8.154MultiChannelQosPolicy Class Reference . . . . . . . . . . . . . . 1187
8.155MultiTopic Interface Reference . . . . . . . . . . . . . . . . . . . 1190
8.156ObjectHolder Class Reference . . . . . . . . . . . . . . . . . . . . 1194
8.157OfferedDeadlineMissedStatus Class Reference . . . . . . . . . . . 1195
8.158OfferedIncompatibleQosStatus Class Reference . . . . . . . . . . 1197
8.159OwnershipQosPolicy Class Reference . . . . . . . . . . . . . . . . 1199
8.160OwnershipQosPolicyKind Class Reference . . . . . . . . . . . . . 1207
8.161OwnershipStrengthQosPolicy Class Reference . . . . . . . . . . . 1209
8.162ParticipantBuiltinTopicData Class Reference . . . . . . . . . . . 1211
8.163ParticipantBuiltinTopicDataDataReader Class Reference . . . . . 1214
8.164ParticipantBuiltinTopicDataSeq Class Reference . . . . . . . . . 1215
8.165ParticipantBuiltinTopicDataTypeSupport Class Reference . . . . 1216
8.166PartitionQosPolicy Class Reference . . . . . . . . . . . . . . . . . 1217
8.167PresentationQosPolicy Class Reference . . . . . . . . . . . . . . . 1221
xii
CONTENTS
8.168PresentationQosPolicyAccessScopeKind Class Reference . . . . . 1226
8.169PRIVATE MEMBER Class Reference . . . . . . . . . . . . . . . 1228
8.170ProductVersion t Class Reference . . . . . . . . . . . . . . . . . . 1229
8.171ProfileQosPolicy Class Reference . . . . . . . . . . . . . . . . . . 1231
8.172Property t Class Reference . . . . . . . . . . . . . . . . . . . . . 1234
8.173PropertyQosPolicy Class Reference . . . . . . . . . . . . . . . . . 1236
8.174PropertyQosPolicyHelper Class Reference . . . . . . . . . . . . . 1239
8.175PropertySeq Class Reference . . . . . . . . . . . . . . . . . . . . 1244
8.176ProtocolVersion t Class Reference . . . . . . . . . . . . . . . . . . 1245
8.177PUBLIC MEMBER Class Reference . . . . . . . . . . . . . . . . 1248
8.178PublicationBuiltinTopicData Class Reference . . . . . . . . . . . 1249
8.179PublicationBuiltinTopicDataDataReader Class Reference . . . . 1256
8.180PublicationBuiltinTopicDataSeq Class Reference . . . . . . . . . 1257
8.181PublicationBuiltinTopicDataTypeSupport Class Reference . . . . 1258
8.182PublicationMatchedStatus Class Reference . . . . . . . . . . . . . 1259
8.183Publisher Interface Reference . . . . . . . . . . . . . . . . . . . . 1262
8.184PublisherAdapter Class Reference
. . . . . . . . . . . . . . . . . 1288
8.185PublisherListener Interface Reference . . . . . . . . . . . . . . . . 1289

8.186PublisherQos Class Reference . . . . . . . . . . . . . . . . . . . . 1290
8.187PublisherSeq Class Reference . . . . . . . . . . . . . . . . . . . . 1293
8.188PublishModeQosPolicy Class Reference . . . . . . . . . . . . . . 1295
8.189PublishModeQosPolicyKind Class Reference . . . . . . . . . . . . 1298
8.190Qos Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . 1300
8.191QosPolicy Class Reference . . . . . . . . . . . . . . . . . . . . . . 1301
8.192QosPolicyCount Class Reference . . . . . . . . . . . . . . . . . . 1302
8.193QosPolicyCountSeq Class Reference . . . . . . . . . . . . . . . . 1304
8.194QosPolicyId t Class Reference . . . . . . . . . . . . . . . . . . . . 1305
8.195QueryCondition Interface Reference . . . . . . . . . . . . . . . . 1311
8.196ReadCondition Interface Reference . . . . . . . . . . . . . . . . . 1313
8.197ReaderDataLifecycleQosPolicy Class Reference . . . . . . . . . . 1315
8.198ReceiverPoolQosPolicy Class Reference . . . . . . . . . . . . . . . 1318
CONTENTS
xiii
8.199RefilterQosPolicyKind Class Reference . . . . . . . . . . . . . . . 1322

8.200ReliabilityQosPolicy Class Reference . . . . . . . . . . . . . . . . 1324
8.201ReliabilityQosPolicyAcknowledgmentModeKind Class Reference . 1329
8.202ReliabilityQosPolicyKind Class Reference . . . . . . . . . . . . . 1331
8.203ReliableReaderActivityChangedStatus Class Reference . . . . . . 1333
8.204ReliableWriterCacheChangedStatus Class Reference . . . . . . . 1336
8.205ReliableWriterCacheEventCount Class Reference . . . . . . . . . 1340
8.206RemoteParticipantPurgeKind Class Reference . . . . . . . . . . . 1341
8.207RequestedDeadlineMissedStatus Class Reference . . . . . . . . . 1344
8.208RequestedIncompatibleQosStatus Class Reference . . . . . . . . . 1346
8.209ResourceLimitsQosPolicy Class Reference . . . . . . . . . . . . . 1348
8.210RETCODE ALREADY DELETED Class Reference . . . . . . . 1354
8.211RETCODE BAD PARAMETER Class Reference . . . . . . . . . 1355
8.212RETCODE ERROR Class Reference . . . . . . . . . . . . . . . . 1356
8.213RETCODE ILLEGAL OPERATION Class Reference . . . . . . 1357
8.214RETCODE IMMUTABLE POLICY Class Reference . . . . . . . 1358
8.215RETCODE INCONSISTENT POLICY Class Reference . . . . . 1359
8.216RETCODE NO DATA Class Reference . . . . . . . . . . . . . . 1360
8.217RETCODE NOT ENABLED Class Reference . . . . . . . . . . . 1361
8.218RETCODE OUT OF RESOURCES Class Reference . . . . . . . 1362
8.219RETCODE PRECONDITION NOT MET Class Reference . . . 1363
8.220RETCODE TIMEOUT Class Reference . . . . . . . . . . . . . . 1364
8.221RETCODE UNSUPPORTED Class Reference . . . . . . . . . . 1365
8.222RtpsReliableReaderProtocol t Class Reference . . . . . . . . . . . 1366
8.223RtpsReliableWriterProtocol t Class Reference . . . . . . . . . . . 1372
8.224RtpsReservedPortKind Class Reference
. . . . . . . . . . . . . . 1388
8.225RtpsWellKnownPorts t Class Reference . . . . . . . . . . . . . . 1390

8.226SampleIdentity t Class Reference . . . . . . . . . . . . . . . . . . 1396
8.227SampleInfo Class Reference . . . . . . . . . . . . . . . . . . . . . 1398
8.228SampleInfoSeq Class Reference . . . . . . . . . . . . . . . . . . . 1409
8.229SampleLostStatus Class Reference . . . . . . . . . . . . . . . . . 1410
xiv
CONTENTS
8.230SampleLostStatusKind Class Reference . . . . . . . . . . . . . . . 1412

8.231SampleRejectedStatus Class Reference . . . . . . . . . . . . . . . 1418
8.232SampleRejectedStatusKind Class Reference . . . . . . . . . . . . 1420
8.233SampleStateKind Class Reference . . . . . . . . . . . . . . . . . . 1426
8.234Sequence Interface Reference . . . . . . . . . . . . . . . . . . . . 1428
8.235SequenceNumber t Class Reference . . . . . . . . . . . . . . . . . 1431
8.236ShmemTransport Interface Reference . . . . . . . . . . . . . . . . 1435
8.237ShmemTransport.Property t Class Reference . . . . . . . . . . . 1439
8.238ShortSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 1442
8.239StatusCondition Interface Reference . . . . . . . . . . . . . . . . 1448
8.240StatusKind Class Reference . . . . . . . . . . . . . . . . . . . . . 1451
8.241StringDataReader Class Reference . . . . . . . . . . . . . . . . . 1462
8.242StringDataWriter Class Reference . . . . . . . . . . . . . . . . . . 1465
8.243StringSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 1467
8.244StringTypeSupport Class Reference . . . . . . . . . . . . . . . . . 1470
8.245StructMember Class Reference . . . . . . . . . . . . . . . . . . . 1474
8.246Subscriber Interface Reference . . . . . . . . . . . . . . . . . . . . 1476
8.247SubscriberAdapter Class Reference . . . . . . . . . . . . . . . . . 1502
8.248SubscriberListener Interface Reference . . . . . . . . . . . . . . . 1503
8.249SubscriberQos Class Reference . . . . . . . . . . . . . . . . . . . 1505
8.250SubscriberSeq Class Reference . . . . . . . . . . . . . . . . . . . . 1507
8.251SubscriptionBuiltinTopicData Class Reference . . . . . . . . . . . 1509
8.252SubscriptionBuiltinTopicDataDataReader Class Reference . . . . 1516
8.253SubscriptionBuiltinTopicDataSeq Class Reference . . . . . . . . . 1517
8.254SubscriptionBuiltinTopicDataTypeSupport Class Reference . . . 1518
8.255SubscriptionMatchedStatus Class Reference . . . . . . . . . . . . 1519
8.256SystemException Class Reference . . . . . . . . . . . . . . . . . . 1522
8.257SystemResourceLimitsQosPolicy Class Reference . . . . . . . . . 1523
8.258TCKind Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1525
8.259ThreadSettings t Class Reference . . . . . . . . . . . . . . . . . . 1530
8.260ThreadSettingsCpuRotationKind Class Reference . . . . . . . . . 1533
CONTENTS
xv
8.261ThreadSettingsKind Class Reference . . . . . . . . . . . . . . . . 1535

8.262Time t Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 1537
8.263TimeBasedFilterQosPolicy Class Reference . . . . . . . . . . . . 1541
8.264Topic Interface Reference . . . . . . . . . . . . . . . . . . . . . . 1545
8.265TopicAdapter Class Reference . . . . . . . . . . . . . . . . . . . . 1550
8.266TopicBuiltinTopicData Class Reference . . . . . . . . . . . . . . . 1552
8.267TopicBuiltinTopicDataDataReader Class Reference . . . . . . . . 1556
8.268TopicBuiltinTopicDataSeq Class Reference . . . . . . . . . . . . . 1557
8.269TopicBuiltinTopicDataTypeSupport Class Reference . . . . . . . 1558
8.270TopicDataQosPolicy Class Reference . . . . . . . . . . . . . . . . 1559
8.271TopicDescription Interface Reference . . . . . . . . . . . . . . . . 1561
8.272TopicListener Interface Reference . . . . . . . . . . . . . . . . . . 1564
8.273TopicQos Class Reference . . . . . . . . . . . . . . . . . . . . . . 1566
8.274Transport Interface Reference . . . . . . . . . . . . . . . . . . . . 1569
8.275Transport.Property t Class Reference . . . . . . . . . . . . . . . . 1570
8.276TransportBuiltinKind Class Reference . . . . . . . . . . . . . . . 1578
8.277TransportBuiltinQosPolicy Class Reference . . . . . . . . . . . . 1580
8.278TransportMulticastMapping t Class Reference . . . . . . . . . . . 1582
8.279TransportMulticastMappingFunction t Class Reference . . . . . . 1585
8.280TransportMulticastMappingQosPolicy Class Reference . . . . . . 1587
8.281TransportMulticastMappingSeq Class Reference . . . . . . . . . . 1589
8.282TransportMulticastQosPolicy Class Reference . . . . . . . . . . . 1590
8.283TransportMulticastQosPolicyKind Class Reference . . . . . . . . 1593
8.284TransportMulticastSettings t Class Reference . . . . . . . . . . . 1594
8.285TransportMulticastSettingsSeq Class Reference . . . . . . . . . . 1597
8.286TransportPriorityQosPolicy Class Reference . . . . . . . . . . . . 1598
8.287TransportSelectionQosPolicy Class Reference . . . . . . . . . . . 1600
8.288TransportSupport Class Reference . . . . . . . . . . . . . . . . . 1602
8.289TransportUnicastQosPolicy Class Reference . . . . . . . . . . . . 1605
8.290TransportUnicastSettings t Class Reference . . . . . . . . . . . . 1608
8.291TransportUnicastSettingsSeq Class Reference . . . . . . . . . . . 1610
xvi
CONTENTS
8.292TypeCode Class Reference . . . . . . . . . . . . . . . . . . . . . . 1611

8.293TypeCodeFactory Class Reference . . . . . . . . . . . . . . . . . 1647
8.294TypeConsistencyEnforcementQosPolicy Class Reference . . . . . 1661
8.295TypeConsistencyKind Class Reference . . . . . . . . . . . . . . . 1663
8.296TypeSupport Interface Reference . . . . . . . . . . . . . . . . . . 1665
8.297TypeSupportQosPolicy Class Reference . . . . . . . . . . . . . . 1666
8.298UDPv4Transport Interface Reference . . . . . . . . . . . . . . . . 1668
8.299UDPv4Transport.Property t Class Reference . . . . . . . . . . . 1672
8.300UDPv6Transport Interface Reference . . . . . . . . . . . . . . . . 1680
8.301UDPv6Transport.Property t Class Reference . . . . . . . . . . . 1684
8.302Union Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 1691
8.303UnionMember Class Reference . . . . . . . . . . . . . . . . . . . 1692
8.304UserDataQosPolicy Class Reference
. . . . . . . . . . . . . . . . 1694
8.305UserException Class Reference . . . . . . . . . . . . . . . . . . . 1696

8.306ValueMember Class Reference . . . . . . . . . . . . . . . . . . . . 1697
8.307VendorId t Class Reference . . . . . . . . . . . . . . . . . . . . . 1699
8.308Version Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1701
8.309ViewStateKind Class Reference . . . . . . . . . . . . . . . . . . . 1703
8.310VM ABSTRACT Class Reference . . . . . . . . . . . . . . . . . . 1705
8.311VM CUSTOM Class Reference . . . . . . . . . . . . . . . . . . . 1706
8.312VM NONE Class Reference . . . . . . . . . . . . . . . . . . . . . 1707
8.313VM TRUNCATABLE Class Reference . . . . . . . . . . . . . . . 1708
8.314WaitSet Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1709
8.315WaitSetProperty t Class Reference . . . . . . . . . . . . . . . . . 1719
8.316WcharSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 1721
8.317WireProtocolQosPolicy Class Reference . . . . . . . . . . . . . . 1723
8.318WireProtocolQosPolicyAutoKind Class Reference . . . . . . . . . 1732
8.319WriteParams t Class Reference . . . . . . . . . . . . . . . . . . . 1733
8.320WriterContentFilter Interface Reference . . . . . . . . . . . . . . 1737
8.321WriterDataLifecycleQosPolicy Class Reference . . . . . . . . . . . 1738
8.322WstringSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 1741
CONTENTS
9 Example Documentation
xvii
1743
9.1
HelloWorld.idl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1743
9.2
HelloWorldDataReader.java . . . . . . . . . . . . . . . . . . . . . 1745
9.3
HelloWorldPublisher.java . . . . . . . . . . . . . . . . . . . . . . 1761
9.4
HelloWorldSeq.java . . . . . . . . . . . . . . . . . . . . . . . . . . 1765
9.5
HelloWorldSubscriber.java . . . . . . . . . . . . . . . . . . . . . . 1770
Chapter 1
RTI Connext
Core Libraries and Utilities
Real-Time Innovations, Inc.
RTI Connext is network middleware for real-time distributed applications. It
provides the communications services that programmers need to distribute timecritical data between embedded and/or enterprise devices or nodes. RTI Connext uses the publish-subscribe communications model to make data distribution efficient and robust.
The RTI Connext Application Programming Interface (API) is based on the
OMGs Data Distribution Service (DDS) specification. The most recent publication of this specification can be found in the Catalog of OMG Specifications
under Middleware Specifications.
1.1
Feedback and Support for this Release.
For more information, visit our knowledge base (accessible from

https://support.rti.com/) to see sample code, general information on
RTI Connext, performance information, troubleshooting tips, and technical
details.
By its very nature, the knowledge base is continuously evolving and improving. We hope that you will find it helpful. If there are questions that
you would like to see addressed or comments you would like to share, please
send e-mail to support@rti.com. We can only guarantee a response for customers with a current maintenance contract or subscription. To purchase a
maintenance contract or subscription, contact your local RTI representative
RTI Connext
(see http://www.rti.com/company/contact.html), send an email request to

sales@rti.com, or call +1 (408) 990-7400.
Please do not hesitate to contact RTI with questions or comments about this
release. We welcome any input on how to improve RTI Connext to suit your
needs.
1.2
Available Documentation.
The documentation for this release is provided in two forms: the HTML API
reference documentation and PDF documents. If you are new to RTI Connext,
the Documentation Roadmap (p. 277) will provide direction on how to learn
about this product.
1.2.1
The PDF documents for the Core Libraries and Utilities are:
Whats New. An overview of the new features in this release.

Release Notes. System requirements, compatibility, whats fixed in this
release, and known issues.
Getting Started Guide. Download and installation instructions. It also
lays out the core value and concepts behind the product and takes you
step-by-step through the creation of a simple example application. Developers should read this document first.
Getting Started Guide, Database Addendum. Additional installation
and setup information for database usage.
Getting Started Guide, Embedded Systems Addendum. Additional installation and setup information for embedded systems.
Users Manual. Introduction to RTI Connext, product tour and conceptual presentation of the functionality of RTI Connext.
Platform Notes. Specific details, such as compilation setting and libraries, related to building and using RTI Connext on the various supported platforms.
QoS Reference Guide. A compact summary of supported Quality of Service (QoS) policies.
1.2 Available Documentation.
XML-Based Application Creation Getting Started Guide. Details

on how to use XML-Based Application Creation, an experimental feature
in this release.
C API Reference Manual. A consolidated PDF version of the HTML C
API reference documentation.
C++ API Reference Manual. A consolidated PDF version of the HTML
C++ API reference documentation.
Java API Reference Manual. A consolidate PDF version of the HTML
Java API reference documentation.
.NET API Reference Manual. A consolidated PDF version of the HTML
.Net API reference documentation.
1.2.2
The HTML API Reference documentation contains:
DDS API Reference (p. 280) - The DDS API reference.

RTI Connext API Reference (p. 294) - RTI Connext APIs independent of the DDS standard.
Programming How-Tos (p. 295) - Describes and shows the common
tasks done using the API.
Programming Tools (p. 297) - RTI Connext helper tools.
The HTML API Reference documentation can be accessed through the tree view
in the left frame of the web browser window. The bulk of the documentation is
found under the entry labeled Modules.
RTI Connext
Chapter 2
Module Index
2.1
Modules
Here is a list of all modules:

Thread Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Documentation Roadmap . . . . . . . . . . . . . . . . . . . . . . . . .
Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DDS API Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Domain Module . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . .
DomainParticipants . . . . . . . . . . . . . . . . . . . . . . . .
Built-in Topics . . . . . . . . . . . . . . . . . . . . . . . . . . .
Topic Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
User Data Type Support . . . . . . . . . . . . . . . . . . . . .
Type Code Support . . . . . . . . . . . . . . . . . . . . . . . .
Built-in Types . . . . . . . . . . . . . . . . . . . . . . . . . . .
KeyedString Built-in Type . . . . . . . . . . . . . . . . . . .
Octets Built-in Type . . . . . . . . . . . . . . . . . . . . . . .
KeyedOctets Built-in Type . . . . . . . . . . . . . . . . . . .
Dynamic Data . . . . . . . . . . . . . . . . . . . . . . . . . . .
Publication Module . . . . . . . . . . . . . . . . . . . . . . . . . .
Publishers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data Writers . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Flow Controllers . . . . . . . . . . . . . . . . . . . . . . . . . .
Subscription Module . . . . . . . . . . . . . . . . . . . . . . . . . .
Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DataReaders . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Read Conditions . . . . . . . . . . . . . . . . . . . . . . . . .
116
277
278
280
147
149
151
157
161
162
164
165
170
141
142
143
175
180
181
184
186
192
195
198
200
Module Index
Query Conditions . . . . . . . . . . . . . . . . . . . . . . . . .
Data Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sample States . . . . . . . . . . . . . . . . . . . . . . . . . . .
View States . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance States . . . . . . . . . . . . . . . . . . . . . . . . . .
Infrastructure Module . . . . . . . . . . . . . . . . . . . . . . . . .
Conditions and WaitSets . . . . . . . . . . . . . . . . . . . . .
Time Support . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Entity Support . . . . . . . . . . . . . . . . . . . . . . . . . . .
GUID Support . . . . . . . . . . . . . . . . . . . . . . . . . . .
Object Support . . . . . . . . . . . . . . . . . . . . . . . . . . .
QoS Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ASYNCHRONOUS PUBLISHER . . . . . . . . . . . . . . .
AVAILABILITY . . . . . . . . . . . . . . . . . . . . . . . . .
BATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DATABASE . . . . . . . . . . . . . . . . . . . . . . . . . . .
DATA READER PROTOCOL . . . . . . . . . . . . . . . . .
DATA READER RESOURCE LIMITS . . . . . . . . . . . .
DATA WRITER PROTOCOL . . . . . . . . . . . . . . . . .
DATA WRITER RESOURCE LIMITS . . . . . . . . . . . .
DEADLINE . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DESTINATION ORDER . . . . . . . . . . . . . . . . . . . .
DISCOVERY CONFIG . . . . . . . . . . . . . . . . . . . . .
DISCOVERY . . . . . . . . . . . . . . . . . . . . . . . . . . .
NDDS DISCOVERY PEERS . . . . . . . . . . . . . . . .
DOMAIN PARTICIPANT RESOURCE LIMITS . . . . . . .
DURABILITY . . . . . . . . . . . . . . . . . . . . . . . . . .
DURABILITY SERVICE . . . . . . . . . . . . . . . . . . . .
ENTITY FACTORY . . . . . . . . . . . . . . . . . . . . . . .
ENTITY NAME . . . . . . . . . . . . . . . . . . . . . . . . .
EVENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EXCLUSIVE AREA . . . . . . . . . . . . . . . . . . . . . . .
GROUP DATA . . . . . . . . . . . . . . . . . . . . . . . . . .
HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LATENCY BUDGET . . . . . . . . . . . . . . . . . . . . . .
LIFESPAN . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LIVELINESS . . . . . . . . . . . . . . . . . . . . . . . . . . .
LOCATORFILTER . . . . . . . . . . . . . . . . . . . . . . .
LOGGING . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MULTICHANNEL . . . . . . . . . . . . . . . . . . . . . . . .
OWNERSHIP . . . . . . . . . . . . . . . . . . . . . . . . . .
OWNERSHIP STRENGTH . . . . . . . . . . . . . . . . . . .
PARTITION . . . . . . . . . . . . . . . . . . . . . . . . . . .
PRESENTATION . . . . . . . . . . . . . . . . . . . . . . . .
PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
201
202
203
204
205
206
45
71
72
78
86
94
41
43
44
46
47
48
50
51
52
53
54
56
57
66
68
69
73
74
75
76
77
79
80
81
82
83
84
85
87
88
89
90
91
2.1 Modules
PROPERTY . . . . . . . . . . . . . . . . . . . . . . . . . . .
PUBLISH MODE . . . . . . . . . . . . . . . . . . . . . . . .
READER DATA LIFECYCLE . . . . . . . . . . . . . . . . .
RECEIVER POOL . . . . . . . . . . . . . . . . . . . . . . .
RELIABILITY . . . . . . . . . . . . . . . . . . . . . . . . . .
RESOURCE LIMITS . . . . . . . . . . . . . . . . . . . . . .
SYSTEM RESOURCE LIMITS . . . . . . . . . . . . . . . .
TIME BASED FILTER . . . . . . . . . . . . . . . . . . . . .
TOPIC DATA . . . . . . . . . . . . . . . . . . . . . . . . . .
TRANSPORT BUILTIN . . . . . . . . . . . . . . . . . . . .
TRANSPORT MULTICAST MAPPING . . . . . . . . . . .
TRANSPORT MULTICAST . . . . . . . . . . . . . . . . . .
TRANSPORT PRIORITY . . . . . . . . . . . . . . . . . . .
TRANSPORT SELECTION . . . . . . . . . . . . . . . . . .
TRANSPORT UNICAST . . . . . . . . . . . . . . . . . . . .
TYPE CONSISTENCY ENFORCEMENT . . . . . . . . . .
TYPESUPPORT . . . . . . . . . . . . . . . . . . . . . . . . .
USER DATA . . . . . . . . . . . . . . . . . . . . . . . . . . .
WIRE PROTOCOL . . . . . . . . . . . . . . . . . . . . . . .
WRITER DATA LIFECYCLE . . . . . . . . . . . . . . . . .
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sequence Number Support . . . . . . . . . . . . . . . . . . . .
Status Kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Exception Codes . . . . . . . . . . . . . . . . . . . . . . . . . .
Sequence Support . . . . . . . . . . . . . . . . . . . . . . . . .
Built-in Sequences . . . . . . . . . . . . . . . . . . . . . . . .
Queries and Filters Syntax . . . . . . . . . . . . . . . . . . . . . .
RTI Connext API Reference . . . . . . . . . . . . . . . . . . . . . . . .
Clock Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Multi-channel DataWriters . . . . . . . . . . . . . . . . . . . . . .
Pluggable Transports . . . . . . . . . . . . . . . . . . . . . . . . .
Using Transport Plugins . . . . . . . . . . . . . . . . . . . . . .
Built-in Transport Plugins . . . . . . . . . . . . . . . . . . . . .
Configuration Utilities . . . . . . . . . . . . . . . . . . . . . . . . .
Durability and Persistence . . . . . . . . . . . . . . . . . . . . . . .
System Properties . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring QoS Profiles with XML . . . . . . . . . . . . . . . . .
Programming How-Tos . . . . . . . . . . . . . . . . . . . . . . . . . .
Publication Example . . . . . . . . . . . . . . . . . . . . . . . . . .
Subscription Example . . . . . . . . . . . . . . . . . . . . . . . . .
Participant Use Cases . . . . . . . . . . . . . . . . . . . . . . . . .
Topic Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FlowController Use Cases . . . . . . . . . . . . . . . . . . . . . . .
Publisher Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . .
DataWriter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . .
7
92
93
103
104
105
106
115
117
118
119
122
123
126
127
128
129
130
132
134
140
107
109
110
133
144
208
286
294
145
210
213
219
222
224
225
231
233
295
237
238
239
241
243
247
248
Module Index
Subscriber Use Cases . . . . . . .
DataReader Use Cases . . . . . .
Entity Use Cases . . . . . . . . .
Waitset Use Cases . . . . . . . .
Transport Use Cases . . . . . . .
Filter Use Cases . . . . . . . . .
Creating Custom Content Filters
Large Data Use Cases . . . . . .
Programming Tools . . . . . . . . .
rtiddsgen . . . . . . . . . . . . .
rtiddsping . . . . . . . . . . . . .
rtiddsspy . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
250
253
257
261
263
265
271
275
297
298
311
318
Chapter 3
Namespace Index
3.1
Package List
Here are the packages with brief descriptions (if available):

com.rti (RTI ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
com.rti.dds (DDS ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
com.rti.dds.domain (Contains the com.rti.dds.domain.DomainParticipant
(p. 654) class that acts as an entrypoint of RTI Connext
and acts as a factory for many of the classes.
The
com.rti.dds.domain.DomainParticipant (p. 654) also
acts as a container for the other objects that make up RTI
Connext ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
com.rti.dds.domain.builtin (Builtin topic (p. 359) for accessing information about the DomainParticipants discovered by RTI
Connext ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
com.rti.dds.dynamicdata (<<eXtension>> ( p. 278) The Dynamic Data API provides a way to interact with arbitrarily
complex data types at runtime without the need for code generation ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331
com.rti.dds.infrastructure (Defines the abstract classes and the interfaces that are refined by the other modules. Contains common definitions such as return codes, status values, and QoS
policies ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
10
Namespace Index
com.rti.dds.publication
(Contains
the
com.rti.dds.publication.FlowController
(p. 964),
com.rti.dds.publication.Publisher
(p. 1262),
and
com.rti.dds.publication.DataWriter
(p. 557)
classes
as
well
as
the
com.rti.dds.publication.PublisherListener
(p. 1289)
and
com.rti.dds.publication.DataWriterListener
(p. 586) interfaces, and more generally, all that is needed on
the publication (p. 349) side ) . . . . . . . . . . . . . . . . .
com.rti.dds.publication.builtin (Builtin topic (p. 359) for accessing information about the Publications discovered by RTI
Connext ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
com.rti.dds.subscription
(Contains
the
com.rti.dds.subscription.Subscriber
(p. 1476),
com.rti.dds.subscription.DataReader
(p. 487),
com.rti.dds.subscription.ReadCondition
(p. 1313),
and
com.rti.dds.subscription.QueryCondition
(p. 1311)
classes,
as
well
as
the
com.rti.dds.subscription.SubscriberListener (p. 1503)
and
com.rti.dds.subscription.DataReaderListener
(p. 518) interfaces, and more generally, all that is needed on
the subscription (p. 353) side ) . . . . . . . . . . . . . . . .
com.rti.dds.subscription.builtin (Builtin topic (p. 359) for accessing information about the Subscriptions discovered by RTI
Connext ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
com.rti.dds.topic
(Contains
the
com.rti.dds.topic.Topic
(p. 1545),
com.rti.dds.topic.ContentFilteredTopic
(p. 471), and com.rti.dds.topic.MultiTopic (p. 1190)
classes, the com.rti.dds.topic.TopicListener (p. 1564)
interface, and more generally, all that is needed by an
application to define com.rti.dds.topic.Topic (p. 1545)
objects and attach QoS policies to them ) . . . . . . . . . . .
com.rti.dds.topic.builtin (Builtin topic (p. 359) for accessing information about the Topics discovered by RTI Connext ) . . . .
com.rti.dds.type.builtin (<<eXtension>> ( p. 278) RTI Connext
provides a set of very simple data types for you to use with
the topics in your application ) . . . . . . . . . . . . . . . . .
com.rti.dds.typecode
(<<eXtension>>
( p. 278)
A
com.rti.dds.typecode.TypeCode ( p. 1611) is a mechanism for representing a type at runtime. RTI Connext
can use type codes to send type definitions on the network.
You will need to understand this API in order to use the
Dynamic Data (p. 175) capability or to inspect the type
information you receive from remote readers and writers ) . .
com.rti.dds.util (Utility types that support the DDS API ) . . . . .
com.rti.ndds (DDS extensions ) . . . . . . . . . . . . . . . . . . . . .
349
352
353
358
359
361
362
368
372
373
3.1 Package List
11
com.rti.ndds.config (Utility APIs independent of the DDS standard )374

com.rti.ndds.example (Programming HowTos: Code templates for
common use cases ) . . . . . . . . . . . . . . . . . . . . . . . . 375
com.rti.ndds.transport (APIs related to RTI Connext pluggable
transports ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
12
Namespace Index
Chapter 4
Class Index
4.1
Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:

AbstractBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . . . .
ParticipantBuiltinTopicDataTypeSupport . . . . . . . . . . . . . .
PublicationBuiltinTopicDataTypeSupport . . . . . . . . . . . . . .
SubscriptionBuiltinTopicDataTypeSupport . . . . . . . . . . . . .
TopicBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . . . .
AcknowledgmentInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AckResponseData t . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AllocationSettings t . . . . . . . . . . . . . . . . . . . . . . . . . . . .
BuiltinTopicReaderResourceLimits t . . . . . . . . . . . . . . . . . . .
ChannelSettings t . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ChannelSettingsSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
StatusCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ReadCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QueryCondition . . . . . . . . . . . . . . . . . . . . . . . . . .
ConditionSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ContentFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WriterContentFilter . . . . . . . . . . . . . . . . . . . . . . . . . .
ContentFilterProperty t . . . . . . . . . . . . . . . . . . . . . . . . . .
Cookie t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CookieSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Copyable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DynamicData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
InstanceHandle t . . . . . . . . . . . . . . . . . . . . . . . . . . . .
383
1216
1258
1518
1558
393
394
395
426
454
457
464
1448
1313
1311
465
467
1737
476
478
479
480
817
1055
14
Class Index
StringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1467
WstringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1741
Time t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1537
WriteParams t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1733
SampleInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1398
BuiltinTopicKey t . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Bytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
BytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
KeyedBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1070
KeyedBytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
KeyedString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1098
KeyedStringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1117
AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . . . 385
BooleanSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
ByteSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
CharSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
WcharSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1721
DoubleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 796
LongDoubleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1179
FloatSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
IntSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1064
LongSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1181
ShortSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1442
Enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
DataWriterResourceLimitsInstanceReplacementKind . . . . . . 617
DestinationOrderQosPolicyKind . . . . . . . . . . . . . . . . . 634
DiscoveryPluginPromiscuityKind . . . . . . . . . . . . . . . . . 648
DurabilityQosPolicyKind . . . . . . . . . . . . . . . . . . . . . 807
HistoryQosPolicyKind . . . . . . . . . . . . . . . . . . . . . . . 1050
LivelinessQosPolicyKind . . . . . . . . . . . . . . . . . . . . . . 1144
OwnershipQosPolicyKind . . . . . . . . . . . . . . . . . . . . . 1207
PresentationQosPolicyAccessScopeKind . . . . . . . . . . . . . 1226
PublishModeQosPolicyKind . . . . . . . . . . . . . . . . . . . . 1298
QosPolicyId t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1305
RefilterQosPolicyKind . . . . . . . . . . . . . . . . . . . . . . . 1322
ReliabilityQosPolicyAcknowledgmentModeKind . . . . . . . . . 1329
ReliabilityQosPolicyKind . . . . . . . . . . . . . . . . . . . . . 1331
RemoteParticipantPurgeKind . . . . . . . . . . . . . . . . . . . 1341
ThreadSettingsCpuRotationKind . . . . . . . . . . . . . . . . . 1533
TransportMulticastQosPolicyKind . . . . . . . . . . . . . . . . 1593
TypeConsistencyKind . . . . . . . . . . . . . . . . . . . . . . . 1663
WireProtocolQosPolicyAutoKind . . . . . . . . . . . . . . . . . 1732
FlowControllerSchedulingPolicy . . . . . . . . . . . . . . . . . . 970
SampleLostStatusKind . . . . . . . . . . . . . . . . . . . . . . . 1412
SampleRejectedStatusKind . . . . . . . . . . . . . . . . . . . . 1420
4.1 Class Hierarchy
15
ExtensibilityKind . . . . . . . . . . . . . . . . . . . . . . . . . . 956
TCKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1525
LogCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1161
LogLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1171
LogPrintFormat . . . . . . . . . . . . . . . . . . . . . . . . . . 1174
LogVerbosity . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1177
Foo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 977
FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034
DataReaderCacheStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 517
DataReaderProtocolStatus . . . . . . . . . . . . . . . . . . . . . . . . 526
DataReaderSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
DataWriterCacheStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 585
DataWriterProtocolStatus . . . . . . . . . . . . . . . . . . . . . . . . . 598
DiscoveryBuiltinReaderFragmentationResourceLimits t . . . . . . . . 636
DiscoveryConfigBuiltinPluginKind . . . . . . . . . . . . . . . . . . . . 638
DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . . . . . 742
Duration t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
DynamicDataInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
DynamicDataMemberInfo . . . . . . . . . . . . . . . . . . . . . . . . . 887
DynamicDataProperty t . . . . . . . . . . . . . . . . . . . . . . . . . . 890
DynamicDataTypeProperty t . . . . . . . . . . . . . . . . . . . . . . . 897
DynamicDataTypeSerializationProperty t . . . . . . . . . . . . . . . . 899
EndpointGroup t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
EndpointGroupSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930
Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
DomainParticipant . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
DomainEntity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
DataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557
DynamicDataWriter . . . . . . . . . . . . . . . . . . . . . . . 907
BytesDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . 437
KeyedBytesDataWriter . . . . . . . . . . . . . . . . . . . . . 1081
KeyedStringDataWriter . . . . . . . . . . . . . . . . . . . . . 1109
StringDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . 1465
FooDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . 1012
Publisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1262
DataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487
DynamicDataReader . . . . . . . . . . . . . . . . . . . . . . . 892
BytesDataReader . . . . . . . . . . . . . . . . . . . . . . . . . 433
KeyedBytesDataReader . . . . . . . . . . . . . . . . . . . . . 1073
KeyedStringDataReader . . . . . . . . . . . . . . . . . . . . . 1101
StringDataReader . . . . . . . . . . . . . . . . . . . . . . . . 1462
FooDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . 979
Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1476
Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1545
EnumMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
16
Class Index
ExpressionProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
FilterSampleInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
FlowController . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964
FlowControllerProperty t . . . . . . . . . . . . . . . . . . . . . . . . . 968
FlowControllerTokenBucketProperty t . . . . . . . . . . . . . . . . . . 973
FooTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1036
GuardCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041
GUID t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1044
InconsistentTopicStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 1052
InetAddressSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1054
InstanceHandleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1058
InstanceStateKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061
LibraryVersion t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1126
Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1130
DataWriterListener . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
DataWriterAdapter . . . . . . . . . . . . . . . . . . . . . . . . 580
PublisherAdapter . . . . . . . . . . . . . . . . . . . . . . . . . 1288
PublisherListener . . . . . . . . . . . . . . . . . . . . . . . . . . 1289
DomainParticipantListener . . . . . . . . . . . . . . . . . . . 771
DomainParticipantAdapter . . . . . . . . . . . . . . . . . 736
PublisherAdapter . . . . . . . . . . . . . . . . . . . . . . . . . 1288
DataReaderListener . . . . . . . . . . . . . . . . . . . . . . . . . . 518
DataReaderAdapter . . . . . . . . . . . . . . . . . . . . . . . . 514
SubscriberAdapter . . . . . . . . . . . . . . . . . . . . . . . . 1502
DomainParticipantAdapter . . . . . . . . . . . . . . . . . 736
SubscriberListener . . . . . . . . . . . . . . . . . . . . . . . . . 1503
DomainParticipantListener . . . . . . . . . . . . . . . . . . . 771
SubscriberAdapter . . . . . . . . . . . . . . . . . . . . . . . . 1502
TopicListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1564
DomainParticipantListener . . . . . . . . . . . . . . . . . . . . 771
TopicAdapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550
EntityHowTo.MyEntityListener . . . . . . . . . . . . . . . . . . . . 941
LivelinessChangedStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 1135
LivelinessLostStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1138
Locator t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1150
LocatorFilter t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1154
LocatorFilterSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1159
LocatorSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1160
Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1163
LoggerDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1167
LogMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1173
ObjectHolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1194
OfferedDeadlineMissedStatus . . . . . . . . . . . . . . . . . . . . . . . 1195
OfferedIncompatibleQosStatus . . . . . . . . . . . . . . . . . . . . . . 1197
ParticipantBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . 1211
4.1 Class Hierarchy

ParticipantBuiltinTopicDataDataReader . . . . .
ParticipantBuiltinTopicDataSeq . . . . . . . . .
PRIVATE MEMBER . . . . . . . . . . . . . . .
ProductVersion t . . . . . . . . . . . . . . . . . .
Property t . . . . . . . . . . . . . . . . . . . . . .
PropertyQosPolicyHelper . . . . . . . . . . . . .
PropertySeq . . . . . . . . . . . . . . . . . . . . .
ProtocolVersion t . . . . . . . . . . . . . . . . . .
PUBLIC MEMBER . . . . . . . . . . . . . . . .
PublicationBuiltinTopicData . . . . . . . . . . .
PublicationBuiltinTopicDataDataReader . . . . .
PublicationBuiltinTopicDataSeq . . . . . . . . .
PublicationMatchedStatus . . . . . . . . . . . . .
PublisherSeq . . . . . . . . . . . . . . . . . . . .
Qos . . . . . . . . . . . . . . . . . . . . . . . . .
DomainParticipantFactoryQos . . . . . . . .
DomainParticipantQos . . . . . . . . . . . . .
DataWriterQos . . . . . . . . . . . . . . . . .
PublisherQos . . . . . . . . . . . . . . . . . .
DataReaderQos . . . . . . . . . . . . . . . . .
SubscriberQos . . . . . . . . . . . . . . . . .
TopicQos . . . . . . . . . . . . . . . . . . . .
QosPolicy . . . . . . . . . . . . . . . . . . . . . .
AsynchronousPublisherQosPolicy . . . . . . .
AvailabilityQosPolicy . . . . . . . . . . . . .
BatchQosPolicy . . . . . . . . . . . . . . . . .
DatabaseQosPolicy . . . . . . . . . . . . . . .
DataReaderProtocolQosPolicy . . . . . . . .
DataReaderResourceLimitsQosPolicy . . . . .
DataWriterProtocolQosPolicy . . . . . . . . .
DataWriterResourceLimitsQosPolicy . . . . .
DeadlineQosPolicy . . . . . . . . . . . . . . .
DestinationOrderQosPolicy . . . . . . . . . .
DiscoveryConfigQosPolicy . . . . . . . . . . .
DiscoveryQosPolicy . . . . . . . . . . . . . .
DomainParticipantResourceLimitsQosPolicy .
DurabilityQosPolicy . . . . . . . . . . . . . .
DurabilityServiceQosPolicy . . . . . . . . . .
EntityFactoryQosPolicy . . . . . . . . . . . .
EntityNameQosPolicy . . . . . . . . . . . . .
EventQosPolicy . . . . . . . . . . . . . . . . .
ExclusiveAreaQosPolicy . . . . . . . . . . . .
GroupDataQosPolicy . . . . . . . . . . . . . .
HistoryQosPolicy . . . . . . . . . . . . . . . .
LatencyBudgetQosPolicy . . . . . . . . . . .
17
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
1214
1215
1228
1229
1234
1239
1244
1245
1248
1249
1256
1257
1259
1293
1300
769
773
610
1290
536
1505
1566
1301
397
402
412
482
521
542
592
621
628
631
639
649
778
802
810
938
942
949
952
1039
1046
1124
18
Class Index
LifespanQosPolicy . . . . . . . . . . . .
LivelinessQosPolicy . . . . . . . . . . . .
LocatorFilterQosPolicy . . . . . . . . .
LoggingQosPolicy . . . . . . . . . . . .
MultiChannelQosPolicy . . . . . . . . .
OwnershipQosPolicy . . . . . . . . . . .
OwnershipStrengthQosPolicy . . . . . .
PartitionQosPolicy . . . . . . . . . . . .
PresentationQosPolicy . . . . . . . . . .
ProfileQosPolicy . . . . . . . . . . . . .
PropertyQosPolicy . . . . . . . . . . . .
PublishModeQosPolicy . . . . . . . . . .
ReaderDataLifecycleQosPolicy . . . . .
ReceiverPoolQosPolicy . . . . . . . . . .
ReliabilityQosPolicy . . . . . . . . . . .
ResourceLimitsQosPolicy . . . . . . . .
SystemResourceLimitsQosPolicy . . . .
TimeBasedFilterQosPolicy . . . . . . .
TopicDataQosPolicy . . . . . . . . . . .
TransportBuiltinQosPolicy . . . . . . .
TransportMulticastMappingQosPolicy .
TransportMulticastQosPolicy . . . . . .
TransportPriorityQosPolicy . . . . . . .
TransportSelectionQosPolicy . . . . . .
TransportUnicastQosPolicy . . . . . . .
TypeConsistencyEnforcementQosPolicy
TypeSupportQosPolicy . . . . . . . . .
UserDataQosPolicy . . . . . . . . . . . .
WireProtocolQosPolicy . . . . . . . . .
WriterDataLifecycleQosPolicy . . . . . .
QosPolicyCount . . . . . . . . . . . . . . .
QosPolicyCountSeq . . . . . . . . . . . . .
ReliableReaderActivityChangedStatus . . .
ReliableWriterCacheChangedStatus . . . .
ReliableWriterCacheEventCount . . . . . .
RequestedDeadlineMissedStatus . . . . . .
RequestedIncompatibleQosStatus . . . . . .
RETCODE ERROR . . . . . . . . . . . . .
RETCODE ALREADY DELETED . .
RETCODE BAD PARAMETER . . . .
RETCODE ILLEGAL OPERATION .
RETCODE IMMUTABLE POLICY . .
RETCODE INCONSISTENT POLICY
RETCODE NO DATA . . . . . . . . .
RETCODE NOT ENABLED . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
1128
1140
1157
1169
1187
1199
1209
1217
1221
1231
1236
1295
1315
1318
1324
1348
1523
1541
1559
1580
1587
1590
1598
1600
1605
1661
1666
1694
1723
1738
1302
1304
1333
1336
1340
1344
1346
1356
1354
1355
1357
1358
1359
1360
1361
4.1 Class Hierarchy
19
RETCODE OUT OF RESOURCES . . . . . . . . . . . . . . . . . 1362

RETCODE PRECONDITION NOT MET . . . . . . . . . . . . . 1363
RETCODE TIMEOUT . . . . . . . . . . . . . . . . . . . . . . . . 1364
RETCODE UNSUPPORTED . . . . . . . . . . . . . . . . . . . . . 1365
RtpsReliableReaderProtocol t . . . . . . . . . . . . . . . . . . . . . . . 1366
RtpsReliableWriterProtocol t . . . . . . . . . . . . . . . . . . . . . . . 1372
RtpsReservedPortKind . . . . . . . . . . . . . . . . . . . . . . . . . . . 1388
RtpsWellKnownPorts t . . . . . . . . . . . . . . . . . . . . . . . . . . 1390
SampleIdentity t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1396
SampleLostStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1410
SampleRejectedStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . 1418
SampleStateKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1426
Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1428
DynamicDataSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
SampleInfoSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1409
BytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
KeyedBytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
KeyedStringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1117
AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . . . 385
AbstractSequence . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . 385
LoanableSequence . . . . . . . . . . . . . . . . . . . . . . . . . 1146
SampleInfoSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1409
BytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447
KeyedBytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
KeyedStringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1117
FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034
FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034
SequenceNumber t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1431
StatusKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1451
StructMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1474
SubscriberSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1507
SubscriptionBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . 1509
SubscriptionBuiltinTopicDataDataReader . . . . . . . . . . . . . . . . 1516
SubscriptionBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . 1517
SubscriptionMatchedStatus . . . . . . . . . . . . . . . . . . . . . . . . 1519
SystemException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1522
BAD PARAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
BAD TYPECODE . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
ThreadSettings t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1530
ThreadSettingsKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1535
TopicBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . . . . . 1552
TopicBuiltinTopicDataDataReader . . . . . . . . . . . . . . . . . . . . 1556
TopicBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . . . . . 1557
TopicDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1561
20
Class Index
ContentFilteredTopic . . . . . . . .
MultiTopic . . . . . . . . . . . . . .
Topic . . . . . . . . . . . . . . . . .
Transport . . . . . . . . . . . . . . . . .
ShmemTransport . . . . . . . . . . .
UDPv4Transport . . . . . . . . . . .
UDPv6Transport . . . . . . . . . . .
Transport.Property t . . . . . . . . . . .
ShmemTransport.Property t . . . .
UDPv4Transport.Property t . . . .
UDPv6Transport.Property t . . . .
TransportBuiltinKind . . . . . . . . . .
TransportMulticastMapping t . . . . . .
TransportMulticastMappingFunction t .
TransportMulticastMappingSeq . . . . .
TransportMulticastSettings t . . . . . .
TransportMulticastSettingsSeq . . . . .
TransportSupport . . . . . . . . . . . .
TransportUnicastSettings t . . . . . . .
TransportUnicastSettingsSeq . . . . . .
TypeCode . . . . . . . . . . . . . . . . .
TypeCodeFactory . . . . . . . . . . . .
TypeSupport . . . . . . . . . . . . . . .
DynamicDataTypeSupport . . . . .
BytesTypeSupport . . . . . . . . . .
KeyedBytesTypeSupport . . . . . .
KeyedStringTypeSupport . . . . . .
StringTypeSupport . . . . . . . . . .
Union . . . . . . . . . . . . . . . . . . .
UnionMember . . . . . . . . . . . . . .
UserException . . . . . . . . . . . . . .
BadKind . . . . . . . . . . . . . . .
BadMemberId . . . . . . . . . . . .
BadMemberName . . . . . . . . . .
Bounds . . . . . . . . . . . . . . . .
ValueMember . . . . . . . . . . . . . . .
VendorId t . . . . . . . . . . . . . . . .
Version . . . . . . . . . . . . . . . . . .
ViewStateKind . . . . . . . . . . . . . .
VM ABSTRACT . . . . . . . . . . . . .
VM CUSTOM . . . . . . . . . . . . . .
VM NONE . . . . . . . . . . . . . . . .
VM TRUNCATABLE . . . . . . . . . .
WaitSet . . . . . . . . . . . . . . . . . .
WaitSetProperty t . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
471
1190
1545
1569
1435
1668
1680
1570
1439
1672
1684
1578
1582
1585
1589
1594
1597
1602
1608
1610
1611
1647
1665
901
450
1094
1120
1470
1691
1692
1696
409
410
411
423
1697
1699
1701
1703
1705
1706
1707
1708
1709
1719
Chapter 5
Class Index
5.1
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
AbstractBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . 383
AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . . 385
AbstractSequence (Abstract sequence ) . . . . . . . . . . . . . . . . 390
AcknowledgmentInfo (Information about an application-level acknowledged sample ) . . . . . . . . . . . . . . . . . . . . . . . 393
AckResponseData t (Data payload of an application-level acknowledgment ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
AllocationSettings t (Resource allocation settings ) . . . . . . . . . 395
AsynchronousPublisherQosPolicy (Configures the mechanism
that sends user data in an external middleware thread ) . . . 397
AvailabilityQosPolicy (Configures the availability of data ) . . . . . 402
BAD PARAM (The exception BadKind (p. 409) is thrown when
an inappropriate operation is invoked on a TypeCode object ) 407
BAD TYPECODE (The exception BadKind (p. 409) is thrown
when an inappropriate operation is invoked on a TypeCode
object ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
BadKind (The exception BadKind (p. 409) is thrown when an inappropriate operation is invoked on a TypeCode object ) . . . . 409
BadMemberId (The specified com.rti.dds.typecode.TypeCode
(p. 1611) member ID is invalid ) . . . . . . . . . . . . . . . . . 410
BadMemberName (The specified com.rti.dds.typecode.TypeCode
(p. 1611) member name is invalid ) . . . . . . . . . . . . . . . 411
BatchQosPolicy (Used to configure batching of multiple samples into
a single network packet in order to increase throughput for
small samples ) . . . . . . . . . . . . . . . . . . . . . . . . . . 412
22
Class Index
BooleanSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< boolean > ) . . . . . . . . . . . . . . . . . . . . . . . . . . 417
Bounds (A user exception thrown when a parameter is not within the
legal bounds ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
BuiltinTopicKey t (The key type of the built-in topic (p. 359) types )424
BuiltinTopicReaderResourceLimits t (Built-in topic (p. 359)
readers resource limits ) . . . . . . . . . . . . . . . . . . . . . 426
Bytes (Built-in type consisting of a variable-length array of opaque
bytes ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
BytesDataReader
(<<interface>>
Instantiates
DataReader
<
( p. 279)
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes
>
) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
BytesDataWriter
(<<interface>>
( p. 279)
Instantiates
DataWriter
<
>
) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
ByteSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< byte > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
BytesSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes > ) . 447
BytesTypeSupport
(<<interface>>
( p. 279)
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes type
support ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
ChannelSettings t (Type used to configure the properties of a channel ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
ChannelSettingsSeq
(Declares
IDL
sequence<
com.rti.dds.infrastructure.ChannelSettings t (p. 454)
> ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
CharSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< char > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Condition
(<<interface>>
( p. 279)
Root
class
for
all the conditions that may be attached to a
com.rti.dds.infrastructure.WaitSet (p. 1709) ) . . . . . . 464
ConditionSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< com.rti.dds.infrastructure.Condition (p. 464) > ) . . . 465
ContentFilter
(<<interface>>
( p. 279)
Interface to be used by a custom filter of a
com.rti.dds.topic.ContentFilteredTopic (p. 471) ) . . . . 467
ContentFilteredTopic (<<interface>> ( p. 279) Specialization of
com.rti.dds.topic.TopicDescription (p. 1561) that allows
for content-based subscriptions ) . . . . . . . . . . . . . . . . 471
ContentFilterProperty t (<<eXtension>> ( p. 278) Type used
to provide all the required information to enable content filtering ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
5.1 Class List
23
Cookie t (<<eXtension>> ( p. 278) Sequence of bytes identifying

a written data sample, used when writing with parameters ) . 478
CookieSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Copyable (<<eXtension>> ( p. 278) <<interface>> ( p. 279) Interface for all the user-defined data type classes that support
copy ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
DatabaseQosPolicy (Various threads and resource limits settings
used by RTI Connext to control its internal database ) . . . . 482
DataReader (<<interface>> ( p. 279) Allows the application to:
(1) declare the data it wishes to receive (i.e. make a subscription (p. 353)) and (2) access the data received by the
attached com.rti.dds.subscription.Subscriber (p. 1476) ) 487
DataReaderAdapter (<<eXtension>> ( p. 278) A listener
adapter in the spirit of the Java AWT listener adapters. (The
Adapter provides empty implementations for the listener
methods) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
DataReaderCacheStatus (<<eXtension>> ( p. 278) The status
of the readers cache ) . . . . . . . . . . . . . . . . . . . . . . 517
DataReaderListener
(<<interface>>
( p. 279)
com.rti.dds.infrastructure.Listener (p. 1130) for reader
status ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518
DataReaderProtocolQosPolicy
(Along
with
com.rti.dds.infrastructure.WireProtocolQosPolicy
(p. 1723) and com.rti.dds.infrastructure.DataWriterProtocolQosPolicy
(p. 592), this QoS policy configures the DDS on-the-network
protocol (RTPS) ) . . . . . . . . . . . . . . . . . . . . . . . . 521
DataReaderProtocolStatus (<<eXtension>> ( p. 278) The status of a readers internal protocol related metrics, like the
number of samples received, filtered, rejected; and status of
wire protocol traffic ) . . . . . . . . . . . . . . . . . . . . . . . 526
DataReaderQos
(QoS
policies
supported
by
a
com.rti.dds.subscription.DataReader (p. 487) entity
) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
DataReaderResourceLimitsQosPolicy (Various settings that
configure how a com.rti.dds.subscription.DataReader
(p. 487) allocates and uses physical memory for internal resources ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 542
DataReaderSeq
(Declares
IDL
sequence
<
com.rti.dds.subscription.DataReader (p. 487) > ) . . . . 555
DataWriter (<<interface>> ( p. 279) Allows an application to
set the value of the data to be published under a given
com.rti.dds.topic.Topic (p. 1545) ) . . . . . . . . . . . . . . 557
DataWriterAdapter (<<eXtension>> ( p. 278) A listener adapter
in the spirit of the Java AWT listener adapters. (The Adapter
provides empty implementations for the listener methods or
functions.) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
24
Class Index
DataWriterCacheStatus (<<eXtension>> ( p. 278) The status of
the writers cache ) . . . . . . . . . . . . . . . . . . . . . . . .
DataWriterListener
(<<interface>>
( p. 279)
com.rti.dds.infrastructure.Listener (p. 1130) for writer
status ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DataWriterProtocolQosPolicy (Protocol that applies only to
com.rti.dds.publication.DataWriter (p. 557) instances ) .
DataWriterProtocolStatus (<<eXtension>> ( p. 278) The status of a writers internal protocol related metrics, like the
number of samples pushed, pulled, filtered; and status of wire
protocol traffic ) . . . . . . . . . . . . . . . . . . . . . . . . .
DataWriterQos
(QoS
policies
supported
by
a
(p. 557)
entity
) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DataWriterResourceLimitsInstanceReplacementKind
(Sets
the kinds of instances that can be replaced when instance
resource limits are reached ) . . . . . . . . . . . . . . . . . . .
DataWriterResourceLimitsQosPolicy (Various settings that configure how a com.rti.dds.publication.DataWriter (p. 557)
allocates and uses physical memory for internal resources ) .
DeadlineQosPolicy (Expresses the maximum duration (deadline)
within which an instance is expected to be updated ) . . . . .
DestinationOrderQosPolicy
(Controls
how
the
middleware will deal with data sent by multiple
(p. 557)
entities for the same instance of data (i.e., same
com.rti.dds.topic.Topic (p. 1545) and key) ) . . . . . . . .
DestinationOrderQosPolicyKind (Kinds of destination order ) . .
DiscoveryBuiltinReaderFragmentationResourceLimits t . . .
DiscoveryConfigBuiltinPluginKind (Built-in discovery plugins
that can be used ) . . . . . . . . . . . . . . . . . . . . . . . .
DiscoveryConfigQosPolicy (Settings for discovery configuration ) .
DiscoveryPluginPromiscuityKind (<<eXtension>> ( p. 278)
Type used to indicate promiscuity mode of the discovery plugin ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DiscoveryQosPolicy (Configures the mechanism used by the middleware to automatically discover and connect with new remote
applications ) . . . . . . . . . . . . . . . . . . . . . . . . . . .
DomainEntity
(<<interface>>
( p. 279)
Abstract
base class for all DDS entities except for the
com.rti.dds.domain.DomainParticipant (p. 654) ) . . . .
DomainParticipant (<<interface>> ( p. 279) Container for all
com.rti.dds.infrastructure.DomainEntity (p. 653) objects ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
585
586
592
598
610
617
621
628
631
634
636
638
639
648
649
653
654
5.1 Class List
25
DomainParticipantAdapter (<<eXtension>> ( p. 278) A listener adapter in the spirit of the Java AWT listener adapters.
(The Adapter provides empty implementations for the listener
methods) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
DomainParticipantFactory
(<<singleton>>
( p. 279)
<<interface>> ( p. 279) Allows creation and destruction of com.rti.dds.domain.DomainParticipant (p. 654)
objects ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742
DomainParticipantFactoryQos (QoS policies supported by
a
com.rti.dds.domain.DomainParticipantFactory
(p. 742) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 769
DomainParticipantListener (<<interface>> ( p. 279) Listener
for participant status ) . . . . . . . . . . . . . . . . . . . . . . 771
DomainParticipantQos
(QoS
policies
supported
by
a
com.rti.dds.domain.DomainParticipant (p. 654) entity ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
DomainParticipantResourceLimitsQosPolicy
(Various
settings
that
configure
how
a
com.rti.dds.domain.DomainParticipant (p. 654) allocates and uses physical memory for internal resources,
including the maximum sizes of various properties ) . . . . . 778
DoubleSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< double > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 796
DurabilityQosPolicy (This QoS policy specifies whether or not
RTI Connext will store and deliver previously published data
samples to new com.rti.dds.subscription.DataReader
(p. 487) entities that join the network later ) . . . . . . . . . . 802
DurabilityQosPolicyKind (Kinds of durability ) . . . . . . . . . . . 807
DurabilityServiceQosPolicy
(Various
settings
to
configure
the
external
RTI
Persistence
Service
used by RTI Connext for DataWriters with a
com.rti.dds.infrastructure.DurabilityQosPolicy
(p. 802) setting of com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.PERSIST
DURABILITY QOS or com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.TR
DURABILITY QOS ) . . . . . . . . . . . . . . . . . . . . . . 810
Duration t (Type for duration representation ) . . . . . . . . . . . . 813
DynamicData (A sample of any complex data type, which can be
inspected and manipulated reflectively ) . . . . . . . . . . . . 817
DynamicDataInfo
(A
descriptor
for
a
com.rti.dds.dynamicdata.DynamicData (p. 817) object ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
DynamicDataMemberInfo (A descriptor for a single member (i.e.
field) of dynamically defined data type ) . . . . . . . . . . . . 887
DynamicDataProperty t (A collection of attributes used to configure com.rti.dds.dynamicdata.DynamicData (p. 817) objects ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 890
26
Class Index
DynamicDataReader (Reads (subscribes to) objects of type
com.rti.dds.dynamicdata.DynamicData (p. 817) ) . . . . 892
DynamicDataSeq
(An
ordered
collection
of
com.rti.dds.dynamicdata.DynamicData (p. 817) elements ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
DynamicDataTypeProperty t (A collection of attributes used
to configure com.rti.dds.dynamicdata.DynamicData
(p. 817) objects ) . . . . . . . . . . . . . . . . . . . . . . . . . 897
DynamicDataTypeSerializationProperty t (Properties that govern how data of a certain type will be serialized on the network
) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
DynamicDataTypeSupport
(A
factory
for
registering
a
dynamically
defined
type
and
creating
com.rti.dds.dynamicdata.DynamicData (p. 817) objects ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
DynamicDataWriter (Writes (publishes) objects of type
com.rti.dds.dynamicdata.DynamicData (p. 817) ) . . . . 907
EndpointGroup t (Specifies a group of endpoints that can be collectively identified by a name and satisfied by a quorum ) . . . . 928
EndpointGroupSeq
(A
sequence
of
com.rti.dds.infrastructure.EndpointGroup t (p. 928) ) . 930
Entity (<<interface>> ( p. 279) Abstract base class for all the DDS
objects that support QoS policies, a listener, and a status
condition ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
EntityFactoryQosPolicy
(A
QoS
policy
for
all
com.rti.dds.infrastructure.Entity
(p. 931)
types
that can act as factories for one or more other
com.rti.dds.infrastructure.Entity (p. 931) types ) . . . . . 938
EntityHowTo.MyEntityListener . . . . . . . . . . . . . . . . . . . 941
EntityNameQosPolicy (Assigns a name and a role name to
a
com.rti.dds.domain.DomainParticipant
(p. 654),
(p. 557)
or
com.rti.dds.subscription.DataReader (p. 487). These
names will be visible during the discovery process and in RTI
tools to help you visualize and debug your system ) . . . . . . 942
Enum (A superclass for all type-safe enumerated types ) . . . . . . . 944
EnumMember (A description of a member of an enumeration ) . . . 947
EventQosPolicy (Settings for event ) . . . . . . . . . . . . . . . . . . 949
ExclusiveAreaQosPolicy (Configures multi-thread concurrency and
deadlock prevention capabilities ) . . . . . . . . . . . . . . . . 952
ExpressionProperty . . . . . . . . . . . . . . . . . . . . . . . . . . 955
ExtensibilityKind (Type to indicate the extensibility of a type ) . . 956
FilterSampleInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
FloatSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< float > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
5.1 Class List
27
FlowController (<<interface>> ( p. 279) A flow controller

is the object responsible for shaping the network
traffic by determining when attached asynchronous
com.rti.dds.publication.DataWriter (p. 557) instances
are allowed to write data ) . . . . . . . . . . . . . . . . . . . . 964
FlowControllerProperty t (Determines the flow control characteristics of the com.rti.dds.publication.FlowController
(p. 964) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
FlowControllerSchedulingPolicy (Kinds of flow controller scheduling policy ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
FlowControllerTokenBucketProperty t
(Com.rti.dds.publication.FlowController uses the popular token bucket approach for open loop network flow control.
The flow control characteristics are determined by the token
bucket properties ) . . . . . . . . . . . . . . . . . . . . . . . . 973
Foo (A representative user-defined data type ) . . . . . . . . . . . . . 977
FooDataReader
(<<interface>> ( p. 279)
<<generic>>
( p. 279) User data type-specific data reader ) . . . . . . . . . 979
FooDataWriter (<<interface>> ( p. 279) <<generic>> ( p. 279)
User data type specific data writer ) . . . . . . . . . . . . . . 1012
FooSeq (<<interface>> ( p. 279) <<generic>> ( p. 279) A
type-safe, ordered collection of elements.
The type of
these elements is referred to in this documentation as
com.rti.ndds.example.Foo (p. 977) ) . . . . . . . . . . . . 1034
FooTypeSupport (<<interface>> ( p. 279) <<generic>>
( p. 279) User data type specific interface ) . . . . . . . . . . . 1036
GroupDataQosPolicy (Attaches a buffer of opaque data that is distributed by means of Built-in Topics (p. 157) during discovery ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1039
GuardCondition
(<<interface>>
( p. 279)
A
specific
com.rti.dds.infrastructure.Condition (p. 464) whose
trigger value is completely under the control of the
application ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041
GUID t (Type for GUID (Global Unique Identifier) representation ) 1044
HistoryQosPolicy (Specifies the behavior of RTI Connext in the case
where the value of a sample changes (one or more times) before
it can be successfully communicated to one or more existing
subscribers ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 1046
HistoryQosPolicyKind (Kinds of history ) . . . . . . . . . . . . . . 1050
InconsistentTopicStatus (Com.rti.dds.infrastructure.StatusKind.StatusKind.INCONSISTENT TOPIC STATUS ) . . . . . . . . . . . . . . . . . . . . . . . . 1052
InetAddressSeq
(Declares
IDL
sequence<
com.rti.dds.infrastructure.java.net.InetAddress > ) . . . . . . 1054
InstanceHandle t (Type definition for an instance handle ) . . . . . 1055
28
Class Index
InstanceHandleSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
<
com.rti.dds.infrastructure.InstanceHandle t
(p. 1055) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 1058
InstanceStateKind (Indicates is the samples are from a live
com.rti.dds.publication.DataWriter (p. 557) or not ) . . 1061
IntSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< com.rti.dds.infrastructure.int > ) . . . . . . . . . . . . . . . 1064
KeyedBytes (Built-in type consisting of a variable-length array of
opaque bytes and a string that is the key ) . . . . . . . . . . . 1070
KeyedBytesDataReader
(<<interface>>
( p. 279)
Instantiates
DataReader
<
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes
> ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1073
KeyedBytesDataWriter
(<<interface>>
( p. 279)
Instantiates
DataWriter
<
> ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1081
KeyedBytesSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes
> ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
KeyedBytesTypeSupport
(<<interface>>
( p. 279)
type support ) . . . . . . . . . . . . . . . . . . . . . . . . . . 1094
KeyedString (Keyed string built-in type ) . . . . . . . . . . . . . . . 1098
KeyedStringDataReader
(<<interface>>
( p. 279)
Instantiates
DataReader
<
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString
> ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1101
KeyedStringDataWriter
(<<interface>>
( p. 279)
Instantiates
DataWriter
<
> ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1109
KeyedStringSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString
> ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1117
KeyedStringTypeSupport (<<interface>> ( p. 279) Keyed
string type support ) . . . . . . . . . . . . . . . . . . . . . . . 1120
LatencyBudgetQosPolicy (Provides a hint as to the maximum acceptable delay from the time the data is written to the time
it is received by the subscribing applications ) . . . . . . . . . 1124
LibraryVersion t (The version of a single library shipped as part of
an RTI Connext distribution ) . . . . . . . . . . . . . . . . . 1126
LifespanQosPolicy (Specifies how long the data written by the
com.rti.dds.publication.DataWriter (p. 557) is considered valid ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1128
5.1 Class List
29
Listener (<<interface>> ( p. 279) Abstract base class for all Listener (p. 1130) interfaces ) . . . . . . . . . . . . . . . . . . . 1130
LivelinessChangedStatus (Com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS CHANGED STATUS ) . . . . . . . . . . . . . . . . . . . . . . 1135
LivelinessLostStatus (Com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS LOST STATUS ) . . . . . . . . . . . . . . . . . . . . . . . . . 1138
LivelinessQosPolicy (Specifies and configures the mechanism that
allows com.rti.dds.subscription.DataReader (p. 487) entities to detect when com.rti.dds.publication.DataWriter
(p. 557) entities become disconnected or dead. ) . . . . . . . 1140
LivelinessQosPolicyKind (Kinds of liveliness ) . . . . . . . . . . . . 1144
LoanableSequence (A sequence capable of storing its elements directly or taking out a loan on them from an internal middleware store ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1146
Locator t (<<eXtension>> ( p. 278) Type used to represent the
addressing information needed to send a message to an RTPS
Endpoint using one of the supported transports ) . . . . . . . 1150
LocatorFilter t (Specifies the configuration of an individual channel
within a MultiChannel DataWriter ) . . . . . . . . . . . . . . 1154
LocatorFilterQosPolicy (The QoS policy used to report the
configuration of a MultiChannel DataWriter as part of
builtin.PublicationBuiltinTopicData ) . . . . . . . . . . . . . 1157
LocatorFilterSeq
(Declares
IDL
sequence<
com.rti.dds.infrastructure.LocatorFilter t
(p. 1154)
> ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1159
LocatorSeq
(Declares
IDL
sequence
<
com.rti.dds.infrastructure.Locator t (p. 1150) > ) . . . . 1160
LogCategory (Categories of logged messages ) . . . . . . . . . . . . . 1161
Logger (<<interface>> ( p. 279) The singleton type used to configure RTI Connext logging ) . . . . . . . . . . . . . . . . . . . . 1163
LoggerDevice (<<interface>> ( p. 279) Logging device interface.
Use for user-defined logging devices ) . . . . . . . . . . . . . . 1167
LoggingQosPolicy (Configures the RTI Connext logging facility ) . 1169
LogLevel (Level category assigned to RTI Connext log messages returned to an output device ) . . . . . . . . . . . . . . . . . . . 1171
LogMessage (Log message ) . . . . . . . . . . . . . . . . . . . . . . . 1173
LogPrintFormat (The format used to output RTI Connext diagnostic information ) . . . . . . . . . . . . . . . . . . . . . . . . . 1174
LogVerbosity (The verbosities at which RTI Connext diagnostic information is logged ) . . . . . . . . . . . . . . . . . . . . . . . 1177
LongDoubleSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< com.rti.dds.infrastructure.LongDouble > ) . . . . . . . . . 1179
LongSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< long > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1181
30
Class Index
MultiChannelQosPolicy (Configures the ability of a DataWriter to
send data on different multicast groups (addresses) based on
the value of the data ) . . . . . . . . . . . . . . . . . . . . . . 1187
MultiTopic
([Not
supported
(optional)]
<<interface>>
( p. 279)
A
specialization
of
that
com.rti.dds.topic.TopicDescription
(p. 1561)
allows subscriptions that combine/filter/rearrange data
coming from several topics ) . . . . . . . . . . . . . . . . . . . 1190
ObjectHolder (<<eXtension>> ( p. 278) Holder of object instance )1194
OfferedDeadlineMissedStatus (Com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED DEADLINE MISSED STATUS ) . . . . . . . . . . . . . . . . 1195
OfferedIncompatibleQosStatus (Com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED INCOMPATIBLE QOS STATUS ) . . . . . . . . . . . . . . . 1197
OwnershipQosPolicy (Specifies whether it is allowed for multiple
com.rti.dds.publication.DataWriter (p. 557) (s) to write
the same instance of the data and if so, how these modifications should be arbitrated ) . . . . . . . . . . . . . . . . . . . 1199
OwnershipQosPolicyKind (Kinds of ownership ) . . . . . . . . . . 1207
OwnershipStrengthQosPolicy
(Specifies
the
value
of
the strength used to arbitrate among multiple
com.rti.dds.publication.DataWriter (p. 557) objects
that attempt to modify the same instance of a data type
(identified by com.rti.dds.topic.Topic (p. 1545) + key) ) . 1209
ParticipantBuiltinTopicData (Entry created when a DomainParticipant (p. 654) object is discovered ) . . . . . . . . . . . . . 1211
ParticipantBuiltinTopicDataDataReader
(Instantiates
DataReader < builtin.ParticipantBuiltinTopicData
(p. 1211) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 1214
ParticipantBuiltinTopicDataSeq
(Instantiates
com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< builtin.ParticipantBuiltinTopicData (p. 1211) > ) . . 1215
ParticipantBuiltinTopicDataTypeSupport
(Instantiates
TypeSupport < builtin.ParticipantBuiltinTopicData
(p. 1211) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 1216
PartitionQosPolicy (Set of strings that introduces a
logical partition among the topics visible by a
com.rti.dds.publication.Publisher (p. 1262) and a
com.rti.dds.subscription.Subscriber (p. 1476) ) . . . . . . 1217
PresentationQosPolicy (Specifies how the samples representing
changes to data instances are presented to a subscribing application ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1221
PresentationQosPolicyAccessScopeKind (Kinds of presentation
access scope ) . . . . . . . . . . . . . . . . . . . . . . . . . . 1226
PRIVATE MEMBER (Constant used to indicate that a value type
member is private ) . . . . . . . . . . . . . . . . . . . . . . . . 1228
5.1 Class List
31
ProductVersion t (<<eXtension>> ( p. 278) Type used to represent the current version of RTI Connext ) . . . . . . . . . . . 1229
ProfileQosPolicy (Configures the way that XML documents containing QoS profiles are loaded by RTI Connext ) . . . . . . . . . 1231
Property t (Properties are name/value pairs objects ) . . . . . . . . 1234
PropertyQosPolicy (Stores name/value(string) pairs that can be
used to configure certain parameters of RTI Connext that are
not exposed through formal QoS policies. Can also be used
to store and propagate application-specific name/value pairs
that can be retrieved by user code during discovery ) . . . . . 1236
PropertyQosPolicyHelper (Policy Helpers which facilitate management of the properties in the input policy ) . . . . . . . . . . 1239
PropertySeq
(Declares
IDL
sequence
<
com.rti.dds.infrastructure.Property t
(p. 1234)
>
) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1244
ProtocolVersion t (<<eXtension>> ( p. 278) Type used to represent the version of the RTPS protocol ) . . . . . . . . . . . . 1245
PUBLIC MEMBER (Constant used to indicate that a value type
member is public ) . . . . . . . . . . . . . . . . . . . . . . . . 1248
PublicationBuiltinTopicData
(Entry
created
when
a
com.rti.dds.publication.DataWriter (p. 557) is discovered in association with its Publisher (p. 1262) ) . . . . . 1249
PublicationBuiltinTopicDataDataReader
(Instantiates
DataReader < builtin.PublicationBuiltinTopicData
(p. 1249) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 1256
PublicationBuiltinTopicDataSeq
(Instantiates
< builtin.PublicationBuiltinTopicData (p. 1249) > ) . . 1257
PublicationBuiltinTopicDataTypeSupport
(Instantiates
TypeSupport < builtin.PublicationBuiltinTopicData
(p. 1249) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 1258
PublicationMatchedStatus (Com.rti.dds.infrastructure.StatusKind.StatusKind.PUBLICATION MATCHED STATUS ) . . . . . . . . . . . . . . . . . . . . . . 1259
Publisher (<<interface>> ( p. 279) A publisher is the object responsible for the actual dissemination of publications ) . . . . 1262
PublisherAdapter (<<eXtension>> ( p. 278) A listener adapter in
the spirit of the Java AWT listener adapters. (The Adapter
provides empty implementations for the listener methods) ) . 1288
PublisherListener
(<<interface>>
( p. 279)
com.rti.dds.infrastructure.Listener
(p. 1130)
for
(p. 1262)
status
) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1289
PublisherQos
(QoS
policies
supported
by
a
(p. 1262)
entity
) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1290
32
Class Index
PublisherSeq
(Declares
IDL
sequence
<
com.rti.dds.publication.Publisher (p. 1262) > ) . . . . . .
PublishModeQosPolicy (Specifies how RTI Connext sends application data on the network. This QoS policy can be used to tell
RTI Connext to use its own thread to send data, instead of
the user thread ) . . . . . . . . . . . . . . . . . . . . . . . . .
PublishModeQosPolicyKind (Kinds of publishing mode ) . . . . .
Qos (An abstract base class for all QoS types ) . . . . . . . . . . . . .
QosPolicy (The base class for all QoS policies ) . . . . . . . . . . . .
QosPolicyCount
(Type
to
hold
a
counter
for
a
(p. 1305)
com.rti.dds.infrastructure.QosPolicyId t
) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QosPolicyCountSeq
(Declares
IDL
sequence
<
com.rti.dds.infrastructure.QosPolicyCount (p. 1302) > )
QosPolicyId t (Type to identify QosPolicies ) . . . . . . . . . . . .
QueryCondition (<<interface>> ( p. 279) These are specialised
com.rti.dds.subscription.ReadCondition (p. 1313) objects that allow the application to also specify a filter on the
locally available data ) . . . . . . . . . . . . . . . . . . . . . .
ReadCondition (<<interface>> ( p. 279) Conditions specifically dedicated to read operations and attached to one
com.rti.dds.subscription.DataReader (p. 487) ) . . . . .
ReaderDataLifecycleQosPolicy (Controls how a DataReader manages the lifecycle of the data that it has received ) . . . . . .
ReceiverPoolQosPolicy (Configures threads used by RTI Connext
to receive and process data from transports (for example,
UDP sockets) ) . . . . . . . . . . . . . . . . . . . . . . . . . .
RefilterQosPolicyKind (<<eXtension>> ( p. 278) Kinds of Refiltering ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ReliabilityQosPolicy (Indicates the level of reliability offered/requested by RTI Connext ) . . . . . . . . . . . . . . .
ReliabilityQosPolicyAcknowledgmentModeKind (Kinds of acknowledgment ) . . . . . . . . . . . . . . . . . . . . . . . . . .
ReliabilityQosPolicyKind (Kinds of reliability ) . . . . . . . . . . .
ReliableReaderActivityChangedStatus
(<<eXtension>>
( p. 278) Describes the activity (i.e. are acknowledgements
forthcoming) of reliable readers matched to a reliable writer )
ReliableWriterCacheChangedStatus
(<<eXtension>>
( p. 278) A summary of the state of a data writers cache of
unacknowledged samples written ) . . . . . . . . . . . . . . .
ReliableWriterCacheEventCount (<<eXtension>> ( p. 278)
The number of times the number of unacknowledged samples in the cache of a reliable writer hit a certain well-defined
threshold ) . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1293
1295
1298
1300
1301
1302
1304
1305
1311
1313
1315
1318
1322
1324
1329
1331
1333
1336
1340
5.1 Class List
33
RemoteParticipantPurgeKind (Available behaviors for halting

communication with remote participants (and their contained
entities) with which discovery communication has been lost ) 1341
RequestedDeadlineMissedStatus (Com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED DEADLINE MISSED STATUS ) . . . . . . . . . . . . . . . . 1344
RequestedIncompatibleQosStatus (Com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED INCOMPATIBLE QOS STATUS ) . . . . . . . . . . . . . . . 1346
ResourceLimitsQosPolicy (Controls the amount of physical memory allocated for DDS entities, if dynamic allocations are
allowed, and how they occur. Also controls memory usage
among different instance values for keyed topics ) . . . . . . . 1348
RETCODE ALREADY DELETED (The object target of this operation has already been deleted ) . . . . . . . . . . . . . . . 1354
RETCODE BAD PARAMETER (Illegal parameter value ) . . . 1355
RETCODE ERROR (Generic, unspecified error ) . . . . . . . . . . 1356
RETCODE ILLEGAL OPERATION (The operation was called
under improper circumstances ) . . . . . . . . . . . . . . . . . 1357
RETCODE IMMUTABLE POLICY (Application attempted to
modify an immutable QoS policy ) . . . . . . . . . . . . . . . 1358
RETCODE INCONSISTENT POLICY (Application specified a
set of QoS policies that are not consistent with each other ) . 1359
RETCODE NO DATA (Indicates a transient situation where the
operation did not return any data but there is no inherent
error ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1360
RETCODE NOT ENABLED
(Operation
invoked
on
a
com.rti.dds.infrastructure.Entity (p. 931) that is not yet
enabled ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1361
RETCODE OUT OF RESOURCES (RTI Connext ran out of the
resources needed to complete the operation ) . . . . . . . . . 1362
RETCODE PRECONDITION NOT MET (A pre-condition for
the operation was not met ) . . . . . . . . . . . . . . . . . . . 1363
RETCODE TIMEOUT (The operation timed out ) . . . . . . . . . 1364
RETCODE UNSUPPORTED (Unsupported operation. Can only
returned by operations that are unsupported ) . . . . . . . . 1365
RtpsReliableReaderProtocol t (Qos (p. 1300) related to reliable
reader protocol defined in RTPS ) . . . . . . . . . . . . . . . 1366
RtpsReliableWriterProtocol t (QoS related to the reliable writer
protocol defined in RTPS ) . . . . . . . . . . . . . . . . . . . 1372
RtpsReservedPortKind (RTPS reserved port kind, used to identify
the types of ports that can be reserved on domain (p. 328)
participant enable ) . . . . . . . . . . . . . . . . . . . . . . . . 1388
RtpsWellKnownPorts t (RTPS well-known port mapping configuration ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1390
SampleIdentity t (Type definition for an Sample Identity ) . . . . . 1396
SampleInfo (Information that accompanies each sample that is read
or taken ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1398
34
Class Index
SampleInfoSeq
(Declares
IDL
sequence
<
com.rti.dds.subscription.SampleInfo (p. 1398) > ) . . . . 1409
SampleLostStatus (Com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE LOST STATUS STATUS ) . . . . . . . . . . . . . . . . . . . 1410
SampleLostStatusKind (Kinds of reasons why a sample was lost ) . 1412
SampleRejectedStatus (Com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE REJECTED STATUS ) . . . . . . . . . . . . . . . . . . . . . 1418
SampleRejectedStatusKind (Kinds of reasons for rejecting a sample ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1420
SampleStateKind (Indicates whether or not a sample has ever been
read ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1426
Sequence (<<interface>> ( p. 279) <<generic>> ( p. 279) A
type-safe, ordered collection of elements.
The type of
these elements is referred to in this documentation as
com.rti.ndds.example.Foo (p. 977) ) . . . . . . . . . . . . 1428
SequenceNumber t (Type for sequence number representation ) . . 1431
ShmemTransport (Built-in transport (p. 376) plug-in for interprocess communications using shared memory ) . . . . . . . . 1435
ShmemTransport.Property t
(Subclass
of
com.rti.ndds.transport.Transport.Property t (p. 1570)
allowing specification of parameters that are specific to the
shared-memory transport (p. 376) ) . . . . . . . . . . . . . . 1439
ShortSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< short > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1442
StatusCondition
(<<interface>>
( p. 279)
A
specific
com.rti.dds.infrastructure.Condition
(p. 464)
that
is associated with each com.rti.dds.infrastructure.Entity
(p. 931) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1448
StatusKind (Type for status kinds ) . . . . . . . . . . . . . . . . . . 1451
StringDataReader
(<<interface>>
( p. 279)
Instantiates
DataReader < com.rti.dds.infrastructure.String > ) . . . . . . 1462
StringDataWriter
(<<interface>>
( p. 279)
Instantiates
DataWriter < com.rti.dds.infrastructure.String > ) . . . . . . 1465
StringSeq
(Declares
IDL
sequence
<
com.rti.dds.infrastructure.String > ) . . . . . . . . . . . . . . 1467
StringTypeSupport (<<interface>> ( p. 279) String type support )1470
StructMember (A description of a member of a struct ) . . . . . . . 1474
Subscriber (<<interface>> ( p. 279) A subscriber is the object responsible for actually receiving data from a subscription
(p. 353) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1476
SubscriberAdapter (A listener adapter in the spirit of the Java AWT
listener adapters. (The Adapter provides empty implementations for the listener methods) ) . . . . . . . . . . . . . . . . . 1502
SubscriberListener
(<<interface>>
( p. 279)
com.rti.dds.infrastructure.Listener (p. 1130) for status about a subscriber ) . . . . . . . . . . . . . . . . . . . . . 1503
5.1 Class List
35
SubscriberQos
(QoS
policies
supported
by
a
com.rti.dds.subscription.Subscriber (p. 1476) entity
) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1505
SubscriberSeq
(Declares
IDL
sequence
<
com.rti.dds.subscription.Subscriber (p. 1476) > ) . . . . 1507
SubscriptionBuiltinTopicData
(Entry
created
when
a
com.rti.dds.subscription.DataReader (p. 487) is discovered in association with its Subscriber (p. 1476) ) . . . . 1509
SubscriptionBuiltinTopicDataDataReader
<
(Instantiates
DataReader (p. 487)
builtin.SubscriptionBuiltinTopicData
(p. 1509)
>
) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1516
SubscriptionBuiltinTopicDataSeq
(Instantiates
< builtin.SubscriptionBuiltinTopicData (p. 1509) > ) . . 1517
SubscriptionBuiltinTopicDataTypeSupport
(Instantiates
TypeSupport < builtin.SubscriptionBuiltinTopicData
(p. 1509) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 1518
SubscriptionMatchedStatus (Com.rti.dds.infrastructure.StatusKind.StatusKind.SUBSCRIPTION MATCHED STATUS ) . . . . . . . . . . . . . . . . . . . . . . 1519
SystemException (System exception ) . . . . . . . . . . . . . . . . . 1522
SystemResourceLimitsQosPolicy
(Configures
(p. 654)independent
resources
used
by
RTI
Connext.
Mainly used to change the maximum number of
com.rti.dds.domain.DomainParticipant (p. 654) entities that can be created within a single process (address
space) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1523
TCKind (Enumeration type for com.rti.dds.typecode.TypeCode
(p. 1611) kinds ) . . . . . . . . . . . . . . . . . . . . . . . . . 1525
ThreadSettings t (The properties of a thread of execution ) . . . . . 1530
ThreadSettingsCpuRotationKind
(Determines
how
com.rti.dds.infrastructure.ThreadSettings t.cpu list (p. 1531) affects processor affinity for thread-related QoS
policies that apply to multiple threads ) . . . . . . . . . . . . 1533
ThreadSettingsKind (A collection of flags used to configure threads
of execution ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 1535
Time t (Type for time representation ) . . . . . . . . . . . . . . . . . 1537
TimeBasedFilterQosPolicy
(Filter
that
allows
a
com.rti.dds.subscription.DataReader (p. 487) to specify
that it is interested only in (potentially) a subset of the values
of the data ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1541
Topic (<<interface>> ( p. 279) The most basic description of the
data to be published and subscribed ) . . . . . . . . . . . . . 1545
36
Class Index
TopicAdapter (<<eXtension>> ( p. 278) A listener adapter in the
spirit of the Java AWT listener adapters. (The Adapter provides empty implementations for the listener methods) ) . . . 1550
TopicBuiltinTopicData (Entry created when a Topic (p. 1545) object discovered ) . . . . . . . . . . . . . . . . . . . . . . . . . 1552
TopicBuiltinTopicDataDataReader (Instantiates DataReader <
builtin.TopicBuiltinTopicData (p. 1552) > ) . . . . . . . . 1556
TopicBuiltinTopicDataSeq
(Instantiates
< builtin.TopicBuiltinTopicData (p. 1552) > ) . . . . . . 1557
TopicBuiltinTopicDataTypeSupport (Instantiates TypeSupport
(p. 1665) < builtin.TopicBuiltinTopicData (p. 1552) > ) 1558
TopicDataQosPolicy (Attaches a buffer of opaque data that is distributed by means of Built-in Topics (p. 157) during discovery ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1559
TopicDescription (Com.rti.dds.topic.Topic entity and associated elements ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1561
TopicListener
(<<interface>>
( p. 279)
(p. 1130)
for
com.rti.dds.topic.Topic (p. 1545) entities ) . . . . . . . . . 1564
TopicQos (QoS policies supported by a com.rti.dds.topic.Topic
(p. 1545) entity ) . . . . . . . . . . . . . . . . . . . . . . . . . 1566
Transport (RTI Connexts abstract pluggable transport (p. 376) interface ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1569
Transport.Property t (Base structure that must be inherited by
derived Transport (p. 1569) Plugin classes ) . . . . . . . . . 1570
TransportBuiltinKind (Built-in transport kind ) . . . . . . . . . . . 1578
TransportBuiltinQosPolicy (Specifies which built-in transports are
used ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1580
TransportMulticastMapping t (Type representing a list of multicast mapping elements ) . . . . . . . . . . . . . . . . . . . . . 1582
TransportMulticastMappingFunction t (Type representing an
external mapping function ) . . . . . . . . . . . . . . . . . . . 1585
TransportMulticastMappingQosPolicy (Specifies the multicast
address on which a com.rti.dds.subscription.DataReader
(p. 487) wants to receive its data.
It can also specify a port number as well as a subset of the available
(at the com.rti.dds.domain.DomainParticipant (p. 654)
level) transports with which to receive the multicast data ) . 1587
TransportMulticastMappingSeq (Declares IDL sequence<
com.rti.dds.infrastructure.TransportMulticastSettings t (p. 1594) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . 1589
5.1 Class List

TransportMulticastQosPolicy (Specifies the multicast address on
which a com.rti.dds.subscription.DataReader (p. 487)
wants to receive its data.
It can also specify a port
number as well as a subset of the available (at the
com.rti.dds.domain.DomainParticipant (p. 654) level)
transports with which to receive the multicast data ) . . . . .
TransportMulticastQosPolicyKind (Transport Multicast Policy
Kind ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TransportMulticastSettings t (Type representing a list of multicast locators ) . . . . . . . . . . . . . . . . . . . . . . . . . . .
TransportMulticastSettingsSeq (Declares IDL sequence<
com.rti.dds.infrastructure.TransportMulticastSettings
t (p. 1594) > ) . . . . . . . . . . . . . . . . . . . . . . . . . .
TransportPriorityQosPolicy (This QoS policy allows the application to take advantage of transports that are capable of sending messages with different priorities ) . . . . . . . . . . . . .
TransportSelectionQosPolicy (Specifies the physical transports a com.rti.dds.publication.DataWriter (p. 557) or
com.rti.dds.subscription.DataReader (p. 487) may use
to send or receive data ) . . . . . . . . . . . . . . . . . . . . .
TransportSupport (<<interface>> ( p. 279) The utility class used
to configure RTI Connext pluggable transports ) . . . . . . .
TransportUnicastQosPolicy (Specifies a subset of transports and a
port number that can be used by an Entity (p. 931) to receive
data ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TransportUnicastSettings t (Type representing a list of unicast locators ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TransportUnicastSettingsSeq
(Declares
IDL
sequence<
com.rti.dds.infrastructure.TransportUnicastSettings t (p. 1608) > ) . . . . . . . . . . . . . . . . . . . . . . . . . .
TypeCode (The definition of a particular data type, which you can
use to inspect the name, members, and other properties of
types generated with rtiddsgen (p. 298) or to modify types
you define yourself at runtime ) . . . . . . . . . . . . . . . . .
TypeCodeFactory (A singleton factory for creating, copying, and
deleting data type definitions dynamically ) . . . . . . . . . .
TypeConsistencyEnforcementQosPolicy (Defines the rules for
determining whether the type used to publish a given topic
(p. 359) is consistent with that used to subscribe to it ) . . .
TypeConsistencyKind (Kinds of type consistency ) . . . . . . . . .
TypeSupport (<<interface>> ( p. 279) An abstract marker interface that has to be specialized for each concrete user data type
that will be used by the application ) . . . . . . . . . . . . . .
37
1590
1593
1594
1597
1598
1600
1602
1605
1608
1610
1611
1647
1661
1663
1665
38
Class Index
TypeSupportQosPolicy (Allows you to attach application-specific
values to a DataWriter or DataReader that are passed to the
serialization or deserialization routine of the associated data
type ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1666
UDPv4Transport (Built-in transport (p. 376) plug-in using
UDP/IPv4 ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1668
UDPv4Transport.Property t (Configurable IPv4/UDP TransportPlugin properties ) . . . . . . . . . . . . . . . . . . . . . . . . 1672
UDPv6Transport (Built-in transport (p. 376) plug-in using
UDP/IPv6 ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1680
UDPv6Transport.Property t (Configurable IPv6/UDP TransportPlugin properties ) . . . . . . . . . . . . . . . . . . . . . . . . 1684
Union . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1691
UnionMember (A description of a member of a union ) . . . . . . . 1692
UserDataQosPolicy (Attaches a buffer of opaque data that is distributed by means of Built-in Topics (p. 157) during discovery ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1694
UserException (User exception ) . . . . . . . . . . . . . . . . . . . . 1696
ValueMember (A description of a member of a value type ) . . . . . 1697
VendorId t (<<eXtension>> ( p. 278) Type used to represent the
vendor of the service implementing the RTPS protocol ) . . . 1699
Version (<<interface>> ( p. 279) The version of an RTI Connext
distribution ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 1701
ViewStateKind (Indicates whether or not an instance is new ) . . . 1703
VM ABSTRACT (Constant used to indicate that a value type has
the abstract modifier ) . . . . . . . . . . . . . . . . . . . . . 1705
VM CUSTOM (Constant used to indicate that a value type has the
custom modifier ) . . . . . . . . . . . . . . . . . . . . . . . . . 1706
VM NONE (Constant used to indicate that a value type has no modifiers ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1707
VM TRUNCATABLE (Constant used to indicate that a value type
has the truncatable modifier ) . . . . . . . . . . . . . . . . . 1708
WaitSet
(<<interface>> ( p. 279)
Allows
an
application to wait until one or more of the attached
com.rti.dds.infrastructure.Condition (p. 464) objects
has a trigger value of com.rti.dds.infrastructure.true or
else until the timeout expires ) . . . . . . . . . . . . . . . . . 1709
WaitSetProperty t (<<eXtension>> ( p. 278) Specifies the
com.rti.dds.infrastructure.WaitSet (p. 1709) behavior for
multiple trigger events ) . . . . . . . . . . . . . . . . . . . . . 1719
WcharSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< com.rti.dds.infrastructure.char > ) . . . . . . . . . . . . . . 1721
WireProtocolQosPolicy (Specifies the wire-protocol-related attributes for the com.rti.dds.domain.DomainParticipant
(p. 654) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1723
5.1 Class List
39
WireProtocolQosPolicyAutoKind (Kind of auto mechanism used

to calculate the GUID prefix ) . . . . . . . . . . . . . . . . . . 1732
WriteParams t
(<<eXtension>>
( p. 278)
Input
parameters
for
writing
with
com.rti.ndds.example.FooDataWriter.write w params (p. 1026), com.rti.ndds.example.FooDataWriter.dispose w params (p. 1031), com.rti.ndds.example.FooDataWriter.register (p. 1016),
instance w params
com.rti.ndds.example.FooDataWriter.unregister instance w params (p. 1021) ) . . . . . . . . . . . . . . . . 1733
WriterContentFilter . . . . . . . . . . . . . . . . . . . . . . . . . . 1737
WriterDataLifecycleQosPolicy
(Controls
how
a
com.rti.dds.publication.DataWriter (p. 557) handles
the lifecycle of the instances (keys) that it is registered to
manage ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1738
WstringSeq (Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence
< com.rti.dds.infrastructure.char > ) . . . . . . . . . . . . . 1741
40
Class Index
Chapter 6
Module Documentation
6.1
ASYNCHRONOUS PUBLISHER
<<eXtension>> ( p. 278) Specifies the asynchronous publishing settings of

the com.rti.dds.publication.Publisher (p. 1262) instances.
Classes
class AsynchronousPublisherQosPolicy
Configures the mechanism that sends user data in an external middleware
thread.
Variables
static final QosPolicyId t ASYNCHRONOUSPUBLISHER QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.AsynchronousPublisherQosPolicy
( p. 397)
6.1.1
for
Detailed Description
<<eXtension>> ( p. 278) Specifies the asynchronous publishing settings of

the com.rti.dds.publication.Publisher (p. 1262) instances.
42
6.1.2
Variable Documentation
6.1.2.1
final QosPolicyId t ASYNCHRONOUSPUBLISHER QOS POLICY ID [static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.AsynchronousPublisherQosP

(p. 397)
6.2 AVAILABILITY
6.2
43
AVAILABILITY
<<eXtension>> ( p. 278) Configures the availability of data.
Classes
class AvailabilityQosPolicy
Configures the availability of data.
class EndpointGroup t
Specifies a group of endpoints that can be collectively identified by a name
and satisfied by a quorum.
class EndpointGroupSeq
A sequence of com.rti.dds.infrastructure.EndpointGroup t ( p. 928).
Variables
static final QosPolicyId t AVAILABILITY QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.AvailabilityQosPolicy ( p. 402)
6.2.1
for
<<eXtension>> ( p. 278) Configures the availability of data.
6.2.2
6.2.2.1
final QosPolicyId t AVAILABILITY QOS POLICY ID

[static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.AvailabilityQosPolicy

(p. 402)
44
6.3
BATCH
<<eXtension>> ( p. 278) Batch QoS policy used to enable batching in

com.rti.dds.publication.DataWriter (p. 557) instances.
Classes
class BatchQosPolicy
Used to configure batching of multiple samples into a single network packet
in order to increase throughput for small samples.
Variables
static final QosPolicyId t BATCH QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.BatchQosPolicy ( p. 412)
6.3.1
for
<<eXtension>> ( p. 278) Batch QoS policy used to enable batching in

6.3.2
6.3.2.1
final QosPolicyId t BATCH QOS POLICY ID [static,

inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.BatchQosPolicy

(p. 412)
6.4 Conditions and WaitSets
6.4
45
Conditions and WaitSets
(p. 464)
com.rti.dds.infrastructure.WaitSet (p. 1709) and related items.
and
Classes
interface Condition
<<interface>> (p. 279) Root class for all the conditions that may be attached to a com.rti.dds.infrastructure.WaitSet ( p. 1709).
class ConditionSeq
Instantiates com.rti.dds.infrastructure.com.rti.dds.util.Sequence <
com.rti.dds.infrastructure.Condition ( p. 464) >.
class GuardCondition
<<interface>> (p. 279) A specific com.rti.dds.infrastructure.Condition
( p. 464) whose trigger value is completely under the control of the application.
interface StatusCondition
( p. 464) that is associated with each com.rti.dds.infrastructure.Entity
( p. 931).
class WaitSet
<<interface>> (p. 279) Allows an application to wait until one or more
of the attached com.rti.dds.infrastructure.Condition ( p. 464) objects has
a trigger value of com.rti.dds.infrastructure.true or else until the timeout
expires.
class WaitSetProperty t
<<eXtension>>
(p. 278)
Specifies
the
com.rti.dds.infrastructure.WaitSet ( p. 1709) behavior for multiple
trigger events.
6.4.1
(p. 464)
com.rti.dds.infrastructure.WaitSet (p. 1709) and related items.
and
46
6.5
DATABASE
<<eXtension>> ( p. 278) Various threads and resource limits settings used

by RTI Connext to control its internal database.
Classes
class DatabaseQosPolicy
Various threads and resource limits settings used by RTI Connext to control
its internal database.
Variables
static final QosPolicyId t DATABASE QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.DatabaseQosPolicy ( p. 482)
6.5.1
for
<<eXtension>> ( p. 278) Various threads and resource limits settings used

6.5.2
6.5.2.1
final QosPolicyId t DATABASE QOS POLICY ID

[static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.DatabaseQosPolicy

(p. 482)
6.6 DATA READER PROTOCOL
6.6
47
DATA READER PROTOCOL
<<eXtension>> ( p. 278) Specifies the DataReader-specific protocol QoS.
Classes
class DataReaderProtocolQosPolicy
Along
with
( p. 1723) and com.rti.dds.infrastructure.DataWriterProtocolQosPolicy
( p. 592), this QoS policy configures the DDS on-the-network protocol
(RTPS).
Variables
static final QosPolicyId t
POLICY ID
DATAREADERPROTOCOL QOS -
<<eXtension>>
(p. 278)
Identifier
for
com.rti.dds.infrastructure.DataReaderProtocolQosPolicy ( p. 521)
6.6.1
<<eXtension>> ( p. 278) Specifies the DataReader-specific protocol QoS.
6.6.2
6.6.2.1
final QosPolicyId t DATAREADERPROTOCOL QOS POLICY ID [static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.DataReaderProtocolQosPolicy

(p. 521)
48
6.7
DATA READER RESOURCE LIMITS
<<eXtension>> ( p. 278) Various settings that configure how DataReaders

allocate and use physical memory for internal resources.
Classes
class DataReaderResourceLimitsQosPolicy
Various
settings
that
physical memory for internal resources.
configure
how
( p. 487) allocates and
a
uses
Variables
static final int AUTO MAX TOTAL INSTANCES
<<eXtension>>
(p. 278)
This
value
is
used
to
make
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max total instances ( p. 551) equal to com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max instances ( p. 1352).
static final QosPolicyId t DATAREADERRESOURCELIMITS QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
for
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy
( p. 542)
6.7.1
<<eXtension>> ( p. 278) Various settings that configure how DataReaders

6.7.2
6.7.2.1
final int AUTO MAX TOTAL INSTANCES [static,

inherited]
<<eXtension>>
( p. 278)
This
value
is
used
to
make
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max total instances (p. 551) equal to com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max instances (p. 1352).
6.7 DATA READER RESOURCE LIMITS

6.7.2.2
49
final QosPolicyId t DATAREADERRESOURCELIMITS QOS POLICY ID [static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy

(p. 542)
50
6.8
DATA WRITER PROTOCOL
<<eXtension>> ( p. 278) Along with com.rti.dds.infrastructure.WireProtocolQosPolicy

(p. 1723) and com.rti.dds.infrastructure.DataReaderProtocolQosPolicy
(p. 521), this QoS policy configures the DDS on-the-network protocol (RTPS).
Classes
class DataWriterProtocolQosPolicy
Protocol that applies only to com.rti.dds.publication.DataWriter ( p. 557)
instances.
Variables
POLICY ID
DATAWRITERPROTOCOL QOS -
<<eXtension>>
(p. 278)
Identifier
for
com.rti.dds.infrastructure.DataWriterProtocolQosPolicy ( p. 592)
6.8.1
<<eXtension>> ( p. 278) Along with com.rti.dds.infrastructure.WireProtocolQosPolicy

(p. 1723) and com.rti.dds.infrastructure.DataReaderProtocolQosPolicy
(p. 521), this QoS policy configures the DDS on-the-network protocol (RTPS).
6.8.2
6.8.2.1
final QosPolicyId t DATAWRITERPROTOCOL QOS POLICY ID [static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.DataWriterProtocolQosPolic

(p. 592)
6.9 DATA WRITER RESOURCE LIMITS
6.9
51
DATA WRITER RESOURCE LIMITS
<<eXtension>> ( p. 278) Various settings that configure how a

com.rti.dds.publication.DataWriter (p. 557) allocates and uses physical memory for internal resources.
Classes
class DataWriterResourceLimitsInstanceReplacementKind
Sets the kinds of instances that can be replaced when instance resource limits
are reached.
class DataWriterResourceLimitsQosPolicy
Various
settings
that
configure
how
a
com.rti.dds.publication.DataWriter ( p. 557) allocates and uses physical
memory for internal resources.
Variables
static final QosPolicyId t DATA WRITER RESOURCE LIMITS QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
for
com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy
( p. 621)
6.9.1

com.rti.dds.publication.DataWriter (p. 557) allocates and uses physical memory for internal resources.
6.9.2
6.9.2.1
final QosPolicyId t DATA WRITER RESOURCE LIMITS QOS POLICY ID [static,

inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy

(p. 621)
52
6.10
DEADLINE
Expresses the maximum duration (deadline) within which an instance is expected to be updated.
Classes
class DeadlineQosPolicy
Variables
static final QosPolicyId t DEADLINE QOS POLICY ID
Identifier for com.rti.dds.infrastructure.DeadlineQosPolicy ( p. 628).
6.10.1
6.10.2
6.10.2.1
final QosPolicyId t DEADLINE QOS POLICY ID

[static, inherited]
Identifier for com.rti.dds.infrastructure.DeadlineQosPolicy (p. 628).
6.11 DESTINATION ORDER
6.11
53
DESTINATION ORDER
Controls the criteria used to determine the logical order among changes made
by com.rti.dds.publication.Publisher (p. 1262) entities to the same instance
of data (i.e., matching com.rti.dds.topic.Topic (p. 1545) and key).
Classes
class DestinationOrderQosPolicy
Controls how the middleware will deal with data sent by multiple
com.rti.dds.publication.DataWriter ( p. 557) entities for the same instance of data (i.e., same com.rti.dds.topic.Topic ( p. 1545) and key).
class DestinationOrderQosPolicyKind
Kinds of destination order.
Variables
static final QosPolicyId t DESTINATIONORDER QOS POLICY ID
Identifier for com.rti.dds.infrastructure.DestinationOrderQosPolicy
( p. 631).
6.11.1
by com.rti.dds.publication.Publisher (p. 1262) entities to the same instance
of data (i.e., matching com.rti.dds.topic.Topic (p. 1545) and key).
6.11.2
6.11.2.1
final QosPolicyId t DESTINATIONORDER QOS POLICY ID [static, inherited]
Identifier
(p. 631).
for
com.rti.dds.infrastructure.DestinationOrderQosPolicy
54
6.12
DISCOVERY CONFIG
<<eXtension>> ( p. 278) Specifies the discovery configuration QoS.
Classes
class BuiltinTopicReaderResourceLimits t
Built-in topic ( p. 359) readers resource limits.
class DiscoveryConfigBuiltinPluginKind
Built-in discovery plugins that can be used.
class DiscoveryConfigQosPolicy
Settings for discovery configuration.
class RemoteParticipantPurgeKind
Available behaviors for halting communication with remote participants (and
their contained entities) with which discovery communication has been lost.
Variables
static final int SDP
static final int MASK NONE = 0

A bit-mask (list) of built-in discovery plugins.
static final int MASK ALL = 0xefff

static final QosPolicyId t DISCOVERYCONFIG QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.DiscoveryConfigQosPolicy ( p. 639)
6.12.1
for
<<eXtension>> ( p. 278) Specifies the discovery configuration QoS.

6.12 DISCOVERY CONFIG
6.12.2
6.12.2.1
final int SDP [static, inherited]
55

See also:
com.rti.dds.infrastructure.DiscoveryConfigBuiltinPluginKindMask
(p. 55)
6.12.2.2
.SDP
final int MASK NONE = 0 [static, inherited]

The bit-mask is an efficient and compact representation of a fixed-length list of
com.rti.dds.infrastructure.DiscoveryConfigBuiltinPluginKind (p. 638)
values.
QoS:
com.rti.dds.infrastructure.DiscoveryConfigQosPolicy (p. 639)
.MASK NONE
6.12.2.3
final int MASK ALL = 0xefff [static, inherited]

The bit-mask is an efficient and compact representation of a fixed-length list of
com.rti.dds.infrastructure.DiscoveryConfigBuiltinPluginKind (p. 638)
values.
QoS:
.MASK ALL
6.12.2.4
final QosPolicyId t DISCOVERYCONFIG QOS POLICY ID [static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.DiscoveryConfigQosPolicy

(p. 639)
56
6.13
DISCOVERY
<<eXtension>> ( p. 278) Specifies the attributes required to discover participants in the domain.
Modules
NDDS DISCOVERY PEERS
Environment variable or a file that specifies the default values of
com.rti.dds.infrastructure.DiscoveryQosPolicy.initial peers ( p. 651)
and
com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast receive addresses
( p. 650)
contained
in
the
com.rti.dds.domain.DomainParticipantQos.discovery
( p. 776)
qos policy.
Classes
class DiscoveryQosPolicy
Configures the mechanism used by the middleware to automatically discover
and connect with new remote applications.
Variables
static final QosPolicyId t DISCOVERY QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.DiscoveryQosPolicy ( p. 649)
6.13.1
for
<<eXtension>> ( p. 278) Specifies the attributes required to discover participants in the domain.
6.13.2
6.13.2.1
final QosPolicyId t DISCOVERY QOS POLICY ID

[static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.DiscoveryQosPolicy

(p. 649)
6.14 NDDS DISCOVERY PEERS
6.14
57
Environment variable or a file that specifies the default values of

(p. 651)
com.rti.dds.infrastructure.DiscoveryQosPolicy.initial peers
and
(p. 650)
contained
in
the
com.rti.dds.domain.DomainParticipantQos.discovery
(p. 776)
qos
policy.
The default value of the com.rti.dds.domain.DomainParticipantQos

(p. 773) is obtained by calling com.rti.dds.domain.DomainParticipantFactory.get default participant qos() (p. 750).
specifies
the
default
value
of
the
(p. 651)
and
(p. 650)
fields,
when
the
default
participant QoS policies have not been explictly set by the user (i.e.,
com.rti.dds.domain.DomainParticipantFactory.set default participant qos() (p. 751) has never been called or was called using
com.rti.dds.domain.DomainParticipantFactory.PARTICIPANT QOS DEFAULT (p. 149)).
does
not
contain
If
a
multicast
address,
then
the
string
sequence
com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast receive addresses (p. 650) is cleared and the RTI discovery process will not listen for
discovery messages via multicast.
contains
one
or
more
If
multicast
addresses,
the
addresses
will
be
stored
in
com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast receive addresses (p. 650), starting at element 0. They will be stored in the order in
which they appear in NDDS DISCOVERY PEERS.
Note: IPv4 multicast addresses must have a prefix. Therefore, when using the
UDPv6 transport: if there are any IPv4 multicast addresses in the peers list,
make sure they have udpv4:// in front of them (such as udpv4://239.255.0.1).
Note:
Currently,
RTI Connext will only listen for discovery
traffic
on
the
first
multicast
address
(element
0)
in
com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast receive addresses (p. 650).
NDDS DISCOVERY PEERS provides a mechanism to dynamically switch the
discovery configuration of an RTI Connext application without recompilation.
58
The application programmer is free to not use the default values; instead use
values supplied by other means.
NDDS DISCOVERY PEERS can be specified either in an environment variable
as comma (,) separated "peer descriptors" (see Peer Descriptor Format
(p. 58)) or in a file. These formats are described below.
6.14.1
Peer Descriptor Format
A peer descriptor string specifies a range of participants at

a given locator.
Peer descriptor strings are used in the
(p. 651)
field and the com.rti.dds.domain.DomainParticipant.add peer() (p. 720)
operation.
The anatomy of a peer descriptor is illustrated below using a special StarFabric transport example.
A peer descriptor consists of:
optional Participant ID. If a simple integer is specified, it indicates the maximum
participant ID to be contacted by the RTI Connext discovery mechanism
at the given locator. If that integer is enclosed in square brackets (e.g.:
[2]) only that Participant ID will be used. You can also specify a range
in the form of [a,b]: in this case only the Participant IDs in that specific
range are contacted. If omitted, a default value of 4 is implied.
Locator. See Locator Format (p. 58).
These are separated by the @ character. The separator may be omitted if a
participant ID limit is not explictly specified.
Note that the participant ID limit only applies to unicast locators; it is ignored for multicast locators (and therefore should be omitted for multicast peer
descriptors).
6.14.1.1
Locator Format
A locator string specifies a transport and an address in string format. Locators

are used to form peer descriptors. A locator is equivalent to a peer descriptor
with the default maximum participant ID.
A locator consists of:
optional Transport name (alias or class). This identifies the set of transport plugins (Transport Aliases (p. 377)) that may be used to parse the address
59
portion of the locator. Note that a transport class name is an implicit alias
that is used to refer to all the transport plugin instances of that class.
optional Address. See Address Format (p. 59).
These are separated by the //: string. The separator is specified if and only
if a transport name is specified.
If a transport name is specified, the address may be omitted; in that case, all
the unicast addresses (across all transport plugin instances) associated with the
transport class are implied. Thus, a locator string may specify several addresses.
If an address is specified, the transport name and the separator string
may be omitted; in that case all the available transport plugins (for the
com.rti.dds.infrastructure.Entity (p. 931)) may be used to parse the address string.
6.14.1.2
Address Format
An address string specifies a transport-independent network address that qualifies a transport-dependent address string.
Addresses are used to form locators.
Addresses are also used in
com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast receive addresses (p. 650), and com.rti.dds.infrastructure.TransportMulticastSettings t.receive address (p. 1595) fields. An address is equivalent to a locator in
which the transport name and separator are omitted.
An address consists of:
optional Network Address. An address in IPv4 or IPv6 string notation. If omitted, the network address of the transport is implied (Transport Network
Address (p. 381)).
optional Transport Address.
A string that is passed to the transport for processing.
The transport maps this string into
com.rti.ndds.transport.Transport.Property t.address bit count
(p. 1573) bits. If omitted the network address is used as the fully qualified
address.
These are separated by the # character. If a separator is specified, it must be
followed by a non-empty string which is passed to the transport plugin.
The
bits
resulting
from
the
transport
address
string
are
prepended with the network address.
The least significant
com.rti.ndds.transport.Transport.Property t.address bit count
(p. 1573) bits of the network address are ignored (Transport Network
Address (p. 381)).
60
If the separator is omitted and the string is not a valid IPv4 or IPv6 address,
it is treated as a transport address with an implicit network address (of the
transport plugin).
6.14.2
NDDS DISCOVERY PEERS Environment Variable Format
NDDS DISCOVERY PEERS can be specified via an environment variable of

the same name, consisting of a sequence of peer descriptors separated by the
comma (,) character.
Examples
Multicast (maximum participant ID is irrelevant)
239.255.0.1
Default maximum participant ID on localhost
localhost
Default maximum participant ID on host 192.168.1.1 (IPv4)
192.168.1.1
Default maximum participant ID on host FAA0::0 (IPv6)
FAA0::1
Default maximum participant ID on host FAA0::0#localhost (could be a UDPv4
transport plugin registered at network address of FAA0::0) (IPv6)
FAA0::0#localhost
Default maximum participant ID on host himalaya accessed using the udpv4
transport plugin(s) (IPv4)
udpv4://himalaya
Default maximum participant ID on localhost using the udpv4 transport plugin(s) registered at network address FAA0::0
udpv4://FAA0::0#localhost
Default maximum participant ID on all unicast addresses accessed via the
udpv4 (UDPv4) transport plugin(s)
61
udpv4://
Default maximum participant ID on host 0/0/R (StarFabric)
0/0/R
#0/0/R
Default maximum participant ID on host 0/0/R (StarFabric) using the starfabric (StarFabric) transport plugin(s)
starfabric://0/0/R
starfabric://#0/0/R
Default maximum participant ID on host 0/0/R (StarFabric) using the starfabric (StarFabric) transport plugin(s) registered at network address FAA0::0
starfabric://FBB0::0#0/0/R
Default maximum participant ID on all unicast addresses accessed via the starfabric (StarFabric) transport plugin(s)
starfabric://
shmem (shared memory) transport plugin(s)
shmem://
shmem (shared memory) transport plugin(s) registered at network address
FCC0::0
shmem://FCC0::0
Default maximum participant ID on hosts himalaya and gangotri
himalaya,gangotri
Maximum participant ID of 1 on hosts himalaya and gangotri
1@himalaya,1@gangotri
Combinations of above
62
239.255.0.1,localhost,192.168.1.1,0/0/R
FAA0::1,FAA0::0#localhost,FBB0::0#0/0/R
udpv4://himalaya,udpv4://FAA0::0#localhost,#0/0/R
starfabric://0/0/R,starfabric://FBB0::0#0/0/R,shmem://
starfabric://,shmem://FCC0::0,1@himalaya,1@gangotri
6.14.3
NDDS DISCOVERY PEERS File Format
NDDS DISCOVERY PEERS can be specified via a file of the same name in the
programs current working directory. A NDDS DISCOVERY PEERS file would
contain a sequence of peer descriptors separated by whitespace or the comma
(,) character. The file may also contain comments starting with a semicolon
(;) character till the end of the line.
Example:
;; NDDS_DISCOVERY_PEERS - Default Discovery Configuration File
;;
;;
;; NOTE:
;;
1. This file must be in the current working directory, i.e.
;;
in the folder from which the application is launched.
;;
;;
2. This file takes precedence over the environment variable NDDS_DISCOVERY_PEERS
;;
;; Multicast
239.255.0.1
; The default RTI Connext discovery multicast address
;; Unicast
localhost,192.168.1.1
; A comma can be used a separator
FAA0::1
; Whitespace can be used as a separator
FAA0::0#localhost
1@himalaya
1@gangotri
;; UDPv4
udpv4://himalaya
udpv4://FAA0::0#localhost
;; Shared Memory
shmem://
builtin.shmem://
shmem://FCC0::0
; Maximum participant ID of 1 on himalaya
; himalaya via udpv4 transport plugin(s)

; localhost via updv4 transport
; plugin registered at network address FAA0::0
; All shmem transport plugin(s)

; The builtin shmem transport plugin
; Shared memory transport plugin registered
;
at network address FCC0::0
;; StarFabric

0/0/R
starfabric://0/0/R
starfabric://FBB0::0#0/0/R
starfabric://
6.14.4
;
;
;
;
;
;
63
StarFabric node 0/0/R

0/0/R accessed via starfabric
transport plugin(s)
StarFabric transport plugin registered
at network address FBB0::0
All starfabric transport plugin(s)
NDDS DISCOVERY PEERS Precedence
If the current working directory from which the RTI Connext application is
launched contains a file called NDDS DISCOVERY PEERS, and an environment variable named NDDS DISCOVERY PEERS is also defined, the file takes
precedence; the environment variable is ignored.
6.14.5
NDDS DISCOVERY PEERS Default Value
If NDDS DISCOVERY PEERS is not specified (either as a file in the current

working directory, or as an environment variable), it implicitly defaults to the
following.
;; Multicast (only on platforms which allow UDPv4 multicast out of the box)
;;
;; This allows any RTI Connext applications anywhere on the local network to
;; discover each other over UDPv4.
builtin.udpv4://239.255.0.1
;;
;;
;;
;;
;;
; RTI Connexts default discovery multicast address
Unicast - UDPv4 (on all platforms)

This allows two RTI Connext applications using participant IDs up to the maximum
default participant ID on the local host and domain to discover each
other over UDP/IPv4.
builtin.udpv4://127.0.0.1
;;
;;
;;
;;
;;
Unicast - Shared Memory (only on platforms that support shared memory)

This allows two RTI Connext applications using participant IDs up to the maximum
default participant ID on the local host and domain to discover each
other over shared memory.
builtin.shmem://
6.14.6
Builtin Transport Class Names
The class names for the builtin transport plugins are:

64
shmem - com.rti.ndds.transport.ShmemTransport (p. 1435)
udpv4 - com.rti.ndds.transport.UDPv4Transport (p. 1668)
udpv6 - com.rti.ndds.transport.UDPv6Transport (p. 1680)
These may be used as the transport names in the Locator Format (p. 58).
6.14.7

Communication
and
Local
Host
Suppose you want to communicate with other RTI Connext applications on the
same host and you are setting NDDS DISCOVERY PEERS explicitly (generally
in order to use unicast discovery with applications on other hosts).
If the local host platform does not support the shared memory transport, then
you can include the name of the local host in the NDDS DISCOVERY PEERS
list.
If the local host platform supports the shared memory transport, then you can
do one of the following:
Include shmem:// in the NDDS DISCOVERY PEERS list. This will
cause shared memory to be used for discovery and data traffic for applications on the same host.
or:
Include the name of the local host in the NDDS DISCOVERY PEERS list and disable the shared memory transport in the
com.rti.dds.infrastructure.TransportBuiltinQosPolicy (p. 1580) of
the com.rti.dds.domain.DomainParticipant (p. 654). This will cause
UDP loopback to be used for discovery and data traffic for applications
on the same host.
(To check if your platform supports shared memory, see the Platform Notes.)
See also:
com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast receive addresses (p. 650)
(p. 651)
com.rti.dds.domain.DomainParticipant.add peer() (p. 720)
com.rti.dds.domain.DomainParticipantFactory.PARTICIPANT QOS DEFAULT (p. 149)

com.rti.dds.domain.DomainParticipantFactory.get default participant qos() (p. 750)
Transport Aliases (p. 377)
Transport Network Address (p. 381)
65
66
6.15
DOMAIN PARTICIPANT RESOURCE LIMITS

com.rti.dds.domain.DomainParticipant (p. 654) allocates and uses
physical memory for internal resources, including the maximum sizes of various
properties.
Classes
class AllocationSettings t
Resource allocation settings.
class DomainParticipantResourceLimitsQosPolicy
Various
settings
that
configure
how
a
com.rti.dds.domain.DomainParticipant ( p. 654) allocates and uses
physical memory for internal resources, including the maximum sizes of
various properties.
Variables
static final QosPolicyId t DOMAINPARTICIPANTRESOURCELIMITS QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
for
com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy
( p. 778)
6.15.1

com.rti.dds.domain.DomainParticipant (p. 654) allocates and uses
physical memory for internal resources, including the maximum sizes of various
properties.
6.15 DOMAIN PARTICIPANT RESOURCE LIMITS
6.15.2
6.15.2.1
final QosPolicyId t DOMAINPARTICIPANTRESOURCELIMITS QOS POLICY ID [static,

inherited]
67
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosP

(p. 778)
68
6.16
DURABILITY
This QoS policy specifies whether or not RTI Connext will

store and deliver previously published data samples to new
com.rti.dds.subscription.DataReader (p. 487) entities that join the
network later.
Classes
class DurabilityQosPolicy
com.rti.dds.subscription.DataReader ( p. 487) entities that join the
network later.
class DurabilityQosPolicyKind
Kinds of durability.
Variables
static final QosPolicyId t DURABILITY QOS POLICY ID
Identifier for com.rti.dds.infrastructure.DurabilityQosPolicy ( p. 802).
6.16.1

network later.
6.16.2
6.16.2.1
final QosPolicyId t DURABILITY QOS POLICY ID

[static, inherited]
Identifier for com.rti.dds.infrastructure.DurabilityQosPolicy (p. 802).
6.17 DURABILITY SERVICE
6.17
69
DURABILITY SERVICE
Various
settings
to
configure
the
external
RTI
Persistence Service used by RTI Connext for DataWriters with a
com.rti.dds.infrastructure.DurabilityQosPolicy (p. 802) setting of
com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.PERSISTENT DURABILITY QOS or com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.TRANSIENT
DURABILITY QOS.
Classes
class DurabilityServiceQosPolicy
Various
settings
to
configure
the
external
RTI
com.rti.dds.infrastructure.DurabilityQosPolicy ( p. 802) setting of
com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.PERSISTENT DURABILITY QOS or com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.TRANSIENT DURABILITY QOS.
Variables
static
final
POLICY ID
QosPolicyId t
DURABILITY SERVICE QOS -
Identifier for com.rti.dds.infrastructure.DurabilityServiceQosPolicy

( p. 810).
6.17.1
Various
settings
to
configure
the
external
RTI
com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.PERSISTENT DURABILITY QOS or com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.TRANSIENT
DURABILITY QOS.
70
6.17.2
6.17.2.1
final QosPolicyId t DURABILITY SERVICE QOS POLICY ID [static, inherited]
Identifier
(p. 810).
for
com.rti.dds.infrastructure.DurabilityServiceQosPolicy
6.18 Time Support
6.18
Time Support
Time and duration types and defines.
Classes
class Duration t
Type for duration representation.
class Time t
Type for time representation.
6.18.1
71
72
6.19
Entity Support
com.rti.dds.infrastructure.Entity (p. 931), com.rti.dds.infrastructure.Listener

(p. 1130) and related items.
Classes
interface DomainEntity
<<interface>> (p. 279) Abstract base class for all DDS entities except for
the com.rti.dds.domain.DomainParticipant ( p. 654).
interface Entity
<<interface>> (p. 279) Abstract base class for all the DDS objects that
support QoS policies, a listener, and a status condition.
interface Listener
<<interface>> (p. 279) Abstract base class for all Listener ( p. 1130) interfaces.
6.19.1
com.rti.dds.infrastructure.Entity (p. 931), com.rti.dds.infrastructure.Listener

(p. 1130) and related items.
subtypes
are
crecom.rti.dds.infrastructure.Entity
(p. 931)
ated and destroyed by factory objects.
With the exception of
(p. 654),
whose
factory
is
(p. 742),
all
com.rti.dds.infrastructure.Entity (p. 931) factory objects are themselves
com.rti.dds.infrastructure.Entity (p. 931) subtypes as well.
Important: all com.rti.dds.infrastructure.Entity (p. 931) delete operations
are inherently thread-unsafe. The user must take extreme care that a given
com.rti.dds.infrastructure.Entity (p. 931) is not destroyed in one thread
while being used concurrently (including being deleted concurrently) in another
thread. An operations effect in the presence of the concurrent deletion of the
operations target com.rti.dds.infrastructure.Entity (p. 931) is undefined.
6.20 ENTITY FACTORY
6.20
73
ENTITY FACTORY
A QoS policy for all com.rti.dds.infrastructure.Entity (p. 931) types that

can act as factories for one or more other com.rti.dds.infrastructure.Entity
(p. 931) types.
Classes
class EntityFactoryQosPolicy
A
QoS
policy
for
all
( p. 931) types that can act as factories for one or more other
com.rti.dds.infrastructure.Entity ( p. 931) types.
Variables
static final QosPolicyId t ENTITYFACTORY QOS POLICY ID
Identifier
( p. 938).
6.20.1
for
com.rti.dds.infrastructure.EntityFactoryQosPolicy

(p. 931) types.
6.20.2
6.20.2.1
final QosPolicyId t ENTITYFACTORY QOS POLICY ID

[static, inherited]
Identifier
(p. 938).
for
74
6.21
ENTITY NAME
Assigns
a
name
to
a
<<eXtension>>
( p. 278)
com.rti.dds.domain.DomainParticipant (p. 654).
This name will be
visible during the discovery process and in RTI tools to help you visualize and
debug your system.
Classes
class EntityNameQosPolicy
Assigns
a
name
and
a
role
name
to
a
( p. 654),
( p. 557)
or
com.rti.dds.subscription.DataReader ( p. 487).
These names will
be visible during the discovery process and in RTI tools to help you visualize
and debug your system.
6.21.1
<<eXtension>>
( p. 278)
Assigns
a
name
to
a
This name will be
debug your system.
6.22 EVENT
6.22
75
EVENT
<<eXtension>> ( p. 278) Configures the internal thread in a DomainParticipant that handles timed events.
Classes
class EventQosPolicy
Settings for event.
Variables
static final QosPolicyId t EVENT QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.EventQosPolicy ( p. 949)
6.22.1
for
<<eXtension>> ( p. 278) Configures the internal thread in a DomainParticipant that handles timed events.
6.22.2
6.22.2.1
final QosPolicyId t EVENT QOS POLICY ID [static,

inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.EventQosPolicy

(p. 949)
76
6.23
EXCLUSIVE AREA
<<eXtension>> ( p. 278) Configures multi-thread concurrency and deadlock

prevention capabilities.
Classes
class ExclusiveAreaQosPolicy
Configures multi-thread concurrency and deadlock prevention capabilities.
Variables
static final QosPolicyId t EXCLUSIVEAREA QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.ExclusiveAreaQosPolicy ( p. 952)
6.23.1
for
<<eXtension>> ( p. 278) Configures multi-thread concurrency and deadlock

prevention capabilities.
6.23.2
6.23.2.1
final QosPolicyId t EXCLUSIVEAREA QOS POLICY ID

[static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.ExclusiveAreaQosPolicy

(p. 952)
6.24 GROUP DATA
6.24
77
GROUP DATA
Attaches a buffer of opaque data that is distributed by means of Built-in

Topics (p. 157) during discovery.
Classes
class GroupDataQosPolicy
Topics ( p. 157) during discovery.
Variables
static final QosPolicyId t GROUPDATA QOS POLICY ID
Identifier
( p. 1039).
6.24.1
for
com.rti.dds.infrastructure.GroupDataQosPolicy

6.24.2
6.24.2.1
final QosPolicyId t GROUPDATA QOS POLICY ID

[static, inherited]
Identifier for com.rti.dds.infrastructure.GroupDataQosPolicy (p. 1039).
78
6.25
GUID Support
<<eXtension>> ( p. 278) GUID type and defines.
Classes
class GUID t
Type for GUID (Global Unique Identifier) representation.
6.25.1
<<eXtension>> ( p. 278) GUID type and defines.
6.26 HISTORY
6.26
79
HISTORY
Specifies the behavior of RTI Connext in the case where the value of an instance
changes (one or more times) before it can be successfully communicated to one
or more existing subscribers.
Classes
class HistoryQosPolicy
Specifies the behavior of RTI Connext in the case where the value of a sample
changes (one or more times) before it can be successfully communicated to
one or more existing subscribers.
class HistoryQosPolicyKind
Kinds of history.
class RefilterQosPolicyKind
<<eXtension>> (p. 278) Kinds of Refiltering
Variables
static final QosPolicyId t HISTORY QOS POLICY ID
Identifier for com.rti.dds.infrastructure.HistoryQosPolicy ( p. 1046).
6.26.1
Specifies the behavior of RTI Connext in the case where the value of an instance
6.26.2
6.26.2.1
final QosPolicyId t HISTORY QOS POLICY ID [static,

inherited]
Identifier for com.rti.dds.infrastructure.HistoryQosPolicy (p. 1046).
80
6.27
LATENCY BUDGET
Provides a hint as to the maximum acceptable delay from the time the data is
written to the time it is received by the subscribing applications.
Classes
class LatencyBudgetQosPolicy
Provides a hint as to the maximum acceptable delay from the time the data
is written to the time it is received by the subscribing applications.
Variables
static final QosPolicyId t LATENCYBUDGET QOS POLICY ID
Identifier
( p. 1124).
6.27.1
for
com.rti.dds.infrastructure.LatencyBudgetQosPolicy
6.27.2
6.27.2.1
final QosPolicyId t LATENCYBUDGET QOS POLICY ID [static, inherited]
Identifier
(p. 1124).
for
6.28 LIFESPAN
6.28
81
LIFESPAN
Specifies
how
long
the
data
written
by
com.rti.dds.publication.DataWriter (p. 557) is considered valid.
the
Classes
class LifespanQosPolicy
Specifies
how
long
the
data
written
by
com.rti.dds.publication.DataWriter ( p. 557) is considered valid.
the
Variables
static final QosPolicyId t LIFESPAN QOS POLICY ID
Identifier for com.rti.dds.infrastructure.LifespanQosPolicy ( p. 1128).
6.28.1
Specifies
how
long
the
data
written
by
6.28.2
6.28.2.1
final QosPolicyId t LIFESPAN QOS POLICY ID

[static, inherited]
Identifier for com.rti.dds.infrastructure.LifespanQosPolicy (p. 1128).
the
82
6.29
LIVELINESS
Specifies
and
configures
the
mechanism
that
allows
com.rti.dds.subscription.DataReader (p. 487) entities to detect when
com.rti.dds.publication.DataWriter (p. 557) entities become disconnected
or dead..
Classes
class LivelinessQosPolicy
Specifies
and
configures
the
mechanism
that
allows
com.rti.dds.subscription.DataReader ( p. 487) entities to detect
when com.rti.dds.publication.DataWriter ( p. 557) entities become
disconnected or dead..
class LivelinessQosPolicyKind
Kinds of liveliness.
Variables
static final QosPolicyId t LIVELINESS QOS POLICY ID
Identifier for com.rti.dds.infrastructure.LivelinessQosPolicy ( p. 1140).
6.29.1
Specifies
and
configures
the
mechanism
that
allows
or dead..
6.29.2
6.29.2.1
final QosPolicyId t LIVELINESS QOS POLICY ID

[static, inherited]
Identifier for com.rti.dds.infrastructure.LivelinessQosPolicy (p. 1140).
6.30 LOCATORFILTER
6.30
83
LOCATORFILTER
<<eXtension>> ( p. 278) The QoS policy used to report the configuration of

a MultiChannel DataWriter as part of builtin.PublicationBuiltinTopicData.
Classes
class LocatorFilter t
Specifies the configuration of an individual channel within a MultiChannel
DataWriter.
class LocatorFilterQosPolicy
The QoS policy used to report the configuration of a MultiChannel
DataWriter as part of builtin.PublicationBuiltinTopicData.
class LocatorFilterSeq
Declares IDL sequence< com.rti.dds.infrastructure.LocatorFilter t ( p. 1154) >.
Variables
static final QosPolicyId t LOCATORFILTER QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.LocatorFilterQosPolicy ( p. 1157)
6.30.1
for
<<eXtension>> ( p. 278) The QoS policy used to report the configuration of

6.30.2
6.30.2.1
final QosPolicyId t LOCATORFILTER QOS POLICY ID

[static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.LocatorFilterQosPolicy

(p. 1157)
84
6.31
LOGGING
<<eXtension>> ( p. 278) Configures the RTI Connext logging facility.
Classes
class LoggingQosPolicy
Configures the RTI Connext logging facility.
Variables
static final QosPolicyId t LOGGING QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.LoggingQosPolicy ( p. 1169)
6.31.1
for
<<eXtension>> ( p. 278) Configures the RTI Connext logging facility.
6.31.2
6.31.2.1
final QosPolicyId t LOGGING QOS POLICY ID

[static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.LoggingQosPolicy

(p. 1169)
6.32 MULTICHANNEL
6.32
85
MULTICHANNEL
<<eXtension>> ( p. 278) Configures the ability of a DataWriter to send data

on different multicast groups (addresses) based on the value of the data.
Classes
class ChannelSettings t
Type used to configure the properties of a channel.
class ChannelSettingsSeq
Declares IDL sequence< com.rti.dds.infrastructure.ChannelSettings t
( p. 454) >.
class MultiChannelQosPolicy
Configures the ability of a DataWriter to send data on different multicast
groups (addresses) based on the value of the data.
Variables
static final QosPolicyId t MULTICHANNEL QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.MultiChannelQosPolicy ( p. 1187)
6.32.1
for
<<eXtension>> ( p. 278) Configures the ability of a DataWriter to send data

on different multicast groups (addresses) based on the value of the data.
6.32.2
6.32.2.1
final QosPolicyId t MULTICHANNEL QOS POLICY ID

[static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.MultiChannelQosPolicy

(p. 1187)
86
6.33
Object Support
<<eXtension>> ( p. 278) Object related items.
Classes
interface Copyable
<<eXtension>> (p. 278) <<interface>> (p. 279) Interface for all the
user-defined data type classes that support copy.
class ObjectHolder
<<eXtension>> (p. 278) Holder of object instance
6.33.1
<<eXtension>> ( p. 278) Object related items.

A user-defined type class implements this interface to indicate that the class can be copied.
This is typically used in
com.rti.ndds.example.FooDataReader.take next sample (p. 994) or
com.rti.ndds.example.FooDataReader.read next sample (p. 993).
6.34 OWNERSHIP
6.34
87
OWNERSHIP
Specifies
whether
it
is
allowed
for
multiple
com.rti.dds.publication.DataWriter (p. 557) (s) to write the same
instance of the data and if so, how these modifications should be arbitrated.
Classes
class OwnershipQosPolicy
Specifies
whether
it
is
allowed
for
multiple
com.rti.dds.publication.DataWriter ( p. 557) (s) to write the same
class OwnershipQosPolicyKind
Kinds of ownership.
Variables
static final QosPolicyId t OWNERSHIP QOS POLICY ID
Identifier
( p. 1199).
6.34.1
for
com.rti.dds.infrastructure.OwnershipQosPolicy
Specifies
whether
it
is
allowed
for
multiple
6.34.2
6.34.2.1
final QosPolicyId t OWNERSHIP QOS POLICY ID

[static, inherited]
Identifier for com.rti.dds.infrastructure.OwnershipQosPolicy (p. 1199).
88
6.35
OWNERSHIP STRENGTH
Specifies the value of the strength used to arbitrate among multiple

com.rti.dds.publication.DataWriter (p. 557) objects that attempt to modify the same instance of a data type (identified by com.rti.dds.topic.Topic
(p. 1545) + key).
Classes
class OwnershipStrengthQosPolicy
Specifies the value of the strength used to arbitrate among multiple com.rti.dds.publication.DataWriter ( p. 557) objects that attempt to modify the same instance of a data type (identified by
com.rti.dds.topic.Topic ( p. 1545) + key).
Variables
POLICY ID
OWNERSHIPSTRENGTH QOS -
Identifier for com.rti.dds.infrastructure.OwnershipStrengthQosPolicy

( p. 1209).
6.35.1

(p. 1545) + key).
6.35.2
6.35.2.1
final QosPolicyId t OWNERSHIPSTRENGTH QOS POLICY ID [static, inherited]

(p. 1209).
6.36 PARTITION
6.36
89
PARTITION
Set of strings that introduces a logical partition among the topics visible by a com.rti.dds.publication.Publisher (p. 1262) and a
com.rti.dds.subscription.Subscriber (p. 1476).
Classes
class PartitionQosPolicy
Set of strings that introduces a logical partition among the topics visible by a com.rti.dds.publication.Publisher ( p. 1262) and a
com.rti.dds.subscription.Subscriber ( p. 1476).
Variables
static final QosPolicyId t PARTITION QOS POLICY ID
Identifier for com.rti.dds.infrastructure.PartitionQosPolicy ( p. 1217).
6.36.1
6.36.2
6.36.2.1
final QosPolicyId t PARTITION QOS POLICY ID

[static, inherited]
Identifier for com.rti.dds.infrastructure.PartitionQosPolicy (p. 1217).
90
6.37
PRESENTATION
Specifies how the samples representing changes to data instances are presented
to a subscribing application.
Classes
class PresentationQosPolicy
Specifies how the samples representing changes to data instances are presented to a subscribing application.
class PresentationQosPolicyAccessScopeKind
Kinds of presentation access scope.
Variables
static final QosPolicyId t PRESENTATION QOS POLICY ID
Identifier
( p. 1221).
6.37.1
for
com.rti.dds.infrastructure.PresentationQosPolicy
6.37.2
6.37.2.1
final QosPolicyId t PRESENTATION QOS POLICY ID

[static, inherited]
Identifier for com.rti.dds.infrastructure.PresentationQosPolicy (p. 1221).
6.38 PROFILE
6.38
91
PROFILE
<<eXtension>> ( p. 278) Configures the way that XML documents containing QoS profiles are loaded by RTI Connext.
Classes
class ProfileQosPolicy
Configures the way that XML documents containing QoS profiles are loaded
by RTI Connext.
Variables
static final QosPolicyId t PROFILE QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.ProfileQosPolicy ( p. 1231)
6.38.1
for
<<eXtension>> ( p. 278) Configures the way that XML documents containing QoS profiles are loaded by RTI Connext.
6.38.2
6.38.2.1
final QosPolicyId t PROFILE QOS POLICY ID [static,

inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.ProfileQosPolicy

(p. 1231)
92
6.39
PROPERTY
<<eXtension>> ( p. 278) Stores name/value (string) pairs that can be used

to configure certain parameters of RTI Connext that are not exposed through
formal QoS policies. Can also be used to store and propagate application-specific
name/value pairs that can be retrieved by user code during discovery.
Classes
class Property t
Properties are name/value pairs objects.
class PropertyQosPolicy
Stores name/value(string) pairs that can be used to configure certain parameters of RTI Connext that are not exposed through formal QoS policies. Can
also be used to store and propagate application-specific name/value pairs that
can be retrieved by user code during discovery.
class PropertyQosPolicyHelper
Policy Helpers which facilitate management of the properties in the input
policy.
class PropertySeq
Declares IDL
( p. 1234) >.
6.39.1
sequence
<
<<eXtension>> ( p. 278) Stores name/value (string) pairs that can be used

formal QoS policies. Can also be used to store and propagate application-specific
name/value pairs that can be retrieved by user code during discovery.
RTI Connext will automatically set some system properties in the
com.rti.dds.infrastructure.PropertyQosPolicy (p. 1236) associated with a
com.rti.dds.domain.DomainParticipantQos (p. 773). See System Properties (p. 231) for additional details.
6.40 PUBLISH MODE
6.40
93
PUBLISH MODE
<<eXtension>> ( p. 278) Specifies how RTI Connext sends application data

on the network. This QoS policy can be used to tell RTI Connext to use its
own thread to send data, instead of the user thread.
Classes
class PublishModeQosPolicy
Specifies how RTI Connext sends application data on the network. This QoS
policy can be used to tell RTI Connext to use its own thread to send data,
instead of the user thread.
class PublishModeQosPolicyKind
Kinds of publishing mode.
Variables
static final QosPolicyId t PUBLISHMODE QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.PublishModeQosPolicy ( p. 1295)
6.40.1
for
<<eXtension>> ( p. 278) Specifies how RTI Connext sends application data

6.40.2
6.40.2.1
final QosPolicyId t PUBLISHMODE QOS POLICY ID

[static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.PublishModeQosPolicy

(p. 1295)
94
6.41
QoS Policies
Quality of Service (QoS) policies.
Modules
ASYNCHRONOUS PUBLISHER
<<eXtension>> (p. 278) Specifies the asynchronous publishing settings of
the com.rti.dds.publication.Publisher ( p. 1262) instances.
AVAILABILITY
<<eXtension>> (p. 278) Configures the availability of data.
BATCH
<<eXtension>> (p. 278) Batch QoS policy used to enable batching in
com.rti.dds.publication.DataWriter ( p. 557) instances.
DATABASE
<<eXtension>> (p. 278) Various threads and resource limits settings used
DATA READER PROTOCOL

<<eXtension>> (p. 278) Specifies the DataReader-specific protocol QoS.
DATA READER RESOURCE LIMITS

<<eXtension>> (p. 278) Various settings that configure how DataReaders
DATA WRITER PROTOCOL

<<eXtension>> (p. 278) Along with com.rti.dds.infrastructure.WireProtocolQosPolicy
( p. 1723) and com.rti.dds.infrastructure.DataReaderProtocolQosPolicy
(RTPS).
DATA WRITER RESOURCE LIMITS

<<eXtension>> (p. 278) Various settings that configure how a
DEADLINE
DESTINATION ORDER
6.41 QoS Policies
95
by com.rti.dds.publication.Publisher ( p. 1262) entities to the same instance of data (i.e., matching com.rti.dds.topic.Topic ( p. 1545) and key).
DISCOVERY CONFIG
<<eXtension>> (p. 278) Specifies the discovery configuration QoS.
DISCOVERY
<<eXtension>> (p. 278) Specifies the attributes required to discover participants in the domain.
DOMAIN PARTICIPANT RESOURCE LIMITS

<<eXtension>> (p. 278) Various settings that configure how a
various properties.
DURABILITY
network later.
DURABILITY SERVICE
Various
settings
to
configure
the
external
RTI
ENTITY FACTORY
A
QoS
policy
for
all
ENTITY NAME
<<eXtension>>
(p. 278)
Assigns
a
name
to
a
com.rti.dds.domain.DomainParticipant ( p. 654).
This name will
EVENT
<<eXtension>> (p. 278) Configures the internal thread in a DomainParticipant that handles timed events.
96
EXCLUSIVE AREA
<<eXtension>> (p. 278) Configures multi-thread concurrency and deadlock prevention capabilities.
GROUP DATA
HISTORY
Specifies the behavior of RTI Connext in the case where the value of an
instance changes (one or more times) before it can be successfully communicated to one or more existing subscribers.
LATENCY BUDGET
LIFESPAN
Specifies
how
long
the
data
written
by
the
LIVELINESS
Specifies
and
configures
the
mechanism
that
allows
LOCATORFILTER
<<eXtension>> (p. 278) The QoS policy used to report the configuration of
LOGGING
<<eXtension>> (p. 278) Configures the RTI Connext logging facility.
MULTICHANNEL
<<eXtension>> (p. 278) Configures the ability of a DataWriter to send
data on different multicast groups (addresses) based on the value of the data.
OWNERSHIP
Specifies
whether
it
is
allowed
for
multiple
OWNERSHIP STRENGTH
6.41 QoS Policies
97
PARTITION
PRESENTATION
PROFILE
<<eXtension>> (p. 278) Configures the way that XML documents containing QoS profiles are loaded by RTI Connext.
PROPERTY
<<eXtension>> (p. 278) Stores name/value (string) pairs that can be used
formal QoS policies. Can also be used to store and propagate applicationspecific name/value pairs that can be retrieved by user code during discovery.
PUBLISH MODE
<<eXtension>> (p. 278) Specifies how RTI Connext sends application data
READER DATA LIFECYCLE

Controls how a DataReader manages the lifecycle of the data that it has
received.
RECEIVER POOL
<<eXtension>> (p. 278) Configures threads used by RTI Connext to receive and process data from transports (for example, UDP sockets).
RELIABILITY
Indicates the level of reliability offered/requested by RTI Connext.
RESOURCE LIMITS
Controls the amount of physical memory allocated for DDS entities, if dynamic allocations are allowed, and how they occur. Also controls memory
usage among different instance values for keyed topics.
98
SYSTEM RESOURCE LIMITS
<<eXtension>> (p. 278) Configures DomainParticipant-independent resources used by RTI Connext.
TIME BASED FILTER

Filter that allows a com.rti.dds.subscription.DataReader ( p. 487) to
specify that it is interested only in (potentially) a subset of the values of
the data.
TOPIC DATA
TRANSPORT BUILTIN
<<eXtension>> (p. 278) Specifies which built-in transports are used.
TRANSPORT MULTICAST MAPPING

<<eXtension>> (p. 278) Specifies a list of topic expressions and addresses
that can be used by an Entity with a specific topic name to receive data.
TRANSPORT MULTICAST
<<eXtension>> (p. 278) Specifies the multicast address on which a
com.rti.dds.subscription.DataReader ( p. 487) wants to receive its data.
It can also specify a port number, as well as a subset of the available (at the
com.rti.dds.domain.DomainParticipant ( p. 654) level) transports with
which to receive the multicast data.
TRANSPORT PRIORITY
This QoS policy allows the application to take advantage of transports that
are capable of sending messages with different priorities.
TRANSPORT SELECTION
<<eXtension>>
(p. 278)
Specifies
the
physical
transports
that
a
( p. 557)
or
com.rti.dds.subscription.DataReader ( p. 487) may use to send or
receive data.
TRANSPORT UNICAST
<<eXtension>> (p. 278) Specifies a subset of transports and a port number
that can be used by an Entity to receive data.
TYPE CONSISTENCY ENFORCEMENT

Defines the rules for determining whether the type used to publish a given
topic is consistent with that used to subscribe to it.
6.41 QoS Policies
99
TYPESUPPORT
<<eXtension>> (p. 278) Allows you to attach application-specific values
to a DataWriter or DataReader that are passed to the serialization or deserialization routine of the associated data type.
USER DATA
WIRE PROTOCOL
<<eXtension>> (p. 278) Specifies the wire protocol related attributes for
WRITER DATA LIFECYCLE

Controls how a DataWriter handles the lifecycle of the instances (keys) that
it is registered to manage.
Classes
class Qos
An abstract base class for all QoS types.
class QosPolicy
The base class for all QoS policies.
class QosPolicyCount
Type to hold a counter for a com.rti.dds.infrastructure.QosPolicyId t
( p. 1305).
class QosPolicyCountSeq
Declares IDL sequence < com.rti.dds.infrastructure.QosPolicyCount
( p. 1302) >.
class QosPolicyId t
Type to identify QosPolicies.
6.41.1

Data Distribution Service (DDS) relies on the use of QoS. A QoS is a set of
characteristics that controls some aspect of the behavior of DDS. A QoS is
100
comprised of individual QoS policies (objects conceptually deriving from an

abstract QosPolicy class).
The QosPolicy provides the basic mechanism for an application to specify quality
of service parameters. It has an attribute name that is used to uniquely identify
each QosPolicy.
QosPolicy implementation is comprised of a name, an ID, and a type. The type
of a QosPolicy value may be atomic, such as an integer or float, or compound
(a structure). Compound types are used whenever multiple parameters must
be set coherently to define a consistent value for a QosPolicy.
QoS (i.e., a list of QosPolicy objects) may be associated with all
com.rti.dds.infrastructure.Entity (p. 931) objects in the system such as
com.rti.dds.topic.Topic (p. 1545), com.rti.dds.publication.DataWriter
(p. 557),
(p. 487),
(p. 1262),
(p. 1476),
and
6.41.2
Specifying QoS on entities
QosPolicies
can
be
set
programmatically
when
an
com.rti.dds.infrastructure.Entity (p. 931) is created, or modified with
the com.rti.dds.infrastructure.Entity (p. 931)s set qos (abstract)
(p. 932) method.
QosPolicies can also be configured from XML resources (files, strings). With
this approach, you can change the QoS without recompiling the application.
For more information, see Configuring QoS Profiles with XML (p. 233).
To customize a com.rti.dds.infrastructure.Entity (p. 931)s QoS before creating the entity, the correct pattern is:
First, initialize a QoS object with the appropriate INITIALIZER constructor.
Call the relevant get <entity> default qos() method.
Modify the QoS values as desired.
Finally, create the entity.
Each QosPolicy is treated independently from the others. This approach has
the advantage of being very extensible. However, there may be cases where
several policies are in conflict. Consistency checking is performed each time the
policies are modified via the set qos (abstract) (p. 932) operation, or when
the com.rti.dds.infrastructure.Entity (p. 931) is created.
6.41 QoS Policies
101
When a policy is changed after being set to a given value, it is not required that the new value be applied instantaneously; RTI Connext is allowed to apply it after a transition phase. In addition, some QosPolicy
have immutable semantics, meaning that they can only be specified either at
com.rti.dds.infrastructure.Entity (p. 931) creation time or else prior to calling the com.rti.dds.infrastructure.Entity.enable (p. 935) operation on the
entity.
Each com.rti.dds.infrastructure.Entity (p. 931) can be configured with
a list of QosPolicy objects.
However, not all QosPolicies are supFor inported by each com.rti.dds.infrastructure.Entity (p. 931).
stance, a com.rti.dds.domain.DomainParticipant (p. 654) supports a different set of QosPolicies than a com.rti.dds.topic.Topic (p. 1545) or a
com.rti.dds.publication.Publisher (p. 1262).
6.41.3
QoS compatibility
In several cases, for communications to occur properly (or efficiently), a QosPolicy on the publisher side must be compatible with a corresponding policy on
the subscriber side. For example, if a com.rti.dds.subscription.Subscriber
(p. 1476) requests to receive data reliably while the corresponding
com.rti.dds.publication.Publisher (p. 1262) defines a best-effort policy,
communication will not happen as requested.
To address this issue and maintain the desirable decoupling of publication
and subscription as much as possible, the QosPolicy specification follows the
subscriber-requested, publisher-offered pattern.
In this pattern, the subscriber side can specify a requested value for
a particular QosPolicy. The publisher side specifes an offered value
for that QosPolicy.
RTI Connext will then determine whether the
value requested by the subscriber side is compatible with what is offered by the publisher side.
If the two policies are compatible, then
communication will be established. If the two policies are not compatible, RTI Connext will not establish communications between the two
com.rti.dds.infrastructure.Entity (p. 931) objects and will record this fact
by means of the com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED on
the
publisher
end
and
INCOMPATIBLE QOS STATUS
com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED INCOMPATIBLE QOS STATUS on the subscriber end. The application
can detect this fact by means of a com.rti.dds.infrastructure.Listener
(p. 1130) or a com.rti.dds.infrastructure.Condition (p. 464).
The following properties are defined on a QosPolicy.
RxO (p. 101) property
The QosPolicy objects that need to be set in a compatible manner between
102
the publisher and subscriber end are indicated by the setting of the
RxO (p. 101) property:
RxO (p. 101) = YES indicates that the policy can be set both at
the publishing and subscribing ends and the values must be set in a
compatible manner. In this case the compatible values are explicitly
defined.
RxO (p. 101) = NO indicates that the policy can be set both at the
publishing and subscribing ends but the two settings are independent.
That is, all combinations of values are compatible.
RxO (p. 101) = N/A indicates that the policy can only be specified
at either the publishing or the subscribing end, but not at both ends.
So compatibility does not apply.
Changeable (p. 102) property
Determines whether a QosPolicy can be changed.
NO
(p. 102)
policy
can
only
be
specified
com.rti.dds.infrastructure.Entity (p. 931) creation time.
at
UNTIL ENABLE (p. 102) policy can only be changed before the
com.rti.dds.infrastructure.Entity (p. 931) is enabled.
YES (p. 102) policy can be changed at any time.
6.42 READER DATA LIFECYCLE
6.42
103
READER DATA LIFECYCLE
Controls how a DataReader manages the lifecycle of the data that it has received.
Classes
class ReaderDataLifecycleQosPolicy
received.
Variables
POLICY ID
READERDATALIFECYCLE QOS -
Identifier for com.rti.dds.infrastructure.ReaderDataLifecycleQosPolicy

( p. 1315).
6.42.1
6.42.2
6.42.2.1
final QosPolicyId t READERDATALIFECYCLE QOS POLICY ID [static, inherited]

(p. 1315).
104
6.43
RECEIVER POOL
<<eXtension>> ( p. 278) Configures threads used by RTI Connext to receive

and process data from transports (for example, UDP sockets).
Classes
class ReceiverPoolQosPolicy
Configures threads used by RTI Connext to receive and process data from
transports (for example, UDP sockets).
Variables
static final QosPolicyId t RECEIVERPOOL QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.ReceiverPoolQosPolicy ( p. 1318)
6.43.1
for
<<eXtension>> ( p. 278) Configures threads used by RTI Connext to receive

and process data from transports (for example, UDP sockets).
6.43.2
6.43.2.1
final QosPolicyId t RECEIVERPOOL QOS POLICY ID

[static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.ReceiverPoolQosPolicy

(p. 1318)
6.44 RELIABILITY
6.44
105
RELIABILITY
Classes
class ReliabilityQosPolicy
class ReliabilityQosPolicyAcknowledgmentModeKind
Kinds of acknowledgment.
class ReliabilityQosPolicyKind
Kinds of reliability.
Variables
static final QosPolicyId t RELIABILITY QOS POLICY ID
Identifier
( p. 1324).
6.44.1
for
com.rti.dds.infrastructure.ReliabilityQosPolicy
6.44.2
6.44.2.1
final QosPolicyId t RELIABILITY QOS POLICY ID

[static, inherited]
Identifier for com.rti.dds.infrastructure.ReliabilityQosPolicy (p. 1324).
106
6.45
RESOURCE LIMITS
Controls the amount of physical memory allocated for DDS entities, if dynamic
allocations are allowed, and how they occur. Also controls memory usage among
different instance values for keyed topics.
Classes
class ResourceLimitsQosPolicy
Variables
static final QosPolicyId t RESOURCELIMITS QOS POLICY ID
Identifier for
( p. 1348).
com.rti.dds.infrastructure.ResourceLimitsQosPolicy
static final int LENGTH UNLIMITED

A special value indicating an unlimited quantity.
6.45.1
6.45.2
6.45.2.1
final QosPolicyId t RESOURCELIMITS QOS POLICY ID [static, inherited]
Identifier
(p. 1348).
6.45.2.2
for
final int LENGTH UNLIMITED [static, inherited]
6.46 Return Codes
6.46
107
Return Codes
Types of return codes.
Classes
class RETCODE ALREADY DELETED
The object target of this operation has already been deleted.
class RETCODE BAD PARAMETER

Illegal parameter value.
class RETCODE ERROR

Generic, unspecified error.
class RETCODE ILLEGAL OPERATION

The operation was called under improper circumstances.
class RETCODE IMMUTABLE POLICY

Application attempted to modify an immutable QoS policy.
class RETCODE INCONSISTENT POLICY

Application specified a set of QoS policies that are not consistent with each
other.
class RETCODE NO DATA

Indicates a transient situation where the operation did not return any data
but there is no inherent error.
class RETCODE NOT ENABLED

Operation invoked on a com.rti.dds.infrastructure.Entity ( p. 931) that is
not yet enabled.
class RETCODE OUT OF RESOURCES

RTI Connext ran out of the resources needed to complete the operation.
class RETCODE PRECONDITION NOT MET

A pre-condition for the operation was not met.
class RETCODE TIMEOUT

The operation timed out.
108
class RETCODE UNSUPPORTED
Unsupported operation. Can only returned by operations that are unsupported.
6.46.1
6.46.2
Standard Return Codes
Any void operation that documents that it may throw an exception of type may
throw exactly com.rti.dds.infrastructure.RETCODE ERROR (p. 1356)
or
com.rti.dds.infrastructure.RETCODE ILLEGAL OPERATION
(p. 1357). Any such operation that takes one or more input parameters may
additionally throw the subclass com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355).
Any operation on an object created from any of the factories may additionally throw the subclass
com.rti.dds.infrastructure.RETCODE ALREADY DELETED
(p. 1354). Any operation that is stated as optional may additionally throw
the subclass com.rti.dds.infrastructure.RETCODE UNSUPPORTED
(p. 1365).
Thus, the standard return codes are:
com.rti.dds.infrastructure.RETCODE OK
com.rti.dds.infrastructure.RETCODE ERROR (p. 1356)
(p. 1357)
com.rti.dds.infrastructure.RETCODE ALREADY DELETED
(p. 1354)
com.rti.dds.infrastructure.RETCODE BAD PARAMETER
(p. 1355)
com.rti.dds.infrastructure.RETCODE UNSUPPORTED
(p. 1365)
Operations that may throw any other exception type will state so explicitly.
6.47 Sequence Number Support
6.47
Sequence Number Support
<<eXtension>> ( p. 278) Sequence number type and defines.
Classes
class SequenceNumber t
Type for sequence number representation.
6.47.1
<<eXtension>> ( p. 278) Sequence number type and defines.
109
110
6.48
Status Kinds
Kinds of communication status.
Classes
class StatusKind
Type for status kinds.
Variables
static final int STATUS MASK NONE
No bits are set.
static final int STATUS MASK ALL

All bits are set.
6.48.1

Entity:
com.rti.dds.infrastructure.Entity (p. 931)
QoS:
QoS Policies (p. 94)
Listener:
com.rti.dds.infrastructure.Listener (p. 1130)
Each concrete com.rti.dds.infrastructure.Entity (p. 931) is associated with
a set of Status objects whose value represents the communication status of that
entity. Each status value can be accessed with a corresponding method on the
com.rti.dds.infrastructure.Entity (p. 931).
When
these
status
values
change,
the
corresponding
com.rti.dds.infrastructure.StatusCondition (p. 1448) objects are activated and the proper com.rti.dds.infrastructure.Listener (p. 1130)
objects are invoked to asynchronously inform the application.
6.48 Status Kinds
111
An
application
is
notified
of
communication
status
by
means
of
the
(p. 1130)
or
the
com.rti.dds.infrastructure.WaitSet
(p. 1709)
/
The
com.rti.dds.infrastructure.Condition (p. 464) mechanism.
two mechanisms may be combined in the application (e.g.,
using
(p. 1709)
(s)
/
com.rti.dds.infrastructure.Condition (p. 464) (s) to access the data
and com.rti.dds.infrastructure.Listener (p. 1130) (s) to be warned
asynchronously of erroneous communication statuses).
It is likely that the application will choose one or the other mechanism for each
particular communication status (not both). However, if both mechanisms are
enabled, then the com.rti.dds.infrastructure.Listener (p. 1130) mechanism
is used first and then the com.rti.dds.infrastructure.WaitSet (p. 1709) objects are signalled.
The statuses may be classified into:
read communication statuses: i.e., those that are related to arrival of data,
namely
com.rti.dds.infrastructure.StatusKind.StatusKind.DATA ON READERS STATUS and com.rti.dds.infrastructure.StatusKind.StatusKind.DATA AVAILABLE STATUS.
plain communication statuses: i.e., all the others.
Read communication statuses are treated slightly differently than
the others because they dont change independently.
In other
words,
at least two changes will appear at the same time
(com.rti.dds.infrastructure.StatusKind.StatusKind.DATA ON READERS STATUS
and
com.rti.dds.infrastructure.StatusKind.StatusKind.DATA AVAILABLE STATUS) and even several of the last kind may be part of the
set. This grouping has to be communicated to the application.
For each plain communication status, there is a corresponding structure to hold
the status value. These values contain the information related to the change of
status, as well as information related to the statuses themselves (e.g., contains
cumulative counts).
6.48.2
Changes in Status
Associated with each one of an com.rti.dds.infrastructure.Entity (p. 931)s

communication status is a logical StatusChangedFlag. This flag indicates
whether that particular communication status has changed since the last time
the status was read by the application. The way the status changes is slightly
different for the Plain Communication Status and the Read Communication
status.
112
6.48.2.1
Changes in plain communication status
For the plain communication status, the StatusChangedFlag flag is initially set to FALSE. It becomes TRUE whenever the plain communication status changes and it is reset to com.rti.dds.infrastructure.false
each time the application accesses the plain communication status
via the proper get <plain communication status>() operation on the
The communication status is also reset to FALSE whenever the associated listener operation is called as the listener implicitly accesses the status which is
passed as a parameter to the operation. The fact that the status is reset prior
to calling the listener means that if the application calls the get <plain communication status> from inside the listener it will see the status already reset.
An exception to this rule is when the associated listener is the nil listener. The
nil listener is treated as a NOOP and the act of calling the nil listener does
not reset the communication status.
For example, the value of the StatusChangedFlag associated with
the
com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED DEADLINE MISSED STATUS
will
become
TRUE
each
time
new
deadline
occurs
(which
increases
the
com.rti.dds.subscription.RequestedDeadlineMissedStatus.total count (p. 1344) field).
The value changes to FALSE when
the
application
accesses
the
status
via
the
corresponding
com.rti.dds.subscription.DataReader.get requested deadline missed status (p. 499) method on the proper Entity
6.48.2.2
Changes in read communication status
For the read communication status, the StatusChangedFlag flag is initially

set to FALSE. The StatusChangedFlag becomes TRUE when either a datasample arrives or else the com.rti.dds.subscription.ViewStateKind
(p. 1703),
com.rti.dds.subscription.SampleStateKind
(p. 1426),
of
or
com.rti.dds.subscription.InstanceStateKind
(p. 1061)
any existing sample changes for any reason other than a
call
to
com.rti.ndds.example.FooDataReader.read
(p. 981),
com.rti.ndds.example.FooDataReader.take (p. 983) or their variants.
Specifically any of the following events will cause the StatusChangedFlag to
become TRUE:
The arrival of new data.
A change in the com.rti.dds.subscription.InstanceStateKind
(p. 1061) of a contained instance. This can be caused by either:
6.48 Status Kinds
113
The arrival of the notification that an instance has been disposed by:
the
(p. 557)
that owns it if OWNERSHIP (p. 87) QoS kind=
com.rti.dds.infrastructure.OwnershipQosPolicyKind.OwnershipQosPolicyKind.EXCLUSIVE OWNERSHIP QOS
or
by
any
(p. 557)
if
OWNERSHIP
(p. 87)
QoS
kind=
com.rti.dds.infrastructure.OwnershipQosPolicyKind.OwnershipQosPolicyKind.SHARED OWNERSHIP QOS
The loss of liveliness of the com.rti.dds.publication.DataWriter
(p. 557) of an instance for which there is no other
com.rti.dds.publication.DataWriter (p. 557).
The arrival of the notification that an instance has been unregistered
by the only com.rti.dds.publication.DataWriter (p. 557) that is
known to be writing the instance.
Depending on the kind of StatusChangedFlag, the flag transitions to FALSE
again as follows:
The
com.rti.dds.infrastructure.StatusKind.StatusKind.DATA AVAILABLE STATUS StatusChangedFlag becomes FALSE when
either the corresponding listener operation (on data available) is called or
the read or take operation (or their variants) is called on the associated
com.rti.dds.subscription.DataReader (p. 487).
The
com.rti.dds.infrastructure.StatusKind.StatusKind.DATA ON READERS STATUS StatusChangedFlag becomes FALSE when any of
the following events occurs:
The corresponding listener operation (on data on readers) is called.
The on data available listener operation is called on any
com.rti.dds.subscription.DataReader (p. 487) belonging to
the com.rti.dds.subscription.Subscriber (p. 1476).
The read or take operation (or their variants) is called on any
com.rti.dds.subscription.DataReader (p. 487) belonging to the
See also:
com.rti.dds.infrastructure.Condition (p. 464)
(p. 1709),
114
6.48.3
6.48.3.1
final int STATUS MASK NONE [static, inherited]
No bits are set.

6.48.3.2
final int STATUS MASK ALL [static, inherited]
All bits are set.
6.49 SYSTEM RESOURCE LIMITS
6.49
115
SYSTEM RESOURCE LIMITS
<<eXtension>> ( p. 278) Configures DomainParticipant-independent resources used by RTI Connext.
Classes
class SystemResourceLimitsQosPolicy
Configures
( p. 654)independent resources used by RTI Connext. Mainly used to change
the maximum number of com.rti.dds.domain.DomainParticipant
( p. 654) entities that can be created within a single process (address space).
Variables
static final QosPolicyId t SYSTEMRESOURCELIMITS QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.SystemResourceLimitsQosPolicy
( p. 1523)
6.49.1
for
<<eXtension>> ( p. 278) Configures DomainParticipant-independent resources used by RTI Connext.
6.49.2
6.49.2.1
final QosPolicyId t SYSTEMRESOURCELIMITS QOS POLICY ID [static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.SystemResourceLimitsQosPolicy

(p. 1523)
116
6.50
Thread Settings
The properties of a thread of execution.
Classes
class ThreadSettings t
class ThreadSettingsCpuRotationKind
Determines how com.rti.dds.infrastructure.ThreadSettings t.cpu list
( p. 1531) affects processor affinity for thread-related QoS policies that apply to multiple threads.
class ThreadSettingsKind
A collection of flags used to configure threads of execution.
Variables
static final int THREAD SETTINGS KIND MASK DEFAULT
The mask of default thread options.
6.50.1
6.50.2
6.50.2.1
final int THREAD SETTINGS KIND MASK DEFAULT

[static, inherited]
6.51 TIME BASED FILTER
6.51
117
TIME BASED FILTER
Filter that allows a com.rti.dds.subscription.DataReader (p. 487) to specify that it is interested only in (potentially) a subset of the values of the data.
Classes
class TimeBasedFilterQosPolicy
the data.
Variables
static final QosPolicyId t TIMEBASEDFILTER QOS POLICY ID
Identifier for com.rti.dds.infrastructure.TimeBasedFilterQosPolicy
( p. 1541).
6.51.1
6.51.2
6.51.2.1
final QosPolicyId t TIMEBASEDFILTER QOS POLICY ID [static, inherited]
Identifier
(p. 1541).
for
com.rti.dds.infrastructure.TimeBasedFilterQosPolicy
118
6.52
TOPIC DATA

Classes
class TopicDataQosPolicy
Variables
static final QosPolicyId t TOPICDATA QOS POLICY ID
Identifier
( p. 1559).
6.52.1
for
com.rti.dds.infrastructure.TopicDataQosPolicy

6.52.2
6.52.2.1
final QosPolicyId t TOPICDATA QOS POLICY ID

[static, inherited]
Identifier for com.rti.dds.infrastructure.TopicDataQosPolicy (p. 1559).
6.53 TRANSPORT BUILTIN
6.53
119
TRANSPORT BUILTIN
<<eXtension>> ( p. 278) Specifies which built-in transports are used.
Classes
class TransportBuiltinKind
Built-in transport kind.
class TransportBuiltinQosPolicy
Specifies which built-in transports are used.
Variables
static final QosPolicyId t TRANSPORTBUILTIN QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.TransportBuiltinQosPolicy ( p. 1580)
for
static final String UDPv4 ALIAS

Alias name for the UDPv4 built-in transport.
static final String SHMEM ALIAS

Alias name for the shared memory built-in transport.

static final int MASK NONE

None of the built-in transports will be registered automatically
when
the
( p. 654)
is enabled.
The user must explictly register transports using
com.rti.ndds.transport.TransportSupport.register transport.
static final int MASK DEFAULT

The default value of com.rti.dds.infrastructure.TransportBuiltinQosPolicy.mask
( p. 1581).
static final int MASK ALL

All the available built-in transports are registered automatically when the
com.rti.dds.domain.DomainParticipant ( p. 654) is enabled.
120
6.53.1
<<eXtension>> ( p. 278) Specifies which built-in transports are used.

See also:
Changing the automatically registered built-in transports (p. 263)
6.53.2
6.53.2.1
final QosPolicyId t TRANSPORTBUILTIN QOS POLICY ID [static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.TransportBuiltinQosPolicy

(p. 1580)
6.53.2.2
final String UDPv4 ALIAS [static, inherited]
6.53.2.3
final String SHMEM ALIAS [static, inherited]
6.53.2.4
final String UDPv6 ALIAS [static, inherited]
6.53.2.5
final int MASK NONE [static, inherited]
None of the built-in transports will be registered automatically when the com.rti.dds.domain.DomainParticipant (p. 654)
is enabled.
See also:
com.rti.dds.infrastructure.TransportBuiltinKindMask
6.53 TRANSPORT BUILTIN

6.53.2.6
121
final int MASK DEFAULT [static, inherited]

(p. 1581).
The set of builtin transport plugins that will be automatically registered with
the participant by default. The user can register additional transports using
See also:
6.53.2.7
final int MASK ALL [static, inherited]
com.rti.dds.domain.DomainParticipant (p. 654) is enabled.
See also:
122
6.54
TRANSPORT MULTICAST MAPPING
<<eXtension>> ( p. 278) Specifies a list of topic expressions and addresses

that can be used by an Entity with a specific topic name to receive data.
6.55 TRANSPORT MULTICAST
6.55
123
TRANSPORT MULTICAST
<<eXtension>> ( p. 278) Specifies the multicast address on which a

com.rti.dds.subscription.DataReader (p. 487) wants to receive its data.
It can also specify a port number, as well as a subset of the available (at
the com.rti.dds.domain.DomainParticipant (p. 654) level) transports with
Classes
class TransportMulticastMappingQosPolicy
Specifies
the
multicast
address
on
which
a
com.rti.dds.subscription.DataReader ( p. 487) wants to receive its
data. It can also specify a port number as well as a subset of the available (at the com.rti.dds.domain.DomainParticipant ( p. 654) level)
transports with which to receive the multicast data.
class TransportMulticastQosPolicy
Specifies
the
multicast
address
on
which
a
class TransportMulticastQosPolicyKind
Transport Multicast Policy Kind.
Variables
POLICY ID
TRANSPORTMULTICAST QOS -
<<eXtension>>
(p. 278)
Identifier
for
com.rti.dds.infrastructure.TransportMulticastQosPolicy ( p. 1590)
static
final
TransportMulticastQosPolicyKind
TRANSPORT MULTICAST QOS
AUTOMATIC -
static final TransportMulticastQosPolicyKind UNICAST ONLY TRANSPORT MULTICAST QOS = new TransportMulticastQosPolicyKind(UNICAST ONLY TRANSPORT MULTICAST QOS,
1)
124
6.55.1
<<eXtension>> ( p. 278) Specifies the multicast address on which a

com.rti.dds.subscription.DataReader (p. 487) wants to receive its data.
It can also specify a port number, as well as a subset of the available (at
6.55.2
6.55.2.1
final QosPolicyId t TRANSPORTMULTICAST QOS POLICY ID [static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.TransportMulticastQosPolicy

(p. 1590)
6.55.2.2
final TransportMulticastQosPolicyKind
AUTOMATIC TRANSPORT MULTICAST QOS
[static, inherited]
Initial value:
new TransportMulticastQosPolicyKind(
"AUTOMATIC_TRANSPORT_MULTICAST_QOS", 0)

See also:
com.rti.dds.infrastructure.TransportMulticastQosPolicy.AUTOMATIC TRANSPORT MULTICAST QOS
6.55.2.3
final TransportMulticastQosPolicyKind
UNICAST ONLY TRANSPORT MULTICAST QOS =
new TransportMulticastQosPolicyKind(UNICAST ONLY TRANSPORT MULTICAST QOS, 1) [static,
inherited]

6.55 TRANSPORT MULTICAST

See also:
com.rti.dds.infrastructure.TransportMulticastQosPolicy.UNICAST ONLY TRANSPORT MULTICAST QOS
125
126
6.56
TRANSPORT PRIORITY
This QoS policy allows the application to take advantage of transports that are
capable of sending messages with different priorities.
Classes
class TransportPriorityQosPolicy
Variables
static
final
POLICY ID
QosPolicyId t
TRANSPORTPRIORITY QOS -
Identifier for com.rti.dds.infrastructure.TransportPriorityQosPolicy

( p. 1598).
6.56.1
6.56.2
6.56.2.1
final QosPolicyId t TRANSPORTPRIORITY QOS POLICY ID [static, inherited]
Identifier for
(p. 1598).
com.rti.dds.infrastructure.TransportPriorityQosPolicy
6.57 TRANSPORT SELECTION
6.57
127
TRANSPORT SELECTION
Specifies
the
physical
transports
<<eXtension>>
( p. 278)
that
a
(p. 557)
or
com.rti.dds.subscription.DataReader (p. 487) may use to send or receive data.
Classes
class TransportSelectionQosPolicy
Specifies the physical transports a com.rti.dds.publication.DataWriter
( p. 557) or com.rti.dds.subscription.DataReader ( p. 487) may use to
send or receive data.
Variables
POLICY ID
TRANSPORTSELECTION QOS -
<<eXtension>>
(p. 278)
Identifier
for
com.rti.dds.infrastructure.TransportSelectionQosPolicy ( p. 1600)
6.57.1
<<eXtension>>
( p. 278)
Specifies
the
physical
transports
that
a
(p. 557)
or
com.rti.dds.subscription.DataReader (p. 487) may use to send or receive data.
6.57.2
6.57.2.1
final QosPolicyId t TRANSPORTSELECTION QOS POLICY ID [static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.TransportSelectionQosPolicy

(p. 1600)
128
6.58
TRANSPORT UNICAST
<<eXtension>> ( p. 278) Specifies a subset of transports and a port number

Classes
class TransportUnicastQosPolicy
Specifies a subset of transports and a port number that can be used by an
Entity ( p. 931) to receive data.
Variables
static
final
POLICY ID
QosPolicyId t
TRANSPORTUNICAST QOS -
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.TransportUnicastQosPolicy ( p. 1605)
6.58.1
for
<<eXtension>> ( p. 278) Specifies a subset of transports and a port number

6.58.2
6.58.2.1
final QosPolicyId t TRANSPORTUNICAST QOS POLICY ID [static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.TransportUnicastQosPolicy

(p. 1605)
6.59 TYPE CONSISTENCY ENFORCEMENT
6.59
129
TYPE CONSISTENCY ENFORCEMENT
Defines the rules for determining whether the type used to publish a given topic
is consistent with that used to subscribe to it.
Classes
class TypeConsistencyEnforcementQosPolicy
topic ( p. 359) is consistent with that used to subscribe to it.
class TypeConsistencyKind
Kinds of type consistency.
6.59.1
is consistent with that used to subscribe to it.
130
6.60
TYPESUPPORT
<<eXtension>> ( p. 278) Allows you to attach application-specific values to a

DataWriter or DataReader that are passed to the serialization or deserialization
routine of the associated data type.
Classes
class TypeSupportQosPolicy
Allows you to attach application-specific values to a DataWriter or
DataReader that are passed to the serialization or deserialization routine
of the associated data type.
Variables
static final QosPolicyId t TYPESUPPORT QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.TypeSupportQosPolicy ( p. 1666)
for
static final QosPolicyId t ENTITYNAME QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
6.60.1
for
<<eXtension>> ( p. 278) Allows you to attach application-specific values to a

DataWriter or DataReader that are passed to the serialization or deserialization
routine of the associated data type.
6.60.2
6.60.2.1
final QosPolicyId t TYPESUPPORT QOS POLICY ID

[static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.TypeSupportQosPolicy

(p. 1666)
6.60 TYPESUPPORT
6.60.2.2
131
final QosPolicyId t ENTITYNAME QOS POLICY ID

[static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.TypeSupportQosPolicy

(p. 1666)
132
6.61
USER DATA

Classes
class UserDataQosPolicy
Variables
static final QosPolicyId t USERDATA QOS POLICY ID
Identifier for com.rti.dds.infrastructure.UserDataQosPolicy ( p. 1694).
6.61.1

6.61.2
6.61.2.1
final QosPolicyId t USERDATA QOS POLICY ID

[static, inherited]
Identifier for com.rti.dds.infrastructure.UserDataQosPolicy (p. 1694).
6.62 Exception Codes
6.62
133
Exception Codes
<<eXtension>> ( p. 278) Exception codes.
Classes
class BAD PARAM
The exception BadKind ( p. 409) is thrown when an inappropriate operation
is invoked on a TypeCode object.
class BAD TYPECODE

class BadKind
class BadMemberId
The specified com.rti.dds.typecode.TypeCode ( p. 1611) member ID is invalid.
class BadMemberName
The specified com.rti.dds.typecode.TypeCode ( p. 1611) member name is
invalid.
class Bounds
A user exception thrown when a parameter is not within the legal bounds.
class SystemException
System exception.
class UserException
User exception.
6.62.1
<<eXtension>> ( p. 278) Exception codes.

These exceptions are used for error handling by the Type Code Support
(p. 165) API.
134
6.63
WIRE PROTOCOL
<<eXtension>> ( p. 278) Specifies the wire protocol related attributes for the
Classes
class RtpsReservedPortKind
RTPS reserved port kind, used to identify the types of ports that can be reserved on domain ( p. 328) participant enable.
class RtpsWellKnownPorts t
RTPS well-known port mapping configuration.
class WireProtocolQosPolicy
Specifies
the
wire-protocol-related
attributes
for
the
class WireProtocolQosPolicyAutoKind
Kind of auto mechanism used to calculate the GUID prefix.
Variables
static final QosPolicyId t WIREPROTOCOL QOS POLICY ID
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.WireProtocolQosPolicy ( p. 1723)
for
static final int MASK DEFAULT = BUILTIN UNICAST | BUILTIN MULTICAST | USER UNICAST
The default value of com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps reserved port mask ( p. 1731).

No bits are set.

All bits are set.
static
final
RtpsWellKnownPorts t
RTI BACKWARDS COMPATIBLE RTPS WELL KNOWN PORTS
Assign to use well-known port mappings which are compatible with previous
versions of the RTI Connext middleware.
6.63 WIRE PROTOCOL
static final RtpsWellKnownPorts t

WELL KNOWN PORTS
135
INTEROPERABLE RTPS -
Assign to use well-known port mappings which are compliant with OMGs
DDS Interoperability Wire Protocol.
static final WireProtocolQosPolicyAutoKind RTPS AUTO ID FROM IP = new WireProtocolQosPolicyAutoKind(RTPS AUTO ID FROM IP, 0)
static final WireProtocolQosPolicyAutoKind RTPS AUTO ID FROM MAC = new WireProtocolQosPolicyAutoKind(RTPS AUTO ID FROM MAC, 1)
6.63.1
<<eXtension>> ( p. 278) Specifies the wire protocol related attributes for the
6.63.2
6.63.2.1
final QosPolicyId t WIREPROTOCOL QOS POLICY ID

[static, inherited]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.WireProtocolQosPolicy

(p. 1723)
6.63.2.2
final int MASK DEFAULT = BUILTIN UNICAST |

BUILTIN MULTICAST | USER UNICAST [static,
inherited]
The default value of com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps reserved port mask (p. 1731).

Most of the ports that may be needed by DDS will be reserved
by the transport when the participant is enabled.
With this value
set, failure to allocate a port that is computed based on the
com.rti.dds.infrastructure.RtpsWellKnownPorts t (p. 1390) will be
detected at this time and the enable operation will fail.
136
This setting will avoid reserving the usertraffic multicast port, which is not
actually used unless there are DataReaders that enable multicast but fail to
specify a port.
Automatic participant ID selection will be based on finding a participant index
with both the discovery (metatraffic) unicast port and usertraffic unicast port
available.
See also:
com.rti.dds.infrastructure.RtpsReservedPortKindMask
6.63.2.3
final int MASK NONE [static, inherited]
No bits are set.

None of the ports that are needed by DDS will be allocated until they are
specifically required. With this value set, automatic participant Id selection
will be based on selecting a port for discovery (metatraffic) unicast traffic on a
single transport.
See also:
6.63.2.4
final int MASK ALL [static, inherited]
All bits are set.

All of the ports that may be needed by DDS will be reserved when the participant is enabled. With this value set, failure to allocate a port that is computed based on the com.rti.dds.infrastructure.RtpsWellKnownPorts t
(p. 1390) will be detected at this time, and the enable operation will fail.
Note that this will also reserve the usertraffic multicast port which is not
actually used unless there are DataReaders that enable multicast but fail to
specify a port. To avoid unnecesary resource usage for these ports, use RTPS RESERVED PORT MASK DEFAULT.
Automatic participant ID selection will be based on finding a participant index
with both the discovery (metatraffic) unicast port and usertraffic unicast port
available.
See also:
6.63 WIRE PROTOCOL

6.63.2.5
137
final RtpsWellKnownPorts t RTI BACKWARDS COMPATIBLE RTPS WELL KNOWN PORTS [static,
inherited]
Assign com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps well known ports (p. 1729) to this value to remain compatible with previous
versions of the RTI Connext middleware that used fixed port mappings.
values
for
The
following
are
the
rtps well known ports
com.rti.dds.infrastructure.RtpsWellKnownPorts t.RTI BACKWARDS COMPATIBLE RTPS WELL KNOWN PORTS
(p. 137):
port base = 7400
domain id gain = 10
participant id gain = 1000
builtin multicast port offset = 2
builtin unicast port offset = 0
user multicast port offset = 1
user unicast port offset = 3
These settings are not compliant with OMGs DDS Interoperability Wire Protocol.
To comply with the specification,
please
use
com.rti.dds.infrastructure.RtpsWellKnownPorts t.INTEROPERABLE RTPS WELL KNOWN PORTS (p. 137).
See also:
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps well known ports (p. 1729)
com.rti.dds.infrastructure.RtpsWellKnownPorts t.INTEROPERABLE RTPS WELL KNOWN PORTS (p. 137)
6.63.2.6
final RtpsWellKnownPorts t INTEROPERABLE RTPS WELL KNOWN PORTS [static,

inherited]
Assign to use well-known port mappings which are compliant with OMGs DDS
Interoperability Wire Protocol.
Assign com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps well known ports (p. 1729) to this value to use well-known port mappings which
138
are compliant with OMGs DDS Interoperability Wire Protocol.

The
following
are
the
rtps well known ports
values
for
com.rti.dds.infrastructure.RtpsWellKnownPorts t.INTEROPERABLE RTPS WELL KNOWN PORTS (p. 137):
port base = 7400
domain id gain = 250
participant id gain = 2
builtin multicast port offset = 0
builtin unicast port offset = 10
user multicast port offset = 1
user unicast port offset = 11
Assuming a maximum port number of 65535 (UDPv4), the above settings enable
the use of about 230 domains with up to 120 Participants per node per domain
(p. 328).
These settings are not backwards compatible with previous versions of the RTI
Connext middleware that used fixed port mappings. For backwards compability, please use com.rti.dds.infrastructure.RtpsWellKnownPorts t.RTI BACKWARDS COMPATIBLE RTPS WELL KNOWN PORTS
(p. 137).
See also:
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps well known ports (p. 1729)
com.rti.dds.infrastructure.RtpsWellKnownPorts t.RTI BACKWARDS COMPATIBLE RTPS WELL KNOWN PORTS
(p. 137)
6.63.2.7
final WireProtocolQosPolicyAutoKind
RTPS AUTO ID FROM IP = new
WireProtocolQosPolicyAutoKind(RTPS AUTO ID FROM IP, 0) [static,
inherited]

See also:
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps auto id kind.RTPS AUTO ID FROM IP
6.63 WIRE PROTOCOL

6.63.2.8
final WireProtocolQosPolicyAutoKind
RTPS AUTO ID FROM MAC = new
WireProtocolQosPolicyAutoKind(RTPS AUTO ID FROM MAC, 1) [static,
inherited]

See also:
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps auto id kind.RTPS AUTO ID FROM MAC
139
140
6.64
WRITER DATA LIFECYCLE
Controls how a DataWriter handles the lifecycle of the instances (keys) that it
is registered to manage.
Classes
class WriterDataLifecycleQosPolicy
Controls how a com.rti.dds.publication.DataWriter ( p. 557) handles the
lifecycle of the instances (keys) that it is registered to manage.
Variables
POLICY ID
WRITERDATALIFECYCLE QOS -
Identifier for com.rti.dds.infrastructure.WriterDataLifecycleQosPolicy

( p. 1738).
6.64.1
Controls how a DataWriter handles the lifecycle of the instances (keys) that it
is registered to manage.
6.64.2
6.64.2.1
final QosPolicyId t WRITERDATALIFECYCLE QOS POLICY ID [static, inherited]

(p. 1738).
6.65 KeyedString Built-in Type
6.65
141
KeyedString Built-in Type
Built-in type consisting of a single character string.
Classes
class KeyedString
Keyed string built-in type.
class KeyedStringDataReader
<<interface>>
(p. 279)
Instantiates
DataReader
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString >.
<
class KeyedStringDataWriter
<<interface>>
(p. 279)
Instantiates
DataWriter
<
class KeyedStringSeq
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString > .
class KeyedStringTypeSupport
<<interface>> (p. 279) Keyed string type support.
6.65.1

defgroup DDSStringBuiltInTypeModule String Built-in Type
Built-in type consisting of a string payload and a second string that is the key.
142
6.66
Octets Built-in Type
Built-in type consisting of a variable-length array of opaque bytes.
Classes
class Bytes
class BytesDataReader
<<interface>>
(p. 279)
Instantiates
DataReader
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes >.
<
class BytesDataWriter
<<interface>>
(p. 279)
Instantiates
DataWriter
<
class BytesSeq
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes > .
class BytesTypeSupport
<<interface>> (p. 279) com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes
type support.
6.66.1
6.67 KeyedOctets Built-in Type
6.67
143
KeyedOctets Built-in Type
Built-in type consisting of a variable-length array of opaque bytes and a string

that is the key.
Classes
class KeyedBytes
that is the key.
class KeyedBytesDataReader
<<interface>>
(p. 279)
Instantiates
DataReader
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes >.
<
class KeyedBytesDataWriter
<<interface>>
(p. 279)
Instantiates
DataWriter
<
class KeyedBytesSeq
class KeyedBytesTypeSupport
<<interface>> (p. 279) com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes
type support.
6.67.1

that is the key.
144
6.68
Sequence Support
The com.rti.dds.infrastructure.com.rti.dds.util.Sequence interface allows you to

work with variable-length collections of homogeneous data.
Modules
Built-in Sequences
Defines sequences of primitive data type.
Classes
interface Sequence
<<interface>> (p. 279) <<generic>> (p. 279) A type-safe, ordered collection of elements. The type of these elements is referred to in this documentation as com.rti.ndds.example.Foo (p. 977).
class FooSeq
6.68.1
The com.rti.dds.infrastructure.com.rti.dds.util.Sequence interface allows you to

work with variable-length collections of homogeneous data.
This interface is a minimal extension to the standard java.util.List interface,
making it easier to use RTI Connext alongside other Java APIs.
The java.util.List interface does not provide direct support for lists of primitive types. The Built-in Sequences (p. 208) provide extension APIs for working with collections of primitive elements without the overhead of boxing the
unboxing.
When you use the rtiddsgen (p. 298) code generation tool, it will automatically
generate concrete sequence instantiations for each of your own custom types.
See also:
http://java.sun.com/javase/6/docs/api/java/util/List.html
6.69 Clock Selection
6.69
145
Clock Selection
APIs related to clock selection. RTI Connext uses clocks to measure time and
generate timestamps.
The middleware uses two clocks, an internal clock and an external clock. The
internal clock is used to measure time and handles all timing in the middleware.
The external clock is used solely to generate timestamps, such as the source
timestamp and the reception timestamp, in addition to providing the time given
by com.rti.dds.domain.DomainParticipant.get current time (p. 723).
6.69.1
Available Clocks
Two clock implementations are generally available, the monotonic clock and the
realtime clock.
The monotonic clock provides times that are monotonic from a clock that is not
adjustable. This clock is useful to use in order to not be subject to changes in
the system or realtime clock, which may be adjusted by the user or via time
synchronization protocols. However, this time generally starts from an arbitrary
point in time, such as system startup. Note that this clock is not available for
all architectures. Please see the Platform Notes for the architectures on which
it is supported. For the purposes of clock selection, this clock can be referenced
by the name monotonic.
The realtime clock provides the realtime of the system. This clock may generally
be monotonic but may not be guaranteed to be so. It is adjustable and may be
subject to small and large changes in time. The time obtained from this clock
is generally a meaningful time in that it is the amount of time from a known
epoch. For the purposes of clock selection, this clock can be referenced by the
names realtime or system.
6.69.2
Clock Selection Strategy
By default, both the internal and external clocks use the real-time clock. If you
want your application to be robust to changes in the system time, you may use
the monotonic clock as the internal clock, and leave the system clock as the
external clock. Note, however, that this may slightly diminish performance in
that both the send and receive paths may need to obtain times from both clocks.
Since the monotonic clock is not available on all architectures, you may want
to specify monotonic,realtime for the internal clock (see the table below). By
doing so, the middleware will attempt to use the monotonic clock if available,
and will fall back to the realtime clock if the monotonic clock is not available.
If you want your application to be robust to changes in the system time, you
are not relying on source timestamps, and you want to avoid obtaining times
146
from both clocks, you may use the monotonic clock for both the internal and
external clocks.
6.69.3
Configuring Clock Selection
To configure the clock selection, use the PROPERTY (p. 92) QoS policy associated with the com.rti.dds.domain.DomainParticipant (p. 654).
See also:
com.rti.dds.infrastructure.PropertyQosPolicy (p. 1236)
The following table lists the supported clock selection properties.
Property
dds.clock.external clock
dds.clock.internal clock
Description
Comma-delimited list of clocks to
use for the external clock, in the
order of preference. Valid clock
names are realtime, system,
and monotonic.
Default: realtime
Comma-delimited list of clocks to
use for the internal clock, in the
order of preference. Valid clock
names are realtime, system,
and monotonic.
Default: realtime
Table 6.1: Clock Selection Properties
6.70 Domain Module
6.70
147
Domain Module
Contains the com.rti.dds.domain.DomainParticipant (p. 654) class that

acts as an entrypoint of RTI Connext and acts as a factory for many of the
classes. The com.rti.dds.domain.DomainParticipant (p. 654) also acts as
a container for the other objects that make up RTI Connext.
Modules
com.rti.dds.domain.DomainParticipantFactory ( p. 742) entity and associated elements
DomainParticipants
com.rti.dds.domain.DomainParticipant ( p. 654) entity and associated
elements
Built-in Topics
Built-in objects created by RTI Connext but accessible to the application.
Variables
static DomainParticipantFactory TheParticipantFactory = create singletonI()
Can be used as an alias for the singleton factory returned by the operation com.rti.dds.domain.DomainParticipantFactory.get instance()
( p. 747).
6.70.1

148
6.70.2
6.70.2.1
DomainParticipantFactory TheParticipantFactory =
create singletonI() [static, inherited]
Can be used as an alias for the singleton factory returned by the operation
com.rti.dds.domain.DomainParticipantFactory.get instance() (p. 747).
See also:
com.rti.dds.domain.DomainParticipantFactory.get instance
(p. 747)
6.71 DomainParticipantFactory
6.71
149
com.rti.dds.domain.DomainParticipantFactory (p. 742) entity and associated elements
Classes
class DomainParticipantFactory
<<singleton>> (p. 279) <<interface>> (p. 279) Allows creation and destruction of com.rti.dds.domain.DomainParticipant ( p. 654) objects.
class DomainParticipantFactoryQos
QoS policies supported by a com.rti.dds.domain.DomainParticipantFactory
( p. 742).
Variables
static
final
DEFAULT
PARTICIPANT QOS -
Special value for creating a DomainParticipant ( p. 654) with default QoS.
6.71.1
com.rti.dds.domain.DomainParticipantFactory (p. 742) entity and associated elements
6.71.2
6.71.2.1
final DomainParticipantQos PARTICIPANT QOS DEFAULT [static, inherited]
Initial value:
new DomainParticipantQos()
Special value for creating a DomainParticipant (p. 654) with default QoS.
When used in com.rti.dds.domain.DomainParticipantFactory.create participant (p. 748), this special value is used to indicate that the
com.rti.dds.domain.DomainParticipant (p. 654) should be created with
150
the default com.rti.dds.domain.DomainParticipant (p. 654) QoS by means

of the operation com.rti.dds.domain.DomainParticipantFactory.get default participant qos() (p. 750) and using the resulting QoS to create the
When used in com.rti.dds.domain.DomainParticipantFactory.set default participant qos (p. 751), this special value is used to indicate that
the default QoS should be reset back to the initial value that would be used
if the com.rti.dds.domain.DomainParticipantFactory.set default participant qos (p. 751) operation had never been called.
When
used
in
com.rti.dds.domain.DomainParticipant.set qos (p. 705), this special value is used to indicate that the
QoS
of
the
(p. 654)
should be changed to match the current default QoS set in the
(p. 742)
that
the
com.rti.dds.domain.DomainParticipant (p. 654) belongs to.
RTI Connext treats this special value as a constant.
Note:
You cannot use this value to get the default QoS values
from the DomainParticipant (p. 654) factory;
for this purpose,
use
com.rti.dds.domain.DomainParticipantFactory.get default participant qos (p. 750).
See also:
NDDS DISCOVERY PEERS (p. 57)
com.rti.dds.domain.DomainParticipantFactory.create participant() (p. 748)
com.rti.dds.domain.DomainParticipantFactory.set default participant qos() (p. 751)
com.rti.dds.domain.DomainParticipant.set qos() (p. 705)
6.72 DomainParticipants
6.72
151
DomainParticipants
com.rti.dds.domain.DomainParticipant (p. 654) entity and associated elements
Classes
interface DomainParticipant
<<interface>>
(p. 279)
Container
for
com.rti.dds.infrastructure.DomainEntity ( p. 653) objects.
all
class DomainParticipantAdapter
<<eXtension>> (p. 278) A listener adapter in the spirit of the Java AWT
listener adapters. (The Adapter provides empty implementations for the listener methods)
interface DomainParticipantListener
<<interface>> (p. 279) Listener for participant status.
class DomainParticipantQos
QoS policies supported by a com.rti.dds.domain.DomainParticipant
( p. 654) entity.
Variables
static final TopicQos TOPIC QOS DEFAULT = new TopicQos()
Special value for creating a com.rti.dds.topic.Topic ( p. 1545) with default
QoS.
static final PublisherQos PUBLISHER QOS DEFAULT = new PublisherQos()

Special value for creating a com.rti.dds.publication.Publisher ( p. 1262)
with default QoS.
static final SubscriberQos SUBSCRIBER QOS DEFAULT

Special value for creating a com.rti.dds.subscription.Subscriber ( p. 1476)
with default QoS.
static final FlowControllerProperty t

PROPERTY DEFAULT
FLOW CONTROLLER -
<<eXtension>>
(p. 278)
Special
value
for
creating
a
com.rti.dds.publication.FlowController ( p. 964) with default property.
152
static final String SQLFILTER NAME

<<eXtension>> (p. 278) The name of the built-in SQL filter that can be
used with ContentFilteredTopics and MultiChannel DataWriters.
static final String STRINGMATCHFILTER NAME

<<eXtension>> (p. 278) The name of the built-in StringMatch filter that
can be used with ContentFilteredTopics and MultiChannel DataWriters.
6.72.1
com.rti.dds.domain.DomainParticipant (p. 654) entity and associated elements
6.72.2
6.72.2.1
final TopicQos TOPIC QOS DEFAULT = new TopicQos()

[static, inherited]
Special value for creating a com.rti.dds.topic.Topic (p. 1545) with default

QoS.
When used in com.rti.dds.domain.DomainParticipant.create topic
(p. 697), this special value is used to indicate that the com.rti.dds.topic.Topic
(p. 1545) should be created with the default com.rti.dds.topic.Topic (p. 1545)
QoS by means of the operation get default topic qos and using the resulting
QoS to create the com.rti.dds.topic.Topic (p. 1545).
When used in com.rti.dds.domain.DomainParticipant.set default topic qos (p. 667), this special value is used to indicate that the default QoS should be reset back to the initial value that would be
used if the com.rti.dds.domain.DomainParticipant.set default topic qos (p. 667) operation had never been called.
When used in com.rti.dds.topic.Topic.set qos (p. 1547), this special
value is used to indicate that the QoS of the com.rti.dds.topic.Topic
(p. 1545) should be changed to match the current default QoS set
in the com.rti.dds.domain.DomainParticipant (p. 654) that the
com.rti.dds.topic.Topic (p. 1545) belongs to.
Note: You cannot use this value to get the default QoS values for a Topic; for
this purpose, use com.rti.dds.domain.DomainParticipant.get default topic qos (p. 667).
153
See also:
com.rti.dds.domain.DomainParticipant.create topic (p. 697)
com.rti.dds.domain.DomainParticipant.set default topic qos
(p. 667)
com.rti.dds.topic.Topic.set qos (p. 1547)
6.72.2.2
final PublisherQos PUBLISHER QOS DEFAULT = new

PublisherQos() [static, inherited]
Special value for creating a com.rti.dds.publication.Publisher (p. 1262)

with default QoS.
When
used
in
com.rti.dds.domain.DomainParticipant.create publisher (p. 683), this special value is used to indicate that the
com.rti.dds.publication.Publisher (p. 1262) should be created with
the default com.rti.dds.publication.Publisher (p. 1262) QoS by means of
the operation get default publisher qos and using the resulting QoS to create
the com.rti.dds.publication.Publisher (p. 1262).
When used in com.rti.dds.domain.DomainParticipant.set default publisher qos (p. 671), this special value is used to indicate that the default QoS should be reset back to the initial value that would be used
if the com.rti.dds.domain.DomainParticipant.set default publisher qos (p. 671) operation had never been called.
When used in com.rti.dds.publication.Publisher.set qos (p. 1275),
this special value is used to indicate that the QoS of the
com.rti.dds.publication.Publisher (p. 1262) should be changed to match
the current default QoS set in the com.rti.dds.domain.DomainParticipant
(p. 654) that the com.rti.dds.publication.Publisher (p. 1262) belongs to.
Note: You cannot use this value to get the default QoS values for a Publisher; for this purpose, use com.rti.dds.domain.DomainParticipant.get default publisher qos (p. 670).
See also:
com.rti.dds.domain.DomainParticipant.create publisher (p. 683)
com.rti.dds.domain.DomainParticipant.set default publisher qos
(p. 671)
com.rti.dds.publication.Publisher.set qos (p. 1275)
6.72.2.3
final SubscriberQos SUBSCRIBER QOS DEFAULT

[static, inherited]
Initial value:
154
new SubscriberQos()
Special value for creating a com.rti.dds.subscription.Subscriber (p. 1476)

with default QoS.
When
used
in
com.rti.dds.domain.DomainParticipant.create subscriber (p. 686), this special value is used to indicate that the
com.rti.dds.subscription.Subscriber (p. 1476) should be created with
the default com.rti.dds.subscription.Subscriber (p. 1476) QoS by means of
the operation get default subscriber qos and using the resulting QoS to create
When used in com.rti.dds.domain.DomainParticipant.set default subscriber qos (p. 676), this special value is used to indicate that the default QoS should be reset back to the initial value that would be used if
the com.rti.dds.domain.DomainParticipant.set default subscriber qos
(p. 676) operation had never been called.
When
used
in
com.rti.dds.subscription.Subscriber.set qos
(p. 1492), this special value is used to indicate that the QoS of the
com.rti.dds.subscription.Subscriber (p. 1476) should be changed to match
the current default QoS set in the com.rti.dds.domain.DomainParticipant
(p. 654) that the com.rti.dds.subscription.Subscriber (p. 1476) belongs to.
Note: You cannot use this value to get the default QoS values for a Subscriber;
for this purpose, use com.rti.dds.domain.DomainParticipant.get default subscriber qos (p. 678).
See also:
com.rti.dds.domain.DomainParticipant.create subscriber (p. 686)
com.rti.dds.domain.DomainParticipant.get default subscriber qos (p. 678)
com.rti.dds.subscription.Subscriber.set qos (p. 1492)
6.72.2.4
final FlowControllerProperty t FLOW CONTROLLER PROPERTY DEFAULT [static,

inherited]
Initial value:
new FlowControllerProperty_t()
Special
value
for
creating
<<eXtension>>
( p. 278)
com.rti.dds.publication.FlowController (p. 964) with default property.
When
used
in
com.rti.dds.domain.DomainParticipant.create flowcontroller (p. 681), this special value is used to indicate that the
155
com.rti.dds.publication.FlowController (p. 964) should be created with

the default com.rti.dds.publication.FlowController (p. 964) property by
means of the operation get default flowcontroller property and using the resulting QoS to create the com.rti.dds.publication.FlowControllerProperty t
(p. 968).
When used in com.rti.dds.domain.DomainParticipant.set default flowcontroller property (p. 666), this special value is used to indicate
that the default QoS should be reset back to the initial value that would
be used if the com.rti.dds.domain.DomainParticipant.set default flowcontroller property (p. 666) operation had never been called.
When
used
in
com.rti.dds.publication.FlowController.set property (p. 965), this special value is used to indicate that the
property of the com.rti.dds.publication.FlowController (p. 964)
should be changed to match the current default property set in
the
(p. 654)
that
the
com.rti.dds.publication.FlowController (p. 964) belongs to.
Note: You cannot use this value to get the default properties for a FlowController; for this purpose, use com.rti.dds.domain.DomainParticipant.get default flowcontroller property (p. 665).
See also:
com.rti.dds.domain.DomainParticipant.create flowcontroller
(p. 681)
com.rti.dds.domain.DomainParticipant.set default flowcontroller property (p. 666)
com.rti.dds.publication.FlowController.set property (p. 965)
6.72.2.5
final String SQLFILTER NAME [static, inherited]
<<eXtension>> ( p. 278) The name of the built-in SQL filter that can be
See also:
Queries and Filters Syntax (p. 286)
6.72.2.6
final String STRINGMATCHFILTER NAME [static,

inherited]
<<eXtension>> ( p. 278) The name of the built-in StringMatch filter that

156
The StringMatch Filter is a subset of the SQL filter; it only supports the
MATCH relational operator on a single string field.
See also:
6.73 Built-in Topics
6.73
157
Built-in Topics
Packages
package com.rti.dds.domain.builtin
Builtin topic ( p. 359) for accessing information about the DomainParticipants discovered by RTI Connext.
package com.rti.dds.publication.builtin
Builtin topic ( p. 359) for accessing information about the Publications discovered by RTI Connext.
package com.rti.dds.subscription.builtin
Builtin topic ( p. 359) for accessing information about the Subscriptions discovered by RTI Connext.
package com.rti.dds.topic.builtin
Builtin topic ( p. 359) for accessing information about the Topics discovered
by RTI Connext.
Classes
class ContentFilterProperty t
<<eXtension>> (p. 278) Type used to provide all the required information
to enable content filtering.
class Locator t
<<eXtension>> (p. 278) Type used to represent the addressing information
needed to send a message to an RTPS Endpoint using one of the supported
transports.
class LocatorSeq
Declares IDL sequence < com.rti.dds.infrastructure.Locator t ( p. 1150)
>.
class ProductVersion t
<<eXtension>> (p. 278) Type used to represent the current version of RTI
Connext.
class ProtocolVersion t
158
<<eXtension>> (p. 278) Type used to represent the version of the RTPS
protocol.
class VendorId t
<<eXtension>> (p. 278) Type used to represent the vendor of the service
implementing the RTPS protocol.
class BuiltinTopicKey t
The key type of the built-in topic ( p. 359) types.
6.73.1

RTI Connext must discover and keep track of the remote entities, such as new
participants in the domain. This information may also be important to the
application, which may want to react to this discovery, or else access it on
demand.
A
set
of
built-in
topics
and
corresponding
com.rti.dds.subscription.DataReader (p. 487) objects are introduced
to be used by the application to access these discovery information.
The information can be accessed as if it was normal application data. This
allows the application to know when there are any changes in those values by means of the com.rti.dds.infrastructure.Listener (p. 1130) or the
com.rti.dds.infrastructure.Condition (p. 464) mechanisms.
The
built-in
data-readers
all
belong
to
a
built-in
com.rti.dds.subscription.Subscriber (p. 1476), which can be retrieved by
using the method com.rti.dds.domain.DomainParticipant.get builtin subscriber (p. 711). The built-in com.rti.dds.subscription.DataReader
(p. 487)
objects
can
be
retrieved
by
using
the
operation
com.rti.dds.subscription.Subscriber.lookup datareader
(p. 1488),
with the topic name as a parameter.
Built-in entities have default listener settings as well.
The built-in
com.rti.dds.subscription.Subscriber (p. 1476) and all of its built-in topics
have nil listeners with all statuses appearing in their listener masks (acting
as a NO-OP listener that does not reset communication status). The built-in
DataReaders have null listeners with no statuses in their masks.
The information that is accessible about the remote entities by means of the
built-in topics includes all the QoS policies that apply to the corresponding
remote Entity. This QoS policies appear as normal data fields inside the data
read by means of the built-in Topic. Additional information is provided to
identify the Entity and facilitate the application logic.
6.73 Built-in Topics
159
The
built-in
(p. 487)
will
not provide data pertaining to entities created from the same
com.rti.dds.domain.DomainParticipant (p. 654) under the assumption that such entities are already known to the application that created
them.
Refer to builtin.ParticipantBuiltinTopicData, builtin.TopicBuiltinTopicData,
builtin.SubscriptionBuiltinTopicData and builtin.PublicationBuiltinTopicData
for a description of all the built-in topics and their contents.
The QoS of the built-in com.rti.dds.subscription.Subscriber (p. 1476) and
com.rti.dds.subscription.DataReader (p. 487) objects is given by the following table:
160
QoS
Value
0-length sequence
com.rti.dds.infrastructure.UserDataQosPolicy
(p. 1694)
0-length sequence
(p. 1559)
0-length sequence
(p. 1039)
com.rti.dds.infrastructure.DurabilityQosPolicy
com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQ
(p. 802)
LOCAL DURABILITY QOS
Does not apply as
com.rti.dds.infrastructure.DurabilityQosPolicyKind
com.rti.dds.infrastructure.DurabilityServiceQosPolicy
(p. 807) is
(p. 810)
com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQ
LOCAL DURABILITY QOS
access scope =
com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeK
(p. 1221)
PRESENTATION QOS
coherent access =
com.rti.dds.infrastructure.false
ordered access =
Period = infinite
com.rti.dds.infrastructure.DeadlineQosPolicy
(p. 628)
duration = 0
(p. 1124)
com.rti.dds.infrastructure.OwnershipQosPolicyKind.Ownership
(p. 1199)
OWNERSHIP QOS
value = 0
com.rti.dds.infrastructure.OwnershipStrengthQosPolicy
(p. 1209)
kind =
com.rti.dds.infrastructure.LivelinessQosPolicy
com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQo
(p. 1140)
LIVELINESS QOS lease duration =
0
minimum separation = 0
com.rti.dds.infrastructure.TimeBasedFilterQosPolicy
(p. 1541)
0-length sequence
com.rti.dds.infrastructure.PartitionQosPolicy
(p. 1217)
Generated on Mon Aug 13 09:02:20 2012
for RTI
kind
= Connext Java API by Doxygen
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQ
(p. 1324)
RELIABILITY QOS
max blocking time = 100
milliseconds
com.rti.dds.infrastructure.DestinationOrderQosPolicy
com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.Des
(p. 631)
RECEPTION TIMESTAMP -
6.74 Topic Module
6.74
161
Topic Module
Contains
the
(p. 1545),
(p. 471),
and
com.rti.dds.topic.MultiTopic
(p. 1190)
classes,
the
com.rti.dds.topic.TopicListener (p. 1564) interface, and more generally, all that is needed by an application to define com.rti.dds.topic.Topic
(p. 1545) objects and attach QoS policies to them.
Modules
Topics
com.rti.dds.topic.Topic ( p. 1545) entity and associated elements
User Data Type Support

Defines generic classes and macros to support user data types.
Type Code Support

<<eXtension>> (p. 278) A com.rti.dds.typecode.TypeCode (p. 1611)
is a mechanism for representing a type at runtime. RTI Connext can use type
codes to send type definitions on the network. You will need to understand
this API in order to use the Dynamic Data ( p. 175) capability or to inspect
the type information you receive from remote readers and writers.
Built-in Types
<<eXtension>> (p. 278) RTI Connext provides a set of very simple data
types for you to use with the topics in your application.
Dynamic Data
<<eXtension>> (p. 278) The Dynamic Data API provides a way to interact with arbitrarily complex data types at runtime without the need for code
generation.
6.74.1
Contains
the
(p. 1545),
(p. 471),
and
(p. 1190)
classes,
the
162
6.75
Topics
com.rti.dds.topic.Topic (p. 1545) entity and associated elements
Classes
interface ContentFilter
<<interface>> (p. 279) Interface to be used by a custom filter of a
com.rti.dds.topic.ContentFilteredTopic ( p. 471)
interface ContentFilteredTopic
<<interface>>
(p. 279)
Specialization
of
com.rti.dds.topic.TopicDescription ( p. 1561) that allows for contentbased subscriptions.
class InconsistentTopicStatus
com.rti.dds.infrastructure.StatusKind.StatusKind.INCONSISTENT TOPIC STATUS
interface MultiTopic
[Not supported (optional)] <<interface>> (p. 279) A specialization
of com.rti.dds.topic.TopicDescription ( p. 1561) that allows subscriptions
that combine/filter/rearrange data coming from several topics.
interface Topic
<<interface>> (p. 279) The most basic description of the data to be published and subscribed.
class TopicAdapter
interface TopicDescription
interface TopicListener
<<interface>> (p. 279) com.rti.dds.infrastructure.Listener ( p. 1130)
for com.rti.dds.topic.Topic ( p. 1545) entities.
class TopicQos
QoS policies supported by a com.rti.dds.topic.Topic ( p. 1545) entity.
6.75 Topics
6.75.1
163
164
6.76
Classes
class InstanceHandle t
Type definition for an instance handle.
class InstanceHandleSeq
com.rti.dds.infrastructure.InstanceHandle t ( p. 1055) > .
interface TypeSupport
<<interface>> (p. 279) An abstract marker interface that has to be specialized for each concrete user data type that will be used by the application.
class Foo
A representative user-defined data type.
class FooTypeSupport
<<interface>> (p. 279) <<generic>> (p. 279) User data type specific interface.
6.76.1

DDS specifies strongly typed interfaces to read and write user data. For each
data class defined by the application, there is a number of specialised classes
that are required to facilitate the type-safe interaction of the application with
RTI Connext.
RTI Connext provides an automatic means to generate all these type-specific
classes with the rtiddsgen (p. 298) utility. The complete set of automatic
classes created for a hypothetical user data type named Foo are shown below.
The macros defined here declare the strongly typed APIs needed to support an
arbitrary user defined data of type Foo.
See also:
rtiddsgen (p. 298)
6.77 Type Code Support
6.77
165
Type Code Support
<<eXtension>> ( p. 278) A com.rti.dds.typecode.TypeCode ( p. 1611) is

a mechanism for representing a type at runtime. RTI Connext can use type
codes to send type definitions on the network. You will need to understand this
API in order to use the Dynamic Data (p. 175) capability or to inspect the
type information you receive from remote readers and writers.
Classes
class EnumMember
A description of a member of an enumeration.
class ExtensibilityKind
Type to indicate the extensibility of a type.
class PRIVATE MEMBER

Constant used to indicate that a value type member is private.
class PUBLIC MEMBER

Constant used to indicate that a value type member is public.
class StructMember
A description of a member of a struct.
class TCKind
Enumeration type for com.rti.dds.typecode.TypeCode ( p. 1611) kinds.
class TypeCode
The definition of a particular data type, which you can use to inspect the
name, members, and other properties of types generated with rtiddsgen
( p. 298) or to modify types you define yourself at runtime.
class TypeCodeFactory
A singleton factory for creating, copying, and deleting data type definitions
dynamically.
class UnionMember
A description of a member of a union.
class ValueMember
A description of a member of a value type.
166
class VM ABSTRACT
Constant used to indicate that a value type has the abstract modifier.
class VM CUSTOM
Constant used to indicate that a value type has the custom modifier.
class VM NONE
Constant used to indicate that a value type has no modifiers.
class VM TRUNCATABLE
Constant used to indicate that a value type has the truncatable modifier.
Variables
static final ExtensibilityKind FINAL EXTENSIBILITY
Specifies that a type has FINAL extensibility.
static final ExtensibilityKind EXTENSIBLE EXTENSIBILITY

Specifies that a type has EXTENSIBLE extensibility.
static final ExtensibilityKind MUTABLE EXTENSIBILITY

Specifies that a type has MUTABLE extensibility.
6.77.1

Type codes are values that are used to describe arbitrarily complex types at runtime.
Type code values are manipulated via the
com.rti.dds.typecode.TypeCode (p. 1611) class, which has an analogue in
CORBA.
A com.rti.dds.typecode.TypeCode (p. 1611) value consists of a type code
kind (represented by the com.rti.dds.typecode.TCKind (p. 1525) enumeration) and a list of members (that is, fields). These members are recursive: each
one has its own com.rti.dds.typecode.TypeCode (p. 1611), and in the case
of complex types (structures, arrays, and so on), these contained type codes
contain their own members.
167
There are a number of uses for type codes.

The type code mechanism can be used to unambiguously match type representations.
The
com.rti.dds.typecode.TypeCode.TypeCode.equals method is a more reliable test
than comparing the string type names, requiring equivalent definitions of the
types.
6.77.2
Accessing a Local com.rti.dds.typecode.TypeCode
When generating types with rtiddsgen (p. 298), type codes are enabled
by default. (The -notypecode option can be used to disable generation of
com.rti.dds.typecode.TypeCode (p. 1611) information.) For these types,
a com.rti.dds.typecode.TypeCode (p. 1611) may be accessed via the
FooTypeCode.VALUE member.
This
API
also
includes
support
for
dynamic
creation
of
values,
typically
com.rti.dds.typecode.TypeCode
(p. 1611)
for use with the Dynamic Data (p. 175) API. You can create
a
(p. 1611)
using
the
You will
com.rti.dds.typecode.TypeCodeFactory (p. 1647) class.
construct the com.rti.dds.typecode.TypeCode (p. 1611) recursively, from
the outside in: start with the type codes for primitive types, then compose
them into complex types like arrays, structures, and so on. You will find the
following methods helpful:
com.rti.dds.typecode.TypeCodeFactory.get primitive tc
(p. 1660), which provides the com.rti.dds.typecode.TypeCode
(p. 1611)
instances
corresponding
to
the
primitive
types
(e.g.
com.rti.dds.typecode.TCKind.TK LONG (p. 1527),
com.rti.dds.typecode.TCKind.TK SHORT (p. 1527),
and so
on).
com.rti.dds.typecode.TypeCodeFactory.create string tc (p. 1657)
and
com.rti.dds.typecode.TypeCodeFactory.create wstring tc (p. 1658) create a com.rti.dds.typecode.TypeCode (p. 1611)
representing a text string with a certain bound (i.e. maximum length).
com.rti.dds.typecode.TypeCodeFactory.create array tc (p. 1659)
and com.rti.dds.typecode.TypeCodeFactory.create sequence tc
(p. 1658) create a com.rti.dds.typecode.TypeCode (p. 1611) for a
collection based on the com.rti.dds.typecode.TypeCode (p. 1611) for
its elements.
com.rti.dds.typecode.TypeCodeFactory.create struct tc
(p. 1651), com.rti.dds.typecode.TypeCodeFactory.create value tc
(p. 1652), and com.rti.dds.typecode.TypeCodeFactory.create sparse tc (p. 1653) create a com.rti.dds.typecode.TypeCode
(p. 1611) for a structured type.
168
6.77.3
Accessing a Remote com.rti.dds.typecode.TypeCode
In addition to being used locally, RTI Connext can transmit

com.rti.dds.typecode.TypeCode (p. 1611) on the network between
participants. This information can be used to access information about types
used remotely at runtime, for example to be able to publish or subscribe to
topics of arbitrarily types (see Dynamic Data (p. 175)). This functionality is
useful for a generic system monitoring tool like rtiddsspy.
Remote com.rti.dds.typecode.TypeCode (p. 1611) information is shared
during discovery over the publication and subscription built-in topics and
can be accessed using the built-in readers for these topics; see BuiltDiscovered com.rti.dds.typecode.TypeCode
in Topics (p. 157).
(p. 1611) values are not cached by RTI Connext upon receipt and
are therefore not available from the built-in topic data returned by
com.rti.dds.publication.DataWriter.get matched subscription data (p. 571) or com.rti.dds.subscription.DataReader.get matched publication data (p. 502).
The
space
available
locally
to
deserialize
a
discovered
reis
specimote
(p. 1611)
fied
by
the
(p. 654)s
com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.type code max serialized length (p. 792) QoS parameter. To support especially
complex type codes, it may be necessary for you to increase the value of this
parameter.
See also:
com.rti.dds.typecode.TypeCode (p. 1611)
Dynamic Data (p. 175)
rtiddsgen (p. 298)
builtin.PublicationBuiltinTopicData
6.77.4
6.77.4.1
final ExtensibilityKind FINAL EXTENSIBILITY

[static, inherited]

A type may be final, indicating that the range of its possible values is strictly
defined. In particular, it is not possible to add elements to members of collection
or aggregated types while maintaining type assignability.
The following types are always final:
169
com.rti.dds.typecode.TCKind.TK ARRAY (p. 1528)

All primitive types
6.77.4.2
final ExtensibilityKind EXTENSIBLE EXTENSIBILITY

[static, inherited]

A type may be extensible, indicating that two types, where one contains all of
the elements/members of the other plus additional elements/members appended
to the end, may remain assignable.
6.77.4.3
final ExtensibilityKind MUTABLE EXTENSIBILITY

[static, inherited]

[Not supported.]
A type may be mutable, indicating that two types may differ from one another
in the additional, removal, and/or transposition of elements/members while
remaining assignable.
The following types are always mutable:
com.rti.dds.typecode.TCKind.TK SEQUENCE (p. 1528)
com.rti.dds.typecode.TCKind.TK STRING (p. 1528)
com.rti.dds.typecode.TCKind.TK WSTRING (p. 1529)
The support for type mutability in this release is limited to
com.rti.dds.typecode.TCKind.TK SEQUENCE
(p. 1528),
com.rti.dds.typecode.TCKind.TK STRING
(p. 1528),
and
com.rti.dds.typecode.TCKind.TK WSTRING (p. 1529).
Mutability
in
com.rti.dds.typecode.TCKind.TK STRUCT
(p. 1528),
com.rti.dds.typecode.TCKind.TK UNION
(p. 1528),
com.rti.dds.typecode.TCKind.TK VALUE
(p. 1529),
and
com.rti.dds.typecode.TCKind.TK ENUM (p. 1528) is not supported.
170
6.78
Built-in Types
<<eXtension>> ( p. 278) RTI Connext provides a set of very simple data

Modules
KeyedString Built-in Type
Octets Built-in Type

KeyedOctets Built-in Type

that is the key.
6.78.1

The middleware provides four built-in types:
String: A payload consisting of a single string of characters. This type
has no key.
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString: A payload
consisting of a single string of characters and a second string, the key,
that identifies the instance to which the sample belongs.
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes: A payload consisting of an opaque variable-length array of bytes. This type has no
key.
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes: A payload
consisting of an opaque variable-length array of bytes and a string, the
key, that identifies the instance to which the sample belongs.
The String and com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString
types
are
appropriate
for
simple
text-based
applications.
The
and
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes types are appropriate for applications that perform their own custom data serialization,
6.78 Built-in Types
171
such as legacy applications still in the process of migrating to RTI Connext. In

most cases, string-based or structured data is preferable to opaque data, because the latter cannot be easily visualized in tools or used with content-based
filters (see com.rti.dds.topic.ContentFilteredTopic (p. 471)).
The built-in types are very simple in order to get you up and running as quickly
as possible. If you need a structured data type you can define your own type
with exactly the fields you need in one of two ways:
At compile time, by generating code from an IDL or XML file using the
rtiddsgen (p. 298) utility
At runtime, by using the Dynamic Data (p. 175) API
6.78.2
Managing Memory for Builtin Types
When a sample is written, the DataWriter serializes it and stores the result in
a buffer obtained from a pool of preallocated buffers. In the same way, when
a sample is received, the DataReader deserializes it and stores the result in a
sample coming from a pool of preallocated samples.
For builtin types, the maximum size of the buffers/samples and depends on the
nature of the application using the builtin type.
You can configure the maximum size of the builtin types
on
a
per-DataWriter
and
per-DataReader
basis
using
the
com.rti.dds.infrastructure.PropertyQosPolicy (p. 1236) in DataWriters,
DataReaders or Participants.
The following table lists the supported builtin type properties to configure memory allocation. When the properties are defined in the DomainParticipant, they
are applicable to all DataWriters and DataReaders belonging to the DomainParticipant unless they are overwrittem in the DataWriters and DataReaders.
The previous properties must be set consistently with respect to the corresponding .max size properties that set the maximum size of the builtin types in the
typecode.
6.78.3
Typecodes for Builtin Types
The typecodes associated with the builtin types are generated from the following
IDL type definitions:
module DDS {
172
struct String {
string value;
};
struct KeyedString {
string key;
string value;
};
struct Octets {
sequence<octet> value;
};
struct KeyedOctets {
string key;
};
};
The maximum size of the strings and sequences that will be included in the type
code definitions can be configured on a per-DomainParticipant-basis by using
the properties in following table.
For more information about the built-in types, including how to control memory usage and maximum lengths, please see chapter 3, Data Types and Data
Samples, in the Users Manual.
6.78 Built-in Types

Property
dds.builtin type.string.alloc size
dds.builtin type.keyed string.alloc key size
dds.builtin type.keyed string.alloc size
dds.builtin type.octets.alloc size
dds.builtin type.keyed octets.alloc key size
dds.builtin type.keyed octets.alloc size
173
Description
Maximum size of the strings
published by the
com.rti.dds.type.builtin.StringDataWriter
(p. 1465) or received the
com.rti.dds.type.builtin.StringDataReader
(p. 1462) (includes the
NULL-terminated character).
Default:
dds.builtin type.string.max size if
defined. Otherwise, 1024.
Maximum size of the keys used by
the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter
or
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader
(includes the NULL-terminated
character).
Default: dds.builtin type.keyed string.max key size if defined.
Otherwise, 1024.
published by the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter
or received by the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader
character).
Default: dds.builtin type.keyed string.max size if defined.
Otherwise, 1024.
Maximum size of the octet
sequences published the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesDataWriter
or received by the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesDataReader.
Default:
dds.builtin type.octets.max size if
Maximum size of the key published by the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter
or received by the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader
character).
Default: dds.builtin type.keyed size
if by
defined.
for octets.max
RTI Connextkey
Java
API
Doxygen
Otherwise, 1024.
Maximum size of the octets
sequences published by a
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter
or received by a
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.
Default: dds.builtin type.keyed -
174
Property
dds.builtin type.string.max size
dds.builtin type.keyed string.max key size
dds.builtin type.keyed string.max size
dds.builtin type.octets.max size
dds.builtin type.keyed octets.max key size
dds.builtin type.keyed octets.max size
Description
published by the StringDataWriters
and received by the
StringDataReaders belonging to a
DomainParticipant (includes the
Default: 1024.
the KeyedStringDataWriters and
KeyedStringDataReaders belonging
to a DomainParticipant (includes
the NULL-terminated character).
Default: 1024.
published by the
KeyedStringDataWriters and
received by the
to a DomainParticipant using the
builtin type (includes the
Default: 1024
sequences published by the
OctetsDataWriters and received by
the OctetsDataReader belonging to
a DomainParticipant.
Default: 2048
the KeyedOctetsStringDataWriters
and KeyedOctetsStringDataReaders
belonging to a DomainParticipant
character).
Default: 1024.
KeyedOctetsDataWriters and
received by the
KeyedOctetsDataReaders belonging
to a DomainParticipant.
Default: 2048
Table 6.4: Properties for Allocating Size of Builtin Types, per DomainParticipant
6.79 Dynamic Data
6.79
175
Dynamic Data
<<eXtension>> ( p. 278) The Dynamic Data API provides a way to interact with arbitrarily complex data types at runtime without the need for code
generation.
Classes
class DynamicData
A sample of any complex data type, which can be inspected and manipulated
reflectively.
class DynamicDataInfo
A descriptor for a com.rti.dds.dynamicdata.DynamicData ( p. 817) object.
class DynamicDataMemberInfo
A descriptor for a single member (i.e. field) of dynamically defined data type.
class DynamicDataProperty t
A
collection
of
attributes
used
to
com.rti.dds.dynamicdata.DynamicData ( p. 817) objects.
configure
class DynamicDataReader
Reads
(subscribes
to)
objects
com.rti.dds.dynamicdata.DynamicData ( p. 817).
of
type
class DynamicDataSeq
An ordered collection
( p. 817) elements.
of
com.rti.dds.dynamicdata.DynamicData
class DynamicDataTypeProperty t
A
collection
of
attributes
used
to
configure
class DynamicDataTypeSerializationProperty t
Properties that govern how data of a certain type will be serialized on the
network.
class DynamicDataTypeSupport
A factory for registering a dynamically defined type and creating
176
class DynamicDataWriter
Writes (publishes) objects of type com.rti.dds.dynamicdata.DynamicData
( p. 817).
Functions
DynamicDataInfo ()
DynamicDataInfo (int member count, int stored size, boolean is optimized storage)
DynamicDataMemberInfo ()
DynamicDataMemberInfo (int member id, String member name,

boolean member exists, TCKind member kind, int representation count,
int element count, TCKind element kind)
Variables
static final DynamicDataProperty t PROPERTY DEFAULT
Sentinel
constant
indicating
default
values
com.rti.dds.dynamicdata.DynamicDataProperty t ( p. 890).
static final
DEFAULT
DynamicDataTypeProperty t
TYPE PROPERTY -
Sentinel
constant
indicating
default
values
com.rti.dds.dynamicdata.DynamicDataTypeProperty t ( p. 897).
6.79.1
for
for
generation.
6.79 Dynamic Data
177
This API allows you to define new data types, modify existing data types, and
interact reflectively with samples. To use it, you will take the following steps:
1. Obtain a com.rti.dds.typecode.TypeCode (p. 1611) (see Type Code
Support (p. 165)) that defines the type definition you want to use.
A com.rti.dds.typecode.TypeCode (p. 1611) includes a types kind
(com.rti.dds.typecode.TCKind (p. 1525)), name, and members (that
is, fields). You can create your own com.rti.dds.typecode.TypeCode
(p. 1611) using the com.rti.dds.typecode.TypeCodeFactory (p. 1647) class
see, for example, the com.rti.dds.typecode.TypeCodeFactory.create struct tc (p. 1651) method.
Alternatively, you can use a remote
com.rti.dds.typecode.TypeCode (p. 1611) that you discovered on the network (see Built-in Topics (p. 157)) or one generated by rtiddsgen (p. 298).
2.
Wrap the com.rti.dds.typecode.TypeCode (p. 1611) in a
com.rti.dds.dynamicdata.DynamicDataTypeSupport (p. 901) object.
See the constructor com.rti.dds.dynamicdata.DynamicDataTypeSupport.DynamicDataTypeSupport.DynamicDataTy

This
object
lets
you
connect
the
type
definition
to
a
com.rti.dds.domain.DomainParticipant (p. 654) and manage data
samples (of type com.rti.dds.dynamicdata.DynamicData (p. 817)).
3. Register the com.rti.dds.dynamicdata.DynamicDataTypeSupport
(p. 901) with one or more domain participants.
See
com.rti.dds.dynamicdata.DynamicDataTypeSupport.register type (p. 904). This action associates the data type with a logical name that you
can use to create topics. (Starting with this step, working with a dynamically
defined data type is almost exactly the same as working with a generated one.)
4.
Create a com.rti.dds.topic.Topic (p. 1545)
from
the
Use the name under which you registered your data type see
com.rti.dds.domain.DomainParticipant.create topic (p. 697).
This
com.rti.dds.topic.Topic (p. 1545) is what you will use to produce and consume data.
5. Create a com.rti.dds.dynamicdata.DynamicDataWriter (p. 907)
and/or com.rti.dds.dynamicdata.DynamicDataReader (p. 892).
These
objects
will
produce
and/or
consume
data
(of
type
(p. 817))
on
the
com.rti.dds.topic.Topic (p. 1545).
You can create these objects directly from the com.rti.dds.domain.DomainParticipant (p. 654) see
com.rti.dds.domain.DomainParticipant.create datawriter (p. 688) and
com.rti.dds.domain.DomainParticipant.create datareader
(p. 693)
or by first creating intermediate com.rti.dds.publication.Publisher
(p. 1262) and com.rti.dds.subscription.Subscriber (p. 1476) objects see
com.rti.dds.domain.DomainParticipant.create publisher (p. 683) and
178
com.rti.dds.domain.DomainParticipant.create subscriber (p. 686).

6. Write and/or read the data of interest.
7. Tear down the objects described above.
You should delete them in the reverse order in which you
created them.
Note that unregistering your data type with
is
opthe
(p. 654)
tional;
all
types
are
automatically
unregistered
when
the
com.rti.dds.domain.DomainParticipant (p. 654) itself is deleted.
6.79.2
Function Documentation
6.79.2.1
DynamicDataInfo () [inherited]
A descriptor for a com.rti.dds.dynamicdata.DynamicData (p. 817) object.

See also:
com.rti.dds.dynamicdata.DynamicData.get info (p. 833)
6.79.2.2
DynamicDataInfo (int member count, int stored size,

boolean is optimized storage) [inherited]

See also:
6.79.2.3
DynamicDataMemberInfo () [inherited]
See also:
com.rti.dds.dynamicdata.DynamicData.get member info (p. 840)
6.79.2.4
DynamicDataMemberInfo (int member id, String

member name, boolean member exists, TCKind
member kind, int representation count, int element count,
TCKind element kind) [inherited]
6.79 Dynamic Data
179
See also:
6.79.3
6.79.3.1
final DynamicDataProperty t PROPERTY DEFAULT

[static, inherited]
Sentinel
constant
indicating
default
values
com.rti.dds.dynamicdata.DynamicDataProperty t (p. 890).
for
Pass this object instead of your own com.rti.dds.dynamicdata.DynamicDataProperty t (p. 890) object to use the default property values:
DynamicData sample = new DynamicData(
myTypeCode,
DynamicData.DYNAMIC_DATA_PROPERTY_DEFAULT);
See also:
com.rti.dds.dynamicdata.DynamicDataProperty t (p. 890)
6.79.3.2
final DynamicDataTypeProperty t
TYPE PROPERTY DEFAULT [static, inherited]
Sentinel
constant
indicating
default
values
com.rti.dds.dynamicdata.DynamicDataTypeProperty t (p. 897).
for
Pass this object instead of your own com.rti.dds.dynamicdata.DynamicDataTypeProperty t (p. 897) object to use the default property values:
DynamicDataTypeSupport support = new DynamicDataTypeSupport(
myTypeCode,
DynamicDataTypeSupport.DYNAMIC_DATA_TYPE_PROPERTY_DEFAULT);
See also:
com.rti.dds.dynamicdata.DynamicDataTypeProperty t (p. 897)
180
6.80
Publication Module
Contains
the
(p. 1262),
and
(p. 964),
com.rti.dds.publication.DataWriter (p. 557) classes as well as
the
(p. 1289)
and
com.rti.dds.publication.DataWriterListener (p. 586) interfaces, and
more generally, all that is needed on the publication side.
Modules
Publishers
com.rti.dds.publication.Publisher ( p. 1262) entity and associated elements
Data Writers
com.rti.dds.publication.DataWriter ( p. 557) entity and associated elements
Flow Controllers
<<eXtension>> (p. 278) com.rti.dds.publication.FlowController
( p. 964) and associated elements
6.80.1
Contains
the
(p. 1262),
and
(p. 964),
the
(p. 1289)
and
6.81 Publishers
6.81
181
Publishers
com.rti.dds.publication.Publisher (p. 1262) entity and associated elements
Classes
interface Publisher
<<interface>> (p. 279) A publisher is the object responsible for the actual
dissemination of publications.
class PublisherAdapter
interface PublisherListener
for com.rti.dds.publication.Publisher ( p. 1262) status.
class PublisherQos
QoS policies supported by a com.rti.dds.publication.Publisher ( p. 1262)
entity.
class PublisherSeq
Declares IDL sequence < com.rti.dds.publication.Publisher ( p. 1262) >
.
Variables
static final DataWriterQos DATAWRITER QOS DEFAULT
Special value for creating com.rti.dds.publication.DataWriter ( p. 557)
with default QoS.
static final DataWriterQos DATAWRITER QOS USE TOPIC QOS

= new DataWriterQos()
Special
value
for
creating
( p. 557)
with
a
combination
of
the
default
com.rti.dds.publication.DataWriterQos
( p. 610)
and
the
com.rti.dds.topic.TopicQos ( p. 1566).
182
6.81.1
com.rti.dds.publication.Publisher (p. 1262) entity and associated elements
6.81.2
6.81.2.1
final DataWriterQos DATAWRITER QOS DEFAULT

[static, inherited]
Initial value:
new DataWriterQos()
Special value for creating com.rti.dds.publication.DataWriter (p. 557) with

default QoS.
When
used
in
com.rti.dds.publication.Publisher.create datawriter (p. 1269), this special value is used to indicate that the
com.rti.dds.publication.DataWriter (p. 557) should be created with
the default com.rti.dds.publication.DataWriter (p. 557) QoS by means of
the operation get default datawriter qos and using the resulting QoS to create
the com.rti.dds.publication.DataWriter (p. 557).
When
used
in
com.rti.dds.publication.Publisher.set default datawriter qos (p. 1267), this special value is used to indicate that the
default QoS should be reset back to the initial value that would be used if the
com.rti.dds.publication.Publisher.set default datawriter qos (p. 1267)
operation had never been called.
When
used
in
com.rti.dds.publication.DataWriter.set qos
com.rti.dds.publication.DataWriter (p. 557) should be changed to
match the current defualt QoS set in the com.rti.dds.publication.Publisher
(p. 1262) that the com.rti.dds.publication.DataWriter (p. 557) belongs to.
Note:
You cannot use this value to get the default QoS
values
for
a
DataWriter
(p. 557);
for
this
purpose,
use
com.rti.dds.domain.DomainParticipant.get default datawriter qos
(p. 673).
See also:
com.rti.dds.publication.Publisher.create datawriter (p. 1269)
com.rti.dds.publication.Publisher.set default datawriter qos
(p. 1267)
com.rti.dds.publication.DataWriter.set qos (p. 562)
6.81 Publishers
6.81.2.2
183
final DataWriterQos DATAWRITER QOS USE TOPIC QOS = new DataWriterQos() [static,
inherited]
Special value for creating com.rti.dds.publication.DataWriter (p. 557)

with a combination of the default com.rti.dds.publication.DataWriterQos
(p. 610) and the com.rti.dds.topic.TopicQos (p. 1566).
The use of this value is equivalent to the application obtaining the
default com.rti.dds.publication.DataWriterQos (p. 610) and the
com.rti.dds.topic.TopicQos (p. 1566) (by means of the operation
com.rti.dds.topic.Topic.get qos (p. 1548)) and then combining these
two QoS using the operation com.rti.dds.publication.Publisher.copy from topic qos (p. 1283) whereby any policy that is set on the
com.rti.dds.topic.TopicQos (p. 1566) overrides the corresponding policy
on the default QoS. The resulting QoS is then applied to the creation of the
This value should only be used in com.rti.dds.publication.Publisher.create datawriter (p. 1269).
See also:
com.rti.dds.publication.Publisher.get default datawriter qos
(p. 1266)
com.rti.dds.topic.Topic.get qos (p. 1548)
com.rti.dds.publication.Publisher.copy from topic qos (p. 1283)
184
6.82
Data Writers
com.rti.dds.publication.DataWriter (p. 557) entity and associated elements
Classes
class AcknowledgmentInfo
Information about an application-level acknowledged sample.
interface DataWriter
<<interface>> (p. 279) Allows an application to set the value of the data
to be published under a given com.rti.dds.topic.Topic ( p. 1545).
class DataWriterAdapter
listener adapters. (The Adapter provides empty implementations for the listener methods or functions.)
class DataWriterCacheStatus
<<eXtension>> (p. 278) The status of the writers cache.
interface DataWriterListener
for writer status.
class DataWriterProtocolStatus
<<eXtension>> (p. 278) The status of a writers internal protocol related
metrics, like the number of samples pushed, pulled, filtered; and status of
wire protocol traffic.
class DataWriterQos
QoS policies supported by a com.rti.dds.publication.DataWriter ( p. 557)
entity.
class LivelinessLostStatus
com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS LOST STATUS
class OfferedDeadlineMissedStatus
com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED DEADLINE MISSED STATUS
class OfferedIncompatibleQosStatus
6.82 Data Writers
185
com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED INCOMPATIBLE QOS STATUS
class PublicationMatchedStatus
com.rti.dds.infrastructure.StatusKind.StatusKind.PUBLICATION MATCHED STATUS
class ReliableReaderActivityChangedStatus
<<eXtension>> (p. 278) Describes the activity (i.e. are acknowledgements
forthcoming) of reliable readers matched to a reliable writer.
class ReliableWriterCacheChangedStatus
<<eXtension>> (p. 278) A summary of the state of a data writers cache
of unacknowledged samples written.
class ReliableWriterCacheEventCount
<<eXtension>> (p. 278) The number of times the number of unacknowledged samples in the cache of a reliable writer hit a certain well-defined
threshold.
class FooDataWriter
<<interface>> (p. 279) <<generic>> (p. 279) User data type specific
data writer.
6.82.1
com.rti.dds.publication.DataWriter (p. 557) entity and associated elements
186
6.83
Flow Controllers
<<eXtension>>
( p. 278)
(p. 964) and associated elements
Classes
interface FlowController
<<interface>> (p. 279) A flow controller is the object responsible for
shaping the network traffic by determining when attached asynchronous
com.rti.dds.publication.DataWriter ( p. 557) instances are allowed to
write data.
class FlowControllerProperty t
Determines
the
flow
control
characteristics
com.rti.dds.publication.FlowController ( p. 964).
of
the
class FlowControllerSchedulingPolicy
Kinds of flow controller scheduling policy.
class FlowControllerTokenBucketProperty t
com.rti.dds.publication.FlowController ( p. 964) uses the popular token
bucket approach for open loop network flow control. The flow control characteristics are determined by the token bucket properties.
Variables
static final String DEFAULT FLOW CONTROLLER NAME
[default] Special value of com.rti.dds.infrastructure.PublishModeQosPolicy.flow controller name ( p. 1297) that refers to the built-in default flow controller.
static
final
NAME
String
FIXED RATE FLOW CONTROLLER -
Special value of com.rti.dds.infrastructure.PublishModeQosPolicy.flow controller name ( p. 1297) that refers to the built-in fixed-rate flow
controller.
static final
NAME
String
ON DEMAND FLOW CONTROLLER -
Special value of com.rti.dds.infrastructure.PublishModeQosPolicy.flow controller name ( p. 1297) that refers to the built-in on-demand flow
controller.
6.83 Flow Controllers
6.83.1
187
<<eXtension>>
( p. 278)
(p. 964) and associated elements
com.rti.dds.publication.FlowController (p. 964) provides the network traffic shaping capability to asynchronous com.rti.dds.publication.DataWriter
(p. 557) instances. For use cases and advantages of publishing asnychronously,
please refer to com.rti.dds.infrastructure.PublishModeQosPolicy
(p. 1295) of com.rti.dds.publication.DataWriterQos (p. 610).
See also:
com.rti.dds.infrastructure.PublishModeQosPolicy (p. 1295)
com.rti.dds.publication.DataWriterQos.publish mode (p. 615)
(p. 397)
6.83.2
6.83.2.1
final String DEFAULT FLOW CONTROLLER NAME

[static, inherited]
[default] Special value of com.rti.dds.infrastructure.PublishModeQosPolicy.flow controller name (p. 1297) that refers to the built-in default flow controller.
RTI Connext provides several built-in com.rti.dds.publication.FlowController
(p. 964) for use with an asynchronous com.rti.dds.publication.DataWriter
(p. 557). The user can choose to use the built-in flow controllers and optionally
modify their properties or can create a custom flow controller.
By default, flow control is disabled.
That is, the built-in
com.rti.dds.publication.FlowController.DEFAULT FLOW CONTROLLER NAME (p. 187) flow controller does not apply any
flow control. Instead, it allows data to be sent asynchronously as soon as it is
written by the com.rti.dds.publication.DataWriter (p. 557).
Essentially,
this
is
equivalent
to
a
user-created
com.rti.dds.publication.FlowController (p. 964) with the following
com.rti.dds.publication.FlowControllerProperty t (p. 968) settings:
- com.rti.dds.publication.FlowControllerProperty t.scheduling policy
(p. 969) = com.rti.dds.publication.FlowControllerSchedulingPolicy.FlowControllerSchedulingPolicy.EDF FLOW CONTROLLER SCHED POLICY
com.rti.dds.publication.FlowControllerProperty t.token bucket
(p. 969) max tokens = com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106)
188
com.rti.dds.publication.FlowControllerProperty (p. 969)

tokens added per period
=
t.token bucket
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106)
(p. 969) tokens leaked per period = 0
(p. 969) period = 1 second
(p. 969)
bytes per token
=
See also:
com.rti.dds.domain.DomainParticipant.lookup flowcontroller
(p. 712)
(p. 397)
6.83.2.2
final String FIXED RATE FLOW CONTROLLER NAME

[static, inherited]
Special value of com.rti.dds.infrastructure.PublishModeQosPolicy.flow controller name (p. 1297) that refers to the built-in fixed-rate flow controller.
RTI
Connext
provides
several
builtin
(p. 352)
com.rti.dds.publication.FlowController (p. 964) for use with an asynchronous com.rti.dds.publication.DataWriter (p. 557).
The user can
choose to use the built-in flow controllers and optionally modify their
properties or can create a custom flow controller.
The built-in com.rti.dds.publication.FlowController.FIXED RATE FLOW CONTROLLER NAME (p. 188) flow controller shapes the network
traffic by allowing data to be sent only once every second. Any accumulated
samples destined for the same destination are coalesced into as few network
packets as possible.
Essentially,
this
is
equivalent
to
a
user-created
189

(p. 969) = com.rti.dds.publication.FlowControllerSchedulingPolicy.FlowControllerSchedulingPolicy.EDF FLOW CONTROLLER SCHED POLICY
(p. 969)
=
(p. 969)
tokens leaked per period
=
(p. 969) period = 1 second
(p. 969)
bytes per token
=
See also:
(p. 712)
(p. 397)
6.83.2.3
final String ON DEMAND FLOW CONTROLLER NAME [static, inherited]
Special value of com.rti.dds.infrastructure.PublishModeQosPolicy.flow controller name (p. 1297) that refers to the built-in on-demand flow controller.
RTI
Connext
provides
several
builtin
(p. 352)
com.rti.dds.publication.FlowController (p. 964) for use with an asynchronous com.rti.dds.publication.DataWriter (p. 557).
The user can
choose to use the built-in flow controllers and optionally modify their
properties or can create a custom flow controller.
190
The built-in com.rti.dds.publication.FlowController.ON DEMAND FLOW CONTROLLER NAME (p. 189) allows data to be sent only
when the user calls com.rti.dds.publication.FlowController.trigger flow
(p. 967). With each trigger, all accumulated data since the previous trigger is sent (across all com.rti.dds.publication.Publisher (p. 1262) or
com.rti.dds.publication.DataWriter (p. 557) instances). In other words,
the network traffic shape is fully controlled by the user. Any accumulated samples destined for the same destination are coalesced into as few network packets
as possible.
This external trigger source is ideal for users who want to implement some
form of closed-loop flow control or who want to only put data on the
wire every so many samples (e.g.
with the number of samples based
on com.rti.ndds.transport.Transport.Property t.gather send buffer count max (p. 1574)).
Essentially,
this
is
equivalent
to
a
user-created
(p. 969) = com.rti.dds.publication.FlowControllerSchedulingPolicy.FlowControllerSchedulingPolicy.EDF
FLOW CONTROLLER SCHED POLICY
(p. 969)
=
(p. 969)
tokens leaked per period
=
(p. 969) period = com.rti.dds.infrastructure.Duration t.INFINITE
(p. 969)
bytes per token
=
See also:

(p. 712)
com.rti.dds.publication.FlowController.trigger flow (p. 967)
(p. 397)
191
192
6.84
Subscription Module
Contains
the
(p. 1476),
(p. 487),
and
(p. 1313),
com.rti.dds.subscription.QueryCondition (p. 1311) classes, as well
as the com.rti.dds.subscription.SubscriberListener (p. 1503) and
com.rti.dds.subscription.DataReaderListener (p. 518) interfaces, and
more generally, all that is needed on the subscription side.
Modules
Subscribers
com.rti.dds.subscription.Subscriber ( p. 1476) entity and associated elements
DataReaders
com.rti.dds.subscription.DataReader ( p. 487) entity and associated elements
Data Samples
com.rti.dds.subscription.SampleInfo
com.rti.dds.subscription.ViewStateKind
ated elements
6.84.1
( p. 1061)
( p. 1398),
( p. 1426),
( p. 1703),
and associ-
Contains
the
(p. 1476),
(p. 487),
(p. 1313),
and
6.84.2
Access to data samples
Data is
erations
jects:
made available to the application by the following opon

(p. 487)
obcom.rti.ndds.example.FooDataReader.read
(p. 981),
6.84 Subscription Module

com.rti.ndds.example.FooDataReader.read w condition
com.rti.ndds.example.FooDataReader.take
(p. 990),
com.rti.ndds.example.FooDataReader.take w condition
and the other variants of read() and take().
193
(p. 983),
(p. 991),
The general semantics of the read() operation is that the application only gets
access to the corresponding data (i.e. a precise instance value); the data remains
the responsibility of RTI Connext and can be read again.
The semantics of the take() operations is that the application takes full responsibility for the data; that data will no longer be available locally to RTI
Connext. Consequently, it is possible to access the same information multiple
times only if all previous accesses were read() operations, not take().
Each of these operations returns a collection of Data values and associated
com.rti.dds.subscription.SampleInfo (p. 1398) objects. Each data value
represents an atom of data information (i.e., a value for one instance). This
collection may contain samples related to the same or different instances (identified by the key). Multiple samples can refer to the same instance if the settings
of the HISTORY (p. 79) QoS allow for it.
To return the memory back to the middleware, every read() or take()
that retrieves a sequence of samples must be followed with a call to
com.rti.ndds.example.FooDataReader.return loan (p. 1008).
See also:
Interpretation of the SampleInfo (p. 1400)
6.84.2.1
Data access patterns
The application accesses data by means of the operations read or

take on the com.rti.dds.subscription.DataReader (p. 487). These operations return an ordered collection of DataSamples consisting of a
com.rti.dds.subscription.SampleInfo (p. 1398) part and a Data part.
The way RTI Connext builds the collection depends on QoS policies set on the com.rti.dds.subscription.DataReader (p. 487) and
com.rti.dds.subscription.Subscriber (p. 1476), as well as the source timestamp of the samples, and the parameters passed to the read() / take()
operations, namely:
the
desired
sample
states
(any
combination
com.rti.dds.subscription.SampleStateKind (p. 1426))
of
the
desired
view
states
(any
combination
com.rti.dds.subscription.ViewStateKind (p. 1703))
of
194
the
desired
instance
states
(any
combination
com.rti.dds.subscription.InstanceStateKind (p. 1061))
of
The read() and take() operations are non-blocking and just deliver what is
currently available that matches the specified states.
The read w condition() and take w condition() operations take a
com.rti.dds.subscription.ReadCondition (p. 1313) object as a parameter instead of sample, view or instance states.
The behaviour is
that the samples returned will only be those for which the condition is com.rti.dds.infrastructure.true.
These operations, in conjunction
with com.rti.dds.subscription.ReadCondition (p. 1313) objects and a
com.rti.dds.infrastructure.WaitSet (p. 1709), allow performing waiting
reads.
Once the data samples are available to the data readers, they can be read or
taken by the application. The basic rule is that the application may do this in
any order it wishes. This approach is very flexible and allows the application
ultimate control.
To access data coherently, or in order, the PRESENTATION (p. 90) QoS
must be set properly.
6.85 Subscribers
6.85
195
Subscribers
com.rti.dds.subscription.Subscriber (p. 1476) entity and associated elements
Classes
interface Subscriber
<<interface>> (p. 279) A subscriber is the object responsible for actually
receiving data from a subscription ( p. 353).
class SubscriberAdapter
A listener adapter in the spirit of the Java AWT listener adapters. (The
Adapter provides empty implementations for the listener methods).
interface SubscriberListener
for status about a subscriber.
class SubscriberQos
QoS policies supported
( p. 1476) entity.
by
class SubscriberSeq
Declares IDL sequence < com.rti.dds.subscription.Subscriber ( p. 1476)
>.
Variables
static final DataReaderQos DATAREADER QOS DEFAULT
Special value for creating data reader with default QoS.
static final DataReaderQos DATAREADER QOS USE TOPIC QOS = new DataReaderQos()
Special value for creating com.rti.dds.subscription.DataReader
( p. 487)
with
a
combination
of
the
default
com.rti.dds.subscription.DataReaderQos
( p. 536)
and
the
196
6.85.1
com.rti.dds.subscription.Subscriber (p. 1476) entity and associated elements
6.85.2
6.85.2.1
final DataReaderQos DATAREADER QOS DEFAULT

[static, inherited]
Initial value:
new DataReaderQos()

When
used
in
com.rti.dds.subscription.Subscriber.create datareader (p. 1483), this special value is used to indicate that the
com.rti.dds.subscription.DataReader (p. 487) should be created with
the default com.rti.dds.subscription.DataReader (p. 487) QoS by means
of the operation get default datareader qos and using the resulting QoS to
create the com.rti.dds.subscription.DataReader (p. 487).
When
used
in
com.rti.dds.subscription.Subscriber.set default datareader qos (p. 1481), this special value is used to indicate that the
default QoS should be reset back to the initial value that would be used if
the
com.rti.dds.subscription.Subscriber.set default datareader qos
(p. 1481) operation had never been called.
When
used
in
com.rti.dds.subscription.DataReader.set qos
com.rti.dds.subscription.DataReader (p. 487) should be changed to match
the current default QoS set in the com.rti.dds.subscription.Subscriber
(p. 1476) that the com.rti.dds.subscription.DataReader (p. 487) belongs
to.
Note:
You cannot use this value to get the default QoS
values for a DataReader (p. 487);
for this purpose,
use
com.rti.dds.domain.DomainParticipant.get default datareader qos
(p. 675).
See also:
com.rti.dds.subscription.Subscriber.create datareader (p. 1483)
(p. 1481)
com.rti.dds.subscription.DataReader.set qos (p. 495)
6.85 Subscribers
6.85.2.2
197
final DataReaderQos DATAREADER QOS USE TOPIC QOS = new DataReaderQos() [static,
inherited]
Special
value
for
creating
(p. 487)
with
a
combination
of
the
default
and
the
(p. 536)
com.rti.dds.topic.TopicQos (p. 1566).
The use of this value is equivalent to the application obtaining the
default com.rti.dds.subscription.DataReaderQos (p. 536) and the
com.rti.dds.topic.TopicQos (p. 1566) (by means of the operation
com.rti.dds.topic.Topic.get qos (p. 1548)) and then combining these two
QoS using the operation com.rti.dds.subscription.Subscriber.copy from topic qos (p. 1499) whereby any policy that is set on the
com.rti.dds.topic.TopicQos (p. 1566) overrides the corresponding policy
on the default QoS. The resulting QoS is then applied to the creation of the
This value should only be used in com.rti.dds.subscription.Subscriber.create datareader (p. 1483).
See also:
com.rti.dds.subscription.Subscriber.get default datareader qos
(p. 1480)
com.rti.dds.topic.Topic.get qos (p. 1548)
com.rti.dds.subscription.Subscriber.copy from topic qos (p. 1499)
198
6.86
DataReaders
com.rti.dds.subscription.DataReader (p. 487) entity and associated elements
Modules
Read Conditions
com.rti.dds.subscription.ReadCondition ( p. 1313) and associated elements
Query Conditions
com.rti.dds.subscription.QueryCondition ( p. 1311) and associated elements
Classes
interface DataReader
<<interface>> (p. 279) Allows the application to: (1) declare the data it
wishes to receive (i.e. make a subscription ( p. 353)) and (2) access the data
received by the attached com.rti.dds.subscription.Subscriber ( p. 1476).
class DataReaderAdapter
class DataReaderCacheStatus
<<eXtension>> (p. 278) The status of the readers cache.
interface DataReaderListener
for reader status.
class DataReaderProtocolStatus
<<eXtension>> (p. 278) The status of a readers internal protocol related
metrics, like the number of samples received, filtered, rejected; and status of
class DataReaderQos
QoS policies supported by a com.rti.dds.subscription.DataReader
( p. 487) entity.
6.86 DataReaders
199
class DataReaderSeq
Declares IDL sequence < com.rti.dds.subscription.DataReader ( p. 487)
>.
class LivelinessChangedStatus
com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS CHANGED STATUS
class RequestedDeadlineMissedStatus
class RequestedIncompatibleQosStatus
com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED INCOMPATIBLE QOS STATUS
class SampleLostStatus
com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE LOST STATUS STATUS
class SampleLostStatusKind
Kinds of reasons why a sample was lost.
class SampleRejectedStatus
com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE REJECTED STATUS
class SampleRejectedStatusKind
Kinds of reasons for rejecting a sample.
class SubscriptionMatchedStatus
com.rti.dds.infrastructure.StatusKind.StatusKind.SUBSCRIPTION MATCHED STATUS
class FooDataReader
<<interface>> (p. 279) <<generic>> (p. 279) User data type-specific
data reader.
6.86.1
com.rti.dds.subscription.DataReader (p. 487) entity and associated elements

200
6.87
Read Conditions
com.rti.dds.subscription.ReadCondition (p. 1313) and associated elements
Classes
interface ReadCondition
<<interface>> (p. 279) Conditions specifically dedicated to read operations
and attached to one com.rti.dds.subscription.DataReader ( p. 487).
6.87.1
com.rti.dds.subscription.ReadCondition (p. 1313) and associated elements
6.88 Query Conditions
6.88
201
Query Conditions
com.rti.dds.subscription.QueryCondition (p. 1311) and associated elements
Classes
interface QueryCondition
<<interface>>
(p. 279)
These
are
specialised
com.rti.dds.subscription.ReadCondition ( p. 1313) objects that allow the application to also specify a filter on the locally available data.
6.88.1
com.rti.dds.subscription.QueryCondition (p. 1311) and associated elements
202
6.89
Data Samples
(p. 1398),
(p. 1426),
(p. 1703),
com.rti.dds.subscription.InstanceStateKind (p. 1061) and associated
elements
Modules
Sample States
com.rti.dds.subscription.SampleStateKind ( p. 1426) and associated elements
View States
com.rti.dds.subscription.ViewStateKind ( p. 1703) and associated elements
Instance States
com.rti.dds.subscription.InstanceStateKind ( p. 1061) and associated
elements
Classes
class SampleInfo
Information that accompanies each sample that is read or taken.
class SampleInfoSeq
Declares IDL
( p. 1398) > .
6.89.1
sequence
<
(p. 1398),
(p. 1426),
(p. 1703),
com.rti.dds.subscription.InstanceStateKind (p. 1061) and associated
elements
6.90 Sample States
6.90
203
Sample States
com.rti.dds.subscription.SampleStateKind (p. 1426) and associated elements
Classes
class SampleStateKind
Indicates whether or not a sample has ever been read.
Variables
static final int ANY SAMPLE STATE = 0xffff
Any sample state com.rti.dds.subscription.SampleStateKind.SampleStateKind.READ SAMPLE STATE | com.rti.dds.subscription.SampleStateKind.SampleStateKind.NOT READ SAMPLE STATE.
6.90.1
com.rti.dds.subscription.SampleStateKind (p. 1426) and associated elements
6.90.2
6.90.2.1
final int ANY SAMPLE STATE = 0xffff [static,

inherited]
204
6.91
View States
com.rti.dds.subscription.ViewStateKind (p. 1703) and associated elements
Classes
class ViewStateKind
Indicates whether or not an instance is new.
Variables
static final int ANY VIEW STATE = 0xffff
Any view state com.rti.dds.subscription.ViewStateKind.ViewStateKind.NEW VIEW STATE | com.rti.dds.subscription.ViewStateKind.ViewStateKind.NOT NEW VIEW STATE.
6.91.1
com.rti.dds.subscription.ViewStateKind (p. 1703) and associated elements
6.91.2
6.91.2.1
final int ANY VIEW STATE = 0xffff [static, inherited]
6.92 Instance States
6.92
205
Instance States
com.rti.dds.subscription.InstanceStateKind (p. 1061) and associated elements
Classes
class InstanceStateKind
Indicates
is
the
samples
are
from
com.rti.dds.publication.DataWriter ( p. 557) or not.
live
Variables
static final int ANY INSTANCE STATE = 0xffff
Any instance state ALIVE INSTANCE STATE | NOT ALIVE DISPOSED INSTANCE STATE
|
NOT ALIVE NO WRITERS INSTANCE STATE.
static final int NOT ALIVE INSTANCE STATE = 0x006

Not alive instance state NOT ALIVE DISPOSED INSTANCE STATE |
6.92.1
com.rti.dds.subscription.InstanceStateKind (p. 1061) and associated elements
6.92.2
6.92.2.1
final int ANY INSTANCE STATE = 0xffff [static,

inherited]
Any instance state ALIVE INSTANCE STATE | NOT ALIVE DISPOSED INSTANCE STATE | NOT ALIVE NO WRITERS INSTANCE STATE.
6.92.2.2
final int NOT ALIVE INSTANCE STATE = 0x006

[static, inherited]
Not alive instance state NOT ALIVE DISPOSED INSTANCE STATE | NOT ALIVE NO WRITERS INSTANCE STATE.
206
6.93
Infrastructure Module
Defines the abstract classes and the interfaces that are refined by the other
modules. Contains common definitions such as return codes, status values, and
QoS policies.
Modules
Conditions and WaitSets
( p. 464)
com.rti.dds.infrastructure.WaitSet ( p. 1709) and related items.
and
Time Support
Entity Support
( p. 931),
com.rti.dds.infrastructure.Listener ( p. 1130) and related items.
GUID Support
<<eXtension>> (p. 278) GUID type and defines.
Object Support
<<eXtension>> (p. 278) Object related items.
QoS Policies
Return Codes
Sequence Number Support

<<eXtension>> (p. 278) Sequence number type and defines.
Status Kinds
Exception Codes
<<eXtension>> (p. 278) Exception codes.
Sequence Support
The com.rti.dds.infrastructure.com.rti.dds.util.Sequence interface allows you
to work with variable-length collections of homogeneous data.
6.93 Infrastructure Module
207
Classes
class Enum
A superclass for all type-safe enumerated types.
6.93.1
QoS policies.
208
6.94
Built-in Sequences
Classes
class BooleanSeq
boolean >.
class ByteSeq
byte >.
class CharSeq
char >.
class DoubleSeq
double >.
class FloatSeq
float >.
class IntSeq
com.rti.dds.infrastructure.int >.
class LongDoubleSeq
com.rti.dds.infrastructure.LongDouble >.
class LongSeq
long >.
class ShortSeq
short >.
class StringSeq
6.94 Built-in Sequences
209
Declares IDL sequence < com.rti.dds.infrastructure.String > .
class WcharSeq
com.rti.dds.infrastructure.char >.
class WstringSeq
6.94.1
210
6.95
Multi-channel DataWriters
APIs related to Multi-channel DataWriters.
6.95.1
What is a Multi-channel DataWriter?
A Multi-channel com.rti.dds.publication.DataWriter (p. 557) is a

com.rti.dds.publication.DataWriter (p. 557) that is configured to send
data over multiple multicast addresses, according to some filtering criteria
applied to the data.
To determine which multicast addresses will be used to send the data,
the middleware evaluates a set of filters that are configured for the
Each filter guards a
channel (a set of multicast addresses).
Each time a multi-channel
com.rti.dds.publication.DataWriter (p. 557) writes data, the filters are applied. If a filter evaluates to true, the data is sent over that filters associated
channel (set of multicast addresses). We refer to this type of filter as a Channel
Guard filter.
6.95.2
Configuration on the Writer Side
To configure a multi-channel com.rti.dds.publication.DataWriter

(p. 557),
simply define a list of all its channels in the
com.rti.dds.infrastructure.MultiChannelQosPolicy (p. 1187).
The com.rti.dds.infrastructure.MultiChannelQosPolicy (p. 1187) is
propagated along with discovery traffic. The value of this policy is available
in builtin.PublicationBuiltinTopicData.locator filter.
6.95.3
Configuration on the Reader Side
No special changes are required in a subscribing application to get data from a

multichannel com.rti.dds.publication.DataWriter (p. 557). If you want the
com.rti.dds.subscription.DataReader (p. 487) to subscribe to only a subset
of the channels, use a com.rti.dds.topic.ContentFilteredTopic (p. 471).
For more information on Multi-channel DataWriters, refer to the Users
Manual.
6.95 Multi-channel DataWriters
6.95.4
Reliability with Multi-Channel DataWriters
6.95.4.1
Reliable Delivery
211
Reliable
delivery
is
only
guaranteed
when
the
com.rti.dds.infrastructure.PresentationQosPolicy.access scope
(p. 1225) is set to com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPolicyAccessSco
PRESENTATION QOS and the filters in com.rti.dds.infrastructure.MultiChannelQosPolicy
(p. 1187) are keyed-only based.
If any of the guard filters are based on non-key fields, RTI Connext only guarantees reception of the most recent data from the MultiChannel DataWriter.
6.95.4.2
Reliable Protocol Considerations
Reliability is maintained on a per-channel basis. Each channel has its

own reliability channel send queue. The size of that queue is limited
by com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples
(p. 1351) and/or com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy.max batches (p. 624).
The protocol parameters described in com.rti.dds.infrastructure.DataWriterProtocolQosPolicy
(p. 592) are applied per channel, with the following exceptions:
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.low watermark (p. 1375) and com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.high watermark (p. 1375): The low watermark and high watermark control
the queue levels (in number of samples) that determine when to switch
between regular and fast heartbeat rates. With MultiChannel DataWriters,
high watermark and low watermark refer to the DataWriters queue (not
the reliability channel queue). Therefore, periodic heartbeating cannot be
controlled on a per-channel basis.
Important: With MultiChannel DataWriters, low watermark and high watermark refer to application samples even if batching is enabled. This behavior differs from the one without MultiChannel DataWriters (where low watermark and high watermark refer to batches).
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.heartbeats per max samples (p. 1379): This field defines the number of heartbeats per send queue. For MultiChannel DataWriters, the
value is applied per channel. However, the send queue size that is used
to calculate the a piggyback heartbeat rate is defined per DataWriter (see
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples
(p. 1351))
Important: With MultiChannel DataWriters, heartbeats per max samples
refers to samples even if batching is enabled. This behavior differs from the one
212
without MultiChannels DataWriters (where heartbeats per max samples refers

to batches).
With
batching
and
MultiChannel
DataWriters,
the
size
of
the
DataWriters
send
queue
should
be
configured
using
(p. 1351) instead of max batches com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy
batches (p. 624) in order to take advantage of heartbeats per max samples.
6.96 Pluggable Transports
6.96
213
Pluggable Transports
APIs related to RTI Connext pluggable transports.
Modules
Using Transport Plugins
Configuring transports used by RTI Connext.
Built-in Transport Plugins

Transport plugins delivered with RTI Connext.
6.96.1
6.96.2
Overview
RTI Connext has a pluggable transports architecture. The core of RTI Connext is transport agnostic; it does not make any assumptions about the actual
transports used to send and receive messages. Instead, the RTI Connext core
uses an abstract transport API to interact with the transport plugins which
implement that API.
A transport plugin implements the abstract transport API and performs the
actual work of sending and receiving messages over a physical transport. A
collection of builtin plugins (see Built-in Transport Plugins (p. 222)) is
delivered with RTI Connext for commonly used transports. New transport
plugins can easily be created, thus enabling RTI Connext applications to run
over transports that may not even be conceived yet. This is a powerful capability
and that distinguishes RTI Connext from competing middleware approaches.
RTI Connext also provides a set of APIs for installing and configuring transport plugins to be used in an application. So that RTI Connext applications
work out of the box, a subset of the builtin transport plugins is preconfigured
by default (see com.rti.dds.infrastructure.TransportBuiltinQosPolicy
(p. 1580)). You can turn-off some or all of the builtin transport plugins. In
addition, you can configure other transport plugins for use by the application.
214
6.96.3
Transport Aliases
In order to use a transport plugin instance in an RTI Connext application, it

must be registered with a com.rti.dds.domain.DomainParticipant (p. 654).
When you register a transport, you specify a sequence of alias strings to
symbolically refer to the transport plugin. The same alias strings can be used
to register more than one transport plugin.
You
can
register
multiple
transport
plugins
with
a
An alias symcom.rti.dds.domain.DomainParticipant (p. 654).
bolically refers to one or more transport plugins registered with the
Builtin transport
plugin instances can be referred to using preconfigured aliases (see TRANSPORT BUILTIN (p. 119)).
A transport plugins class name is automatically used as an implicit alias. It
can be used to refer to all the transport plugin instances of that class.
You can use aliases to refer to transport plugins, in order to specify:
the
transport
plugins
to
use
for
discovery
(see
com.rti.dds.infrastructure.DiscoveryQosPolicy.enabled transports
(p. 650)),
and
for
(p. 557)
and
(p. 487)
entities
(see
com.rti.dds.infrastructure.TransportSelectionQosPolicy (p. 1600)).
- the multicast addresses on which to receive discovery messages (see
com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast receive addresses (p. 650)), and the multicast addresses and ports on which to receive
user data (see com.rti.dds.subscription.DataReaderQos.multicast
(p. 541)).
the
unicast
ports
used
for
user
data
(see
com.rti.dds.infrastructure.TransportUnicastQosPolicy
(p. 1605))
on
both
(p. 557)
and
com.rti.dds.subscription.DataReader (p. 487) entities.
- the transport plugins used to parse an address string in a locator (Locator
Format (p. 58) and NDDS DISCOVERY PEERS (p. 57)).
A
(p. 654)
(and
contained its entities) start using a transport plugin after the
com.rti.dds.domain.DomainParticipant (p. 654) is enabled (see
com.rti.dds.infrastructure.Entity.enable (p. 935)). An entity will use
all the transport plugins that match the specified transport QoS policy. All
transport plugins are treated uniformly, regardless of how they were created
or registered; there is no notion of some transports being more special that
others.
6.96.4
215
Transport Lifecycle
A transport plugin is owned by whoever created it. Thus, if you create and
register a transport plugin with a com.rti.dds.domain.DomainParticipant
(p. 654), you are responsible for deleting it by calling its destructor. Note that
builtin transport plugins (TRANSPORT BUILTIN (p. 119)) and transport
plugins that are loaded through the PROPERTY (p. 92) QoS policy (see
Loading Transport Plugins through Property QoS Policy of Domain
Participant (p. 219)) are automatically managed by RTI Connext.
A user-created transport plugin must not be deleted while it is still in
This
use by a com.rti.dds.domain.DomainParticipant (p. 654).
generally means that a user-created transport plugin instance can
only be deleted after the com.rti.dds.domain.DomainParticipant
(p. 654)
with
which
it
was
registered
is
deleted
(see
com.rti.dds.domain.DomainParticipantFactory.delete participant
(p. 749)). Note that a transport plugin cannot be unregistered from a
A transport plugin instance cannot be registered with more than one
com.rti.dds.domain.DomainParticipant (p. 654) at a time. This requirement is necessary to guarantee the multi-threaded safety of the transport API.
If the same physical transport resources are to be used with more
than one com.rti.dds.domain.DomainParticipant (p. 654) in the same
address space, the transport plugin should be written in such a
way so that it can be instantiated multiple timesonce for each
com.rti.dds.domain.DomainParticipant (p. 654) in the address space.
Note that it is always possible to write the transport plugin so that multiple transport plugin instances share the same underlying resources; however the
burden (if any) of guaranteeing multi-threaded safety to access shared resource
shifts to the transport plugin developer.
6.96.5
Transport Class Attributes
A transport plugin instance is associated with two kinds of attributes:

- the class attributes that are decided by the plugin writer; these are invariant
across all instances of the transport plugin class, and
- the instance attributes that can be set on a per instance basis by the transport
plugin user.
Every transport plugin must specify the following class attributes.
transport class id (see com.rti.ndds.transport.Transport.Property t.classid (p. 1573))
Identifies a transport plugin implementation class. It denotes a unique
class to which the transport plugin instance belongs. The class is
216
used to distinguish between different transport plugin implementations.
Thus, a transport plugin vendor should ensure that its transport plugin
implementation has a unique class.
Two transport plugin instances report the same class iff they have compatible implementations. Transport plugin instances with mismatching
classes are not allowed (by the RTI Connext Core) to communicate with
one another.
Multiple implementations (possibly from different vendors) for a physical
transport mechanism can co-exist in an RTI Connext application, provided
they use different transport class IDs.
The class ID can also be used to distinguish between different transport
protocols over the same physical transport network (e.g., UDP vs. TCP
over the IP routing infrastructure).
transport significant address bit count (see com.rti.ndds.transport.Transport.Property t.a

RTI Connexts addressing is modeled after the IPv6 and uses 128-bit
addresses ( java.net.InetAddress ) to route messages.
A transport plugin is expected to map the transports internal addressing
scheme to 128-bit addresses. In general, this mapping is likely to use only
N least significant bits (LSB); these are specified by this attribute.
>-------------- netmask ----------------<
+---------------------------------------+----------------------------+
|
Network Address
|
Transport Local Address |
+---------------------------------------+----------------------------+
>------------ N ------------<
address_bits_count
Only these bits are used
by the transport plugin.
The remaining bits of an address using the 128-bit address representation will be considered as part of the network address (see Transport
Network Address (p. 381)) and thus ignored by the transport plugins
internal addressing scheme.
For unicast addresses, the transport plugin is expected to ignore the higher
(128 - com.rti.ndds.transport.Transport.Property t.address bit count (p. 1573)) bits. RTI Connext is free to manipulate those bits freely
in the addresses passed in/out to the transport plugin APIs.
Theoretically, the significant address bits count, N is related to the size of
the underlying transport network as follows:
address bits count >= ceil(log2 (total addressable transport unicast interf aces))
The equality holds when the most compact (theoretical) internal address
mapping scheme is used. A practical address mapping scheme may waste
some bits.
6.96.6
217
Transport Instance Attributes
The per instance attributes to configure the plugin instance are generally passed
in to the plugin constructor. These are defined by the transport plugin writer,
and can be used to:
- customize the behavior of an instance of a transport plugin, including the send
and the receiver buffer sizes, the maximum message size, various transport level
classes of service (CoS), and so on.
- specify the resource values, network interfaces to use, various transport level
policies, and so on.
RTI Connext requires that every transport plugin instance must specify
the
com.rti.ndds.transport.Transport.Property t.message size max
(p. 1574) and com.rti.ndds.transport.Transport.Property t.gather send buffer count max (p. 1574).
It is up to the transport plugin developer to make these available for configuration to transport plugin user.
Note that it is important that the instance attributes are compatible between
the sending side and the receiving side of communicating applications using
different instances of a transport plugin class. For example, if one side is configured to send messages larger than can be received by the other side, then
communications via the plugin may fail.
6.96.7
Transport Network Address
The address bits not used by the transport plugin for its internal addressing
constitute its network address bits.
In order for RTI Connext to properly route the messages, each unicast interface in the RTI Connext domain must have a unique address. RTI Connext
allows the user to specify the value of the network address when installing
a transport plugin via the com.rti.ndds.transport.TransportSupport.register transport() API.
The network address for a transport plugin should be chosen such that the
resulting fully qualified 128-bit address will be unique in the RTI Connext
domain. Thus, if two instances of a transport plugin are registered with a
com.rti.dds.domain.DomainParticipant (p. 654), they will be at different
network addresses in order for their unicast interfaces to have unique fully qualified 128-bit addresses. It is also possible to create multiple transports with the
same network address, as it can be useful for certain use cases; note that this
will require special entity configuration for most transports to avoid clashes in
resource use (e.g. sockets for UDPv4 transport).
218
6.96.8
Transport Send Route
By default, a transport plugin is configured to send outgoing messages destined

to addresses in the network address range at which the plugin was registered.
RTI Connext allows the user to configure the routing of outgoing messages via
the com.rti.ndds.transport.TransportSupport.add send route() API, so that a
transport plugin will be used to send messages only to certain ranges of destination addresses. The method can be called multiple times for a transport plugin,
with different address ranges.
+--------------------------------------------------------------------+
|
Outgoing Address Range 1
->
Transport Plugin
|
+--------------------------------------------------------------------+
|
:
->
:
|
+--------------------------------------------------------------------+
|
Outgoing Address Range K
->
Transport Plugin
|
+--------------------------------------------------------------------+
The user can set up a routing table to restrict the use of a transport plugin to
send messages to selected addresses ranges.
6.96.9
Transport Receive Route
By default, a transport plugin is configured to receive incoming messages destined to addresses in the network address range at which the plugin was registered.
RTI Connext allows the user to configure the routing of incoming messages via
the com.rti.ndds.transport.TransportSupport.add receive route() API, so that
a transport plugin will be used to receive messages only on certain ranges of
addresses. The method can be called multiple times for a transport plugin, with
different address ranges.
+--------------------------------------------------------------------+
|
Transport Plugin
<- Incoming Address Range 1 |
+--------------------------------------------------------------------+
|
:
<:
|
+--------------------------------------------------------------------+
|
Transport Plugin
<- Incoming Address Range M |
+--------------------------------------------------------------------+
The user can set up a routing table to restrict the use of a transport plugin
to receive messages from selected ranges. For example, the user may restrict a
transport plugin to
- receive messages from a certain multicast address range.
- receive messages only on certain unicast interfaces (when multiple unicast
interfaces are available on the transport plugin).
6.97 Using Transport Plugins
6.97
219
Using Transport Plugins
Classes
class TransportSupport
<<interface>> (p. 279) The utility class used to configure RTI Connext
pluggable transports.
6.97.1

There is more than one way to install a transport plugin for use with RTI
Connext:
If it is a builtin transport plugin, by specifying a bitmask
in com.rti.dds.infrastructure.TransportBuiltinQosPolicy (p. 1580)
(see Built-in Transport Plugins (p. 222))
For all other non-builtin transport plugins, by dynamically loading the plugin through PROPERTY (p. 92) QoS policy settings of
com.rti.dds.domain.DomainParticipant (p. 654) (on UNIX, Solaris
and Windows systems only) (see Loading Transport Plugins through
Property QoS Policy of Domain Participant (p. 219))
The lifecycle of the transport plugin is automatically managed by RTI Connext.
See Transport Lifecycle (p. 378) for details.
6.97.2
Loading Transport Plugins through Property QoS

Policy of Domain Participant
On UNIX, Solaris and Windows operating systems, a non-builtin transport

plugin written in C/C++ and built as a dynamic-link library (.dll/.so) can be
loaded by RTI Connext through the PROPERTY (p. 92) QoS policy settings
of the com.rti.dds.domain.DomainParticipant (p. 654). The dynamic-link
library (and all the dependent libraries) need to be in the path during runtime (in
LD LIBRARY PATH environment variable on Linux/Solaris systems,and in
PATH environment variable for Windows systems).
To allow dynamic loading of the transport plugin, the transport plugin must implement the RTI Connext abstract transport API and must provide a function
220
with the signature com.rti.ndds.transport.NDDS Transport create plugin that

can be called by RTI Connext to create an instance of the transport plugin.
The name of the dynamic library that contains the transport plugin implementation, the name of the function and properties that can be used to create the
plugin, and the aliases and network address that are used to register the plugin can all be specified through the PROPERTY (p. 92) QoS policy of the
The following table lists the property names that are used to load the transport
plugins dynamically:
A transport plugin is dynamically created and registered to the

com.rti.dds.domain.DomainParticipant (p. 654) by RTI Connext when:
the com.rti.dds.domain.DomainParticipant (p. 654) is enabled,
the first DataWriter/DataReader is created, or
you lookup a builtin DataReader (com.rti.dds.subscription.Subscriber.lookup datareader (p. 1488)),
whichever happens first.
Any changes to the transport plugin related properties in PROPERTY
(p. 92) QoS policy after the transport plugin has been registered with the
com.rti.dds.domain.DomainParticipant (p. 654) will have no effect.
6.97 Using Transport Plugins

Property Name
dds.transport.load plugins
<TRANSPORT PREFIX>.library
<TRANSPORT PREFIX>.create function on Mon Aug

Generated
13
Description
Required?
Comma-separated
YES
strings indicating the
prefix names of all
plugins that will be
loaded by RTI
Connext. Up to 8
plugins may be
specified. For example,
dds.transport.WAN.wan1,
dds.transport.DTLS.dtls1,
In the following
examples,
<TRANSPORT PREFIX> is used to
indicate one element of
this string that is used
as a prefix in the
property names for all
the settings that are
related to the plugin.
<TRANSPORT PREFIX> must begin
with dds.transport.
(such as
dds.transport.mytransport).
Should be set to the
YES
name of the dynamic
library (.so for
Unix/Solaris, and .dll
for Windows) that
contains the transport
plugin implementation.
This library (and all
the other dependent
dynamic libraries)
needs to be in the path
during run time for
used by RTI Connext
(in the LD LIBRARY PATH
environment variable
on UNIX/Solaris
systems, in PATH for
Windows systems).
Should be set to the
YES
name of the function
with the
of
09:02:20
2012prototype
for RTI Connext
Java API by Doxygen
com.rti.ndds.transport.NDDS Transport create plugin that can be
called by RTI Connext
to create an instance of
the plugin. The
resulting transport
plugin will then be
221
222
6.98
Built-in Transport Plugins
Classes
interface ShmemTransport
Built-in transport ( p. 376) plug-in for inter-process communications using
shared memory.
interface UDPv4Transport
Built-in transport ( p. 376) plug-in using UDP/IPv4.
6.98.1

The TRANSPORT BUILTIN (p. 119) specifies the collection of transport
plugins that can be automatically configured and managed by RTI Connext as
a convenience to the user.
These transport plugins can simply be turned on or off by a specifying a bitmask in com.rti.dds.infrastructure.TransportBuiltinQosPolicy
(p. 1580), thus bypassing the steps for setting up a transport plugin. RTI Connext preconfigures the transport plugin properties, the network address, and
the aliases to factory defined values.
If
a
builtin
transport
plugin
is
turned
on
in
com.rti.dds.infrastructure.TransportBuiltinQosPolicy
(p. 1580),
the plugin is implicitly created and registered to the corresponding
com.rti.dds.domain.DomainParticipant (p. 654) by RTI Connext when:
the com.rti.dds.domain.DomainParticipant (p. 654) is enabled,
the first DataWriter/DataReader is created, or
you lookup a builtin DataReader (com.rti.dds.subscription.Subscriber.lookup datareader (p. 1488)),
whichever happens first.
6.98 Built-in Transport Plugins
223
Each builtin transport contains its own set of properties. For example, the
com.rti.ndds.transport.UDPv4Transport (p. 1668) allows the application
to specify whether or not multicast is supported, the maximum size of the
message, and provides a mechanism for the application to filter out network
interfaces.
The builtin transport plugin properties can be changed by
the
method
com.rti.ndds.transport.TransportSupport.set builtin transport property()
(p. 1603)
or
by
using
the
PROPERTY
(p. 92)
QoS
policy
associated
with
the
com.rti.dds.domain.DomainParticipant (p. 654). Builtin transport plugin
properties specified in com.rti.dds.infrastructure.PropertyQosPolicy
always
overwrite
the
ones
specified
through
(p. 1236)
com.rti.ndds.transport.TransportSupport.set builtin transport property() (p. 1603). Refer to the specific builtin transport for the list of
property names that can be specified through PROPERTY (p. 92) QoS
policy.
Any changes to the builtin transport properties after the builtin transports have
been registered with will have no effect.
See also:
com.rti.ndds.transport.TransportSupport.set builtin transport property() (p. 1603) com.rti.dds.infrastructure.PropertyQosPolicy
(p. 1236)
224
6.99
Configuration Utilities
Utility APIs independent of the DDS standard.
Classes
class LibraryVersion t
The version of a single library shipped as part of an RTI Connext distribution.
class LogCategory
Categories of logged messages.
class Logger
<<interface>> (p. 279) The singleton type used to configure RTI Connext
logging.
interface LoggerDevice
<<interface>> (p. 279) Logging device interface. Use for user-defined logging devices.
class LogLevel
Level category assigned to RTI Connext log messages returned to an output
device.
class LogMessage
Log message.
class LogPrintFormat
The format used to output RTI Connext diagnostic information.
class LogVerbosity
The verbosities at which RTI Connext diagnostic information is logged.
class Version
<<interface>> (p. 279) The version of an RTI Connext distribution.
6.99.1
6.100 Durability and Persistence
6.100
225
Durability and Persistence
APIs related to RTI Connext Durability and Persistence. RTI Connext offers
the following mechanisms for achieving durability and persistence:
Durable Writer History (p. 225)
Durable Reader State (p. 225)
Data Durability (p. 226)
To use any of these features, you need a relational database, which is not
included with RTI Connext. Supported databases are listed in the Release
Notes.
These three features can be used separately or in combination.
6.100.1
Durable Writer History
This feature allows a com.rti.dds.publication.DataWriter (p. 557) to

locally persist its local history cache so that it can survive shutdowns, crashes and restarts.
When an application restarts, each
com.rti.dds.publication.DataWriter (p. 557) that has been configured to
have durable writer history automatically loads all the data in its history cache from disk and can carry on sending data as if it had never
stopped executing. To the rest of the system, it will appear as if the
com.rti.dds.publication.DataWriter (p. 557) had been temporarily disconnected from the network and then reappeared.
See also:
Configuring Durable Writer History (p. 227)
6.100.2
Durable Reader State
This feature allows a com.rti.dds.subscription.DataReader (p. 487) to

locally persists its state and remember the data it has already received.
When an application restarts, each com.rti.dds.subscription.DataReader
(p. 487) that has been configured to have durable reader state automatically loads its state from disk and can carry on receiving data as if it
had never stopped executing. Data that had already been received by the
com.rti.dds.subscription.DataReader (p. 487) before the restart will be
suppressed so it is not sent over the network.
226
6.100.3
Data Durability
This feature is a full implementation of the OMG DDS Persistence Profile.

The DURABILITY (p. 68) QoS lets an application configure a
com.rti.dds.publication.DataWriter (p. 557) such that the information
written by the com.rti.dds.publication.DataWriter (p. 557) survives beyond the lifetime of the com.rti.dds.publication.DataWriter (p. 557).
In this manner, a late-joining com.rti.dds.subscription.DataReader
(p. 487) can subscribe and receive the information even after the
com.rti.dds.publication.DataWriter (p. 557) application is no longer executing. To use this feature, you need RTI Persistence Service an optional
product that can be purchased separately.
6.100.4
Durability and Persistence Based on Virtual

GUID
Every
modification
to
the
global
dataspace
made
by
a
com.rti.dds.publication.DataWriter (p. 557) is identified by a pair
(virtual GUID, sequence number).
The virtual GUID (Global Unique Identifier) is a 16-byte character identifier associated with a com.rti.dds.publication.DataWriter (p. 557) or
com.rti.dds.subscription.DataReader (p. 487); it is used to uniquely
identify this entity in the global data space.
The sequence number is a 64-bit identifier that identifies changes published
by a specific com.rti.dds.publication.DataWriter (p. 557).
entities
Several
(p. 557)
can be configured with the same virtual GUID. If each of these
com.rti.dds.publication.DataWriter (p. 557) entities publishes a sample with sequence number 0, the sample will only be received once by the
com.rti.dds.subscription.DataReader (p. 487) entities subscribing to the
content published by the com.rti.dds.publication.DataWriter (p. 557)
entities.
RTI Connext also uses the virtual GUID (Global Unique Identifier) to associate
a persisted state (state in permanent storage) to the corresponding DDS entity.
For example, the history of a com.rti.dds.publication.DataWriter (p. 557)
will be persisted in a database table with a name generated from the virtual GUID of the com.rti.dds.publication.DataWriter (p. 557). If the
com.rti.dds.publication.DataWriter (p. 557) is restarted, it must have associated the same virtual GUID to restore its previous history.
Likewise, the state of a com.rti.dds.subscription.DataReader (p. 487)
will be persisted in a database table whose name is generated from the
227
com.rti.dds.subscription.DataReader (p. 487) virtual GUID

A com.rti.dds.publication.DataWriter (p. 557)s virtual GUID can be configured using com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.virtual guid (p. 593).
Similarly, a com.rti.dds.subscription.DataReader
virtual
GUID
can
be
configured
using
(p. 487)s
com.rti.dds.infrastructure.DataReaderProtocolQosPolicy.virtual guid (p. 522).
The builtin.PublicationBuiltinTopicData and builtin.SubscriptionBuiltinTopicData
structures include the virtual GUID associated with the discovered publication
or subscription.
Refer to the Users Manual for additional use cases.
See also:
com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.virtual guid (p. 593) com.rti.dds.infrastructure.DataReaderProtocolQosPolicy.virtual guid (p. 522).
6.100.5
Configuring Durable Writer History
To configure a com.rti.dds.publication.DataWriter (p. 557) to have

durable writer history, use the PROPERTY (p. 92) QoS policy associated with the com.rti.dds.publication.DataWriter (p. 557) or the
Properties defined for the com.rti.dds.domain.DomainParticipant (p. 654)
will be applied to all the com.rti.dds.publication.DataWriter (p. 557) objects belonging to the com.rti.dds.domain.DomainParticipant (p. 654), unless the property is overwritten by the com.rti.dds.publication.DataWriter
(p. 557).
See also:
The following table lists the supported durable writer history properties.
6.100.6
Configuring Durable Reader State
To configure a com.rti.dds.subscription.DataReader (p. 487) with

durable reader state, use the PROPERTY (p. 92) QoS policy associated with the com.rti.dds.subscription.DataReader (p. 487) or
228
A property defined in the com.rti.dds.domain.DomainParticipant (p. 654)

will be applicable to all the com.rti.dds.subscription.DataReader (p. 487)
belonging to the com.rti.dds.domain.DomainParticipant (p. 654) unless it
is overwritten by the com.rti.dds.subscription.DataReader (p. 487).
See also:
The following table lists the supported durable reader state properties.
6.100.7
Configuring Data Durability
RTI Connext implements com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.T

DURABILITY QOS and com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.P
DURABILITY QOS durability using RTI Persistence Service, available for
purchase as a separate RTI product.
For more information on RTI Persistence Service, refer to the Users Manual,
or the RTI Persistence Service API Reference HTML documentation.
See also:
DURABILITY (p. 68)

Property
dds.data writer.history.plugin name
dds.data writer.history.odbc plugin.dsn
dds.data writer.history.odbc plugin.driver
dds.data writer.history.odbc plugin.username
dds.data writer.history.odbc plugin.password
dds.data writer.history.odbc plugin.shared
dds.data writer.history.odbc plugin.instance cache max size
229
Description
Must be set to dds.data writer.history.odbc plugin.builtin
to enable durable writer history in
the DataWriter. This property is
required.
The ODBC DSN (Data Source
Name) associated with the database
where the writer history must be
persisted. This property is required.
This property tells RTI Connext
which ODBC driver to load. If the
property is not specified, RTI
Connext will try to use the standard
ODBC driver manager library:
UnixOdbc (odbc32.dll) on
UNIX/Linux systems; the Windows
ODBC driver manager (libodbc.so)
on Windows systems).
Configures the username used to
connect to the database. This
property is not used if it is
unspecified. There is no default
value.
Configures the password used to
connect to the database. This
property is not used if it is
unspecified. There is no default
value.
If set to 1, RTI Connext creates a
single connection per DSN that will
be shared across DataWriters within
the same Publisher.
If set to 0 (the default), a
(p. 557) will create its own database
connection.
Default: 0 (false)
These properties configure the
resource limits associated with the
ODBC writer history caches. To
minimize the number of accesses to
the database, RTI Connext uses two
caches, one for samples and one for
instances. The initial and maximum
sizes of these caches are configured
using these properties. The resource
for limits
RTI Connext
API by Doxygen
instances,
initial Java
max instances, initial samples,
max samples and
max samples per instance in the
(p. 1348) are used to configure the
maximum number of samples and
instances that can be stored in the
230
Property
dds.data reader.state.odbc.dsn
Description
The ODBC DSN (Data Source
Name) associated with the database where the
(p. 487) state must be persisted.
This property is required.
dds.data reader.state.filter To enable durable reader state, this
redundant samples
property must be set to 1.
Otherwise, the reader state will not
be kept and/or persisted. When the
reader state is not maintained, RTI
Connext does not filter duplicate
samples that may be coming from
the same virtual writer. By default,
this property is set to 1.
dds.data reader.state.odbc.driver
This property is used to indicate
which ODBC driver to load. If the
property is not specified, RTI
Connext will try to use the standard
ODBC driver manager library:
UnixOdbc (odbc32.dll) on
UNIX/Linux systems; the Windows
ODBC driver manager (libodbc.so)
on Windows systems).
dds.data This property configures the
reader.state.odbc.username
username used to connect to the
database. This property is not used
if it is unspecified. There is no
default value.
dds.data reader.state.odbc.password This property configures the
password used to connect to the
database. This property is not used
if it is unspecified. There is no
default value.
dds.data reader.state.restore
This property indicates if the
persisted
(p. 487) state must be restored or
not once the
(p. 487) is restarted. If this property
is 0, the previous state will be
deleted from the database. If it is 1,
the
(p. 487) will restore its previous
state
from
the database
content.
for RTI
Connext
Java API
by Doxygen
Default: 1
dds.data reader.state.checkpoint This property controls how often
frequency
the reader state is stored in the
database. A value of N means to
store the state once every N
samples.
A high frequency will provide better
6.101 System Properties
6.101
231
System Properties
System
Properties.
RTI
Connext
uses
the
com.rti.dds.infrastructure.PropertyQosPolicy (p. 1236) of a DomainParticipant to maintain a set of properties that provide system information such
as hostname.
Unless the default com.rti.dds.domain.DomainParticipantQos (p. 773)
value is overwritten, the system properties are automatically set in the
com.rti.dds.domain.DomainParticipantQos (p. 773) obtained by calling
the
method
com.rti.dds.domain.DomainParticipantFactory.get (p. 750)
or
using
the
constant
default participant qos
com.rti.dds.domain.DomainParticipantFactory.PARTICIPANT QOS DEFAULT (p. 149).
System
properties
are
also
automatically
set
in
the
com.rti.dds.domain.DomainParticipantQos (p. 773) loaded from an
XML QoS profile unless you disable property inheritance using the attribute
inherit in the XML tag <property>.
By default, the system properties are propagated to other DomainParticipants in the system and can be accessed through
builtin.ParticipantBuiltinTopicData.property.
You can disable the propagation of individual properties by setting
the flag com.rti.dds.infrastructure.Property t.propagate (p. 1235) to
com.rti.dds.infrastructure.false or by removing the property using the
method com.rti.dds.infrastructure.PropertyQosPolicyHelper.remove property (p. 1242).
The
number
of
system
properties
set
on
the
com.rti.dds.domain.DomainParticipantQos (p. 773) is platform specific.
6.101.1
System Properties List
The following table lists the supported system properties.

Property Name
dds.sys info.hostname
dds.sys info.process id
6.101.2
Description
Hostname
Process ID
System Resource Consideration
System
properties
are
affected
by
the
resource
limits
com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.participant Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
232
property list max length (p. 794) and com.rti.dds.infrastructure.DomainParticipantResource

property string max length (p. 794).
6.102 Configuring QoS Profiles with XML
6.102
233
Configuring QoS Profiles with XML
APIs related to XML QoS Profiles.
6.102.1
Loading QoS Profiles from XML Resources
A QoS profile is a group of QoS settings, specified in XML format. By using

QoS profiles, you can change QoS settings without recompiling the application.
The Qos profiles are loaded the first time any of the following operations are
called:
com.rti.dds.domain.DomainParticipantFactory.create participant (p. 748)
com.rti.dds.domain.DomainParticipantFactory.create participant with profile (p. 764)
com.rti.dds.domain.DomainParticipantFactory.set default participant qos with profile (p. 752)
com.rti.dds.domain.DomainParticipantFactory.get default participant qos (p. 750)
com.rti.dds.domain.DomainParticipantFactory.set default library (p. 756)
com.rti.dds.domain.DomainParticipantFactory.set default profile (p. 757)
com.rti.dds.domain.DomainParticipantFactory.get participant qos from profile (p. 758)
com.rti.dds.domain.DomainParticipantFactory.get topic qos from profile (p. 762)
com.rti.dds.domain.DomainParticipantFactory.get topic qos from profile w topic name (p. 763)
com.rti.dds.domain.DomainParticipantFactory.get publisher qos from profile (p. 758)
com.rti.dds.domain.DomainParticipantFactory.get subscriber qos from profile (p. 759)
com.rti.dds.domain.DomainParticipantFactory.get datawriter qos from profile (p. 760)
com.rti.dds.domain.DomainParticipantFactory.get datawriter qos from profile w topic name (p. 760)
234
com.rti.dds.domain.DomainParticipantFactory.get datareader qos from profile (p. 761)
com.rti.dds.domain.DomainParticipantFactory.get datareader qos from profile w topic name (p. 761)
com.rti.dds.domain.DomainParticipantFactory.get qos profile libraries (p. 763)
com.rti.dds.domain.DomainParticipantFactory.get qos profiles
(p. 764)
com.rti.dds.domain.DomainParticipantFactory.load profiles
(p. 754)
The QoS profiles are reloaded replacing previously loaded profiles when the
following operations are called:
com.rti.dds.domain.DomainParticipantFactory.set qos (p. 754)
com.rti.dds.domain.DomainParticipantFactory.reload profiles
(p. 755)
The com.rti.dds.domain.DomainParticipantFactory.unload profiles()
(p. 755) operation will free the resources associated with the XML QoS profiles.
There are five ways to configure the XML resources (listed by load order):
The file NDDS QOS PROFILES.xml in NDDSHOME/resource/qos profiles 5.0.0/xml
is
loaded
if
it
exists
and
com.rti.dds.infrastructure.ProfileQosPolicy.ignore resource profile (p. 1233) in com.rti.dds.infrastructure.ProfileQosPolicy
(p. 1231) is set to com.rti.dds.infrastructure.false (first to be loaded). An
example file, NDDS QOS PROFILES.example.xml, is available for reference.
The URL groups separated by semicolons referenced by the enviroment variable NDDS QOS PROFILES are loaded if they exist
and
com.rti.dds.infrastructure.ProfileQosPolicy.ignore environment profile (p. 1232) in com.rti.dds.infrastructure.ProfileQosPolicy
(p. 1231) is set to com.rti.dds.infrastructure.false.
The
file
USER QOS PROFILES.xml
in
the
working
directory
will
be
loaded
if
it
exists
and
com.rti.dds.infrastructure.ProfileQosPolicy.ignore user profile
(p. 1232) in com.rti.dds.infrastructure.ProfileQosPolicy (p. 1231) is
set to com.rti.dds.infrastructure.false.
6.102 Configuring QoS Profiles with XML
235
The URL groups referenced by com.rti.dds.infrastructure.ProfileQosPolicy.url profile (p. 1232) in com.rti.dds.infrastructure.ProfileQosPolicy

(p. 1231) will be loaded if specified.
The
sequence
of
XML
strings
referenced
com.rti.dds.infrastructure.ProfileQosPolicy.string profile
(p. 1232) will be loaded if specified (last to be loaded).
by
The above methods can be combined together.
6.102.2
URL
The location of the XML resources (only files and strings are supported) is
specified using a URL (Uniform Resource Locator) format. For example:
File Specification: file:///usr/local/default dds.xml
String Specification:
library>&lt/dds>
str://<dds><qos library> .
lt;/qos -
If the URL schema name is omitted, RTI Connext will assume a file name. For
example:
File Specification: /usr/local/default dds.xml
6.102.2.1
URL groups
To provide redundancy and fault tolerance, you can specify multiple locations
for a single XML document via URL groups. The syntax of a URL group is as
follows:
[URL1 | URL2 | URL2 | . . .| URLn]
For example:
[file:///usr/local/default dds.xml | file:///usr/local/alternative default dds.xml]
Only one of the elements in the group will be loaded by RTI Connext, starting
from the left.
Brackets are not required for groups with a single URL.
6.102.2.2
NDDS QOS PROFILES environment variable
The environment variable NDDS QOS PROFILES contains a list of URL

groups separated by ;
236
The URL groups referenced by the environment variable are loaded if they exist
and com.rti.dds.infrastructure.ProfileQosPolicy.ignore environment profile (p. 1232) is set to com.rti.dds.infrastructure.false
For more information on XML Configuration, refer to the Users Manual.
6.103 Publication Example
6.103
Publication Example
A data publication example.
6.103.1
A typical publication example
Prep
Create user data types using rtiddsgen (p. 298)
Set up
Get the factory (p. 239)
Set up participant (p. 239)
Set up publisher (p. 247)
Register user data type(s) (p. 241)
Set up topic(s) (p. 241)
Set up data writer(s) (p. 248)
Adjust the desired quality of service (QoS)
Adjust QoS on entities as necessary (p. 257)
Send data
Send data (p. 249)
Tear down
Tear down data writer(s) (p. 249)
Tear down topic(s) (p. 241)
Tear down publisher (p. 247)
Tear down participant (p. 240)
237
238
6.104
Subscription Example
A data subscription example.
6.104.1
A typical subscription example
Prep
Create user data types using rtiddsgen (p. 298)
Set up
Set up subscriber (p. 250)
Register user data type(s) (p. 241)
Set up topic(s) (p. 241)
Set up data reader(s) (p. 253)
Set up data reader (p. 254) OR Set up subscriber (p. 250) to receive
data
Adjust the desired quality of service (QoS)
Adjust QoS on entities as necessary (p. 257)
Receive data
Access received data either via a reader (p. 254) OR via a subscriber
(p. 251) (possibly in a ordered or coherent (p. 252) manner)
Tear down
Tear down data reader(s) (p. 256)
Tear down topic(s) (p. 241)
Tear down subscriber (p. 252)
Tear down participant (p. 240)
6.105 Participant Use Cases
6.105
239
Participant Use Cases
Working with domain partcipants. Working with domain participants.
6.105.1
Turning off auto-enable of newly created participant(s)

Change the value of the ENTITY FACTORY (p. 73) for the
com.rti.dds.domain.DomainParticipantFactory (p. 742)
DomainParticipantFactoryQos factory_qos = new DomainParticipantFactoryQos();
try {
factory.get_qos(factory_qos);
/* Change the QosPolicy to create disabled participants */
factory_qos.entity_factory.autoenable_created_entities = false;
factory.set_qos(factory_qos);
} catch (RETCODE_ERROR err) {
System.out.println(
"***Error: changing domain participant factory qos\n");
}
6.105.2
Getting the factory
Get the DDSDomainParticipantFactory instance:

DomainParticipantFactory factory = null;
factory = DomainParticipantFactory.get_instance();
6.105.3
Setting up a participant

Create DDSDomainParticipant:
int domain_id = 10;
DomainParticipantQos participant_qos = new DomainParticipantQos();
// initialize participant_qos with default values
factory.get_default_participant_qos(participant_qos);
240
/* Set the peer hosts. These list all the computers the application
may communicate with along with the maximum maximum participant
index of the participants that can concurrently run on that
computer. This list only needs to be a superset of the actual list
of computers and participants that will be running at any time.
*/
/* To run this example across multiple nodes, modify the following
IP addresses to match your network configuration.
*/
final String[] NDDS_DISCOVERY_INITIAL_PEERS = {
"1@udpv4://10.10.1.192",
"1@udpv4://10.10.1.190",
"1@udpv4://10.10.1.152"
};
participant_qos.discovery.initial_peers.
ensureCapacity(NDDS_DISCOVERY_INITIAL_PEERS.length);
for (int i = 0; i < NDDS_DISCOVERY_INITIAL_PEERS.length; ++i) {
participant_qos.discovery.initial_peers.add(
NDDS_DISCOVERY_INITIAL_PEERS[i]);
}
// Initialize listener if desired
DomainParticipantListener participant_listener = null;
// Create the participant

DomainParticipant participant = null;
try {
participant = factory.create_participant(
domain_id, participant_qos,
participant_listener, StatusKind.STATUS_MASK_NONE);
// participant couldnt be created
}
6.105.4
Tearing down a participant

Delete DDSDomainParticipant:
try {
factory.delete_participant(participant);
// unable to delete
}
6.106 Topic Use Cases
6.106
241
Topic Use Cases
Working with topics.
6.106.1
Registering a user data type

Register user data type of type Foo under the name My Type
String type_name = "My_Type";
FooTypeSupport.register_type(participant, type_name);
6.106.2
Setting up a topic

Ensure user data type is registered (p. 241)
Create a com.rti.dds.topic.Topic (p. 1545) under the name my topic
String topic_name = "my_topic";
String type_type = "My_Type";
// user data type
TopicQos topic_qos = new TopicQos();
// MyTopicListener is user defined and
// implements TopicListener
TopicListener topic_listener = new MyTopicListener(); // or = null
participant.get_default_topic_qos(topic_qos);
Topic topic = null;
try {
topic = participant.create_topic(topic_name, type_name,
topic_qos, topic_listener,
StatusKind.STATUS_MASK_ALL);
// handle exception
}
6.106.3
Tearing down a topic
Delete Topic:
try {
participant.delete_topic(topic);
242
// handle exception
}
6.107 FlowController Use Cases
6.107
243
FlowController Use Cases
Working with flow controllers.
6.107.1
Creating a flow controller

Create a flow controller
FlowController controller = null;
FlowControllerProperty_t property = new FlowControllerProperty_t();
retcode = participant.get_default_flowcontroller_property(property);
// optionally modify flow controller property values
try {
controller = participant.create_flowcontroller(
"my flow controller name", property);
// handle exception
}
6.107.2
Flow controlling a data writer

Create flow controller (p. 243)
Create an asynchronous data writer, FooDataWriter, of user data type
Foo:
DataWriterQos writer_qos = new DataWriterQos();
// MyWriterListener is user defined and
// implements DataWriterListener
MyWriterListener writer_listener = new MyWriterListener(); // or = null
publisher.get_default_datawriter_qos(writer_qos);
/* Change the writer QoS to publish asnychronously */
writer_qos.publish_mode.kind = PublishModeQosPolicyKind.ASYNCHRONOUS_PUBLISH_MODE_QOS;
/* Setup to use the previously created flow controller */
writer_qos.publish_mode.flow_controller_name = "my flow controller name";
/* Samples queued for asynchronous write are subject to the History Qos policy */
writer_qos.history.kind = HistoryQosPolicyKind.KEEP_ALL_HISTORY_QOS;
244
FooDataWriter writer = null;

try {
writer = (FooDataWriter) publisher.create_datawriter(topic, writer_qos,
writer_listener,
/* Send data asynchronously... */

/* Wait for asynchronous send completes, if desired */
writer.wait_for_asynchronous_publishing(timout);
// handle exception
}
6.107.3
Using the built-in flow controllers
RTI Connext provides several built-in flow controllers.

The
com.rti.dds.publication.FlowController.DEFAULT FLOW CONTROLLER NAME
(p. 187)
built-in
flow
controller
provides the basic asynchronous writer behavior.
When calling
com.rti.ndds.example.FooDataWriter.write (p. 1021), the call signals
the com.rti.dds.publication.Publisher (p. 1262) asynchronous publishing
thread
(com.rti.dds.publication.PublisherQos.asynchronous publisher (p. 1291)) to send the actual data.
As with any
com.rti.dds.infrastructure.PublishModeQosPolicyKind.PublishModeQosPolicyKind.ASYNCHRONOUS
PUBLISH MODE QOS com.rti.dds.publication.DataWriter (p. 557), the
com.rti.ndds.example.FooDataWriter.write (p. 1021) call returns immediately afterwards. The data is sent immediately in the context of the
com.rti.dds.publication.Publisher (p. 1262) asynchronous publishing
thread.
When using the com.rti.dds.publication.FlowController.FIXED RATE FLOW CONTROLLER NAME (p. 188) flow controller, data is
also sent in the context of the com.rti.dds.publication.Publisher (p. 1262)
asynchronous publishing thread, but at a regular fixed interval. The thread accumulates samples from different com.rti.dds.publication.DataWriter
(p. 557) instances and generates data on the wire only once per
com.rti.dds.publication.FlowControllerTokenBucketProperty t.period (p. 975).
In
contrast,
the
com.rti.dds.publication.FlowController.ON DEMAND FLOW CONTROLLER NAME (p. 189) flow controller
permits flow only when com.rti.dds.publication.FlowController.trigger flow (p. 967) is called.
The data is still sent in the context of
the com.rti.dds.publication.Publisher (p. 1262) asynchronous pubGenerated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
6.107 FlowController Use Cases
245
lishing thread.
The thread accumulates samples from different
com.rti.dds.publication.DataWriter (p. 557) instances (across any
com.rti.dds.publication.Publisher (p. 1262)) and sends all data since
the previous trigger.
The properties of the built-in com.rti.dds.publication.FlowController
(p. 964) instances can be adjusted.
Lookup built-in flow controller
FlowController controller = null;
try {
controller = participant.lookup_flowcontroller(
FlowController.DEFAULT_FLOW_CONTROLLER_NAME);
// This should never happen, built-in flow controllers are always created
// handle exception
}
Change property of built-in flow controller, if desired

FlowControllerProperty_t property = new FlowControllerProperty_t();
/* Get the property of the looked-up default flow controller */
controller.get_property(property);
/* Change the property value as desired */
property.token_bucket.period.sec = 2;
property.token_bucket.period.nanosec = 0;
/* Update the flow controller property */
controller.set_property(property);
Create a data writer using the correct flow controller name

(p. 243)
6.107.4
Shaping the network traffic for a particular transport

Create the transports (p. 263)
Create a separate flow controller for each transport (p. 243)
246
Configure com.rti.dds.publication.DataWriter (p. 557) instances to
only use a single transport
Associate all data writers using the same transport to the corresponding flow controller (p. 243)
For each transport, the corresponding flow controller limits the network
traffic based on the token bucket properties
6.107.5
Coalescing multiple samples in a single network

packet

Create a flow controller with a desired token bucket period
(p. 243)
Associate the data writer with the flow controller (p. 243)
Multiple samples written within the specified period will be coalesced
into a single network packet (provided that tokens added per period
and bytes per token permit).
6.108 Publisher Use Cases
6.108
247
Publisher Use Cases
Working with publishers.
6.108.1
Setting up a publisher

Create a DDSPublisher
PublisherQos publisher_qos = new PublisherQos();
// MyPublisherListener is user defined and
// extends DDSPublisherListener
PublisherListener publisher_listener
= new MyPublisherListener(); // or = null
participant.get_default_publisher_qos(publisher_qos);
Publisher publisher = null;
try {
publisher = participant.create_publisher(publisher_qos,
publisher_listener,
// respond to exception
}
6.108.2
Tearing down a publisher
Delete DDSPublisher:
try {
participant.delete_publisher(publisher);
}
248
6.109
DataWriter Use Cases
Working with data writers.
6.109.1
Setting up a data writer
Set up publisher (p. 247)

Set up a topic (p. 241)
Create a data writer, FooDataWriter, of user data type Foo:
DataWriterQos writer_qos = new DataWriterQos();
// MyWriterListener is user defined and
// implements DataWriterListener
MyWriterListener writer_listener = new MyWriterListener(); // or = null
publisher.get_default_datawriter_qos(writer_qos);
FooDataWriter writer = null;
try {
writer = (FooDataWriter) publisher.create_datawriter(topic, writer_qos,
writer_listener,
// handle exception
}
6.109.2
Managing instances
Getting an instance key value of user data type Foo

Foo data = ...;
// user data
try {
writer.get_key_value(data, instance_handle);
// ... check for cause of failure
}
Registering an instance of type Foo

InstanceHandle_t instance_handle = InstanceHandle_t.HANDLE_NIL;
instance_handle = writer->register_instance(data);
Unregistering an instance of type Foo

6.109 DataWriter Use Cases
249
try {
writer.unregister_instance(data, instance_handle);
}
Disposing of an instance of type Foo

try {
writer.dispose(data, instance_handle);
}
6.109.3
Sending data
Set up data writer (p. 248)

Register instance (p. 248)
Write instance of type Foo
Foo data = new Foo();
// user data
InstanceHandle_t instance_handle
= InstanceHandle_t.HANDLE_NIL; // or a valid registered handle
try {
writer.write(data, instance_handle);
} catch (RETCODE_ERR err) {
}
6.109.4
Tearing down a data writer
Delete DataWriter:
try {
publisher.delete_datawriter(writer);
} catch (RETCODE_ERR err) {
}
250
6.110
Subscriber Use Cases
Working with subscribers.
6.110.1
Setting up a subscriber

Create a Subscriber
SubscriberQos subscriber_qos = new SubscriberQos();
// MySubscriberListener is user defined and
// implements SubscriberListener
SubscriberListener subscriber_listener
= new MySubscriberListener(); // or = null
participant.get_default_subscriber_qos(subscriber_qos);
Subscriber subscriber = null;
try {
subscriber = participant.create_subscriber(subscriber_qos,
subscriber_listener,
}
6.110.2
Set up subscriber to access received data

Set up to handle the DATA ON READERS STATUS status, in one or
both of the following two ways.
Enable DATA ON READERS STATUS for the SubscriberListener associated with the subscriber (p. 258)
The processing to handle the status change is done in the
com.rti.dds.subscription.SubscriberListener.on data on readers (p. 1504) method of the attached listener.
Typical processing will access the received data (p. 251), either in
arbitrary order or in a coherent and ordered manner (p. 252).
Enable DATA ON READERS STATUS for the StatusCondition
associated with the subscriber (p. 259)
6.110 Subscriber Use Cases
251
The processing to handle the status change is done when the subscribers attached status condition is triggered (p. 261) and the
DATA ON READERS STATUS status on the subscriber is changed.
Typical processing will access the received data (p. 251), either in
an arbitrary order or in a coherent and ordered manner (p. 252).
6.110.3
Access received data via a subscriber
Ensure subscriber is set up to access received data (p. 250)

Get the list of readers that have data samples available:
DataReaderSeq reader_seq = new DataReaderSeq(); // list of readers
int max_samples = DataReader.LENGTH_UNLIMITED;
int sample_state_mask = SampleStateKind.NOT_READ_SAMPLE_STATE;
int view_state_mask = ViewStateKind.ANY_VIEW_STATE;
int instance_state_mask = InstanceStateKind.ANY_INSTANCE_STATE;
try {
subscriber.get_datareaders(reader_seq,
sample_state_mask,
view_state_mask,
instance_state_mask);
// handle exception
}
Upon successfully getting the list of readers with data, process the data
readers to either:
Read the data in each reader (p. 255), OR
Take the data in each reader (p. 254)
If the intent is to access the data coherently or in order (p. 252), the
list of data readers must be processed in the order returned:
for (int i = 0; i < reader_seq.size(); ++i) {
FooDataReader reader = (FooDataReader) reader_seq.get(i);
// Take the data from reader,
//
OR
// Read the data from reader
}
Alternatively, call com.rti.dds.subscription.Subscriber.notify datareaders (p. 1491) to invoke the DataReaderListener for each of the
data readers.
subscriber.notify_datareaders();
252
6.110.4
Access received data coherently and/or in order
To access the received data coherently and/or in an ordered manner, according

to the settings of the com.rti.dds.infrastructure.PresentationQosPolicy
(p. 1221) attached to a com.rti.dds.subscription.Subscriber (p. 1476):
Ensure subscriber is set up to access received data (p. 250)
Indicate that data will be accessed via the subscriber:
subscriber.begin_access();
Access received data via the subscriber, making sure that the
data readers are processed in the order returned. (p. 251)
Indicate that the data access via the subscriber is done:
subscriber.end_access();
6.110.5
Tearing down a subscriber
Delete Subscriber:
try {
participant.delete_subscriber(subscriber);
// handle exception
}
6.111 DataReader Use Cases
6.111
253
DataReader Use Cases
Working with data readers.
6.111.1
Setting up a data reader

Create a data reader, FooDataReader, of user data type Foo:
DataReaderQos reader_qos = new DataReaderQos();
// MyReaderListener is user defined and
// implements DataReaderListener
DataReaderListener reader_listener
= new MyReaderListener(); // or = null
subscriber.get_default_datareader_qos(reader_qos);
FooDataReader reader = null;
try {
reader = (FooDataReader) subscriber.create_datareader(topic,
reader_qos,
reader_listener,
}
6.111.2
Managing instances
Given a data reader

FooDataReader reader = ...;
Getting an instance key value of user data type Foo

Foo data = new Foo();
// user data of type Foo
// ...
try {
reader.get_key_value(data, instance_handle);
}
254
6.111.3
Set up reader to access received data
Set up data reader (p. 253)

Set up to handle the DATA AVAILABLE STATUS status, in one or both
of the following two ways.
Enable DATA AVAILABLE STATUS for the DataReaderListener associated with the data reader (p. 258)
The processing to handle the status change is done in
the com.rti.dds.subscription.DataReaderListener.on data available (p. 520) method of the attached listener.
Typical processing will access the received data (p. 254).
Enable DATA AVAILABLE STATUS for the StatusCondition
associated with the data reader (p. 259)
The processing to handle the status change is done when the data
readers attached status condition is triggered (p. 261) and the
DATA AVAILABLE STATUS status on the data reader is changed.
Typical processing will access the received data (p. 254).
6.111.4
Access received data via a reader
Ensure reader is set up to access received data (p. 254)

Access the received data, by either:
Taking the received data in the reader (p. 254), OR
Reading the received data in the reader (p. 255)
6.111.5
Taking data

Take samples of user data type Foo. The samples are removed from the
Service. The caller is responsible for deallocating the buffers.
FooSeq
SampleInfoSeq
int
int
int
data_seq = new FooSeq();

// holder for sequence of user data type Foo
info_seq = new SampleInfoSeq(); // holder for sequence of DDS_SampleInfo
max_samples;
sample_state_mask = SampleStateMask.ANY_SAMPLE_STATE;
view_state_mask = ViewStateMask.ANY_VIEW_STATE;
6.111 DataReader Use Cases

int
255
instance_state_mask = InstanceStateMask.ANY_INSTANCE_STATE;
try {
reader.take(data_seq, info_seq,
max_samples,
sample_state_mask,
view_state_mask,
} catch (RETCODE_ERROR) {
}
Use the received data

// Use the received data samples data_seq and associated
// information info_seq
for (int i = 0; i < data_seq.size(); ++i) {
// use... data_seq.get(i) ...
// use... info_seq.get(i) ...
}
Return the data samples and the information buffers back to the middleware. IMPORTANT : Once this call returns, you must not retain any
pointers to any part of any sample or sample info object.
reader.return_loan(data_seq, info_seq);
6.111.6
Reading data

Read samples of user data type Foo. The samples are not removed from
the Service. It remains responsible for deallocating the buffers.
FooSeq
SampleInfoSeq
int
int
int
int
data_seq = new FooSeq();

// holder for sequence of user data type Foo
info_seq = new SampleInfoSeq)_; // holder for sequence of DDS_SampleInfo
max_samples;
sample_state_mask = SampleStateMask.ANY_SAMPLE_STATE;
view_state_mask = ViewStateMask.ANY_VIEW_STATE;
instance_state_mask = InstanceStateMask.ANY_INSTANCE_STATE;
try {
reader.read(data_seq, info_seq,
max_samples,
sample_state_mask,
view_state_mask,
} catch (RETCODE_ERROR) {
}
256
Use the received data
// Use the received data samples data_seq and associated
// information info_seq
for (int i = 0; i < data_seq.size(); ++i) {
// use... data_seq.get(i) ...
// use... info_seq.get(i) ...
}
Return the data samples and the information buffers back to the middleware
reader.return_loan(data_seq, info_seq);
6.111.7
Tearing down a data reader
Delete DDSDataReader:
try {
subscriber.delete_datareader(reader);
}
6.112 Entity Use Cases
6.112
257
Entity Use Cases
Working with entities.
6.112.1
Enabling an entity
To enable an com.rti.dds.infrastructure.Entity (p. 931)

try {
entity.enable();
System.out.println(
"*** Error: failed to enable entity");
}
6.112.2
Checking if a status changed on an entity.
Given an com.rti.dds.infrastructure.Entity (p. 931) and a

com.rti.dds.infrastructure.StatusKind (p. 1451) to check for,
get the list of statuses that have changed since the last time they were
respectively cleared.
int status_changes_list = entity.get_status_changes();
Check if status kind was changed since the last time it was cleared.
A plain communication status change is cleared when the status is read
using the entitys get <plain communication status>() method. A
read communication status change is cleared when the data is taken from
the middleware via a TDataReader take() call [see Changes in Status
(p. 111) for details].
if ((status_changes_list & status_kind) != 0) {
return true; /* ... YES, status_kind changed ... */
} else {
return false; /* ... NO, status_kind did NOT change ... */
}
6.112.3
Changing the QoS for an entity
The QoS for an entity can be specified at the entity creation time. Once an
entity has been created, its QoS can be manipulated as follows.
Get an entitys QoS settings using get qos (abstract) (p. 933)
258
try {
entity.get_qos(qos);
System.out.println("***Error: failed to get qos\n");
}
Change the desired qos policy fields

/* Change the desired qos policies */
/* qos.policy.field = ... */
Set the qos using set qos (abstract) (p. 932).

try {
entity.set_qos(qos);
} catch (RETCODE_IMMUTABLE_POLICY immutable) {
System.out.println(
"***Error: tried changing a policy that can only be" +
"
set at entity creation time\n");
} catch (RETCODE_INCONSISTENT_POLICY inconsistent) {
System.out.println(
"***Error: tried changing a policy to a value inconsistent" +
"
with other policy settings\n");
} catch (RETCODE_ERROR other) {
System.out.println(
"***Error: tried changing a policy that can only be" +
"
set at entity creation time\n");
}
6.112.4
Changing the listener and enabling/disabling statuses associated with it
The listener for an entity can be specified at the entity creation time. By default
the listener is enabled for all the statuses supported by the entity.
Once an entity has been created, its listener and/or the statuses for which it is
enabled can be manipulated as follows.
User defines entity listener methods
/* ... methods defined by EntityListener ... */
public class MyEntityListener implements Listener {
// ... methods defined by EntityListener ...
}
Get an entitys listener using get listener (abstract) (p. 934)

entity_listener = entity.get_listener();
Enable status kind for the listener

6.112 Entity Use Cases
259
enabled_status_list |= status_kind;
Disable status kind for the listener

enabled_status_list &= ~status_kind;
Set an entitys listener to entity listener using set listener (abstract) (p. 934). Only enable the listener for the statuses specified by
the enabled status list.
try {
entity.set_listener(entity_listener, enabled_status_list);
// respond to failure
}
6.112.5
Enabling/Disabling statuses associated with a status condition
Upon entity creation, by default, all the statuses are enabled for the DDS StatusCondition associated with the entity.
Once an entity has been created, the list of statuses for which the DDS StatusCondition is triggered can be manipulated as follows.
Given an entity, a status kind, and the associated status condition:
statuscondition = entity.get_statuscondition();
Get the list of statuses enabled for the status condition

enabled_status_list = statuscondition.get_enabled_statuses();
Check if the given status kind is enabled for the status condition
if ((enabled_status_list & status_kind) > 0) {
/*... YES, status_kind is enabled ... */
} else {
/* ... NO, status_kind is NOT enabled ... */
}
Enable status kind for the status condition

try {
statuscondition.set_enabled_statuses(enabled_status_list | status_kind);
}
260
Disable status kind for the status condition
try {
statuscondition.set_enabled_statuses(enabled_status_list & ~status_kind);
}
6.113 Waitset Use Cases
6.113
261
Waitset Use Cases
Using wait-sets and conditions.
6.113.1
Setting up a wait-set
Create a wait-set
WaitSet waitset = new WaitSet();
Attach conditions
Condition cond1 = ...;
Condition cond2 = entity.get_statuscondition();
Condition cond3 = reader.create_readcondition(
SampleStateKind.NOT_READ_SAMPLE_STATE,
ViewStateKind.ANY_VIEW_STATE,
InstanceStateKind.ANY_INSTANCE_STATE);
Condition cond4 = new GuardCondition();
Condition cond5 = ...;
waitset.attach_condition(cond1);
6.113.2
Waiting for condition(s) to trigger
Set up a wait-set (p. 261)

Wait for a condition to trigger or timeout, whichever occurs first
Duration_t timeout = new Duration_t(0, 1000000); // 1ms
ConditionSeq active_conditions = new ConditionSeq(); // list of active conditions
boolean is_cond1_triggered = false;
boolean is_cond2_triggered = false;
try {
waitset.wait(active_conditions, timeout);
// check if "cond1" or "cond2" are triggered:
for (int i = 0; i < active_conditions.size(); ++i) {
if (active_conditions.get(i) == cond1) {
System.out.println("Cond1 was triggered!");
is_cond1_triggered = true;
}
if (active_conditions.get(i) == cond2) {
262
System.out.println("Cond2 was triggered!");
is_cond2_triggered = true;
}
}
if (is_cond1_triggered) {
// ... do something because "cond1" was triggered ...
}
if (is_cond2_triggered) {
// ... do something because "cond2" was triggered ...
}
} catch (RETCODE_TIMEOUT timed_out) {
// timeout!
System.out.println(
"Wait timed out!! None of the conditions was triggered.");
} catch (RETCODE_ERROR ex) {
throw ex;
}
6.113.3
Tearing down a wait-set
Delete the wait-set

waitset.delete();
waitset = null;
// let the wait set be garbage collected
6.114 Transport Use Cases
6.114
263
Transport Use Cases
Working with pluggable transports.
6.114.1
Changing the automatically registered built-in

transports
The com.rti.dds.infrastructure.TransportBuiltinKind.MASK DEFAULT

(p. 121)
specifies
the
transport
plugins
that
will
be
automatically
registered
with
a
newly
created
com.rti.dds.domain.DomainParticipant (p. 654) by default.
This default can be changed by changing the value of the
value of TRANSPORT BUILTIN (p. 119) Qos Policy on the
com.rti.dds.domain.DomainParticipant (p. 654)
To change the com.rti.dds.domain.DomainParticipantQos.transport builtin (p. 775) Qos Policy:
DomainParticipantQos participant_qos = new DomainParticipantQos();
factory.get_default_participant_qos(participant_qos);
participant_qos.transport_builtin.mask = TransportBuiltinKind.SHMEM |
TransportBuiltinKind.UDPv4;
6.114.2
Changing the properties of the automatically registered builtin transports
The behavior of the automatically registered builtin transports can be altered

by changing their properties.
Tell the com.rti.dds.domain.DomainParticipantFactory (p. 742) to
create the participants disabled, as described in Turning off autoenable of newly created participant(s) (p. 239)
Get the property of the desired builtin transport plugin,
com.rti.ndds.transport.UDPv4Transport (p. 1668)
say
UDPv4Transport.Property_t property = new UDPv4Transport.Property_t();

TransportSupport.get_builtin_transport_property(participant, property);
264
Change the property fields as desired. Note that the properties should be
changed carefully, as inappropriate values may prevent communications.
For example, the com.rti.ndds.transport.UDPv4Transport (p. 1668)
properties can be changed to support large messages (assuming the underlying operating systems UDPv4 stack supports the large message size).
Note: if message size max is increased from the default for any of the
built-in transports, then the DDS ReceiverPoolQosPolicy.buffer size on
the DomainParticipant should also be changed.
/* Increase the UDPv4 maximum message size to 64K (large messages). */
property.message_size_max
= 65535;
property.recv_socket_buffer_size = 65535;
property.send_socket_buffer_size = 65535;
Set the property of the desired builtin transport plugin,

com.rti.ndds.transport.UDPv4Transport (p. 1668)
say
TransportSupport.set_builtin_transport_property(participant, property);
Enable the participant (p. 257) to turn on communications with other

participants in the domain using the new properties for the automatically
registered builtin transport plugins.
6.115 Filter Use Cases
6.115
265
Filter Use Cases
Working with data filters.
6.115.1
Introduction
RTI Connext supports filtering data either during the exchange

from
(p. 557)
to
com.rti.dds.subscription.DataReader (p. 487), or after the data has
been stored at the com.rti.dds.subscription.DataReader (p. 487).
Filtering
during
the
exchange
process
is
performed
by
a
com.rti.dds.topic.ContentFilteredTopic (p. 471), which is created by
the com.rti.dds.subscription.DataReader (p. 487) as a way of specifying a
subset of the data samples that it wishes to receive.
Filtering
samples
that
have
already
been
received
by
the
com.rti.dds.subscription.DataReader (p. 487) is performed by creating a com.rti.dds.subscription.QueryCondition (p. 1311), which
can then used to check for matching samples, be alerted when
matching samples arrive, or retrieve matching samples through use
of
the
(p. 990) or com.rti.ndds.example.FooDataReader.take w condition
(p. 991) functions.
(Conditions may also be used with the APIs
com.rti.ndds.example.FooDataReader.read next instance w condition (p. 1004) and com.rti.ndds.example.FooDataReader.take next instance w condition (p. 1006).)
Filtering may be performed on any topic, either keyed or un-keyed, except the
Built-in Topics (p. 157). Filtering may be perfomed on any field, subset of
fields, or combination of fields, subject only to the limitations of the filter syntax,
and some restrictions against filtering some sparse value types of the Dynamic
Data (p. 175) API.
RTI Connext contains built in support for filtering using SQL syntax, described
in the Queries and Filters Syntax (p. 286) module.
6.115.1.1
Overview of ContentFilteredTopic
Each
(p. 471)
is
created
based
on
an
existing
(p. 1545).
The com.rti.dds.topic.Topic (p. 1545) specifies the field names
and field types of the data contained within the topic.
The
com.rti.dds.topic.ContentFilteredTopic (p. 471), by means of its filter expression and expression parameters, futher specifies the values of the
data which the com.rti.dds.subscription.DataReader (p. 487) wishes to
266
receive.
Custom filters may also be constructed and utilized as described in the Creating Custom Content Filters (p. 271) module.
Once the com.rti.dds.topic.ContentFilteredTopic (p. 471) has been created, a com.rti.dds.subscription.DataReader (p. 487) can be created
using the filtered topic.
The filters characteristics are exchanged between the com.rti.dds.subscription.DataReader (p. 487) and any matching
com.rti.dds.publication.DataWriter (p. 557) during the discovery processs.
If the com.rti.dds.publication.DataWriter (p. 557) allows (by
com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy.max (p. 623))
and
the
number
of
filtered
remote reader filters
com.rti.dds.subscription.DataReader (p. 487) is less than or equal
to 32, and the com.rti.dds.subscription.DataReader (p. 487) s
com.rti.dds.infrastructure.TransportMulticastQosPolicy
(p. 1590)
is empty, then the com.rti.dds.publication.DataWriter (p. 557) will performing filtering and send to the com.rti.dds.subscription.DataReader
(p. 487) only those samples that meet the filtering criteria.
If disallowed by the com.rti.dds.publication.DataWriter (p. 557), or
if more than 32 com.rti.dds.subscription.DataReader (p. 487) require
filtering, or the com.rti.dds.subscription.DataReader (p. 487) has set
the com.rti.dds.infrastructure.TransportMulticastQosPolicy (p. 1590),
then the com.rti.dds.publication.DataWriter (p. 557) sends all samples to the com.rti.dds.subscription.DataReader (p. 487), and the
com.rti.dds.subscription.DataReader (p. 487) discards any samples that
do not meet the filtering criteria.
Although the filter expression cannot be changed once the
(p. 471)
has
been
created,
the
expression parameters
can
be
modified
using
com.rti.dds.topic.ContentFilteredTopic.set expression parameters (p. 473).
Any changes made to the filtering criteria
by
means
of
com.rti.dds.topic.ContentFilteredTopic.set expression parameters (p. 473), will be conveyed to any conNew samples
nected com.rti.dds.publication.DataWriter (p. 557).
will be subject to the modified filtering criteria, but samples that
have already been accepted or rejected are unaffected.
However, if
the com.rti.dds.subscription.DataReader (p. 487) connects to a
com.rti.dds.publication.DataWriter (p. 557) that re-sends its data,
the re-sent samples will be subjected to the new filtering criteria.
6.115.1.2
Overview of QueryCondition
(p. 1311)
combine
aspects
of
the
content
filtering
capabilities
of
267
com.rti.dds.topic.ContentFilteredTopic (p. 471) with state filtering capabilities of com.rti.dds.subscription.ReadCondition (p. 1313)
to create a reconfigurable means of filtering or searching data in the
com.rti.dds.subscription.DataReader (p. 487) queue.
com.rti.dds.subscription.QueryCondition (p. 1311) may be created on
a disabled com.rti.dds.subscription.DataReader (p. 487), or after the
com.rti.dds.subscription.DataReader (p. 487) has been enabled. If the
com.rti.dds.subscription.DataReader (p. 487) is enabled, and has already
recevied and stored samples in its queue, then all data samples in the are filtered against the com.rti.dds.subscription.QueryCondition (p. 1311) filter criteria at the time that the com.rti.dds.subscription.QueryCondition
(Note that an exclusive lock is held on the
(p. 1311) is created.
com.rti.dds.subscription.DataReader (p. 487) sample queue for the duration of the com.rti.dds.subscription.QueryCondition (p. 1311) creation).
Once
created,
incoming
samples
are
filtered
against
(p. 1311)
filter
teria at the time of their arrival and storage into
com.rti.dds.subscription.DataReader (p. 487) queue.
all
crithe
The number of com.rti.dds.subscription.QueryCondition (p. 1311) filters

that an individual com.rti.dds.subscription.DataReader (p. 487) may create is set by com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max query condition filters (p. 554), to an upper maximum of 32.
6.115.2
Filtering with ContentFilteredTopic

Create a ContentFilteredTopic, of user data type Foo:
String cft_param_list[] = {"1", "100"};
StringSeq cft_parameters = new StringSeq(java.util.Arrays.asList(cft_param_list));
ContentFilteredTopic cft = participant.create_contentfilteredtopic(
"ContentFilteredTopic",
topic,
"value > %0 AND value < %1",
cft_parameters);
if (cft == null) {
System.err.println("create_contentfilteredtopic error\n");
return;
}
Create a FooReader using the ContentFilteredTopic:

268
FooDataReader reader = (FooDataReader)
subscriber.create_datareader(
cft,
datareader_qos, // or Subscriber.DATAREADER_QOS_DEFAULT //
listener, // or null //
if (reader == null) {
System.err.println("create_datareader error\n");
return;
}
Once
setup,
reading
samples
with
a
com.rti.dds.topic.ContentFilteredTopic (p. 471) is exactly the
same as normal reads or takes, as decribed in DataReader Use Cases
(p. 253).
Changing filter crieria using set expression parameters:
cft_parameters.set(0, "5");
cft_parameters.set(1, "9");
cft.set_expression_parameters(cft_parameters);
6.115.3
Filtering with Query Conditions
Given a data reader of type Foo

FooDataReader reader = ...;
Creating a QueryCondition
QueryCondition queryCondition = null;
String qc_param_list[] = {"1", "100"};
StringSeq qc_parameters = new StringSeq(java.util.Arrays.asList(cft_param_list));
queryCondition = reader.create_querycondition(SampleStateKind.NOT_READ_SAMPLE_STATE,
InstanceStateKind.ANY_INSTANCE_STATE,
"value > %0 AND value < %1",
qc_parameters);
if (queryCondition == null) {
System.err.println("create_querycondition error\n");
return;
}
Reading matching samples with a com.rti.dds.subscription.QueryCondition

(p. 1311)
269
FooSeq _dataSeq = new FooSeq();

SampleInfoSeq _infoSeq = new SampleInfoSeq();
try {
reader.read_w_condition(_dataSeq, _infoSeq,
ResourceLimitsQosPolicy.LENGTH_UNLIMITED,
queryCondition);
for(int i = 0; i < _dataSeq.size(); ++i) {
SampleInfo info = (SampleInfo)_infoSeq.get(i);
if (info.valid_data) {
// --- Process data here --- //
}
}
} catch (RETCODE_NO_DATA noData) {
// No data to process
} finally {
reader.return_loan(_dataSeq, _infoSeq);
}
com.rti.dds.subscription.QueryCondition.set query parameters

(p. 1312)
is
used
similarly
com.rti.dds.topic.ContentFilteredTopic.set expression parameters (p. 473), and the same coding techniques can be used.
to
Any
(p. 1311)
that
have
been
created
must
be
deleted
before
the
com.rti.dds.subscription.DataReader (p. 487) can be deleted. This
can be done using com.rti.dds.subscription.DataReader.delete contained entities (p. 504) or manually as in:
retcode = reader.delete_readcondition(queryCondition);
6.115.4
Filtering Performance
Although RTI Connext supports filtering on any field or combination of

fields using the SQL syntax of the built-in filter, filters for keyed topics that filter solely on the contents of key fields have the potential for
much higher performance. This is because for key field only filters, the
com.rti.dds.subscription.DataReader (p. 487) caches the results of the filter (pass or not pass) for each instance. When another sample of the same
instance is seen at the com.rti.dds.subscription.DataReader (p. 487), the
filter results are retrieved from cache, dispensing with the need to call the filter
function.
This optimization applies to all filtering using the built-in SQL filter,
performed by the com.rti.dds.subscription.DataReader (p. 487),
for
either
(p. 471)
or
com.rti.dds.subscription.QueryCondition (p. 1311).
This does not
270
apply to filtering perfomed for com.rti.dds.topic.ContentFilteredTopic

(p. 471) by the com.rti.dds.publication.DataWriter (p. 557).
6.116 Creating Custom Content Filters
6.116
271
Working with custom content filters.
6.116.1
Introduction
By default, RTI Connext creates content filters with the DDS SQL FILTER,
which implements a superset of the DDS-specified SQL WHERE clause. However, in many cases this filter may not be what you want. Some examples are:
The default filter can only filter based on the content of a sample, not on a
computation on the content of a sample. You can use a custom filter that
is customized for a specific type and can filter based on a computation of
the type members.
You want to use a different filter language then SQL
This HOWTO explains how to write your own custom filter and is divided into
the following sections:
The Custom Content Filter API (p. 271)
Example Using C format strings (p. 272)
6.116.2
The Custom Content Filter API
A
custom
content
filter
is
created
by
calling
the
com.rti.dds.domain.DomainParticipant.register contentfilter
(p. 728) function with a com.rti.dds.topic.ContentFilter (p. 467) that
contains a compile, an evaluate function and a finalize function.
com.rti.dds.topic.ContentFilteredTopic (p. 471) can be created with
com.rti.dds.domain.DomainParticipant.create contentfilteredtopic with filter (p. 702) to use this filter.
A custom content filter is used by RTI Connext at the following times during the
life-time of a com.rti.dds.topic.ContentFilteredTopic (p. 471) (the function
called is shown in parenthesis).
When a com.rti.dds.topic.ContentFilteredTopic (p. 471) is created
(compile (p. 272))
When
the
filter
parameters
are
changed
on
the
com.rti.dds.topic.ContentFilteredTopic (p. 471) (compile (p. 272))
with
com.rti.dds.topic.ContentFilteredTopic.set expression parameters (p. 473)
272
When a sample is filtered (evaluate (p. 272)). This function is called by
the RTI Connext core with a de-serialized sample
When a com.rti.dds.topic.ContentFilteredTopic (p. 471) is deleted
(finalize (p. 272))
6.116.2.1
The compile function
The compile (p. 272) function is used to compile a filter expression and expression parameters. Please note that the term compile is intentionally loosely
defined. It is up to the user to decide what this function should do and return.
See com.rti.dds.topic.ContentFilter.compile (p. 468) for details.
6.116.2.2
The evaluate function
The evaluate (p. 273) function is called each time a sample is received to determine if a sample should be filtered out and discarded.
See com.rti.dds.topic.ContentFilter.evaluate (p. 469) for details.
6.116.2.3
The finalize function
The finalize (p. 273) function is called when an instance of the custom content
filter is no longer needed. When this function is called, it is safe to free all
resources used by this particular instance of the custom content filter.
See com.rti.dds.topic.ContentFilter.finalize (p. 470) for details.
6.116.3
Example Using C format strings
Assume that you have a type Foo.

You want to write a custom filter function that will drop all samples where the
value of Foo.x > x and x is a value determined by an expression parameter. The
filter will only be used to filter samples of type Foo.
6.116.3.1
Writing the Compile Function
The first thing to note is that we can ignore the filter expression, since we
already know what the expression is. The second is that x is a parameter that
can be changed. By using this information, the compile function is very easy to
implement. Simply return the parameter string. This string will then be passed
to the evaluate function every time a sample of this type is filtered.
6.116 Creating Custom Content Filters
273
Below is the entire compile (p. 272) function.

public void compile(
ObjectHolder new_compile_data, String expression,
StringSeq parameters, TypeCode type_code, String type_class_name,
Object old_compile_data) {
new_compile_data.value = parameters.get(0);
}
6.116.3.2
Writing the Evaluate Function
The next step is to implement the evaluate function. The evaluate function
receives the parameter string with the actual value to test against. Thus the
evaluate function must read the actual value from the parameter string before
evaluating the expression. Below is the entire evaluate (p. 272) function.
public boolean evaluate(
Object compile_data, Object sample, FilterSampleInfo meta_data) {
String parameter = (String)compile_data;
int x;
Foo foo_sample = (Foo)sample;
x = Integer.parseInt(parameter);
return (foo_sample.x > x ? false : true);
}
6.116.3.3
Writing the Finalize Function
The last function to write is the finalize function. It is safe to free all resources
used by this particular instance of the custom content filter that is allocated in
compile. Below is the entire finalize (p. 272) function.
public void finalize(
Object compile_data) {
/* nothing to do since no resource are allocated */
}
6.116.3.4
Registering the Filter
Before the custom filter can be used, it must be registered with RTI Connext:
ContentFilter myCustomFilter = new MyContentFilter();
participant.register_contentfilter("MyCustomFilter", myCustomFilter);
274
6.116.3.5
Unregistering the Filter
When the filter is no longer needed, it can be unregistered from RTI Connext:
participant.unregister_contentfilter("MyCustomFilter");
6.117 Large Data Use Cases
6.117
275
Large Data Use Cases
Working with large data types.
6.117.1
Introduction
RTI Connext supports data types whose size exceeds the maximum message
size of the underlying transports. A com.rti.dds.publication.DataWriter
(p. 557) will fragment data samples when required. Fragments are automatically
reassembled at the receiving end.
Once all fragments of a sample have been received, the new sample is passed
to the com.rti.dds.subscription.DataReader (p. 487) which can then make
it available to the user. Note that the new sample is treated as a regular
sample at that point and its availability depends on standard QoS settings such
as com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples
(p. 1351) and com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP LAST HISTORY QOS.
The large data feature is fully supported by all DDS APIs, so its use is mostly
transparent. Some additional considerations apply as explained below.
6.117.2
Writing Large Data
In
order
to
use
the
large
data
feature
with
the
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.RELIABLE RELIABILITY QOS setting, the com.rti.dds.publication.DataWriter
(p. 557)
must
be
configured
as
an
asynchronous
writer
(com.rti.dds.infrastructure.PublishModeQosPolicyKind.PublishModeQosPolicyKind.ASYNCHRONOUS PUBLISH MODE QOS) with associated com.rti.dds.publication.FlowController
(p. 964).
While
the
use
of
an
asynchronous
writer
and
flow
controller
is
optional
when
using
the
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.BEST EFFORT RELIABILITY QOS setting, most large data use cases will benefit
from the use of a flow controller to prevent flooding the network when fragments
are being sent.
Set up writer (p. 248)
Add flow control (p. 243)
276
6.117.3
Receiving Large Data
Large data is supported by default and in most cases, no further changes are
required.
The com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy
allows
tuning
the
resources
available
to
the
(p. 542)
com.rti.dds.subscription.DataReader (p. 487) for reassembling fragmented large data.
Set up reader (p. 253)
6.118 Documentation Roadmap
6.118
277
Documentation Roadmap
This section contains a roadmap for the new user with pointers on what to read
first.
If you are new to RTI Connext, we recommend starting in the following order:
See the Getting Started Guide. This document provides download and
installation instructions. It also lays out the core value and concepts
behind the product and takes you step-by-step through the creation of a
simple example application.
The Users Manual describes the features of the product and how to use
them. It is organized around the structure of the DDS APIs and certain
common high-level tasks.
The documentation in the DDS API Reference (p. 280) provides an
overview of API classes and modules for the DDS data-centric publishsubscribe (DCPS) package from a programmers perspective. Start by
reading the documentation on the main page.
After reading the high level module documentation, look at the Publication Example (p. 237) and Subscription Example (p. 238) for stepby-step examples of creating a publication and subscription. These are
hyperlinked code snippets to the full API documentation, and provide a
good place to begin learning the APIs.
Next, work through your own application using the example code files
generated by rtiddsgen (p. 298).
To integrate similar code into your own application and build system, you
will likely need to refer to the Platform Notes.
278
6.119
Conventions
This section describes the conventions used in the API documentation.
6.119.1
Unsupported Features
[Not supported (optional)] This note means that the optional feature from
the DDS specification is not supported in the current release.
6.119.2
API Documentation Terms
In the API documentation, the term module refers to a logical grouping of

documentation and elements in the API.
6.119.3
Stereotypes
Commonly used stereotypes in the API documentation include the following.

6.119.3.1
Extensions
<<eXtension>> ( p. 278)
An RTI Connext product extension to the DDS standard specification.
The extension APIs complement the standard APIs specified by the
OMG DDS specification. They are provided to improve product
usability and enable access to product-specific features such as pluggable transports.
6.119.3.2
Experimental
<<experimental>> ( p. 278)
RTI Connext experimental features are used to evaluate new features
and get user feedback.
These features are not guaranteed to be fully supported and might be
implemented only of some of the programming languages supported
bt RTI Connext
The functional APIs corresponding to experimental features can be
distinguished from other APIs by the suffix exp.
6.119 Conventions
279
Experimental features may or may not appear in future product releases.

The name of the experimental features APIs will change if they become officially supported. At the very least the suffix exp will be
removed.
Experimental features should not be used in production.
6.119.3.3
Types
<<interface>> ( p. 279)
Pure interface type with no state.
Languages such as Java natively support the concept of an interface type, which is a collection of method signatures devoid of any
dynamic state.
In C++, this is achieved via a class with all pure virtual methods
and devoid of any instance variables (ie no dynamic state).
Interfaces are generally organized into a type hierarchy. Static typecasting along the interface type hierarchy is safe for valid objects.
<<generic>> ( p. 279)
A generic type is a skeleton class written in terms of generic parameters. Type-specific instantiations of such types are conventionally referred to in this documentation in terms of the hypothetical
type Foo; for example: FooSeq, FooDataType, FooDataWriter,
and FooDataReader.
<<singleton>> ( p. 279)
Singleton class. There is a single instance of the class.
Generally acccessed via a get instance() static method.
6.119.3.4
Method Parameters
<<in>> ( p. 279)
An input parameter.
<<out>> ( p. 279)
An output parameter.
<<inout>> ( p. 279)
An input and output parameter.
280
6.120
DDS API Reference
RTI Connext modules following the DDS module definitions.
Modules
Domain Module
Contains the com.rti.dds.domain.DomainParticipant ( p. 654) class that
classes. The com.rti.dds.domain.DomainParticipant ( p. 654) also acts
as a container for the other objects that make up RTI Connext.
Topic Module
Contains
the
( p. 1545),
( p. 471),
and
( p. 1190)
classes,
the
com.rti.dds.topic.TopicListener ( p. 1564) interface, and more generally,
all that is needed by an application to define com.rti.dds.topic.Topic
( p. 1545) objects and attach QoS policies to them.
Publication Module
Contains
the
( p. 964),
( p. 1262),
and
com.rti.dds.publication.DataWriter ( p. 557) classes as well as
the
( p. 1289)
and
( p. 586)
interfaces,
and more generally, all that is needed on the publication side.
Subscription Module
Contains
the
( p. 1476),
( p. 487),
and
( p. 1313),
com.rti.dds.subscription.QueryCondition ( p. 1311) classes, as well
as the com.rti.dds.subscription.SubscriberListener ( p. 1503) and
com.rti.dds.subscription.DataReaderListener ( p. 518) interfaces, and
Infrastructure Module
modules. Contains common definitions such as return codes, status values,
and QoS policies.
Queries and Filters Syntax

6.120 DDS API Reference
6.120.1
281
RTI Connext modules following the DDS module definitions.
6.120.2
Overview
Information
flows
with
the
aid
of
the
following
constructs:
(p. 1262)
and
on
the
sendcom.rti.dds.publication.DataWriter
(p. 557)
ing
side,
(p. 1476)
and
com.rti.dds.subscription.DataReader (p. 487) on the receiving side.
A com.rti.dds.publication.Publisher (p. 1262) is an object responsible for data distribution.
It may publish data of different data types.
A TDataWriter acts as a typed (i.e.
each
com.rti.dds.publication.DataWriter (p. 557) object is dedicated
to one application data type) accessor to a publisher.
A
com.rti.dds.publication.DataWriter (p. 557) is the object the application must use to communicate to a publisher the existence and value of
data objects of a given type. When data object values have been communicated to the publisher through the appropriate data-writer, it is the
publishers responsibility to perform the distribution (the publisher will do
this according to its own QoS, or the QoS attached to the corresponding
data-writer). A publication is defined by the association of a data-writer
to a publisher. This association expresses the intent of the application to
publish the data described by the data-writer in the context provided by
the publisher.
A com.rti.dds.subscription.Subscriber (p. 1476) is an object responsible for receiving published data and making it available (according to
the Subscribers QoS) to the receiving application. It may receive and
dispatch data of different specified types. To access the received data, the
application must use a typed TDataReader attached to the subscriber.
Thus, a subscription is defined by the association of a data-reader with
a subscriber. This association expresses the intent of the application to
subscribe to the data described by the data-reader in the context provided
by the subscriber.
com.rti.dds.topic.Topic (p. 1545) objects conceptually fit between publications and subscriptions. Publications must be known in such a way that
subscriptions can refer to them unambiguously. A com.rti.dds.topic.Topic
(p. 1545) is meant to fulfill that purpose: it associates a name (unique in the
domain i.e. the set of applications that are communicating with each other),
a data type, and QoS related to the data itself. In addition to the topic
282
QoS, the QoS of the com.rti.dds.publication.DataWriter (p. 557) associated with that Topic and the QoS of the com.rti.dds.publication.Publisher
(p. 1262) associated to the com.rti.dds.publication.DataWriter (p. 557)
control the behavior on the publishers side, while the corresponding
com.rti.dds.topic.Topic (p. 1545), com.rti.dds.subscription.DataReader
(p. 487) and com.rti.dds.subscription.Subscriber (p. 1476) QoS control the
behavior on the subscribers side.
When an application wishes to publish data of a given type, it
must create a com.rti.dds.publication.Publisher (p. 1262) (or reuse
an already created one) and a com.rti.dds.publication.DataWriter
Sim(p. 557) with all the characteristics of the desired publication.
ilarly, when an application wishes to receive data, it must create a
com.rti.dds.subscription.Subscriber (p. 1476) (or reuse an already created
one) and a com.rti.dds.subscription.DataReader (p. 487) to define the subscription.
6.120.3
Conceptual Model
The overall conceptual model is shown below.

Notice that all the main communication objects (the specializations of Entity)
follow unified patterns of:
Supporting QoS (made up of several QosPolicy); QoS provides a generic
mechanism for the application to control the behavior of the Service and
tailor it to its needs. Each com.rti.dds.infrastructure.Entity (p. 931)
supports its own specialized kind of QoS policies (see QoS Policies
(p. 94)).
Accepting a com.rti.dds.infrastructure.Listener (p. 1130); listeners
provide a generic mechanism for the middleware to notify the application of relevant asynchronous events, such as arrival of data corresponding to a subscription, violation of a QoS setting, etc. Each
com.rti.dds.infrastructure.Entity (p. 931) supports its own specialized kind of listener. Listeners are related to changes in status conditions
(see Status Kinds (p. 110)).
Note that only one Listener per entity is allowed (instead of a list of
them). The reason for that choice is that this allows a much simpler (and,
thus, more efficient) implementation as far as the middleware is concerned.
Moreover, if it were required, the application could easily implement a
listener that, when triggered, triggers in return attached sub-listeners.
Accepting a com.rti.dds.infrastructure.StatusCondition (p. 1448)
(and a set of com.rti.dds.subscription.ReadCondition (p. 1313) obGenerated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
283
jects for the com.rti.dds.subscription.DataReader (p. 487)); conditions (in conjunction with com.rti.dds.infrastructure.WaitSet
(p. 1709) objects) provide support for an alternate communication style
between the middleware and the application (i.e., wait-based rather than
notification-based).
All DCPS entities are attached to a com.rti.dds.domain.DomainParticipant
(p. 654). A domain participant represents the local membership of the application in a domain. A domain is a distributed concept that links all the
applications able to communicate with each other. It represents a communication plane: only the publishers and the subscribers attached to the same
domain may interact.
com.rti.dds.infrastructure.DomainEntity (p. 653) is an intermediate object whose only purpose is to state that a DomainParticipant cannot contain
other domain participants.
At the DCPS level, data types represent information that is sent atomically.
For performance reasons, only plain data structures are handled by this level.
By default, each data modification is propagated individually, independently, and uncorrelated with other modifications. However, an application may request that several modifications be sent as a whole and interpreted as such at the recipient side. This functionality is offered on a Publisher/Subscriber basis. That is, these relationships can only be specified
among com.rti.dds.publication.DataWriter (p. 557) objects attached to
the same com.rti.dds.publication.Publisher (p. 1262) and retrieved among
com.rti.dds.subscription.DataReader (p. 487) objects attached to the same
By definition, a com.rti.dds.topic.Topic (p. 1545) corresponds to a single data
type. However, several topics may refer to the same data type. Therefore, a
com.rti.dds.topic.Topic (p. 1545) identifies data of a single type, ranging from
one single instance to a whole collection of instances of that given type. This is
shown below for the hypothetical data type Foo.
In case a set of instances is gathered under the same topic, different instances
must be distinguishable. This is achieved by means of the values of some data
fields that form the key to that data set. The key description (i.e., the list of
data fields whose value forms the key) has to be indicated to the middleware.
The rule is simple: different data samples with the same key value represent
successive values for the same instance, while different data samples with different key values represent different instances. If no key is provided, the data set
associated with the com.rti.dds.topic.Topic (p. 1545) is restricted to a single
instance.
Topics need to be known by the middleware and potentially propagated. Topic objects are created using the create operations provided by
284
The interaction style is straightforward on the publishers side: when the application decides that it wants to make data available for publication, it calls the
appropriate operation on the related com.rti.dds.publication.DataWriter
(p. 557) (this, in turn, will trigger its com.rti.dds.publication.Publisher
(p. 1262)).
On the subscribers side however, there are more choices: relevant information may arrive when the application is busy doing something else or when
the application is just waiting for that information. Therefore, depending
on the way the application is designed, asynchronous notifications or synchronous access may be more appropriate. Both interaction modes are allowed,
a com.rti.dds.infrastructure.Listener (p. 1130) is used to provide a callback
for synchronous access and a com.rti.dds.infrastructure.WaitSet (p. 1709)
associated with one or several com.rti.dds.infrastructure.Condition
(p. 464) objects provides asynchronous data access.
The same synchronous and asynchronous interaction modes can also be used
to access changes that affect the middleware communication status (see Status Kinds (p. 110)). For instance, this may occur when the middleware asynchronously detects an inconsistency. In addition, other middleware information
that may be relevant to the application (such as the list of the existing topics)
is made available by means of built-in topics (p. 157) that the application can
access as plain application data, using built-in data-readers.
6.120.4
Modules
DCPS consists of five modules:

Infrastructure module (p. 206) defines the abstract classes and the
interfaces that are refined by the other modules. It also provides support
for the two interaction styles (notification-based and wait-based) with the
middleware.
Domain
module
(p. 147)
contains
the
com.rti.dds.domain.DomainParticipant (p. 654) class that acts
as an entrypoint of the Service and acts as a factory for many of the
classes. The com.rti.dds.domain.DomainParticipant (p. 654) also
acts as a container for the other objects that make up the Service.
Topic module (p. 161) contains the com.rti.dds.topic.Topic (p. 1545)
class, the com.rti.dds.topic.TopicListener (p. 1564) interface, and
more generally, all that is needed by the application to define
com.rti.dds.topic.Topic (p. 1545) objects and attach QoS policies to
them.
285
Publication
module
(p. 180)
contains
the
and
(p. 1262)
the com.rti.dds.publication.PublisherListener (p. 1289) and
Subscription
module
(p. 192)
contains
the
(p. 1476),
(p. 487),
(p. 1313),
and
com.rti.dds.subscription.QueryCondition (p. 1311) classes, as
well as the com.rti.dds.subscription.SubscriberListener (p. 1503)
and com.rti.dds.subscription.DataReaderListener (p. 518) interfaces, and more generally, all that is needed on the subscription
side.
286
6.121
Queries and Filters Syntax
6.121.1
Syntax for DDS Queries and Filters
A subset of SQL syntax is used in several parts of the specification:

The filter expression in the com.rti.dds.topic.ContentFilteredTopic
(p. 471)
The query expression in the com.rti.dds.subscription.QueryCondition
(p. 1311)
The topic expression in the com.rti.dds.topic.MultiTopic (p. 1190)
Those expressions may use a subset of SQL, extended with the possibility to
use program variables in the SQL expression. The allowed SQL expressions are
defined with the BNF-grammar below.
The following notational conventions are made:
NonTerminals are typeset in italics.
Terminals are quoted and typeset in a fixed width font. They are
written in upper case in most cases in the BNF-grammar below, but should
be case insensitive.
TOKENS are typeset in bold.
The notation (element // ,) represents a non-empty comma-separated
list of elements.
6.121.2
SQL grammar in BNF
Expression ::= FilterExpression

|
TopicExpression
|
QueryExpression
.
FilterExpression ::= Condition
TopicExpression ::= SelectFrom { Where } ;
QueryExpression ::= { Condition }{ ORDER BY (
NAME // ,) }
.
SelectFrom
Aggregation
::= SELECT Aggregation FROM

.
::= *
|
( SubjectFieldSpec // ,)
FIELD-
Selection
6.121 Queries and Filters Syntax

.
SubjectFieldSpec ::= FIELDNAME
|
FIELDNAME AS IDENTIFIER
|
FIELDNAME IDENTIFIER
.
Selection
::= TOPICNAME
|
TOPICNAME NaturalJoin JoinItem
.
JoinItem
::= TOPICNAME
|
TOPICNAME NaturalJoin JoinItem
|
( TOPICNAME NaturalJoin JoinItem )
.
NaturalJoin ::= INNER JOIN
|
INNER NATURAL JOIN
|
NATURAL JOIN
|
NATURAL INNER JOIN
.
Where
::= WHERE Condition
.
Condition
::= Predicate
|
Condition AND Condition
|
Condition OR Condition
|
NOT Condition
|
( Condition )
.
Predicate
::= ComparisonPredicate
|
BetweenPredicate
.
ComparisonPredicate ::= ComparisonTerm RelOp ComparisonTerm
.
ComparisonTerm
::= FieldIdentifier
| Parameter
.
BetweenPredicate
::= FieldIdentifier BETWEEN Range
|
FieldIdentifier NOT BETWEEN Range
.
FieldIdentifier
::= FIELDNAME
| IDENTIFIER
.
RelOp
::= = | > | >= | < | <= | <> | LIKE |
.
Range
::= Parameter AND Parameter
.
Parameter ::= INTEGERVALUE
|
CHARVALUE
|
FLOATVALUE
|
STRING
|
ENUMERATEDVALUE
|
BOOLEANVALUE
|
PARAMETER
287
MATCH
288
.
Note INNER JOIN, INNER NATURAL JOIN, NATURAL JOIN, and NATURAL INNER JOIN are all aliases, in the sense that they have the same semantics. They are all supported because they all are part of the SQL standard.
6.121.3
Token expression
The syntax and meaning of the tokens used in the SQL grammar is described
as follows:
IDENTIFIER - An identifier for a FIELDNAME, and is defined as any
series of characters a, ..., z, A, ..., Z, 0, ..., 9, but may not start
with a digit.
Formal notation:
IDENTIFIER: LETTER ( PART LETTER )*
where LETTER : [ "A"-"Z"," ","a"-"z" ]
PART LETTER : [ "A"-"Z"," ","a"-"z","0"-"9" ]
FIELDNAME - A fieldname is a reference to a field in the data structure.

The dot . is used to navigate through nested structures. The number of
dots that may be used in a FIELDNAME is unlimited. The FIELDNAME
can refer to fields at any depth in the data structure. The names of the field
are those specified in the IDL definition of the corresponding structure,
which may or may not match the fieldnames that appear on the languagespecific (e.g., C/C++, Java) mapping of the structure. To reference to the
n+1 element in an array or sequence, use the notation [n], where n is a
natural number (zero included). FIELDNAME must resolve to a primitive
IDL type; that is either boolean, octet, (unsigned) short, (unsigned) long,
(unsigned) long long, float double, char, wchar, string, wstring, or enum.
Formal notation:
FIELDNAME: FieldNamePart ( "." FieldNamePart )*
where FieldNamePart : IDENTIFIER ( "[" Index "]" )*
Index> : (["0"-"9"])+
| ["0x","0X"](["0"-"9", "A"-"F", "a"-"f"])+
Primitive IDL types referenced by FIELDNAME are treated as different types

in Predicate according to the following table:

Predicate Data Type
BOOLEANVALUE
INTEGERVALUE
FLOATVALUE
CHARVALUE
STRING
ENUMERATEDVALUE
289
IDL Type
boolean
octet, (unsigned) short, (unsigned)
long, (unsigned) long long
float, double
char, wchar
string, wstring
enum
TOPICNAME - A topic name is an identifier for a topic, and is defined

as any series of characters a, ..., z, A, ..., Z, 0, ..., 9, but may
not start with a digit.
Formal notation:
TOPICNAME : IDENTIFIER
INTEGERVALUE - Any series of digits, optionally preceded by a plus

or minus sign, representing a decimal integer value within the range of the
system. A hexadecimal number is preceded by 0x and must be a valid
hexadecimal expression.
Formal notation:
INTEGERVALUE : (["+","-"])? (["0"-"9"])+ [("L","l")]?
| (["+","-"])? ["0x","0X"](["0"-"9", "A"-"F", "a"-"f"])+ [("L","l")]?
CHARVALUE - A single character enclosed between single quotes.

Formal notation:
CHARVALUE : "" (~[""])? ""
FLOATVALUE - Any series of digits, optionally preceded by a plus or

minus sign and optionally including a floating point (.). A power-of-ten
expression may be postfixed, which has the syntax en or En, where n is
a number, optionally preceded by a plus or minus sign.
Formal notation:
FLOATVALUE : (["+","-"])? (["0"-"9"])* (".")? (["0"-"9"])+ ( EXPONENT )?
where EXPONENT : ["e","E"] (["+","-"])? (["0"-"9"])+
290
STRING - Any series of characters encapsulated in single quotes, except
the single quote itself.
Formal notation:
STRING : "" (~[""])* ""
ENUMERATEDVALUE - An enumerated value is a reference to a

value declared within an enumeration. Enumerated values consist of the
name of the enumeration label enclosed in single quotes. The name used
for the enumeration label must correspond to the label names specified in
the IDL definition of the enumeration.
Formal notation:
ENUMERATEDVALUE : "" ["A" - "Z", "a" - "z"] ["A" - "Z", "a" - "z", " ", "0" - "9"]* ""
BOOLEANVALUE - Can either be TRUE or FALSE, case insensitive.

Formal notation (case insensitive):
BOOLEANVALUE : ["TRUE","FALSE"]
PARAMETER - A parameter is of the form %n, where n represents a

natural number (zero included) smaller than 100. It refers to the n + 1
th argument in the given context. Argument can only in primitive type
value format. It cannot be a FIELDNAME.
Formal notation:
PARAMETER : "%" (["0"-"9"])+
6.121.4
String Parameters
Strings used as parameter values must contain the enclosing quotation marks
() within the parameter value, and not place the quotation marks within the
expression statement. For example, the following expression is legal:
" symbol MATCH %0 " with parameter 0 = " IBM "
whereas the following expression will not compile:

" symbol MATCH %0 " with parameter 0 = " IBM "
6.121.5
291
Type compatability in Predicate
Only certain combination of type comparisons are valid in Predicate. The following table marked all the compatible pairs with YES:
INTEENUBOOLEANFLOAT- CHAR- STRING MERGERVALUE
VALUE
VALUE VALUE
ATEDVALUE
YES
BOOLEAN
INTEYES
YES
GERVALUE
YES
YES
FLOATVALUE
YES
YES
YES
CHARVALUE
YES
YES
STRING
YES(1)
ENUYES
MERYES(2) YES(2) YES(3)
ATEDVALUE
(1) See SQL Extension: Regular Expression Matching (p. 291)
(2) Because the formal notation of the Enumeration values, they are
compatible with string and char literals, but they are not compatible with
string or char variables, i.e., MyEnum=EnumValue would be correct,
but MyEnum=MyString is not allowed.
(3) Only for same type Enums.
6.121.6
SQL Extension: Regular Expression Matching
The relational operator MATCH may only be used with string fields. The righthand operator is a string pattern. A string pattern specifies a template that
the left-hand field value must match. The characters ,/?[]- !% have special
meanings.
MATCH is case-sensitive.
The pattern allows limited wild card matching under the following rules:
292
Character
,
[charlist]
[s-e]
%
[!charlist] or [ charlist]
[!s-e] or [ s-e]
\
Meaning
, separates a list of alternate
patterns. The field string is
matched if it matches one or more
of the patterns.
/ in the pattern string matches a
/ in the field string. This character
is used to separate a sequence of
mandatory substrings.
? in the pattern string matches
any single non-special characters in
the field string.
in the pattern string matches 0
or more non-special characters in
field string.
Matches any one of the characters
from the list of characters in
charlist.
Matches any character any
character from s to e, inclusive.
% is used to designate filter
expressions parameters.
Matches any characters not in
charlist (not supported).
Matches any characters not in the
interval [s-e] (not supported).
Escape character for special
characters (not supported)
The syntax is similar to the POSIX fnmatch syntax (1003.2-1992 section B.6).
The MATCH syntax is also similar to the subject strings of TIBCO Rendezvous.
6.121.7
Examples
Assuming Topic Location has as an associated type a structure with fields

flight id, x, y, z, and Topic FlightPlan has as fields flight id, source, destination. The following are examples of using these expressions.
Example of a filter expression (for com.rti.dds.topic.ContentFilteredTopic
(p. 471)) or a query expression (for com.rti.dds.subscription.QueryCondition
(p. 1311)):
"z < 1000 AND x < 23"
Examples
of
filter expression
using
MATCH
(for
293
com.rti.dds.topic.ContentFilteredTopic (p. 471)) operator:

"symbol MATCH NASDAQ/GOOG"
"symbol MATCH NASDAQ/[A-M]"
Example of a topic expression (for com.rti.dds.topic.MultiTopic (p. 1190)
[Not supported (optional)]):
"SELECT flight id, x, y, z AS height FROM Location NATURAL JOIN
FlightPlan WHERE height < 1000 AND x <23"
294
6.122
RTI Connext API Reference
RTI Connext product specific APIs.
Modules
Clock Selection
APIs related to clock selection.
Multi-channel DataWriters
APIs related to Multi-channel DataWriters.
Pluggable Transports
Configuration Utilities
Durability and Persistence

APIs related to RTI Connext Durability and Persistence.
System Properties
System Properties.
Configuring QoS Profiles with XML

APIs related to XML QoS Profiles.
6.122.1
RTI Connext product specific APIs.
6.123 Programming How-Tos
6.123
295
Programming How-Tos
These How Tos illustrate how to apply RTI Connext APIs to common use
cases.
Modules
Publication Example
A data publication example.
Subscription Example
A data subscription example.
Participant Use Cases

Working with domain partcipants.
Topic Use Cases

Working with topics.
FlowController Use Cases

Working with flow controllers.
Publisher Use Cases

Working with publishers.
DataWriter Use Cases

Working with data writers.
Subscriber Use Cases

Working with subscribers.
DataReader Use Cases

Working with data readers.
Entity Use Cases

Working with entities.
Waitset Use Cases

Using wait-sets and conditions.
Transport Use Cases

Working with pluggable transports.
296
Filter Use Cases

Working with data filters.

Working with custom content filters.
Large Data Use Cases

Working with large data types.
6.123.1
These How Tos illustrate how to apply RTI Connext APIs to common use
cases.
These are a good starting point to familiarize yourself with DDS. You can use
these code fragments as templates for writing your own code.
6.124 Programming Tools
6.124
297
Programming Tools
Modules
rtiddsgen
Generates source code from data types declared in IDL, XML, XSD, or
WSDL files.
rtiddsping
Sends or receives simple messages using RTI Connext.
rtiddsspy
Debugging tool which receives all RTI Connext communication.
298
6.125
rtiddsgen
Generates source code from data types declared in IDL, XML, XSD, or WSDL
files. Generates code necessary to allocate, send, receive, and print user-defined
data types.
6.125.1
Usage
rtiddsgen [-d <outdir>]

[-language <C|C++|Java|C++/CLI|C#|Ada>]
[-namespace]
[-package <packagePrefix>]
[-example <arch>]
[-replace]
[-debug]
[-corba [client header file] [-orb <CORBA ORB>]]
[-optimization <level of optimization>]
[-stringSize <Unbounded strings size>]
[-sequenceSize <Unbounded sequences size>]
[-notypecode]
[-ppDisable]
[-ppPath <preprocessor executable>]
[-ppOption <option>]
[-D <name>[=<value>]]
[-U <name>]
[-I <directory>]
[-noCopyable]
[-use42eAlignment]
[-enableEscapeChar]
[-typeSequenceSuffix <Suffix>]
[-dataReaderSuffix <Suffix>]
[-dataWriterSuffix <Suffix>]
[-convertToXml |
-convertToXsd |
-convertToWsdl |
-convertToIdl]
[-convertToCcl]
[-convertToCcs]
[-expandOctetSeq]
[-expandCharSeq]
[-metp]
[-version]
[-help]
[-verbosity [1-3]]
[[-inputIdl] <IDLInputFile.idl> |
[-inputXml] <XMLInputFile.xml> |
[-inputXsd] <XSDInputFile.xsd> |
[-inputWsdl] <WSDLInputFile.wsdl>]
6.125 rtiddsgen
299
-d Specifies where to put the generated files. If omitted, the input files directory
is used.
-language Generates output for only the language specified. The default is
C++.
Use of generated Ada 2005 code requires installation of RTI Ada 2005 Language
Support. Please contact support@rti.com for more information.
-namespace Specifies the use of C++ namespaces (for C++ only).
-package Specifies a packagePrefix to use as the root package (for Java only).
-example Generates example programs and makefiles (for UNIX-based systems) or workspace and project files (for Windows systems) based on the input
types description file.
The <arch> parameter specifies the architecture for the example makefiles.
For -language C/C++, valid options for <arch> are:
sparcSol2.9gcc3.2,
sparc64Sol2.10gcc3.4.2,
x64Sol2.10gcc3.4.3,
sparcSol2.9cc5.4,
i86Sol2.9gcc3.3.2,
sparcSol2.10gcc3.4.2,
i86Sol2.10gcc3.4.4,
i86Linux2.6gcc3.4.3,
x64Linux2.6gcc3.4.5,
i86RedHawk5.1gcc4.1.2,
x64Suse10.1gcc4.1.0,
cell64Linux2.6gcc4.5.1,
i86WRLinux2.6gcc4.3.2, x64WRLinux2.6gcc4.4.1,
i86RedHawk5.4gcc4.2.1,
i86Suse10.1gcc4.1.0,
armv7leLinux2.6gcc4.4.1,
x64Darwin10gcc4.2.1,
ppc4xxFPLinux2.6gcc4.3.3,
ppc7400Linux2.6gcc3.3.3,
ppc85xxLinux2.6gcc4.3.2, ppc85xxWRLinux2.6gcc4.3.2,
i86Win32VS2005, x64Win64VS2005,
i86Win32VS2010, x64Win64VS2010,
ppc85xxInty5.0.11.xes-p2020,
mInty10.0.0.pcx86,
i86Win32VS2008,
x64Win64VS2008,
mpc8349Inty5.0.11.mds8349,
pentiu-
ppc7400Lynx4.0.0gcc3.2.2,
ppc7400Lynx4.2.0gcc3.2.2,
ppc750Lynx4.0.0gcc3.2.2, ppc7400Lynx5.0.0gcc3.4.3, i86Lynx4.0.0gcc3.2.2,
ppc604Vx5.5gcc, ppc603Vx5.5gcc, ppc604Vx6.3gcc3.4.4, ppc604Vx6.3gcc3.4.4 rtp, ppc604Vx6.5gcc3.4.4, ppc604Vx6.5gcc3.4.4 rtp, pentiumVx6.6gcc4.1.2,
pentiumVx6.6gcc4.1.2 rtp,
ppc405Vx6.6gcc4.1.2,
ppc405Vx6.6gcc4.1.2 rtp,
pentiumVx6.7gcc4.1.2,
pentiumVx6.7gcc4.1.2 rtp,
300
ppc604Vx6.7gcc4.1.2 smp, ppc604Vx6.7gcc4.1.2 rtp, ppc604Vx6.8gcc4.1.2,

pentiumVx6.8gcc4.1.2,
pentiumVx6.8gcc4.1.2 ppc604Vx6.8gcc4.1.2 rtp,
rtp,
pentiumVx6.9gcc4.3.3, pentiumVx6.9gcc4.3.3 rtp, pentium64Vx6.9gcc4.3.3, pentium64Vx6.9gcc4.3.3 rtp, ppc604VxT2.2.2gcc3.3.2, ppc604VxT2.2.2gcc3.3.2 v6,
ppc85xxVxT2.2.3gcc3.3.2,
sbc8641Vx653-2.3gcc3.3.2,
simpcVx6532.3gcc3.3.2,
p5AIX5.3xlc9.0, 64p5AIX5.3xlc9.0,
i86QNX6.4.1qcc gpp i86QNX6.5qcc gpp4.4.2 i86QNX6.4.0qcc acpp4.2.4 ppcbeQNX6.4.0qcc acpp4.2.4
For -language C++/CLI and C#, valid options for <arch> are:
i86Win32dotnet2.0,
x64Win64dotnet4.0
x64Win64dotnet2.0,
i86Win32dotnet4.0,
For -language java, valid options for <arch> are:

i86Sol2.9jdk,
i86Sol2.10jdk,
x64Sol2.10jdk,
sparcSol2.9jdk,
sparcSol2.10jdk,
sparc64Sol2.10jdk,
x64Darwin10gcc4.2.1jdk,
i86Linux2.6gcc3.4.3jdk,
x64Linux2.6gcc3.4.5jdk,
i86Linux2.6gcc3.4.6jdk, i86RedHawk5.1gcc4.1.2jdk, i86RedHawk5.4gcc4.2.1jdk,
i86Suse10.1gcc4.1.0jdk,
x64Suse10.1gcc4.1.0jdk,
i86Win32jdk,
x64Win64jdk, ppc7400Lynx4.0.0gcc3.2.2jdk, ppc750Lynx4.0.0gcc3.2.2jdk,
ppc7400Lynx5.0.0gcc3.4.3jdk, i86Lynx4.0.0gcc3.2.2jdk, p5AIX5.3xlc9.0jdk,
64p5AIX5.3xlc9.0jdk
For -language Ada, valid option for <arch> is i86Linux2.6gcc4.1.2
-replace Overwrites any existing output files. Warning: This removes any
changes you may have made to the original files.
-debug Generates intermediate files for debugging purposes.
-corba [client header file] [-orb <CORBA ORB>] Specifies that you want to
produce CORBA-compliant code.
Use [client header file] and [-orb <CORBA ORB>] for C++ only. The majority
of code generated is independent of the ORB. However, for some IDL features,
the code generated depends on the ORB. This version of rtiddsgen generates
code compatible with ACE-TAO or JacORB. To pick the ACE TAO version,
use the -orb parameter; the default is ACE TAO1.6.
client header file: the name of the header file for the IDL types generated by the
CORBA IDL compiler. This file will be included in the rtiddsgen type header
file instead of generating type definitions.
6.125 rtiddsgen
301
CORBA support requires the RTI CORBA Compatibility Kit, an addon product that provides a different version of rtiddsgen. Please contact
support@rti.com for more information.
-optimization Sets the optimization level. (Only applies to C/C++)
0 (default): No optimization.
1: Compiler generates extra code for typedefs but optimizes its use. If the
type that is used is a typedef that can be resolved either to a primitive type
or to another type defined in the same file, the generated code will invoke
the code of the most basic type to which the typedef can be resolved,
unless the most basic type is an array or a sequence. This level can be
used if the generated code is not expected to be modified.
2: Maximum optimization. Functionally the same as level 1, but extra
code for typedef is not generated. This level can be used if the typedefs
are only referred by types within the same file.
-typeSequenceSuffix Assigns a suffix to the name of the implicit sequence
defined for IDL types. (Only applies to CORBA)
By default, the suffix is Seq. For example, given the type Foo the name of
the implicit sequence will be FooSeq.
-dataReaderSuffix Assigns a suffix to the name of the DataReader interface.
(Only applies to CORBA)
By default, the suffix is DataReader. For example, given the type Foo the
name of the DataReader interface will be FooDataReader.
-dataWriterSuffix Assigns a suffix to the name of the DataWriter interface.
(Only applies to CORBA)
By default, the suffix is DataWriter. For example, given the type Foo the
name of the DataWriter interface will be FooDataWriter.
-stringSize Sets the size for unbounded strings. Default: 255 bytes.
-sequenceSize Sets the size for unbounded sequences. Default: 100 elements.
-notypecode: Disables the generation of type code information.
-ppDisable: Disables the preprocessor.
-ppPath <preprocessor executable>: Specifies the preprocessor path. If you
only specify the name of an executable (not a complete path to that executable),
the executable must be found in your Path.
The default value is cpp for non-Windows architectures, cl.exe for Windows
architectures.
If the default preprocessor is not found in your Path and you use -ppPath
to provide its full path and filename, you must also use -ppOption (described
302
below) to set the following preprocessor options:

If you use a non-default path for cl.exe, you also need to set:
-ppOption /nologo -ppOption /C -ppOption /E -ppOption /X
If you use a non-default path for cpp, you also need to set:
-ppOption -C
-ppOption <option>: Specifies a preprocessor option. This parameter can
be used multiple times to provide the command-line options for the specified
preprocessor. See -ppPath (above).
-D <name>[=<value>]: Defines preprocessor macros.
-U <name>: Cancels any previous definition of name.
-I <directory>: Adds to the list of directories to be searched for type-definition
files (IDL, XML, XSD or WSDL files). Note: A type-definition file in one format
cannot include a file in another format.
-noCopyable: Forces rtiddsgen to put copy logic into the corresponding TypeSupport class rather than the type itself (for Java code generation only).
This option is not compatible with the use of ndds standalone type.jar.
-use42eAlignment: Generates code compliant with RTI Data Distribution
Service 4.2e.
If your RTI Connext applications data type uses a double,long long,unsigned
long long, or long double it will not be backwards compatible with RTI Data
Distribution Service 4.2e applications unless you use the -use42eAlignment flag
when generating code with rtiddsgen.
-enableEscapeChar: Enables use of the escape character in IDL identifiers.
With CORBA this option is always enabled.
-convertToXml: Converts the input type-description file to XML format.
-convertToIdl: Converts the input type-description file to IDL format.
-convertToXsd: Converts the input type-description file to XSD format.
-convertToWsdl: Converts the input type-description file to WSDL format.
-convertToCcl: Converts the input type-description file to CCL format.
-convertToCcs: Converts the input type-description file to CCS format.
-expandOctetSeq: When converting to CCS or CCL files, expand octet sequences. The default is to use a blob type.
-expandCharSeq: When converting to CCS or CCL files, expand char sequences. The default is to use a string type.
6.125 rtiddsgen
303
-metp: Generates code for the Multi-Encapsulation Type Support (METP)

library.
-version: Prints the version, such as 4.5x. (Does not show patch revision
number.)
-help: Prints this rtiddsgen usage help.
-verbosity: rtiddsgen verbosity.
1: exceptions
2: exceptions and warnings
3 (default): exceptions, warnings and information
-inputIdl: Indicates that the input file is an IDL file, regardless of the file
extension.
-inputXml: Indicates that the input file is a XML file, regardless of the file
extension.
-inputXsd: Indicates that the input file is a XSD file, regardless of the file
extension.
-inputWsdl: Indicates that the input file is a WSDL file, regardless of the file
extension.
IDLInputFile.idl: File containing IDL descriptions of your data types. If
-inputIdl is not used, the file must have an .idl extension.
XMLInputFile.xml: File containing XML descriptions of your data types. If
-inputXml is not used, the file must have an .xml extension.
XSDInputFile.xsd: File containing XSD descriptions of your data types. If
-inputXsd is not used, the file must have an .xsd extension.
XSDInputFile.wsdl: WSDL file containing XSD descriptions of your data
types. If -inputWsdl is not used, the file must have an .wsdl extension.
6.125.2
Description
rtiddsgen takes a language-independent specification of the data (in IDL, XML,

XSD or WSDL notation) and generates supporting classes and code to distribute
instances of the data over RTI Connext.
To use rtiddsgen, you must first write a description of your data types in IDL,
XML, XSD or WSDL format.
304
6.125.3
C++ Example
The following is an example generating the RTI Connext type myDataType:

IDL notation
struct myDataType {
long value;
};
XML notation
<?xml version="1.0" encoding="UTF-8"?>
<types xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="rti dds topic types.xsd">
<struct name="myDataType">
<member name="value" type="long"/>
</struct>
</types>
XSD notation

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:dds="http://www.omg.org/dds"
xmlns:tns="http://www.omg.org/IDL-Mapped/"
targetNamespace="http://www.omg.org/IDL-Mapped/">
<xsd:import namespace="http://www.omg.org/dds" schemaLocation="rti dds topic types common.xsd"/
<xsd:complexType name="myDataType">
<xsd:sequence>
<xsd:element name="value" minOccurs="1" maxOccurs="1" type="xsd:int"/>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
WSDL notation

<definitions xmlns="http://schemas.xmlsoap.org/wsdl/" xmlns:dds="http://www.omg.org/dds" xmlns:x
<types>
<xsd:schema targetNamespace="http://www.omg.org/IDL-Mapped/">
<xsd:import namespace="http://www.omg.org/dds" schemaLocation="rti dds topic types common.x
<xsd:complexType name="myDataType">
<xsd:sequence>
<xsd:element name="value" minOccurs="1" maxOccurs="1" type="xsd:int"/>
</xsd:sequence>
</xsd:complexType>
6.125 rtiddsgen
305
</xsd:schema>
</types>
</definitions>
Assuming the name of the idl file is myFileName.(idl|xml|xsd|wsdl) then all you
need to do is type:
rtiddsgen myFileName.(idl|xml|xsd|wsdl)
This generates myFileName.cxx, myFileName.h, myFileNamePlugin.cxx, myFileNamePlugin.h, myFileNameSupport.cxx and myFileNameSupport.h. By
default, rtiddsgen will not overwrite these files. You must use the -replace
argument to do that.
6.125.4
IDL Language
In the IDL language, data types are described in a fashion almost identical to
structures in C. The complete description of the language can be found at the
OMG website.
rtiddsgen does not support the full IDL language.
For detailed information about the IDL support in RTI Connext see Chapter 3
in the Users Manual.
The supported IDL types are:
char
wchar
octet
short
unsigned short
long
unsigned long
long long
unsigned long long
float
double
long double
boolean
306
bounded string
unbounded string
bounded wstring
unbounded wstring
enum
typedef
struct
valuetypes (limited support)
union
sequences
unbounded sequences
arrays
array of sequences
constant
The following non-IDL types are also supported:

bitfield
valued enum
Use of Unsupported Types in an IDL File
You may include unsupported data types in the IDL file. rtiddsgen does not
consider this an error. This allows you to use types that are defined in nonIDL languages with either hand-written or non-rtiddsgen written plug-ins. For
example, the following is allowable:
//@copy #include "Bar.h"
//@copy #include "BarHandGeneratedPlugin.h"
struct Foo {
short height;
Bar barMember;
};
In the above case, Bar is defined externally by the user.

Multiple Types in a Single File
6.125 rtiddsgen
307
You can specify multiple types in a single IDL file. This can simplify management of files in your distributed program.
Use of Directives in an IDL File
The following directives can be used in your IDL file: Note: Do not put a space
between the slashes and the @ sign. Note: Directives are case-sensitive (for
example: use key, not Key).
//@key Specifies that the field declared just before this directive in the
enclosing structure is part of the key. Any number of a structures fields
may be declared part of the key.
//@copy Copies a line of text (verbatim) into the generated code (for all
languages). The text is copied into all the type-specific files generated by
rtiddsgen except the examples.
//@copy-declaration Like //@copy, but only copies the text into the file
where the type is declared (<type>.h for C++/C, or <type>.java for
Java).
//@copy-c Like //@copy, but for C++/C-only code.
//@copy-c-declaration Like //@copy-declaration, but for C++/C-only
code.
//@copy-java Like //@copy, but for Java-only code.
//@copy-java-begin Copies a line of text at the beginning of all the Java
files generated for a type. The directive only applies to the first type that
is immediately below in the IDL file.
//@copy-java-declaration Like //@copy-declaration, but for Java-only
code.
//@copy-java-declaration-begin Like //@copy-java-begin but only copies
the text into the file where the type is declared.
//@copy-ada Like //@copy, but for Ada-only code.
//@copy-ada-begin Like //@copy-java-begin, but for Ada-only code.
//@copy-ada-declaration Like //@copy-declaration, but for Ada-only
code.
//@copy-ada-declaration-begin Like //@copy-java-declaration, but for
Ada-only code.
308
//@resolve-name [true|false] Specifies whether or not rtiddsgen should resolve the scope of a type. If this directive is not present or is set to true,
rtiddsgen resolves the scope. Otherwise rtiddsgen delegates the resolution
of a type to the user.
//@top-level [true|false] Specifies whether or not rtiddsgen should generate
type-support code for a particular struct or union. The default is true.
6.125.5
XML Language
The data types can be described using XML.

RTI Connext provides DTD and XSD files that describe the XML format.
The
DTD
definition
of
the
XML
elements
found
in
../../../resource/dtd/rti dds topic types.dtd
<NDDSHOME>/resource/rtiddsgen/schema.
can
be
under
The
XSD
definition
of
the
XML
elements
found
in
../../../resource/xsd/rti dds topic types.xsd
<NDDSHOME>/resource/rtiddsgen/schema.
can
be
under
The XML validation performed by rtiddsgen always uses the DTD definition.
If the <!DOCTYPE> tag is not present in the XML file, rtiddsgen will look for
the DTD document under <NDDSHOME>/resource/rtiddsgen/schema. Otherwise, it will use the location specified in <!DOCTYPE>.
For detailed information about the mapping between IDL and XML, see Chapter
3 in the Users Manual.
6.125.6
XSD Language
The data types can be described using XML schemas (XSD files). The XSD
specification is based on the standard IDL to WSDL mapping described in the
OMG document CORBA to WSDL/SOAP Interworking Specification
For detailed information about the mapping between IDL and XML see Chapter
6.125.7
WSDL Language
The data types can be described using XML schemas contained in WSDL
files. The XSD specification is based on the standard IDL to WSDL mapping described in the OMG document CORBA to WSDL/SOAP Interworking
Specification
6.125 rtiddsgen
309
For detailed information about the mapping between IDL and XML see Chapter
6.125.8
Using Generated Types Without RTI Connext

(Standalone)
You can use the generated type-specific source and header files without linking
the RTI Connext libraries or even including the RTI Connext header files. That
is, the generated files for your data types can be used standalone.
The directory <NDDSHOME>/resource/rtiddsgen/standalone contains the
helper files required to work in standalone mode:
include: header and templates files for C/C++.
src: source files for C/C++.
class: Java jar file.
Using Standalone Types in C
The generated files that can be used standalone are:
<idl file name>.c : Types source file
<idl file name>.h : Types header file
You cannot use the type plug-in (<idl file>Plugin.c <idl file>Plugin.h) or the
type support (<idl file>Support.c <idl file>Support.h) code standalone.
To use the rtiddsgen-generated types in a standalone manner:
Include the directory <NDDSHOME>/resource/rtiddsgen/standalone/include
in the list of directories to be searched for header files.
Add the source files ndds standalone type.c and <idl file name>.c to your
project.
Include the file <idl file name>.h in the source files that will use the
generated types in a standalone way.
Compile the project using the two following preprocessor definitions:
NDDS STANDALONE TYPE
The definition for your platform: RTI VXWORKS, RTI QNX, RTI WIN32, RTI INTY, RTI LYNX or RTI UNIX
310
Using Standalone Types in C++

<idl file name>.cxx : Types source file
<idl file name>.h : Types header file
You cannot use the type plugin (<idl file>Plugin.cxx <idl file>Plugin.h) or the
type support (<idl file>Support.cxx <idl file>Support.h) code standalone.
To use the generated types in a standalone manner:
Include the directory <NDDSHOME>/resource/rtiddsgen/standalone/include
in the list of directories to be searched for header files.
Add the source files ndds standalone type.cxx and <idl file name>.cxx to
your project.
Include the file <idl file name>.h in the source files that will use the
generated types in a standalone way.
Compile the project using the two following preprocessor definitions:
NDDS STANDALONE TYPE
The definition for your platform: RTI VXWORKS, RTI QNX, RTI WIN32, RTI INTY, RTI LYNX or RTI UNIX
Standalone Types in Java
<idl type>.java
<idl type>Seq.java
You cannot use the type code (<idl file>TypeCode.java), the type support
(<idl type>TypeSupport.java), the data reader (<idl file>DataReader.java) or
the data writer code (<idl file>DataWriter.java) standalone.
To use the generated types in a standalone manner:
Include the file ndds standalone type.jar in the classpath of your project.
Compile the project using the standalone types files (<idl type>.java <idl
type>Seq.java).
6.126 rtiddsping
6.126
311
rtiddsping
Sends or receives simple messages using RTI Connext. The rtiddsping utility
uses RTI Connext to send and receive preconfigured Ping messages to other
rtiddsping applications which can be running in the same or different computers.
The rtiddsping utility can used to test the network and/or computer configuration and the environment settings that affect the operation of RTI Connext.
Usage
rtiddsping [-help] [-version]
[-domainId <domainId>]
... defaults to 0
[-index <NN>]
... defaults to -1 (auto)
[-appId <ID>]
... defaults to a middleware-selected value
[-Verbosity <NN>]
... can be 0..5
[-peer <PEER>]
... PEER format is NN@TRANSPORT://ADDRESS
[-discoveryTTL <NN>]
... can be 0..255
[-transport <MASK>]
... defaults to DDS TRANSPORTBUILTIN MASK DEFAULT
[-msgMaxSize <SIZE>]
... defaults to -1 (transport default)
[-shmRcvSize <SIZE>]
... defaults to -1 (transport default)
[-deadline
<SS>]
... defaults to -1 (no deadline)
[-durability <TYPE>]
... TYPE can be VOLATILE or TRANSIENT LOCAL
[-multicast <ADDRESS>]
... defaults to no multicast
[-numSamples <NN>]
... defaults to infinite
[-publisher]
... this is the default
[-queueSize <NN>]
... defaults to 1
[-reliable]
... defaults to best-efforts
[-sendPeriod <SS>]
... SS is in seconds, defaults to 1
[-subscriber]
[-timeFilter <SS>]
... defaults to 0 (no filter)
[-timeout
<SS>]
... SS is in seconds, defaults to infinite
[-topicName <NAME>]
... defaults to PingTopic
[-typeName
<NAME>]
... defaults to PingType
[-useKeys
<NN>]
... defaults to PingType
[-qosFile <file>]
[-qosProfile <lib.prof>]
Example: rtiddsping -domainId 3 -publisher -numSamples 100
VxWorks Usage
rtiddsping "[<options>]"
The options use the same syntax as above.
Example rtiddsping "-domainId 3 -publisher -numSamples 100"
If the stack of the shell is not large enough to run rtiddsping, use "taskSpawn":
312
taskSpawn <name>,<priority>,<taskspawn options>,<stack size in bytes>,rtiddsping,"[\<options

Example taskSpawn "rtiddsping",100,0x8,50000,rtiddsping,"-domainId 3 -publisher -numSamples
Options:
-help Prints a help message and exits.
-version Prints the version and exits.
-Verbosity <NN> Sets the verbosity level. The range is 0 to 5.
0 has minimal output and does not echo the fact that data is being sent or
received.
1 prints the most relevant statuses, including the sending and receiving of data.
This is the default.
2 prints a summary of the parameters that are in use and echoes more detailed
status messages.
3-5 Mostly affects the verbosity used by the internal RTI Connext modules that
implement rtiddsping. The output is not always readable; its main purpose is
to provide information that may be useful to RTIs support team.
Example: rtiddsping -Verbosity 2
-domainId <NN>
Sets the domain ID. The valid range is 0 to 100.
Example: rtiddsping -domainId 31
-appId <ID>
Sets the application ID. If unspecified, the system will pick one automatically.
This option is rarely used.
Example: rtiddsping -appId 34556
-index <NN>
Sets the participantIndex. If participantIndex is not -1 (auto), it must be different than the one used by all other applications in the same computer and
domainId. If this is not respected, rtiddsping (or the application that starts
last) will get an initialization error.
Example: rtiddsping -index 2
-peer <PEER>
Specifies a PEER to be used for discovery. Like any RTI Connext application, it
defaults to the setting of the environment variable NDDS DISCOVERY PEERS
6.126 rtiddsping
313
or a preconfigured multicast address if the environment is not set.

The format used for PEER is the same one used for NDDS DISCOVERY PEERS and is described in detail in NDDS DISCOVERY PEERS (p. 57).
A brief summary follows:
The general format is: NN@TRANSPORT://ADDRESS where:
ADDRESS is an address (in name form or using the IP notation
xxx.xxx.xxx.xxx). ADDRESS may be a multicast address.
TRANSPORT represents the kind of transport to use and NN is the maximum participantIndex expected at that location. NN can be omitted and
it is defaulted to 4
Valid settings for TRANSPORT are udpv4 and shmem. The default
setting if the transport is omitted is udpv4.
ADDRESS cannot be omitted if the -peer option is specified.
The -peer option may be repeated to specify multiple peers.
Example: rtiddsping -peer 10.10.1.192 -peer mars -peer 4@pluto
-discoveryTTL <TTL>
Sets the TTL (time-to-live) used for multicast discovery. If not specified, it
defaults to the built-in RTI Connext default.
The valid range is 0 to 255. The value 0 limits multicast to the node itself
(i.e., can only discover applications running on the same computer). The value
1 limits multicast discovery to computers on the same subnet. Values higher
than 1 generally indicate the maximum number of routers that may be traversed
(although some routers may be configured differently).
Example: rtiddsping -discoveryTTL 16
-transport <MASK>
A bit-mask that sets the enabled builtin transports. If not specified, the default
set of transports is used (UDPv4 + shmem). The bit values are: 1=UDPv4,
2=shmem, 8=UDPv6.
-msgMaxSize <SIZE>
Configure the maximum message size allowed by the installed transports. This
is needed if you are using rtiddsping to communicate with an application that
has set these transport parameters to larger than default values.
-shmRcvSize <SIZE>
Increase the shared memory receive-buffer size. This is needed if you are using
rtiddsping to communicate with an application that has set these transport
parameters to larger than default values.
314
-deadline <SS>
This option only applies if the -subscriber option is also specified.
Sets the DEADLINE QoS for the subscriptions made by rtiddsping.
Note that this may cause the subscription QoS to be incompatible with the
publisher if the publisher did not specify a sendPeriod greater than the deadline.
If the QoS is incompatible, rtiddsping will not receive updates.
Each time a deadline is detected, rtiddsping will print a message indicating the
number of deadlines received so far.
Example: rtiddsping -deadline 3.5
-durability <TYPE>
Sets the DURABILITY QoS used for publishing or subscribing. Valid settings
are: VOLATILE and TRANSIENT LOCAL (default). The effect of this setting
can only be observed when it is used in in conjunction with reliability and a
queueSize larger than 1. If all these conditions are met, a late-joining subscriber
will be able to see up to queueSize samples that were previously written by the
publisher.
Example: rtiddsping -durability VOLATILE
-multicast <ADDRESS>
Configures ping to receive messages over multicast. The <ADDRESS> parameter indicates the address to use. ADDRESS must be in the valid range for multicast addresses. For IP version 4 the valid range is 224.0.0.1 to 239.255.255.255
Example: rtiddsping -multicast 225.1.1.1
-numSamples <NN>
Sets the number of samples that will be sent by rtiddsping. After those samples
are sent, rtiddsping will exit. messages.
Example: rtiddsping -numSamples 10
-publisher
Causes rtiddsping to send ping messages. This is the default.
Example: rtiddsping -publisher
-queueSize <NN>
Specifies the maximal number of samples to hold in the queue. In the case of the
publisher, it affects the samples that are available for a late-joining subscriber.
Example: rtiddsping -queueSize 100
-reliable
6.126 rtiddsping
315
Configures the RELIABILITY QoS for publishing or subscribing. The default

setting (if -reliable is not used) is BEST EFFORT
Example: rtiddsping -reliable
-sendPeriod <SS>
Sets the period (in seconds) at which rtiddsping sends the messages.
Example: rtiddsping -sendPeriod 0.5
-subscriber
Causes rtiddsping to listen for ping messages. This option cannot be specified
if -publisher is also specified.
Example: rtiddsping -subscriber
-timeFilter <SS>
Sets the TIME BASED FILTER QoS for the subscriptions made by rtiddsping.
This QoS causes RTI Connext to filter out messages that are published at a rate
faster than what the filter duration permits. For example, if the filter duration
is 10 seconds, messages will be printed no faster than once every 10 seconds.
Example: rtiddsping -timeFilter 5.5
-timeout <SS>
Sets a timeout (in seconds) that will cause rtiddsping to exit if no samples are
received for a duration that exceeds the timeout.
Example: rtiddsping -timeout 30
-topicName <NAME>
Sets the topic name used by rtiddsping. The default is RTIddsPingTopic. To
communicate, both the publisher and subscriber must specify the same topic
name.
Example: rtiddsping -topicName Alarm
-typeName <NAME>
Sets the type name used by rtiddsping. The default is RTIddsPingType. To
communicate, both publisher and subscriber must specify the same type name.
Example: rtiddsping -typeName AlarmDescription
-useKeys <NN>
This option causes rtiddsping to use a topic whose data contains a key. The
value of the NN parameter indicates the number of different data objects (each
identified by a different value of the key) that will be published by rtiddsping.
316
The value of NN only affects the publishing behavior. However NN still needs
to be specified when the -useKeys option is used with the -subscriber option.
For communication to occur, both the publisher and subscriber must agree on
whether the topic that they publish/subscribe contains a key. Consequently, if
you specify the -useKeys parameter for the publisher, you must do the same
with the subscriber. Otherwise communication will not be stablished.
Example: rtiddsping -useKeys 20
-qosFile <file>
Allow you to specify additional QoS XML settings using url profile. For more
information on the syntax, see Chapter 15 in the RTI Connext Users Manual.
Example: rtiddsping -qosFile /home/user/QoSProfileFile.xml
-qosProfile <lib.prof>
This option specifies the library name and profile name that the tool should use.
QoS settings
rtiddsping is configured internally using a special set of QoS settings in a profile called InternalPingLibrary.InternalPingProfile. This is the default profile
unless a profile called DefaultPingLibrary.DefaultPingProfile is found. You can
use the command-line option -qosProfile to tell rtiddsping to use a different
lib.profile instead of DefaultPingLibrary.DefaultPingProfile. Like all the other
RTI Connext applications, rtiddsping loads all the profiles specified using the
environment variable NDDS QOS PROFILES or the file named USER QOS PROFILES found in the current working directory.
The QoS settings used internally are available in the file RTIDDSSPING QOS PROFILES.example.xml.
Description
The usage depends on the operating system from which rtiddsping is executed.
Examples for UNIX, Linux, and Windows Systems
On UNIX, Linux, Windows and other operating systems that have a shell, the
syntax matches the one of the regular commands available in the shell. In the
examples below, the string shell prompt> represents the prompt that the shell
prints and are not part of the command that must be typed.
shell prompt>
shell prompt>
shell prompt>
rtiddsping -domainId 3 -publisher -numSamples 100

rtiddsping -domainId 5 -subscriber -timeout 20
rtiddsping -help
VxWorks examples:
On VxWorks systems, the libraries libnddscore.so, libnddsc.so and libnddscpp.so
must first be loaded. The rtiddsping command must be typed to the VxWorks
6.126 rtiddsping
317
shell (either an rlogin shell, a target-server shell, or the serial line prompt). The
arguments are passed embedded into a single string, but otherwise have the
same syntax as for Unix/Windows. In the Unix, Linux, Windows and other
operating systems that have a shell, the syntax matches the one of the regular
commands available in the shell. In the examples below, the string vxworks
prompt> represents the prompt that the shell prints and are not part of the
command that must be typed.
vxworks prompt>
vxworks prompt>
vxworks prompt>
rtiddsping "-domainId 3 -publisher -numSamples 100"

rtiddsping "-domainId 5 -subscriber -timeout 20"
rtiddsping "-help"
or, alternatively (to avoid overflowing the stack):
vxworks prompt> taskSpawn "rtiddsping", 100, 0x8, 50000, rtiddsping, "-domainId 3 -publisher -numSamples 100
vxworks prompt> taskSpawn "rtiddsping", 100, 0x8, 50000, rtiddsping, "-domainId 5 -subscriber -timeout 20"
vxworks prompt> taskSpawn "rtiddsping", 100, 0x8, 50000, rtiddsping, "-help"
318
6.127
rtiddsspy
Debugging tool which receives all RTI Connext communication. The rtiddsspy
utility allows the user to monitor groups of publications available on any RTI
Connext domain.
Note: If you have more than one DataWriter for the same Topic, and these
DataWriters have different settings for the Ownership QoS, then rtiddsspy will
only receive (and thus report on) the samples from the first DataWriter.
To run rtiddsspy, like any RTI Connext application, you must have the NDDS DISCOVERY PEERS environment variable that defines your RTI Connext domain; otherwise you must specify the peers as command line parameters.
Usage
rtiddsspy [-help] [-version]
[-domainId <domainId>]
[-index <NN>]
[-appId <ID>]
[-Verbosity <NN>]
[-peer <PEER>]
[-discoveryTTL <NN>]
[-transport <MASK>]
[-msgMaxSize <SIZE>]
[-shmRcvSize <SIZE>]
[-tcMaxSize <SIZE>]
[-hOutput]
[-deadline
<SS>]
[-history
<DEPTH>]
[-timeFilter <SS>]
[-useFirstPublicationQos]
[-showHandle]
[-typeRegex <REGEX>]
[-topicRegex <REGEX>]
[-typeWidth <WIDTH>]
[-topicWidth <WIDTH>]
[-truncate]
[-printSample]
[-qosFile <file>]
[-qosProfile <lib.prof>]
...
...
...
...
...
...
...
...
...
...
defaults to 0
defaults to -1 (auto)
defaults to a middleware-selected value
can be 0..5
PEER format is NN@TRANSPORT://ADDRESS
can be 0..255
defaults to DDS TRANSPORTBUILTIN MASK DEFAULT
defaults to -1 (transport default)
defaults to -1 (transport default)
defaults to 4096
... defaults to -1 (no deadline)

... defaults to 8192
... defaults to 0 (no filter)
...
...
...
...
defaults to "*"
defaults to "*"
can be 1..255
can be 1..255
Example: rtiddsspy -domainId 3 -topicRegex "Alarm*"
VxWorks Usage
rtiddsspy "[<options>]"
6.127 rtiddsspy
319
Example rtiddsspy "-domainId 3 -topicRegex Alarm*"
rtiddsspy requires about 25 kB of stack. If the stack size of the shell from which it is invoked is not la
taskSpawn <name>, <priority>, <taskspawn options>, <stack size in bytes>, rtiddsspy, "[\<options\>]"
Example taskSpawn "rtiddsspy", 100, 0x8, 50000, rtiddsspy, "-domainId 3 -topicRegex Alarm*"
Options:
-help Prints a help message and exits.
-version Prints the version and exits.
-Verbosity <NN> Sets the verbosity level. The range is 0 to 5.
0 has minimal output and does not echo the fact that data is being sent or
received.
1 prints the most relevant statuses, including the sending and receiving of data.
This is the default.
2 prints a summary of the parameters being used and echoes more detailed
status messages.
3-5 Mostly affect the verbosity used by the internal RTI Connext modules that
implement rtiddsspy. The output is not always readable; its main purpose is to
provide information that may be useful to RTIs support team.
Example: rtiddsspy -Verbosity 2
-domainId <NN>
Sets the domain ID. The valid range is 0 to 100.
Example: rtiddsspy -domainId 31
-appId <ID>
Sets the application ID. If unspecified, the system will pick one automatically.
This option is rarely used.
Example: rtiddsspy -appId 34556
-index <NN>
Sets the participantIndex. If participantIndex is not -1 (auto), it must be different than the one used by all other applications in the same computer and
domainId. If this is not respected, rtiddsspy (or the application that starts last)
will get an initialization error.
320
Example: rtiddsspy -index 2

-peer <PEER>
Specifies a PEER to be used for discovery. Like any RTI Connext application, it
defaults to the setting of the environment variable NDDS DISCOVERY PEERS
or a preconfigured multicast address if the environment is not set.
The format used for PEER is the same used for the NDDS DISCOVERY PEERS and is described in detail in NDDS DISCOVERY PEERS (p. 57).
A brief summary follows:
The general format is: NN@TRANSPORT://ADDRESS where:
ADDRESS is an address (in name form or using the IP notation
xxx.xxx.xxx.xxx). ADDRESS may be a multicast address.
TRANSPORT represents the kind of transport to use and NN is the maximum participantIndex expected at that location. NN can be omitted and
it is defaulted to 4
Valid settings for TRANSPORT are udpv4 and shmem. The default
setting if the transport is omitted is udpv4
ADDRESS cannot be omitted if the -peer option is specified.
The -peer option may be repeated to specify multiple peers.
Example: rtiddsspy -peer 10.10.1.192 -peer mars -peer 4@pluto
-discoveryTTL <TTL>
Sets the TTL (time-to-live) used for multicast discovery. If not specified, it
defaults to the built-in RTI Connext default.
The valid range is 0 to 255. The value 0 limits multicast to the node itself (i.e.
can only discover applications running on the same computer). The value 1
limits multicast discovery to computers on the same subnet. Settings greater
than 1 generally indicate the maximum number of routers that may be traversed
(although some routers may be configured differently).
Example: rtiddsspy -discoveryTTL 16
-transport <MASK>
SPecifies a bit-mask that sets the enabled builtin transports. If not specified,
the default set of transports is used (UDPv4 + shmem). The bit values are:
1=UDPv4, 2=shmem, 8=UDPv6.
-msgMaxSize <SIZE>
Configures the maximum message size allowed by the installed transports. This
is needed if you are using rtiddsspy to communicate with an application that
has set these transport parameters to larger than default values.
6.127 rtiddsspy
321
-shmRcvSize <SIZE>
Increases the shared memory receive-buffer size. This is needed if you are using rtiddsspy to communicate with an application that has set these transport
parameters to larger than default values.
-tcMaxSize <SIZE>
Configures the maximum size, in bytes, of a received type code.
-hOutput
Prints information on the output format used by rtiddsspy.
This option prints an explanation of the output and then exits.
Example: rtiddsspy -hOutput
-deadline <SS>
Sets the requested DEADLINE QoS for the subscriptions made by rtiddsspy.
Note that this may cause the subscription QoS to be incompatible with the
publisher if the publisher did not specify an offered deadline that is greater or
equal to the one requested by rtiddsspy. If the QoS is incompatible rtiddsspy
will not receive updates from that writer.
Each time a deadline is detected rtiddsspy will print a message that indicates
the number of deadlines received so far.
Example: rtiddsspy -deadline 3.5
-timeFilter <SS>
Sets the TIME BASED FILTER QoS for the subscriptions made by rtiddsspy.
This QoS causes RTI Connext to filter-out messages that are published at a rate
faster than what the filter duration permits. For example if the filter duration
is 10 seconds, messages will be printed no faster than once each 10 seconds.
Example: rtiddsspy -timeFilter 10.0
-history <DEPTH>
Sets the HISTORY depth QoS for the subscriptions made by rtiddsspy.
This may be relevant if the publisher has batching turned on, or if the useFirstPublicationQos option is used that is causing a reliable or durable subscription to be created.
Example: rtiddsspy -history 1
-useFirstPublicationQos
Sets the RELIABILITY and DURABILITY QoS of the subscription based on
the first discovered publication of that topic.
See also -history option.
322
Example: rtiddsspy -useFirstPublicationQos

-showHandle
Prints additional information about each sample received. The additional information is the instance handle field in the SampleHeader, which can be used to
distinguish among multiple instances of data objects published under the same
topic and type names.
Samples displayed that share the topic and type names and also have the same
value for the instance handle represent value updates to the same data object.
On the other hand, samples that share the topic and type names but display
different values for the instance handle.
This option causes rtiddsspy to print an explanation of updates to the values of
different data objects.
Example: rtiddsspy -showHandle
-typeRegex <REGEX>
Subscribe only to types that match the REGEX regular expression. The syntax
of the regular expression is defined by the POSIX regex function.
When typing a regular expression to a command-line shell, some symbols may
need to be escaped to avoid interpretation by the shell. In general, it is safest
to include the expression in double quotes.
This option may be repeated to specify multiple topic expressions.
Example: rtiddsspy -typeRegex SensorArray
-topicRegex <REGEX>
Subscribe only to topics that match the REGEX regular expression. The syntax
of the regular expression is defined by the POSIX regex function.
When typing a regular expression to a command-line shell, some symbols may
need to be escaped to avoid interpretation by the shell. In general, it is safest
to include the expression in double quotes.
This option may be repeated to specify topic multiple expressions.
Example: rtiddsspy -topicRegex Alarm
-typeWidth <WIDTH>
Sets the maximum width of the Type name column. Names wider than this will
wrap around, unless -truncate is specified. Can be 1..255.
-topicWidth <WIDTH>
Sets the maximum width of the Topic name column. Names wider than this
will wrap around, unless -truncate is specified. Can be 1..255.
-truncate
6.127 rtiddsspy
323
Specifies that names exceeding the maximum number of characters should be

truncated.
-printSample
Prints the value of the received samples.
-qosFile <file>
Allows you to specify additional QoS XML settings using url profile. For more
information on the syntax, see Chapter 15 in the RTI Connext Users Manual.
Example: rtiddsspy -qosFile /home/user/QoSProfileFile.xml
-qosProfile <lib.prof>
Specifies the library name and profile name to be used.
QoS settings
rtiddsspy is configured to discover as many entities as possible. To do so, an
internal profile is defined, called InternalSpyLibrary.InternalSpyProfile. This is
the default profile, unless a profile called DefaultSpyLibrary.DefaultSpyProfile is
found. You can use the command-line option -qosProfile to tell rtiddsspy to use a
speficied lib.profile instead of DefaultSpyLibrary.DefaultSpyProfile. Like all the
other RTI Connext applications, rtiddsspy loads all the profiles specified using
the environment variable NDDS QOS PROFILES or the file named USER QOS PROFILES found in the current working directory.
The QoS settings used internally are available in the file RTIDDSSPY QOS PROFILES.example.xml.
Usage Examples
The usage depends on the operating system from which rtiddsspy is executed.
Examples for UNIX, Linux, Windows systems
On UNIX, Linux, Windows and other operating systems that have a shell, the
syntax matches the one of the regular commands available in the shell. In the
examples below, the string shell prompt> represents the prompt that the shell
prints and are not part of the command that must be typed.
shell prompt>
shell prompt>
shell prompt>
rtiddsspy -domainId 3
rtiddsspy -domainId 5 -topicRegex "Alarm*"
rtiddsspy -help
Examples for VxWorks Systems

On VxWorks systems, the libraries libnddscore.so, libnddsc.so and libnddscpp.so
must first be loaded. The rtiddsspy command must be typed to the VxWorks
shell (either an rlogin shell, a target-server shell, or the serial line prompt).
The arguments are passed embedded into a single string, but otherwise have
the same syntax as for Unix/Windows. In UNIX, Linux, Windows and other
324
operating systems that have a shell, the syntax matches the one of the regular
comamnds available in the shell. In the examples below, the string vxworks
prompt> represents the prompt that the shell prints and are not part of the
command that must be typed.
vxworks prompt>
vxworks prompt>
vxworks prompt>
rtiddsspy "-domainId 3"

rtiddsspy "-domainId 5 5 -topicRegex "Alarm*"
rtiddsspy "-help"
Chapter 7
Namespace Documentation
7.1
Package com.rti
RTI.
Packages
package dds
DDS.
package ndds
DDS extensions.
7.1.1
RTI.
326
7.2
Package com.rti.dds
DDS.
Packages
package domain
Contains the com.rti.dds.domain.DomainParticipant ( p. 654) class that
classes. The com.rti.dds.domain.DomainParticipant ( p. 654) also acts
as a container for the other objects that make up RTI Connext.
package dynamicdata
<<eXtension>> (p. 278) The Dynamic Data API provides a way to interact with arbitrarily complex data types at runtime without the need for code
generation.
package infrastructure
modules. Contains common definitions such as return codes, status values,
and QoS policies.
package publication
Contains
the
( p. 964),
( p. 1262),
and
com.rti.dds.publication.DataWriter ( p. 557) classes as well as
and
the
( p. 1289)
( p. 586)
interfaces,
and more generally, all that is needed on the publication ( p. 349) side.
package subscription
Contains
the
( p. 1476),
( p. 487),
( p. 1313),
and
com.rti.dds.subscription.QueryCondition ( p. 1311) classes, as well
as the com.rti.dds.subscription.SubscriberListener ( p. 1503) and
com.rti.dds.subscription.DataReaderListener ( p. 518) interfaces, and
more generally, all that is needed on the subscription ( p. 353) side.
package topic
Contains
the
( p. 1545),
( p. 471),
and
( p. 1190)
classes,
the
com.rti.dds.topic.TopicListener ( p. 1564) interface, and more generally,
all that is needed by an application to define com.rti.dds.topic.Topic
( p. 1545) objects and attach QoS policies to them.
7.2 Package com.rti.dds
327
package typecode
<<eXtension>> (p. 278) A com.rti.dds.typecode.TypeCode (p. 1611)
is a mechanism for representing a type at runtime. RTI Connext can use type
codes to send type definitions on the network. You will need to understand
this API in order to use the Dynamic Data ( p. 175) capability or to inspect
the type information you receive from remote readers and writers.
package util
Utility types that support the DDS API.
7.2.1
DDS.
328
7.3
Package com.rti.dds.domain

Classes
interface DomainParticipant
<<interface>>
(p. 279)
Container
for
com.rti.dds.infrastructure.DomainEntity ( p. 653) objects.
all
class DomainParticipantAdapter
class DomainParticipantFactory
<<singleton>> (p. 279) <<interface>> (p. 279) Allows creation and destruction of com.rti.dds.domain.DomainParticipant ( p. 654) objects.
class DomainParticipantFactoryQos
( p. 742).
interface DomainParticipantListener
<<interface>> (p. 279) Listener for participant status.
class DomainParticipantQos
( p. 654) entity.
Packages
package builtin
Builtin topic ( p. 359) for accessing information about the DomainParticipants discovered by RTI Connext.
7.3 Package com.rti.dds.domain
7.3.1
329

330
7.4
Package com.rti.dds.domain.builtin
Builtin topic (p. 359) for accessing information about the DomainParticipants
discovered by RTI Connext.
Classes
class ParticipantBuiltinTopicData
Entry created when a DomainParticipant ( p. 654) object is discovered.
class ParticipantBuiltinTopicDataDataReader
Instantiates
DataReader
( p. 1211) > .
<
builtin.ParticipantBuiltinTopicData
class ParticipantBuiltinTopicDataSeq
builtin.ParticipantBuiltinTopicData ( p. 1211) > .
class ParticipantBuiltinTopicDataTypeSupport
Instantiates TypeSupport
( p. 1211) > .
7.4.1
<
Builtin topic (p. 359) for accessing information about the DomainParticipants
discovered by RTI Connext.
7.5 Package com.rti.dds.dynamicdata
7.5
331
Package com.rti.dds.dynamicdata
generation.
Classes
class DynamicData
reflectively.
class DynamicDataInfo
class DynamicDataMemberInfo
class DynamicDataProperty t
A
collection
of
attributes
used
to
configure
class DynamicDataReader
Reads
(subscribes
to)
objects
of
type
class DynamicDataSeq
An ordered collection
( p. 817) elements.
of
class DynamicDataTypeProperty t
A
collection
of
attributes
used
to
configure
class DynamicDataTypeSerializationProperty t
network.
class DynamicDataTypeSupport
A factory for registering a dynamically defined type and creating
332
class DynamicDataWriter
( p. 817).
7.5.1
generation.
This API allows you to define new data types, modify existing data types, and
interact reflectively with samples. To use it, you will take the following steps:
1. Obtain a com.rti.dds.typecode.TypeCode (p. 1611) (see Type Code
Support (p. 165)) that defines the type definition you want to use.
A com.rti.dds.typecode.TypeCode (p. 1611) includes a types kind
(com.rti.dds.typecode.TCKind (p. 1525)), name, and members (that
is, fields). You can create your own com.rti.dds.typecode.TypeCode
(p. 1611) using the com.rti.dds.typecode.TypeCodeFactory (p. 1647) class
see, for example, the com.rti.dds.typecode.TypeCodeFactory.create Alternatively, you can use a remote
struct tc (p. 1651) method.
com.rti.dds.typecode.TypeCode (p. 1611) that you discovered on the network (see Built-in Topics (p. 157)) or one generated by rtiddsgen (p. 298).
2.
Wrap the com.rti.dds.typecode.TypeCode (p. 1611) in a
com.rti.dds.dynamicdata.DynamicDataTypeSupport (p. 901) object.
See the constructor com.rti.dds.dynamicdata.DynamicDataTypeSupport.DynamicDataTypeSupport.Dyn

This
object
lets
you
connect
the
type
definition
to
a
com.rti.dds.domain.DomainParticipant (p. 654) and manage data
samples (of type com.rti.dds.dynamicdata.DynamicData (p. 817)).
3. Register the com.rti.dds.dynamicdata.DynamicDataTypeSupport
(p. 901) with one or more domain (p. 328) participants.
See
com.rti.dds.dynamicdata.DynamicDataTypeSupport.register type (p. 904). This action associates the data type with a logical name that you
can use to create topics. (Starting with this step, working with a dynamically
defined data type is almost exactly the same as working with a generated one.)
4.
Create a com.rti.dds.topic.Topic (p. 1545)
from
the
Use the name under which you registered your data type see
com.rti.dds.domain.DomainParticipant.create topic (p. 697).
This
com.rti.dds.topic.Topic (p. 1545) is what you will use to produce and consume data.
7.5 Package com.rti.dds.dynamicdata
333
5. Create a com.rti.dds.dynamicdata.DynamicDataWriter (p. 907)

and/or com.rti.dds.dynamicdata.DynamicDataReader (p. 892).
These
objects
will
produce
and/or
consume
data
(of
type
(p. 817))
on
the
You can create these objects dicom.rti.dds.topic.Topic (p. 1545).
rectly from the com.rti.dds.domain.DomainParticipant (p. 654) see
com.rti.dds.domain.DomainParticipant.create datawriter (p. 688) and
(p. 693)
or by first creating intermediate com.rti.dds.publication.Publisher
(p. 1262) and com.rti.dds.subscription.Subscriber (p. 1476) objects see
com.rti.dds.domain.DomainParticipant.create publisher (p. 683) and
com.rti.dds.domain.DomainParticipant.create subscriber (p. 686).
6. Write and/or read the data of interest.
7. Tear down the objects described above.
You should delete them in the reverse order in which you
created them.
Note that unregistering your data type with
the
(p. 654)
is
optional;
all
types
are
automatically
unregistered
when
the
com.rti.dds.domain.DomainParticipant (p. 654) itself is deleted.
334
7.6
Package com.rti.dds.infrastructure
QoS policies.
Classes
class AckResponseData t
Data payload of an application-level acknowledgment.
class AllocationSettings t
class AsynchronousPublisherQosPolicy
thread.
class AvailabilityQosPolicy
class BAD PARAM

class BAD TYPECODE

class BadKind
class BadMemberId
The specified com.rti.dds.typecode.TypeCode ( p. 1611) member ID is invalid.
class BadMemberName
The specified com.rti.dds.typecode.TypeCode ( p. 1611) member name is
invalid.
class BatchQosPolicy
7.6 Package com.rti.dds.infrastructure
335
Used to configure batching of multiple samples into a single network packet

in order to increase throughput for small samples.
class BooleanSeq
boolean >.
class Bounds
class BuiltinTopicReaderResourceLimits t
Built-in topic ( p. 359) readers resource limits.
class ByteSeq
byte >.
class ChannelSettings t
class ChannelSettingsSeq
( p. 454) >.
class CharSeq
char >.
interface Condition
<<interface>> (p. 279) Root class for all the conditions that may be attached to a com.rti.dds.infrastructure.WaitSet ( p. 1709).
class ConditionSeq
com.rti.dds.infrastructure.Condition ( p. 464) >.
class ContentFilterProperty t
<<eXtension>> (p. 278) Type used to provide all the required information
class Cookie t
<<eXtension>> (p. 278) Sequence of bytes identifying a written data sample, used when writing with parameters.
336
class CookieSeq
interface Copyable
<<eXtension>> (p. 278) <<interface>> (p. 279) Interface for all the
user-defined data type classes that support copy.
class DatabaseQosPolicy
Various threads and resource limits settings used by RTI Connext to control
its internal database.
class DataReaderProtocolQosPolicy
Along
with
( p. 1723) and com.rti.dds.infrastructure.DataWriterProtocolQosPolicy
(RTPS).
class DataReaderResourceLimitsQosPolicy
Various
settings
that
physical memory for internal resources.
configure
how
( p. 487) allocates and
a
uses
class DataWriterProtocolQosPolicy
Protocol that applies only to com.rti.dds.publication.DataWriter ( p. 557)
instances.
class DataWriterResourceLimitsInstanceReplacementKind
are reached.
class DataWriterResourceLimitsQosPolicy
Various
settings
that
configure
how
a
class DeadlineQosPolicy
class DestinationOrderQosPolicy
com.rti.dds.publication.DataWriter ( p. 557) entities for the same instance of data (i.e., same com.rti.dds.topic.Topic ( p. 1545) and key).
class DestinationOrderQosPolicyKind
337
class DiscoveryBuiltinReaderFragmentationResourceLimits t
class DiscoveryConfigBuiltinPluginKind
class DiscoveryConfigQosPolicy
class DiscoveryPluginPromiscuityKind
<<eXtension>> (p. 278) Type used to indicate promiscuity mode of the
discovery plugin.
class DiscoveryQosPolicy
interface DomainEntity
<<interface>> (p. 279) Abstract base class for all DDS entities except for
class DomainParticipantResourceLimitsQosPolicy
Various
settings
that
configure
how
a
various properties.
class DoubleSeq
double >.
class DurabilityQosPolicy
network later.
class DurabilityQosPolicyKind
class DurabilityServiceQosPolicy
Various
settings
to
configure
the
external
RTI
338
class Duration t
class EndpointGroup t
Specifies a group of endpoints that can be collectively identified by a name
and satisfied by a quorum.
class EndpointGroupSeq
A sequence of com.rti.dds.infrastructure.EndpointGroup t ( p. 928).
interface Entity
<<interface>> (p. 279) Abstract base class for all the DDS objects that
support QoS policies, a listener, and a status condition.
class EntityFactoryQosPolicy
A
QoS
policy
for
all
class EntityNameQosPolicy
Assigns
a
name
and
a
role
name
to
a
( p. 654),
( p. 557)
or
These names will
class EventQosPolicy
Settings for event.
class ExclusiveAreaQosPolicy
class FloatSeq
float >.
class GroupDataQosPolicy
class GuardCondition
339

( p. 464) whose trigger value is completely under the control of the application.
class GUID t
class HistoryQosPolicy
changes (one or more times) before it can be successfully communicated to
one or more existing subscribers.
class HistoryQosPolicyKind
Kinds of history.
class InetAddressSeq
Declares IDL sequence< com.rti.dds.infrastructure.java.net.InetAddress >.
class InstanceHandle t
class InstanceHandleSeq
com.rti.dds.infrastructure.InstanceHandle t ( p. 1055) > .
class IntSeq
class LatencyBudgetQosPolicy
class LifespanQosPolicy
Specifies
how
long
the
data
written
by
the
interface Listener
<<interface>> (p. 279) Abstract base class for all Listener ( p. 1130) interfaces.
class LivelinessQosPolicy
340
Specifies
and
configures
the
mechanism
that
allows
class LivelinessQosPolicyKind
class Locator t
<<eXtension>> (p. 278) Type used to represent the addressing information
transports.
class LocatorFilter t
DataWriter.
class LocatorFilterQosPolicy
The QoS policy used to report the configuration of a MultiChannel
DataWriter as part of builtin.PublicationBuiltinTopicData.
class LocatorFilterSeq
Declares IDL sequence< com.rti.dds.infrastructure.LocatorFilter t ( p. 1154) >.
class LocatorSeq
Declares IDL sequence < com.rti.dds.infrastructure.Locator t ( p. 1150)
>.
class LoggingQosPolicy
class LongDoubleSeq
class LongSeq
long >.
class MultiChannelQosPolicy
Configures the ability of a DataWriter to send data on different multicast
groups (addresses) based on the value of the data.
341
class ObjectHolder
<<eXtension>> (p. 278) Holder of object instance
class OwnershipQosPolicy
Specifies
whether
it
is
allowed
for
multiple
class OwnershipQosPolicyKind
Kinds of ownership.
class OwnershipStrengthQosPolicy
class PartitionQosPolicy
class PresentationQosPolicy
class PresentationQosPolicyAccessScopeKind
class ProductVersion t
<<eXtension>> (p. 278) Type used to represent the current version of RTI
Connext.
class ProfileQosPolicy
Configures the way that XML documents containing QoS profiles are loaded
by RTI Connext.
class Property t
class PropertyQosPolicy
Stores name/value(string) pairs that can be used to configure certain parameters of RTI Connext that are not exposed through formal QoS policies. Can
also be used to store and propagate application-specific name/value pairs that
can be retrieved by user code during discovery.
342
class PropertyQosPolicyHelper
Policy Helpers which facilitate management of the properties in the input
policy.
class PropertySeq
Declares IDL
( p. 1234) >.
sequence
<
class ProtocolVersion t
<<eXtension>> (p. 278) Type used to represent the version of the RTPS
protocol.
class PublishModeQosPolicy
class PublishModeQosPolicyKind
class Qos
class QosPolicy
class QosPolicyCount
( p. 1305).
class QosPolicyCountSeq
( p. 1302) >.
class QosPolicyId t
class ReaderDataLifecycleQosPolicy
received.
class ReceiverPoolQosPolicy
343
Configures threads used by RTI Connext to receive and process data from
transports (for example, UDP sockets).
class RefilterQosPolicyKind
<<eXtension>> (p. 278) Kinds of Refiltering
class ReliabilityQosPolicy
class ReliabilityQosPolicyAcknowledgmentModeKind
class ReliabilityQosPolicyKind
class RemoteParticipantPurgeKind
class ResourceLimitsQosPolicy
class RETCODE ALREADY DELETED

class RETCODE BAD PARAMETER

class RETCODE ERROR

class RETCODE ILLEGAL OPERATION

class RETCODE IMMUTABLE POLICY

class RETCODE INCONSISTENT POLICY

other.
344
class RETCODE NO DATA
Indicates a transient situation where the operation did not return any data
but there is no inherent error.
class RETCODE NOT ENABLED

Operation invoked on a com.rti.dds.infrastructure.Entity ( p. 931) that is
not yet enabled.
class RETCODE OUT OF RESOURCES

class RETCODE PRECONDITION NOT MET

class RETCODE TIMEOUT

class RETCODE UNSUPPORTED

class RtpsReliableReaderProtocol t
Qos ( p. 1300) related to reliable reader protocol defined in RTPS.
class RtpsReliableWriterProtocol t
QoS related to the reliable writer protocol defined in RTPS.
class RtpsReservedPortKind
RTPS reserved port kind, used to identify the types of ports that can be reserved on domain ( p. 328) participant enable.
class RtpsWellKnownPorts t
class SampleIdentity t
Type definition for an Sample Identity.
class SequenceNumber t
class ShortSeq
short >.
345
interface StatusCondition
( p. 464) that is associated with each com.rti.dds.infrastructure.Entity
( p. 931).
class StatusKind
class StringSeq
class SystemException
System exception.
class SystemResourceLimitsQosPolicy
Configures
( p. 654)independent resources used by RTI Connext. Mainly used to change
the maximum number of com.rti.dds.domain.DomainParticipant
( p. 654) entities that can be created within a single process (address space).
class ThreadSettings t
class ThreadSettingsCpuRotationKind
( p. 1531) affects processor affinity for thread-related QoS policies that apply to multiple threads.
class ThreadSettingsKind
class Time t
class TimeBasedFilterQosPolicy
the data.
class TopicDataQosPolicy
346
class TransportBuiltinKind
class TransportBuiltinQosPolicy
class TransportMulticastMapping t
Type representing a list of multicast mapping elements.
class TransportMulticastMappingFunction t
Type representing an external mapping function.
class TransportMulticastMappingQosPolicy
Specifies
the
multicast
address
on
which
a
class TransportMulticastMappingSeq
Declares IDL sequence< com.rti.dds.infrastructure.TransportMulticastSettings t ( p. 1594) >.
class TransportMulticastQosPolicy
Specifies
the
multicast
address
on
which
a
class TransportMulticastQosPolicyKind
class TransportMulticastSettings t
Type representing a list of multicast locators.
class TransportMulticastSettingsSeq
Declares IDL sequence< com.rti.dds.infrastructure.TransportMulticastSettings t ( p. 1594) >.
class TransportPriorityQosPolicy
347
class TransportSelectionQosPolicy
( p. 557) or com.rti.dds.subscription.DataReader ( p. 487) may use to
send or receive data.
class TransportUnicastQosPolicy
Entity ( p. 931) to receive data.
class TransportUnicastSettings t
Type representing a list of unicast locators.
class TransportUnicastSettingsSeq
Declares IDL sequence< com.rti.dds.infrastructure.TransportUnicastSettings t ( p. 1608) >.
class TypeConsistencyEnforcementQosPolicy
topic ( p. 359) is consistent with that used to subscribe to it.
class TypeConsistencyKind
class TypeSupportQosPolicy
Allows you to attach application-specific values to a DataWriter or
DataReader that are passed to the serialization or deserialization routine
of the associated data type.
class UserDataQosPolicy
class UserException
User exception.
class VendorId t
<<eXtension>> (p. 278) Type used to represent the vendor of the service
class WaitSet
<<interface>> (p. 279) Allows an application to wait until one or more
of the attached com.rti.dds.infrastructure.Condition ( p. 464) objects has
a trigger value of com.rti.dds.infrastructure.true or else until the timeout
expires.
348
class WaitSetProperty t
<<eXtension>>
(p. 278)
Specifies
the
com.rti.dds.infrastructure.WaitSet ( p. 1709) behavior for multiple
trigger events.
class WcharSeq
class WireProtocolQosPolicy
Specifies
the
attributes
for
the
class WireProtocolQosPolicyAutoKind
class WriteParams t
<<eXtension>>
(p. 278) Input parameters for writing with
( p. 1026),
com.rti.ndds.example.FooDataWriter.write w params
com.rti.ndds.example.FooDataWriter.dispose w params
( p. 1031),
com.rti.ndds.example.FooDataWriter.register instance w params
( p. 1016),
com.rti.ndds.example.FooDataWriter.unregister instance w params ( p. 1021)
class WriterDataLifecycleQosPolicy
Controls how a com.rti.dds.publication.DataWriter ( p. 557) handles the
class WstringSeq
7.6.1
QoS policies.
7.7 Package com.rti.dds.publication
7.7
349
Package com.rti.dds.publication
Contains
the
(p. 1262),
and
(p. 964),
the
(p. 1289)
and
more generally, all that is needed on the publication (p. 349) side.
Classes
class AcknowledgmentInfo
interface DataWriter
<<interface>> (p. 279) Allows an application to set the value of the data
to be published under a given com.rti.dds.topic.Topic ( p. 1545).
class DataWriterAdapter
listener adapters. (The Adapter provides empty implementations for the listener methods or functions.)
class DataWriterCacheStatus
interface DataWriterListener
for writer status.
class DataWriterProtocolStatus
metrics, like the number of samples pushed, pulled, filtered; and status of
class DataWriterQos
QoS policies supported by a com.rti.dds.publication.DataWriter ( p. 557)
entity.
interface FlowController
<<interface>> (p. 279) A flow controller is the object responsible for
com.rti.dds.publication.DataWriter ( p. 557) instances are allowed to
write data.
350
class FlowControllerProperty t
Determines
the
flow
control
characteristics
of
the
class FlowControllerSchedulingPolicy
class FlowControllerTokenBucketProperty t
com.rti.dds.publication.FlowController ( p. 964) uses the popular token
class LivelinessLostStatus
class OfferedDeadlineMissedStatus
class OfferedIncompatibleQosStatus
class PublicationMatchedStatus
interface Publisher
<<interface>> (p. 279) A publisher is the object responsible for the actual
class PublisherAdapter
interface PublisherListener
for com.rti.dds.publication.Publisher ( p. 1262) status.
class PublisherQos
7.7 Package com.rti.dds.publication
351
QoS policies supported by a com.rti.dds.publication.Publisher ( p. 1262)

entity.
class PublisherSeq
Declares IDL sequence < com.rti.dds.publication.Publisher ( p. 1262) >
.
class ReliableReaderActivityChangedStatus
<<eXtension>> (p. 278) Describes the activity (i.e. are acknowledgements
class ReliableWriterCacheChangedStatus
<<eXtension>> (p. 278) A summary of the state of a data writers cache
of unacknowledged samples written.
class ReliableWriterCacheEventCount
<<eXtension>> (p. 278) The number of times the number of unacknowledged samples in the cache of a reliable writer hit a certain well-defined
threshold.
Packages
package builtin
Builtin topic ( p. 359) for accessing information about the Publications discovered by RTI Connext.
7.7.1
Contains
the
(p. 964),
(p. 1262),
and
the
(p. 1289)
and
more generally, all that is needed on the publication (p. 349) side.
352
7.8
Package com.rti.dds.publication.builtin
Builtin topic (p. 359) for accessing information about the Publications discovered by RTI Connext.
Classes
class PublicationBuiltinTopicData
Entry created when a com.rti.dds.publication.DataWriter ( p. 557) is discovered in association with its Publisher ( p. 1262).
class PublicationBuiltinTopicDataDataReader
Instantiates
DataReader
( p. 1249) > .
<
class PublicationBuiltinTopicDataSeq
builtin.PublicationBuiltinTopicData ( p. 1249) > .
class PublicationBuiltinTopicDataTypeSupport
( p. 1249) > .
7.8.1
<
Builtin topic (p. 359) for accessing information about the Publications discovered by RTI Connext.
7.9 Package com.rti.dds.subscription
7.9
353
Package com.rti.dds.subscription
Contains
the
(p. 1476),
(p. 487),
and
(p. 1313),
more generally, all that is needed on the subscription (p. 353) side.
Classes
interface DataReader
<<interface>> (p. 279) Allows the application to: (1) declare the data it
wishes to receive (i.e. make a subscription ( p. 353)) and (2) access the data
received by the attached com.rti.dds.subscription.Subscriber ( p. 1476).
class DataReaderAdapter
class DataReaderCacheStatus
interface DataReaderListener
for reader status.
class DataReaderProtocolStatus
class DataReaderQos
QoS policies supported by a com.rti.dds.subscription.DataReader
( p. 487) entity.
class DataReaderSeq
Declares IDL sequence < com.rti.dds.subscription.DataReader ( p. 487)
>.
class InstanceStateKind
354
Indicates
is
the
samples
are
from
com.rti.dds.publication.DataWriter ( p. 557) or not.
live
class LivelinessChangedStatus
interface QueryCondition
<<interface>>
(p. 279)
These
are
specialised
com.rti.dds.subscription.ReadCondition ( p. 1313) objects that allow the application to also specify a filter on the locally available data.
interface ReadCondition
<<interface>> (p. 279) Conditions specifically dedicated to read operations
and attached to one com.rti.dds.subscription.DataReader ( p. 487).
class RequestedDeadlineMissedStatus
class RequestedIncompatibleQosStatus
class SampleInfo
class SampleInfoSeq
Declares IDL
( p. 1398) > .
sequence
<
class SampleLostStatus
class SampleLostStatusKind
class SampleRejectedStatus
class SampleRejectedStatusKind
355
class SampleStateKind
interface Subscriber
<<interface>> (p. 279) A subscriber is the object responsible for actually
receiving data from a subscription ( p. 353).
class SubscriberAdapter
A listener adapter in the spirit of the Java AWT listener adapters. (The
Adapter provides empty implementations for the listener methods).
interface SubscriberListener
for status about a subscriber.
class SubscriberQos
QoS policies supported
( p. 1476) entity.
by
class SubscriberSeq
Declares IDL sequence < com.rti.dds.subscription.Subscriber ( p. 1476)
>.
class SubscriptionMatchedStatus
class ViewStateKind
Packages
package builtin
Builtin topic ( p. 359) for accessing information about the Subscriptions discovered by RTI Connext.
7.9.1
Contains
(p. 1476),
the
(p. 487),
356
(p. 1313),
com.rti.dds.subscription.QueryCondition (p. 1311) classes, as
as the com.rti.dds.subscription.SubscriberListener (p. 1503)
com.rti.dds.subscription.DataReaderListener (p. 518) interfaces,
more generally, all that is needed on the subscription (p. 353) side.
7.9.2
and
well
and
and
Access to data samples
Data is made available to the application by the following operations

on
(p. 487)
objects:
(p. 981),
(p. 990),
(p. 983),
(p. 991),
and the other variants of read() and take().
The general semantics of the read() operation is that the application only gets
access to the corresponding data (i.e. a precise instance value); the data remains
the responsibility of RTI Connext and can be read again.
The semantics of the take() operations is that the application takes full responsibility for the data; that data will no longer be available locally to RTI
Connext. Consequently, it is possible to access the same information multiple
times only if all previous accesses were read() operations, not take().
Each of these operations returns a collection of Data values and associated
com.rti.dds.subscription.SampleInfo (p. 1398) objects. Each data value
represents an atom of data information (i.e., a value for one instance). This
collection may contain samples related to the same or different instances (identified by the key). Multiple samples can refer to the same instance if the settings
of the HISTORY (p. 79) QoS allow for it.
To return the memory back to the middleware, every read() or take()
that retrieves a sequence of samples must be followed with a call to
See also:
Interpretation of the SampleInfo (p. 1400)
7.9.2.1
Data access patterns
The application accesses data by means of the operations read or

take on the com.rti.dds.subscription.DataReader (p. 487). These operations return an ordered collection of DataSamples consisting of a
com.rti.dds.subscription.SampleInfo (p. 1398) part and a Data part.
357
The way RTI Connext builds the collection depends on QoS policies set on the com.rti.dds.subscription.DataReader (p. 487) and
com.rti.dds.subscription.Subscriber (p. 1476), as well as the source timestamp of the samples, and the parameters passed to the read() / take()
operations, namely:
the
desired
sample
states
(any
combination
com.rti.dds.subscription.SampleStateKind (p. 1426))
of
the
desired
view
states
(any
combination
com.rti.dds.subscription.ViewStateKind (p. 1703))
of
the
desired
instance
states
(any
combination
com.rti.dds.subscription.InstanceStateKind (p. 1061))
of
The read() and take() operations are non-blocking and just deliver what is
currently available that matches the specified states.
The read w condition() and take w condition() operations take a
com.rti.dds.subscription.ReadCondition (p. 1313) object as a parameter instead of sample, view or instance states.
The behaviour is
that the samples returned will only be those for which the condition is com.rti.dds.infrastructure.true.
These operations, in conjunction
with com.rti.dds.subscription.ReadCondition (p. 1313) objects and a
com.rti.dds.infrastructure.WaitSet (p. 1709), allow performing waiting
reads.
Once the data samples are available to the data readers, they can be read or
taken by the application. The basic rule is that the application may do this in
any order it wishes. This approach is very flexible and allows the application
ultimate control.
To access data coherently, or in order, the PRESENTATION (p. 90) QoS
must be set properly.
358
7.10
Package com.rti.dds.subscription.builtin
Builtin topic (p. 359) for accessing information about the Subscriptions discovered by RTI Connext.
Classes
class SubscriptionBuiltinTopicData
Entry created when a com.rti.dds.subscription.DataReader ( p. 487) is
discovered in association with its Subscriber ( p. 1476).
class SubscriptionBuiltinTopicDataDataReader
Instantiates DataReader (p. 487) < builtin.SubscriptionBuiltinTopicData
( p. 1509) > .
class SubscriptionBuiltinTopicDataSeq
builtin.SubscriptionBuiltinTopicData ( p. 1509) > .
class SubscriptionBuiltinTopicDataTypeSupport
( p. 1509) > .
7.10.1
<
Builtin topic (p. 359) for accessing information about the Subscriptions discovered by RTI Connext.
7.11 Package com.rti.dds.topic
7.11
359
Package com.rti.dds.topic
Contains
the
(p. 1545),
(p. 471),
and
(p. 1190)
classes,
the
Classes
class BuiltinTopicKey t
The key type of the built-in topic ( p. 359) types.
interface ContentFilter
<<interface>> (p. 279) Interface to be used by a custom filter of a
com.rti.dds.topic.ContentFilteredTopic ( p. 471)
interface ContentFilteredTopic
<<interface>>
(p. 279)
Specialization
of
com.rti.dds.topic.TopicDescription ( p. 1561) that allows for contentbased subscriptions.
class ExpressionProperty
class FilterSampleInfo
class InconsistentTopicStatus
interface MultiTopic
[Not supported (optional)] <<interface>> (p. 279) A specialization
of com.rti.dds.topic.TopicDescription ( p. 1561) that allows subscriptions
that combine/filter/rearrange data coming from several topics.
interface Topic
<<interface>> (p. 279) The most basic description of the data to be published and subscribed.
class TopicAdapter
interface TopicDescription
360
interface TopicListener
for com.rti.dds.topic.Topic ( p. 1545) entities.
class TopicQos
QoS policies supported by a com.rti.dds.topic.Topic ( p. 1545) entity.
interface TypeSupport
<<interface>> (p. 279) An abstract marker interface that has to be specialized for each concrete user data type that will be used by the application.
interface WriterContentFilter
Packages
package builtin
Builtin topic ( p. 359) for accessing information about the Topics discovered
by RTI Connext.
7.11.1
Contains
the
(p. 1545),
(p. 471),
and
(p. 1190)
classes,
the
7.12 Package com.rti.dds.topic.builtin
7.12
361
Package com.rti.dds.topic.builtin
Builtin topic (p. 359) for accessing information about the Topics discovered by
RTI Connext.
Classes
class AbstractBuiltinTopicDataTypeSupport
class TopicBuiltinTopicData
Entry created when a Topic ( p. 1545) object discovered.
class TopicBuiltinTopicDataDataReader
Instantiates DataReader < builtin.TopicBuiltinTopicData ( p. 1552) > .
class TopicBuiltinTopicDataSeq
builtin.TopicBuiltinTopicData ( p. 1552) > .
class TopicBuiltinTopicDataTypeSupport
Instantiates TypeSupport (p. 1665) < builtin.TopicBuiltinTopicData
( p. 1552) > .
7.12.1
Builtin topic (p. 359) for accessing information about the Topics discovered by
RTI Connext.
362
7.13
Package com.rti.dds.type.builtin

Classes
class Bytes
class BytesDataReader
<<interface>>
(p. 279)
Instantiates
DataReader
<
class BytesDataWriter
<<interface>>
(p. 279)
Instantiates
DataWriter
<
class BytesSeq
class BytesTypeSupport
<<interface>> (p. 279) com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes
type support.
class KeyedBytes
that is the key.
class KeyedBytesDataReader
<<interface>>
(p. 279)
Instantiates
DataReader
<
class KeyedBytesDataWriter
<<interface>>
(p. 279)
Instantiates
DataWriter
<
class KeyedBytesSeq
class KeyedBytesTypeSupport
7.13 Package com.rti.dds.type.builtin
363
<<interface>> (p. 279) com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes

type support.
class KeyedString
class KeyedStringDataReader
<<interface>>
(p. 279)
Instantiates
DataReader
<
class KeyedStringDataWriter
<<interface>>
(p. 279)
Instantiates
DataWriter
<
class KeyedStringSeq
class KeyedStringTypeSupport
<<interface>> (p. 279) Keyed string type support.
class StringDataReader
<<interface>>
(p. 279)
com.rti.dds.infrastructure.String >.
Instantiates
DataReader
<
Instantiates
DataWriter
<
class StringDataWriter
<<interface>>
(p. 279)
class StringTypeSupport
<<interface>> (p. 279) String type support.
7.13.1

The middleware provides four built-in types:
String: A payload consisting of a single string of characters. This type
has no key.
364
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString: A payload
consisting of a single string of characters and a second string, the key,
that identifies the instance to which the sample belongs.
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes: A payload consisting of an opaque variable-length array of bytes. This type has no
key.
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes: A payload
consisting of an opaque variable-length array of bytes and a string, the
key, that identifies the instance to which the sample belongs.
The String and com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString

types
are
appropriate
for
simple
text-based
applications.
The
and
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes types are appropriate for applications that perform their own custom data serialization,
such as legacy applications still in the process of migrating to RTI Connext. In
most cases, string-based or structured data is preferable to opaque data, because the latter cannot be easily visualized in tools or used with content-based
filters (see com.rti.dds.topic.ContentFilteredTopic (p. 471)).
The built-in types are very simple in order to get you up and running as quickly
as possible. If you need a structured data type you can define your own type
with exactly the fields you need in one of two ways:
At compile time, by generating code from an IDL or XML file using the
rtiddsgen (p. 298) utility
At runtime, by using the Dynamic Data (p. 175) API
7.13.2
Managing Memory for Builtin Types
When a sample is written, the DataWriter serializes it and stores the result in
a buffer obtained from a pool of preallocated buffers. In the same way, when
a sample is received, the DataReader deserializes it and stores the result in a
sample coming from a pool of preallocated samples.
For builtin (p. 362) types, the maximum size of the buffers/samples and depends on the nature of the application using the builtin (p. 362) type.
You can configure the maximum size of the builtin (p. 362)
types on a per-DataWriter and per-DataReader basis using the
com.rti.dds.infrastructure.PropertyQosPolicy (p. 1236) in DataWriters,
DataReaders or Participants.
The following table lists the supported builtin (p. 362) type properties to configure memory allocation. When the properties are defined in the DomainParticipant, they are applicable to all DataWriters and DataReaders belonging
365
to the DomainParticipant unless they are overwrittem in the DataWriters and

DataReaders.
The previous properties must be set consistently with respect to the corresponding .max size properties that set the maximum size of the builtin (p. 362) types
in the typecode (p. 368).
7.13.3
Typecodes for Builtin Types
The typecodes associated with the builtin (p. 362) types are generated from
the following IDL type definitions:
module DDS {
struct String {
string value;
};
struct KeyedString {
string key;
string value;
};
struct Octets {
};
struct KeyedOctets {
string key;
};
};
The maximum size of the strings and sequences that will be included in the type
code definitions can be configured on a per-DomainParticipant-basis by using
the properties in following table.
For more information about the built-in types, including how to control memory usage and maximum lengths, please see chapter 3, Data Types and Data
Samples, in the Users Manual.
366
Property
dds.builtin type.string.alloc size
Description
published by the
com.rti.dds.type.builtin.StringDataWriter
(p. 1465) or received the
com.rti.dds.type.builtin.StringDataReader
(p. 1462) (includes the
Default:
dds.builtin type.string.max size if
dds.builtin type.keyed string.alloc Maximum size of the keys used by
key size
the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDa
or
character).
Default: dds.builtin type.keyed string.max key size if defined.
Otherwise, 1024.
dds.builtin type.keyed string.alloc Maximum size of the strings
size
published by the
or received by the
character).
Default: dds.builtin type.keyed string.max size if defined.
Otherwise, 1024.
dds.builtin type.octets.alloc size
sequences published the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesDataWrit
or received by the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesDataRead
Default:
dds.builtin type.octets.max size if
dds.builtin type.keyed octets.alloc Maxkey size
imum size of the key published by the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDa
or received by the
character).
Default: dds.builtin type.keyed octets.max
key size
if API
defined.
for RTI Connext
Java
by Doxygen
Otherwise, 1024.
dds.builtin type.keyed octets.alloc Maximum size of the octets
size
sequences published by a
or received by a
Default: dds.builtin type.keyed -

Property
dds.builtin type.string.max size
dds.builtin type.keyed string.max key size
dds.builtin type.keyed string.max size
dds.builtin type.octets.max size
dds.builtin type.keyed octets.max key size
dds.builtin type.keyed octets.max size
367
Description
published by the StringDataWriters
and received by the
StringDataReaders belonging to a
DomainParticipant (includes the
Default: 1024.
the KeyedStringDataWriters and
to a DomainParticipant (includes
the NULL-terminated character).
Default: 1024.
published by the
KeyedStringDataWriters and
received by the
to a DomainParticipant using the
builtin (p. 362) type (includes the
Default: 1024
OctetsDataWriters and received by
the OctetsDataReader belonging to
a DomainParticipant.
Default: 2048
the KeyedOctetsStringDataWriters
and KeyedOctetsStringDataReaders
belonging to a DomainParticipant
character).
Default: 1024.
KeyedOctetsDataWriters and
received by the
KeyedOctetsDataReaders belonging
to a DomainParticipant.
Default: 2048
Table 7.2: Properties for Allocating Size of Builtin Types, per DomainParticipant
368
7.14
Package com.rti.dds.typecode

Classes
class EnumMember
class ExtensibilityKind
class PRIVATE MEMBER

class PUBLIC MEMBER

class StructMember
class TCKind
Enumeration type for com.rti.dds.typecode.TypeCode ( p. 1611) kinds.
class TypeCode
The definition of a particular data type, which you can use to inspect the
name, members, and other properties of types generated with rtiddsgen
( p. 298) or to modify types you define yourself at runtime.
class TypeCodeFactory
dynamically.
class UnionMember
class ValueMember
7.14 Package com.rti.dds.typecode
369
class VM ABSTRACT
class VM CUSTOM
class VM NONE
class VM TRUNCATABLE
7.14.1

Type codes are values that are used to describe arbitrarily complex types at runtime.
Type code values are manipulated via the
com.rti.dds.typecode.TypeCode (p. 1611) class, which has an analogue in
CORBA.
A com.rti.dds.typecode.TypeCode (p. 1611) value consists of a type code
kind (represented by the com.rti.dds.typecode.TCKind (p. 1525) enumeration) and a list of members (that is, fields). These members are recursive: each
one has its own com.rti.dds.typecode.TypeCode (p. 1611), and in the case
of complex types (structures, arrays, and so on), these contained type codes
contain their own members.
There are a number of uses for type codes.
The type code mechanism can be used to unambiguously match type representations.
The
com.rti.dds.typecode.TypeCode.TypeCode.equals method is a more reliable test
than comparing the string type names, requiring equivalent definitions of the
types.
7.14.2
Accessing a Local com.rti.dds.typecode.TypeCode
When generating types with rtiddsgen (p. 298), type codes are enabled
by default. (The -notypecode option can be used to disable generation of
com.rti.dds.typecode.TypeCode (p. 1611) information.) For these types,
370
a com.rti.dds.typecode.TypeCode (p. 1611) may be accessed via the

FooTypeCode.VALUE member.
This
API
also
includes
support
for
dynamic
creation
of
values,
typically
(p. 1611)
for use with the Dynamic Data (p. 175) API. You can create
a
(p. 1611)
using
the
com.rti.dds.typecode.TypeCodeFactory (p. 1647) class.
You will
construct the com.rti.dds.typecode.TypeCode (p. 1611) recursively, from
the outside in: start with the type codes for primitive types, then compose
them into complex types like arrays, structures, and so on. You will find the
following methods helpful:
(p. 1660), which provides the com.rti.dds.typecode.TypeCode
(p. 1611)
instances
corresponding
to
the
primitive
types
(e.g.
com.rti.dds.typecode.TCKind.TK LONG (p. 1527),
com.rti.dds.typecode.TCKind.TK SHORT (p. 1527),
and so
on).
and
com.rti.dds.typecode.TypeCodeFactory.create wstring tc (p. 1658) create a com.rti.dds.typecode.TypeCode (p. 1611)
representing a text string with a certain bound (i.e. maximum length).
and com.rti.dds.typecode.TypeCodeFactory.create sequence tc
(p. 1658) create a com.rti.dds.typecode.TypeCode (p. 1611) for a
collection based on the com.rti.dds.typecode.TypeCode (p. 1611) for
its elements.
com.rti.dds.typecode.TypeCodeFactory.create struct tc
(p. 1651), com.rti.dds.typecode.TypeCodeFactory.create value tc
(p. 1652), and com.rti.dds.typecode.TypeCodeFactory.create sparse tc (p. 1653) create a com.rti.dds.typecode.TypeCode
(p. 1611) for a structured type.
7.14.3
Accessing a Remote com.rti.dds.typecode.TypeCode
In addition to being used locally, RTI Connext can transmit

com.rti.dds.typecode.TypeCode (p. 1611) on the network between
participants. This information can be used to access information about types
used remotely at runtime, for example to be able to publish or subscribe to
topics of arbitrarily types (see Dynamic Data (p. 175)). This functionality is
useful for a generic system monitoring tool like rtiddsspy.
7.14 Package com.rti.dds.typecode
371
Remote com.rti.dds.typecode.TypeCode (p. 1611) information is shared

during discovery over the publication (p. 349) and subscription (p. 353)
built-in topics and can be accessed using the built-in readers for these topics;
see Built-in Topics (p. 157). Discovered com.rti.dds.typecode.TypeCode
(p. 1611) values are not cached by RTI Connext upon receipt and are
therefore not available from the built-in topic (p. 359) data returned
by
com.rti.dds.publication.DataWriter.get matched subscription data (p. 571) or com.rti.dds.subscription.DataReader.get matched publication data (p. 502).
The
space
available
locally
to
deserialize
a
discovered
remote
(p. 1611)
is
specified
by
the
(p. 654)s
com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.type code max serialized length (p. 792) QoS parameter. To support especially
complex type codes, it may be necessary for you to increase the value of this
parameter.
See also:
com.rti.dds.typecode.TypeCode (p. 1611)
Dynamic Data (p. 175)
rtiddsgen (p. 298)
372
7.15
Package com.rti.dds.util
Classes
class AbstractPrimitiveSequence
class AbstractSequence
Abstract sequence.
class Enum
class LoanableSequence
A sequence capable of storing its elements directly or taking out a loan on
them from an internal middleware store.
interface Sequence
class Union
7.15.1
7.16 Package com.rti.ndds
7.16
Package com.rti.ndds
DDS extensions.
Packages
package config
package transport
package example
Programming HowTos: Code templates for common use cases.
7.16.1
DDS extensions.
373
374
7.17
Package com.rti.ndds.config
Classes
class LibraryVersion t
class LogCategory
class Logger
<<interface>> (p. 279) The singleton type used to configure RTI Connext
logging.
interface LoggerDevice
<<interface>> (p. 279) Logging device interface. Use for user-defined logging devices.
class LogLevel
device.
class LogMessage
Log message.
class LogPrintFormat
class LogVerbosity
class Version
<<interface>> (p. 279) The version of an RTI Connext distribution.
7.17.1
7.18 Package com.rti.ndds.example
7.18
375
Package com.rti.ndds.example
Classes
class Foo
class FooDataReader
<<interface>> (p. 279) <<generic>> (p. 279) User data type-specific
data reader.
class FooDataWriter
<<interface>> (p. 279) <<generic>> (p. 279) User data type specific
data writer.
class FooSeq
class FooTypeSupport
<<interface>> (p. 279) <<generic>> (p. 279) User data type specific interface.
7.18.1
376
7.19
Package com.rti.ndds.transport
Classes
interface ShmemTransport
Built-in transport ( p. 376) plug-in for inter-process communications using
shared memory.
interface Transport
RTI Connexts abstract pluggable transport ( p. 376) interface.
class TransportSupport
<<interface>> (p. 279) The utility class used to configure RTI Connext
pluggable transports.
7.19.1
7.19.2
Overview
RTI Connext has a pluggable transports architecture. The core of RTI Connext
is transport (p. 376) agnostic; it does not make any assumptions about the
actual transports used to send and receive messages. Instead, the RTI Connext
core uses an abstract transport API to interact with the transport (p. 376)
plugins which implement that API.
A transport (p. 376) plugin implements the abstract transport (p. 376) API
and performs the actual work of sending and receiving messages over a physical
transport (p. 376). A collection of builtin plugins (see Built-in Transport
Plugins (p. 222)) is delivered with RTI Connext for commonly used transports.
New transport (p. 376) plugins can easily be created, thus enabling RTI Connext applications to run over transports that may not even be conceived yet.
7.19 Package com.rti.ndds.transport
377
This is a powerful capability and that distinguishes RTI Connext from competing middleware approaches.
RTI Connext also provides a set of APIs for installing and configSo
uring transport (p. 376) plugins to be used in an application.
that RTI Connext applications work out of the box, a subset of
the builtin transport (p. 376) plugins is preconfigured by default (see
com.rti.dds.infrastructure.TransportBuiltinQosPolicy (p. 1580)). You
can turn-off some or all of the builtin transport (p. 376) plugins. In addition,
you can configure other transport (p. 376) plugins for use by the application.
7.19.3
Transport Aliases
In order to use a transport (p. 376) plugin instance in an RTI Connext application, it must be registered with a com.rti.dds.domain.DomainParticipant
(p. 654). When you register a transport (p. 376), you specify a sequence of
alias strings to symbolically refer to the transport (p. 376) plugin. The same
alias strings can be used to register more than one transport (p. 376) plugin.
You can register multiple transport (p. 376) plugins with a
An alias symbolicom.rti.dds.domain.DomainParticipant (p. 654).
cally refers to one or more transport (p. 376) plugins registered with the
Builtin transport
(p. 376) plugin instances can be referred to using preconfigured aliases (see
TRANSPORT BUILTIN (p. 119)).
A transport (p. 376) plugins class name is automatically used as an implicit
alias. It can be used to refer to all the transport (p. 376) plugin instances of
that class.
You can use aliases to refer to transport (p. 376) plugins, in order to specify:
- the transport (p. 376) plugins to use for discovery (see
com.rti.dds.infrastructure.DiscoveryQosPolicy.enabled transports
(p. 650)),
and
for
(p. 557)
and
(p. 487)
entities
(see
com.rti.dds.infrastructure.TransportSelectionQosPolicy (p. 1600)).
- the multicast addresses on which to receive discovery messages (see
com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast receive addresses (p. 650)), and the multicast addresses and ports on which to receive
user data (see com.rti.dds.subscription.DataReaderQos.multicast
(p. 541)).
the
unicast
ports
used
for
user
data
(see
com.rti.dds.infrastructure.TransportUnicastQosPolicy
(p. 1605))
on
both
(p. 557)
and
378
- the transport (p. 376) plugins used to parse an address string in a locator
(Locator Format (p. 58) and NDDS DISCOVERY PEERS (p. 57)).
A
(p. 654)
(and
contained its entities) start using a transport (p. 376) plugin after the
com.rti.dds.domain.DomainParticipant (p. 654) is enabled (see
com.rti.dds.infrastructure.Entity.enable (p. 935)). An entity will use
all the transport (p. 376) plugins that match the specified transport (p. 376)
QoS policy. All transport (p. 376) plugins are treated uniformly, regardless
of how they were created or registered; there is no notion of some transports
being more special that others.
7.19.4
Transport Lifecycle
Thus,
A transport (p. 376) plugin is owned by whoever created it.
if you create and register a transport (p. 376) plugin with a
com.rti.dds.domain.DomainParticipant (p. 654), you are responsible
for deleting it by calling its destructor. Note that builtin transport (p. 376)
plugins (TRANSPORT BUILTIN (p. 119)) and transport (p. 376) plugins
that are loaded through the PROPERTY (p. 92) QoS policy (see Loading Transport Plugins through Property QoS Policy of Domain
Participant (p. 219)) are automatically managed by RTI Connext.
A user-created transport (p. 376) plugin must not be deleted while it is
still in use by a com.rti.dds.domain.DomainParticipant (p. 654). This
generally means that a user-created transport (p. 376) plugin instance
can only be deleted after the com.rti.dds.domain.DomainParticipant
(p. 654)
with
which
it
was
registered
is
deleted
(see
com.rti.dds.domain.DomainParticipantFactory.delete participant
(p. 749)). Note that a transport (p. 376) plugin cannot be unregistered
from a com.rti.dds.domain.DomainParticipant (p. 654).
A transport (p. 376) plugin instance cannot be registered with more than
one com.rti.dds.domain.DomainParticipant (p. 654) at a time. This requirement is necessary to guarantee the multi-threaded safety of the transport
(p. 376) API.
If the same physical transport (p. 376) resources are to be used with
more than one com.rti.dds.domain.DomainParticipant (p. 654) in the
same address space, the transport (p. 376) plugin should be written in
such a way so that it can be instantiated multiple timesonce for each
com.rti.dds.domain.DomainParticipant (p. 654) in the address space.
Note that it is always possible to write the transport (p. 376) plugin so that
multiple transport (p. 376) plugin instances share the same underlying resources; however the burden (if any) of guaranteeing multi-threaded safety to
access shared resource shifts to the transport (p. 376) plugin developer.
7.19.5
379
Transport Class Attributes
A transport (p. 376) plugin instance is associated with two kinds of attributes:
- the class attributes that are decided by the plugin writer; these are invariant
across all instances of the transport (p. 376) plugin class, and
- the instance attributes that can be set on a per instance basis by the transport
(p. 376) plugin user.
Every transport (p. 376) plugin must specify the following class attributes.
transport (p. 376) class id (see com.rti.ndds.transport.Transport.Property t.classid (p. 1573))
Identifies a transport (p. 376) plugin implementation class. It denotes a
unique class to which the transport (p. 376) plugin instance belongs.
The class is used to distinguish between different transport (p. 376)
plugin implementations. Thus, a transport (p. 376) plugin vendor
should ensure that its transport (p. 376) plugin implementation has a
unique class.
Two transport (p. 376) plugin instances report the same class iff they
have compatible implementations. Transport (p. 1569) plugin instances
with mismatching classes are not allowed (by the RTI Connext Core) to
communicate with one another.
Multiple implementations (possibly from different vendors) for a physical
transport (p. 376) mechanism can co-exist in an RTI Connext application, provided they use different transport (p. 376) class IDs.
The class ID can also be used to distinguish between different transport
(p. 376) protocols over the same physical transport (p. 376) network (e.g.,
UDP vs. TCP over the IP routing infrastructure).
transport (p. 376) significant address bit count (see com.rti.ndds.transport.Transport.Property t.add
RTI Connexts addressing is modeled after the IPv6 and uses 128-bit
addresses ( java.net.InetAddress ) to route messages.
A transport (p. 376) plugin is expected to map the transports internal addressing scheme to 128-bit addresses. In general, this mapping is
likely to use only N least significant bits (LSB); these are specified by this
attribute.
>-------------- netmask ----------------<
+---------------------------------------+----------------------------+
|
Network Address
|
Transport Local Address |
+---------------------------------------+----------------------------+
>------------ N ------------<
address_bits_count
Only these bits are used
by the transport plugin.
380
The remaining bits of an address using the 128-bit address representation will be considered as part of the network address (see Transport
Network Address (p. 381)) and thus ignored by the transport (p. 376)
plugins internal addressing scheme.
For unicast addresses, the transport (p. 376) plugin is expected to ignore the higher (128 - com.rti.ndds.transport.Transport.Property t.address bit count (p. 1573)) bits. RTI Connext is free to manipulate
those bits freely in the addresses passed in/out to the transport (p. 376)
plugin APIs.
Theoretically, the significant address bits count, N is related to the size of
the underlying transport (p. 376) network as follows:
address bits count >= ceil(log2 (total addressable transport unicast interf aces))
The equality holds when the most compact (theoretical) internal address
mapping scheme is used. A practical address mapping scheme may waste
some bits.
7.19.6
Transport Instance Attributes
The per instance attributes to configure the plugin instance are generally passed
in to the plugin constructor. These are defined by the transport (p. 376) plugin
writer, and can be used to:
- customize the behavior of an instance of a transport (p. 376) plugin, including the send and the receiver buffer sizes, the maximum message size, various
transport (p. 376) level classes of service (CoS), and so on.
- specify the resource values, network interfaces to use, various transport
(p. 376) level policies, and so on.
RTI Connext requires that every transport (p. 376) plugin instance must
specify the com.rti.ndds.transport.Transport.Property t.message size max (p. 1574) and com.rti.ndds.transport.Transport.Property t.gather send buffer count max (p. 1574).
It is up to the transport (p. 376) plugin developer to make these available for
configuration to transport (p. 376) plugin user.
Note that it is important that the instance attributes are compatible between
the sending side and the receiving side of communicating applications using
different instances of a transport (p. 376) plugin class. For example (p. 375),
if one side is configured to send messages larger than can be received by the
other side, then communications via the plugin may fail.
7.19.7
381
Transport Network Address
The address bits not used by the transport (p. 376) plugin for its internal
addressing constitute its network address bits.
In order for RTI Connext to properly route the messages, each unicast interface
in the RTI Connext domain must have a unique address. RTI Connext allows
the user to specify the value of the network address when installing a transport (p. 376) plugin via the com.rti.ndds.transport.TransportSupport.register transport() API.
The network address for a transport (p. 376) plugin should be chosen such that
the resulting fully qualified 128-bit address will be unique in the RTI Connext
domain. Thus, if two instances of a transport (p. 376) plugin are registered
with a com.rti.dds.domain.DomainParticipant (p. 654), they will be at different network addresses in order for their unicast interfaces to have unique fully
qualified 128-bit addresses. It is also possible to create multiple transports with
the same network address, as it can be useful for certain use cases; note that
this will require special entity configuration for most transports to avoid clashes
in resource use (e.g. sockets for UDPv4 transport (p. 376)).
7.19.8
Transport Send Route
By default, a transport (p. 376) plugin is configured to send outgoing messages

destined to addresses in the network address range at which the plugin was
registered.
RTI Connext allows the user to configure the routing of outgoing messages via
the com.rti.ndds.transport.TransportSupport.add send route() API, so that a
transport (p. 376) plugin will be used to send messages only to certain ranges of
destination addresses. The method can be called multiple times for a transport
(p. 376) plugin, with different address ranges.
+--------------------------------------------------------------------+
|
Outgoing Address Range 1
->
Transport Plugin
|
+--------------------------------------------------------------------+
|
:
->
:
|
+--------------------------------------------------------------------+
|
Outgoing Address Range K
->
Transport Plugin
|
+--------------------------------------------------------------------+
The user can set up a routing table to restrict the use of a transport (p. 376)
plugin to send messages to selected addresses ranges.
382
7.19.9
Transport Receive Route
By default, a transport (p. 376) plugin is configured to receive incoming messages destined to addresses in the network address range at which the plugin
was registered.
RTI Connext allows the user to configure the routing of incoming messages via
the com.rti.ndds.transport.TransportSupport.add receive route() API, so that
a transport (p. 376) plugin will be used to receive messages only on certain
ranges of addresses. The method can be called multiple times for a transport
(p. 376) plugin, with different address ranges.
+--------------------------------------------------------------------+
|
Transport Plugin
<- Incoming Address Range 1 |
+--------------------------------------------------------------------+
|
:
<:
|
+--------------------------------------------------------------------+
|
Transport Plugin
<- Incoming Address Range M |
+--------------------------------------------------------------------+
The user can set up a routing table to restrict the use of a transport (p. 376)
plugin to receive messages from selected ranges. For example (p. 375), the user
may restrict a transport (p. 376) plugin to
- receive messages from a certain multicast address range.
- receive messages only on certain unicast interfaces (when multiple unicast
interfaces are available on the transport (p. 376) plugin).
Chapter 8
Class Documentation
8.1
AbstractBuiltinTopicDataTypeSupport
Class Reference
Inheritance diagram for AbstractBuiltinTopicDataTypeSupport::
Protected Member Functions

final void initialize delegateI (DataReaderDelegate delegate)
8.1.1
Abstract superclass for all TypeSupport classes for built-in types.

Author:
rwarren
Version:
Revision
1.17
Date
2009/11/01 18:04:49
384
Class Documentation
8.1.2
Member Function Documentation
8.1.2.1
final void initialize delegateI (DataReaderDelegate

delegate) [protected]
Subclasses should call this method immediately after chaining to the super constructor.
Exceptions:
NullPointerException if the delegate is null
8.2 AbstractPrimitiveSequence Class Reference
8.2
385
AbstractPrimitiveSequence Class Reference
Inheritance diagram for AbstractPrimitiveSequence::
Public Member Functions

final Class getElementType ()
abstract void add (int index, Object element)
Inserts the specified element at the specified position in this sequence.
void loan (Object buffer, int new length)

Loan a contiguous buffer to this sequence.
void unloan ()
Return the loaned buffer in the sequence and set the maximum to 0.
final boolean hasOwnership ()

Return the value of the owned flag.
final
final
final
final
8.2.1
void clear ()
void setSize (int newSize)
int size ()
Object copy from (Object src)
A base class for sequences whose elements are of primitive types. Such sequences
do not support null values.
8.2.2
8.2.2.1
final Class getElementType ()
Returns:
the primitive type of this sequence, not the wrapper type.
See also:
com.rti.dds.util.Sequence.getElementType() (p. 1430)
Reimplemented from AbstractSequence (p. 391).
386
Class Documentation
8.2.2.2
abstract void add (int index, Object element) [pure

virtual]

See also:
java.util.List.add(int, java.lang.Object)
Implemented in BooleanSeq (p. 422), ByteSeq (p. 446), CharSeq (p. 463),
DoubleSeq (p. 801), FloatSeq (p. 963), IntSeq (p. 1069), LongSeq
(p. 1186), and ShortSeq (p. 1447).
8.2.2.3
void loan (Object buffer, int new length)
Loan a contiguous buffer to this sequence.

This operation changes the owned flag of the sequence to
com.rti.dds.infrastructure.false and also sets the underlying buffer used
by the sequence. See the Users Manual for more information about sequences
and memory ownership.
Use this method if you want to manage the memory used by the sequence
yourself. You must provide an array of elements and integers indicating how
many elements are allocated in that array (i.e. the maximum) and how
many elements are valid (i.e. the length). The sequence will subsequently
use the memory you provide and will not permit it to be freed by a call to
com.rti.dds.infrastructure.com.rti.dds.util.Sequence.Sequence.setMaximum.
By default, a sequence you create owns its memory unless you explicitly
loan memory of your own to it. In a very few cases, RTI Connext will
return a sequence to you that has a loan; those cases are documented as
such. For example, if you call com.rti.ndds.example.FooDataReader.read
(p. 981) or com.rti.ndds.example.FooDataReader.take (p. 983) and pass
in sequences with no loan and no memory allocated, RTI Connext
will loan memory to your sequences which must be unloaned with
com.rti.ndds.example.FooDataReader.return loan (p. 1008). See the
documentation of those methods for more information.
Precondition:
com.rti.dds.infrastructure.com.rti.dds.util.Sequence.Sequence.getMaximum
== 0; i.e. the sequence has no memory allocated to it.
com.rti.dds.infrastructure.com.rti.dds.util.Sequence.AbstractPrimitiveSequence.hasOwnership
== com.rti.dds.infrastructure.true; i.e. the sequence does not already have
an outstanding loan
387
Postcondition:
The sequence will store its elements in the buffer provided.
com.rti.dds.infrastructure.com.rti.dds.util.Sequence.AbstractPrimitiveSequence.hasOwnership
== com.rti.dds.infrastructure.false
com.rti.dds.infrastructure.com.rti.dds.util.Sequence.Sequence.size()
==
new length
== new max
Parameters:
buffer The new buffer that the sequence will use. Must point to enough
memory to hold new max elements of type Foo. It may be NULL if
new max == 0.
new length The desired new length for the sequence.
Returns:
com.rti.dds.infrastructure.true if buffer is successfully loaned to this sequence or com.rti.dds.infrastructure.false otherwise. Failure only occurs
due to failing to meet the pre-conditions. Upon failure the sequence remains unmodified.
See also:
com.rti.dds.infrastructure.com.rti.dds.util.Sequence.unloan,
com.rti.dds.infrastructure.com.rti.dds.util.Sequence.loan discontiguous
8.2.2.4
void unloan ()
Return the loaned buffer in the sequence and set the maximum to 0.
This method affects only the state of this sequence; it does not change the
contents of the buffer in any way.
Only the user who originally loaned a buffer should return that loan, as the
user may have dependencies on that memory known only to them. Unloaning
someone elses buffer may cause unspecified problems. For example, suppose a
sequence is loaning memory from a custom memory pool. A user of the sequence
likely has no way to release the memory back into the pool, so unloaning the
sequence buffer would result in a resource leak. If the user were to then re-loan
a different buffer, the original creator of the sequence would have no way to
discover, when freeing the sequence, that the loan no longer referred to its own
memory and would thus not free the users memory properly, exacerbating the
situation and leading to undefined behavior.
388
Class Documentation
Precondition:
owned == com.rti.dds.infrastructure.false
Postcondition:
owned == com.rti.dds.infrastructure.true
maximum == 0
Returns:
com.rti.dds.infrastructure.true if the preconditions were met. Otherwise
com.rti.dds.infrastructure.false. The function only fails if the pre-conditions
are not met, in which case it leaves the sequence unmodified.
See also:
com.rti.dds.infrastructure.com.rti.dds.util.Sequence.AbstractPrimitiveSequence.loan(Object,
int),
com.rti.dds.infrastructure.com.rti.dds.util.Sequence.loan discontiguous, com.rti.dds.infrastructure.com.rti.dds.util.Sequence.Sequence.setMaximum
8.2.2.5

Returns:
com.rti.dds.infrastructure.true if sequence owns the underlying buffer, or
com.rti.dds.infrastructure.false if it has an outstanding loan.
8.2.2.6
final void clear ()
Set the logical size of this sequence to zero. This method does not generate any
garbage for collection.
See also:
java.util.Collection.clear()
8.2.2.7
final void setSize (int newSize)
Set the logical size of this sequence to the given value.

Parameters:
newSize the new logical size of this sequence; it must be less than or equal
to the maximum allocated length of the underlying array.
389
Exceptions:
IndexOutOfBoundsException if the new size is less than zero or greater
than the allocated length of the array.
See also:
AbstractSequence.getMaximum() (p. 1429)
8.2.2.8
final int size ()
The logical size of this sequence.

8.2.2.9
final Object copy from (Object src)
Implementation of the Copyable interface.

Parameters:
src An AbstractPrimitiveSequence (p. 385) which contains the data to
be copied.
Returns:
this
Exceptions:
NullPointerException If src is null.
ClassCastException If src is not a Sequence (p. 1428) OR if one of the
objects contained in the Sequence (p. 1428) is not of the expected
type.
Implements Copyable (p. 480).
390
Class Documentation
8.3
AbstractSequence Class Reference
Abstract sequence.
Inheritance diagram for AbstractSequence::

void setMaximum (int new max)
Resize this sequence to a new desired maximum.
Class getElementType ()
void add (int index, Object element)
boolean add (Object element)

Appends the specified element to the end of this sequence.
final Object remove (int index)

Remove the element at the given index by shifting all subsequent elements
left by one.
8.3.1
Abstract sequence.
8.3.2
8.3.2.1

This operation does nothing if the new desired maximum matches the current
maximum.
Note: If you add an element with add() (p. 391), the sequences size is increased implicitly.
Postcondition:
length == MINIMUM(original length, new max)
8.3 AbstractSequence Class Reference
391
Parameters:
new max Must be >= 0.
Returns:
com.rti.dds.infrastructure.true on success, com.rti.dds.infrastructure.false if
the preconditions are not met. In that case the sequence is not modified.
Implements Sequence (p. 1429).
Reimplemented in LoanableSequence (p. 1148).
8.3.2.2
Returns:
a common supertype for all elements in this sequence.
Reimplemented in AbstractPrimitiveSequence (p. 385).
8.3.2.3

See also:
Reimplemented in BooleanSeq (p. 422), ByteSeq (p. 446), CharSeq
(p. 463), DoubleSeq (p. 801), FloatSeq (p. 963), IntSeq (p. 1069), LongSeq
(p. 1186), ShortSeq (p. 1447), and AbstractPrimitiveSequence (p. 386).
8.3.2.4
boolean add (Object element)
Appends the specified element to the end of this sequence.

See also:
java.util.List.add(java.lang.Object)
392
Class Documentation
8.3.2.5
final Object remove (int index)
Remove the element at the given index by shifting all subsequent elements left
by one.
See also:
java.util.List.remove(int)
8.4 AcknowledgmentInfo Class Reference
8.4
393
AcknowledgmentInfo Class Reference

Inherits Status.
8.4.1

When acknowledging a sample, the reader provides the writer with information
about the sample being acknowledged. The AcknowledgmentInfo (p. 393)
structure provides the identity and cookie of the sample being acknowledged,
as well as user data payload provided by the reader.
394
Class Documentation
8.5
AckResponseData t Class Reference

Inherits Struct.
Public Attributes
final ByteSeq value
a sequence of octets
8.5.1
8.5.2
Member Data Documentation
8.5.2.1
final ByteSeq value
[default] empty (zero-length)
[range] Octet sequence of length [0, com.rti.dds.infrastructure.DataReaderResourceLimitsQosPo

app ack response length (p. 554)],
8.6 AllocationSettings t Class Reference
8.6
395
AllocationSettings t Class Reference

Inherits Struct.

AllocationSettings t (int initial count, int max count, int incremental count)
Constructor with the given initial, maximum and incremental values.
Public Attributes
int initial count
The initial count of resources.
int max count

The maximum count of resources.
int incremental count

The incremental count of resources.
8.6.1

QoS:
(p. 778)
8.6.2
Constructor & Destructor Documentation
8.6.2.1
AllocationSettings t (int initial count, int max count, int

incremental count)
Constructor with the given initial, maximum and incremental values.

396
Class Documentation
8.6.3
8.6.3.1
int initial count
The initial count of resources.

The initial resources to be allocated.
[default] It depends on the case.
[range] [0, 1 million], < max count, (or = max count only if increment count
== 0)
8.6.3.2
int max count
The maximum count of resources.

The maximum resources to be allocated.
[default] Depends on the case.
[range] [1, 1 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), > initial count (or = initial count only if increment count == 0)
8.6.3.3
int incremental count
The incremental count of resources.

The resource to be allocated when more resources are needed.
[default] Depends on the case.
[range] -1 (Double the amount of extra memory allocated each time memory
is needed) or [1,1 million] (or = 0 only if initial count == max count)
8.7 AsynchronousPublisherQosPolicy Class Reference
8.7
AsynchronousPublisherQosPolicy
Reference
397
Class

thread.
Inheritance diagram for AsynchronousPublisherQosPolicy::
Public Attributes
boolean disable asynchronous write
Disable asynchronous publishing.
final ThreadSettings t thread

Settings of the publishing thread.
boolean disable asynchronous batch

Disable asynchronous batch flushing.
final ThreadSettings t asynchronous batch thread

Settings of the batch flushing thread.
8.7.1

thread.
Specifies the asynchronous publishing and asynchronous batch flushing settings
of the com.rti.dds.publication.Publisher (p. 1262) instances.
The QoS policy specifies whether asynchronous publishing and asynchronous
batch flushing are enabled for the com.rti.dds.publication.DataWriter
(p. 557) entities belonging to this com.rti.dds.publication.Publisher
(p. 1262). If so, the publisher will spawn up to two threads, one for asynchronous
publishing and one for asynchronous batch flushing.
See also:
com.rti.dds.infrastructure.BatchQosPolicy (p. 412).
com.rti.dds.infrastructure.PublishModeQosPolicy (p. 1295).
398
Class Documentation
Entity:
com.rti.dds.publication.Publisher (p. 1262)
Properties:
RxO (p. 101) = N/A
Changeable (p. 102) = NO (p. 102)
8.7.2
Usage
You can use this QoS policy to reduce the amount of time your application
thread spends sending data.
You can also use it, along with com.rti.dds.infrastructure.PublishModeQosPolicy
(p. 1295) and a com.rti.dds.publication.FlowController (p. 964), to send
large data reliably. Large in this context means that the data that cannot
be sent as a single packet by a network transport. For example, to send data
larger than 63K reliably using UDP/IP, you must configure RTI Connext to
fragment the data and send it asynchronously.
The
asynchronous
publisher
thread
is
shared
by
all
PUBLISH MODE QOS
(p. 557)
instances that belong to this publisher and handles their data transmission
chores.
The
asynchronous
batch
flushing
thread
is
shared
by
all
com.rti.dds.publication.DataWriter (p. 557) instances with batching
enabled that belong to this publisher.
This QoS policy also allows you to adjust the settings of the asynchronous publishing and the asynchronous batch flushing threads. To use different threads for
two different com.rti.dds.publication.DataWriter (p. 557) entities, the instances must belong to different com.rti.dds.publication.Publisher (p. 1262)
instances.
A com.rti.dds.publication.Publisher (p. 1262) must have asynchronous
publishing enabled for its com.rti.dds.publication.DataWriter (p. 557) instances to write asynchronously.
A com.rti.dds.publication.Publisher (p. 1262) must have asynchronous batch flushing enabled in order to flush the batches of its
com.rti.dds.publication.DataWriter (p. 557) instances asynchronously.
However, no asynchronous batch flushing thread will be started until the
first com.rti.dds.publication.DataWriter (p. 557) instance with batching
enabled is created from this com.rti.dds.publication.Publisher (p. 1262).
8.7.3
8.7.3.1
boolean disable asynchronous write
399
Disable asynchronous publishing.

If
set
to
com.rti.dds.infrastructure.true,
any
created
with
(p. 557)
com.rti.dds.infrastructure.PublishModeQosPolicyKind.PublishModeQosPolicyKind.ASYNCHRONOUS PUBLISH MODE QOS will fail with com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY (p. 1359).
[default] com.rti.dds.infrastructure.false
8.7.3.2
Settings of the publishing thread.

There
is
only
one
asynchronous
publishing
thread
per
[default] priority below normal.

The actual value depends on your architecture:
For Windows: -2
For Solaris: OS default priority
For Linux: OS default priority
For LynxOS: 13
For Integrity: 80
For VxWorks: 110
For all others: OS default priority.
[default] The actual value depends on your architecture:
For Windows: OS default stack size
For Solaris: OS default stack size
For Linux: OS default stack size
For LynxOS: 4161024
For Integrity: 4201024
For VxWorks: 4161024
For all others: OS default stack size.
[default] mask = com.rti.dds.infrastructure.ThreadSettingsKind.THREAD Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
400
Class Documentation
SETTINGS KIND MASK DEFAULT (p. 116)
8.7.3.3
boolean disable asynchronous batch
Disable asynchronous batch flushing.

If
set
to
any
com.rti.dds.publication.DataWriter (p. 557) created with batching enabled will fail with com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY (p. 1359).
If
com.rti.dds.infrastructure.BatchQosPolicy.max flush delay
(p. 414) is different than com.rti.dds.infrastructure.Duration t.INFINITE,
com.rti.dds.infrastructure.AsynchronousPublisherQosPolicy.disable asynchronous batch (p. 400) must be set com.rti.dds.infrastructure.false.
8.7.3.4
final ThreadSettings t asynchronous batch thread
Settings of the batch flushing thread.

There
is
only one asynchronous
batch
flushing
thread
per
[default] priority below normal.

For Windows: -2
For LynxOS: 13
For Integrity: 80
For VxWorks: 110
For LynxOS: 4161024
For Integrity: 4201024
401

[default] mask = com.rti.dds.infrastructure.ThreadSettingsKind.THREAD SETTINGS KIND MASK DEFAULT (p. 116)
402
Class Documentation
8.8
AvailabilityQosPolicy Class Reference

Inheritance diagram for AvailabilityQosPolicy::
Public Attributes
boolean enable required subscriptions
Enables
support
for
required
subscriptions
com.rti.dds.publication.DataWriter ( p. 557).
in
final Duration t max data availability waiting time

Defines how much time to wait before delivering a sample to the application
without having received some of the previous samples.
final Duration t max endpoint availability waiting time

Defines how much time to wait to discover DataWriters providing samples
for the same data source (virtual GUID).
final EndpointGroupSeq required matched endpoint groups

A sequence of endpoint groups.
8.8.1

Entity:
com.rti.dds.publication.DataWriter (p. 557)
(p. 487),
Properties:
RxO (p. 101) = NO
Changeable
(p. 102)
=
YES
(p. 102)
(only
on
a
com.rti.dds.publication.DataWriter (p. 557) except for the member
com.rti.dds.infrastructure.AvailabilityQosPolicy.enable required subscriptions (p. 404))
8.8 AvailabilityQosPolicy Class Reference
8.8.2
403
Usage
This QoS policy is used in the context of two features:

Collaborative DataWriters
Required Subscriptions
The Collaborative DataWriters feature allows having multiple DataWriters publishing samples from a common logical data source. The DataReaders will
combine the samples coming from the DataWriters in order to reconstruct the
correct order at the source.
This QoS policy allows you to configure the ordering and combination process
in the DataReader and can be used to support two different use cases:
Ordered
delivery
of
samples
with
RTI
Persistence
Service:
When a late-joining DataReader configured with
com.rti.dds.infrastructure.DurabilityQosPolicy (p. 802) set to
com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.PERSISTENT DURABILITY QOS or com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.TRANSI
DURABILITY QOS joins a DDS domain (p. 328), it will start receiving
historical samples from multiple DataWriters. For example, if the original
DataWriter is still alive, the newly created DataReader will receive
samples from the original DataWriter and one or more RTI Persistence
Service DataWriters (PRSTDataWriters). This policy can be used to
configure the sample ordering process on the DataReader.
Ordered delivery of samples with Group Ordered Access:

This policy can also be used to configure the sample ordering process when the Subscriber is configured with
com.rti.dds.infrastructure.PresentationQosPolicy (p. 1221) access scope set to com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPolicyAcce
PRESENTATION QOS. In this case, the Subscriber must deliver in order the samples published by a group of DataWriters
that belong to the same Publisher and have access scope set to
com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPolicyAccessScopeKind.GR
PRESENTATION QOS.
Each sample published in a DDS domain (p. 328) for a given logical data source
is uniquely identified by a pair (virtual GUID, virtual sequence number). Samples from the same data source (same virtual GUID) can be published by different DataWriters. A DataReader will deliver a sample (VGUIDn, VSNm) to
the application if one of the following conditions is satisfied:
404
Class Documentation
(VGUIDn, VSNm-1) has already been delivered to the application.
All the known DataWriters publishing VGUIDn have announced that they
do not have (VGUIDn, VSNm-1).
None of the known DataWriters publishing GUIDn have announced potential availability of (VGUIDn, VSNm-1) and both timeouts in this QoS
policy have expired.
A DataWriter announces potential availability of samples by using virtual heartbeats (HBs).
When com.rti.dds.infrastructure.PresentationQosPolicy.access scope

(p. 1225) is set to com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPoli
PRESENTATION QOS or com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.Presentati
PRESENTATION QOS, the virtual HB contains information about the samples
contained in the com.rti.dds.publication.DataWriter (p. 557) history.

PRESENTATION QOS, the virtual HB contains information about all
DataWriters in the com.rti.dds.publication.Publisher (p. 1262).
The
frequency
at
which
virtual
HBs
are
sent
is
controlled
by
the
protocol
parameters
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.virtual heartbeat period (p. 1377) and com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.samples per virtual heartbeat (p. 1378).
In the context of Required Subscriptions, this QoS policy can
be used to configure a set of Required Subscriptions on a
Required subscriptions are preconfigured, named subscriptions that may leave
and subsequently rejoin the network from time to time, at the same or different
physical locations. Any time a required subscription (p. 353) is disconnected,
any samples that would have been delivered to it are stored for delivery if and
when the subscription (p. 353) rejoins the network.
8.8.3
8.8.3.1
boolean enable required subscriptions
Enables
support
for
required
subscriptions
in
8.8 AvailabilityQosPolicy Class Reference

8.8.3.2
405
final Duration t max data availability waiting time
Defines how much time to wait before delivering a sample to the application
without having received some of the previous samples.
A sample identified by (VGUIDn, VSNm) will be delivered to the application if
this timeout expires for the sample and the following two conditions are satisfied:
None of the known DataWriters publishing VGUIDn have announced potential availability of (VGUIDn, VSNm-1).
The DataWriters for all the endpoint groups specified in required matched endpoint groups (p. 406) have been discovered or max endpoint availability waiting time (p. 405) has expired.
This field is not applicable to Required Subscriptions.
[default]
com.rti.dds.infrastructure.Duration t.AUTO
(com.rti.dds.infrastructure.Duration t.INFINITE
for
com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPolicyAccessScopeKind.GROUP
PRESENTATION QOS. Otherwise, 0 seconds)
[range]
[0,
com.rti.dds.infrastructure.Duration t.INFINITE],
8.8.3.3
final Duration t max endpoint availability waiting time
Defines how much time to wait to discover DataWriters providing samples for
the same data source (virtual GUID).
The set of endpoint groups that are required to provide samples for a data source
can be configured using required matched endpoint groups (p. 406).
A non-consecutive sample identified by (VGUIDn, VSNm) cannot be delivered
to the application unless DataWriters for all the endpoint groups in required matched endpoint groups (p. 406) are discovered or this timeout expires.
This field is not applicable to Required Subscriptions.
[default]
(com.rti.dds.infrastructure.Duration t.INFINITE
for
PRESENTATION QOS. Otherwise, 0 seconds)
406
Class Documentation
[range]
[0,
com.rti.dds.infrastructure.Duration t.INFINITE],
8.8.3.4
final EndpointGroupSeq required matched endpoint groups
A sequence of endpoint groups.

In the context of Collaborative DataWriters, it specifies the set of endpoint
groups that are expected to provide samples for the same data source.
The quorum count in a group represents the number of DataWriters that must
be discovered for that group before the DataReader is allowed to provide non
consecutive samples to the application.
A DataWriter becomes a member of an endpoint group by configuring the
role name in com.rti.dds.publication.DataWriterQos.publication name
(p. 615).
In the context of Required Subscriptions, it specifies the set of Required Subscriptions on a com.rti.dds.publication.DataWriter (p. 557).
Each Required Subscription is specified by a name and a quorum count.
The quorum count represents the number of DataReaders that have to acknowledge the sample before it can be considered fully acknowledged for that Required
Subscription.
A DataReader is associated with a Required Subscription by configuring the
role name in com.rti.dds.subscription.DataReaderQos.subscription name (p. 541).
[default] Empty sequence
8.9 BAD PARAM Class Reference
8.9
407
BAD PARAM Class Reference
The exception BadKind (p. 409) is thrown when an inappropriate operation is

invoked on a TypeCode object.
Inheritance diagram for BAD PARAM::
8.9.1

408
Class Documentation
8.10
BAD TYPECODE Class Reference

Inheritance diagram for BAD TYPECODE::
8.10.1

8.11 BadKind Class Reference
8.11
409
BadKind Class Reference

Inheritance diagram for BadKind::
8.11.1

410
Class Documentation
8.12
BadMemberId Class Reference
The specified com.rti.dds.typecode.TypeCode (p. 1611) member ID is invalid.

Inheritance diagram for BadMemberId::
8.12.1
The specified com.rti.dds.typecode.TypeCode (p. 1611) member ID is invalid.

This failure can occur, for example, when querying a field by ID when no such
ID is defined in the type.
See also:
com.rti.dds.infrastructure.ExceptionCode t.BadMemberName
8.13 BadMemberName Class Reference
8.13
411
BadMemberName Class Reference
The specified com.rti.dds.typecode.TypeCode (p. 1611) member name is

invalid.
Inheritance diagram for BadMemberName::
8.13.1
The specified com.rti.dds.typecode.TypeCode (p. 1611) member name is

invalid.
This failure can occur, for example, when querying a field by name when no
such name is defined in the type.
See also:
com.rti.dds.infrastructure.ExceptionCode t.BadMemberId
412
Class Documentation
8.14
BatchQosPolicy Class Reference
Used to configure batching of multiple samples into a single network packet in

order to increase throughput for small samples.
Inheritance diagram for BatchQosPolicy::
Public Attributes
boolean enable
Specifies whether or not batching is enabled.
int max data bytes

The maximum cumulative length of all serialized samples in a batch.
int max samples

The maximum number of samples in a batch.
final Duration t max flush delay

The maximum flush delay.
final Duration t source timestamp resolution

Batch source timestamp resolution.
boolean thread safe write

Determines whether or not the write operation is thread safe.
8.14.1
Used to configure batching of multiple samples into a single network packet in

order to increase throughput for small samples.
This QoS policy configures the ability of the middleware to collect multiple user
data samples to be sent in a single network packet, to take advantage of the
efficiency of sending larger packets and thus increase effective throughput.
This QoS policy can be used to dramatically increase effective throughput for
small data samples. Usually, throughput for small samples (size < 2048 bytes) is
limited by CPU capacity and not by network bandwidth. Batching many smaller
samples to be sent in a single large packet will increase network utilization, and
thus throughput, in terms of samples per second.
413
Entity:
Properties:
RxO (p. 101) = NO
Changeable (p. 102) = UNTIL ENABLE (p. 102)
8.14.2
8.14.2.1
boolean enable
Specifies whether or not batching is enabled.

8.14.2.2
int max data bytes
The maximum cumulative length of all serialized samples in a batch.

A batch is flushed automatically when this maximum is reached.
max data bytes does not include the meta data associated with the batch samples. Each sample has at least 8 bytes of meta data containing information such
as the timestamp and sequence number. The meta data can be as large as 52
bytes for keyed topics and 20 bytes for unkeyed topics.
Note: Batches must contain whole samples. If a new batch is started and its
initial sample causes the serialized size to exceed max data bytes, RTI Connext
will send the sample in a single batch.
[default] 1024
[range] [1,com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106)]
8.14.3
Consistency
The
setting
of
com.rti.dds.infrastructure.BatchQosPolicy.max data bytes
(p. 413)
must
be
consistent
with
com.rti.dds.infrastructure.BatchQosPolicy.max samples
(p. 414).
For these two values to be consistent, they cannot be both
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106).
414
Class Documentation
8.14.3.1
int max samples
The maximum number of samples in a batch.

A batch is flushed automatically when this maximum is reached.
[default] com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106)
8.14.4
Consistency
The
setting
of
com.rti.dds.infrastructure.BatchQosPolicy.max samples
(p. 414)
must
be
consistent
with
com.rti.dds.infrastructure.BatchQosPolicy.max data bytes
(p. 413).
For these two values to be consistent, they cannot be both
8.14.4.1
final Duration t max flush delay
The maximum flush delay.

A batch is flushed automatically after the delay specified by this parameter.
The delay is measured from the time the first sample in the batch is written by
the application.
[default] com.rti.dds.infrastructure.Duration t.INFINITE
[range] [0,com.rti.dds.infrastructure.Duration t.INFINITE]
8.14.5
Consistency
The
setting
of
com.rti.dds.infrastructure.BatchQosPolicy.max flush delay
(p. 414)
must
be
consistent
with
com.rti.dds.infrastructure.AsynchronousPublisherQosPolicy.disable asynchronous batch (p. 400) and com.rti.dds.infrastructure.BatchQosPolicy.thread safe write
(p. 415).
If
the
delay
is
different
than
com.rti.dds.infrastructure.Duration t.INFINITE,
com.rti.dds.infrastructure.AsynchronousPublisherQosPolicy.disable asynchronous batch (p. 400) must be set to com.rti.dds.infrastructure.false
and
com.rti.dds.infrastructure.BatchQosPolicy.thread safe write
(p. 415) must be set to com.rti.dds.infrastructure.true.

8.14.5.1
415
final Duration t source timestamp resolution
Batch source timestamp resolution.

The value of this field determines how the source timestamp is associated with
the samples in a batch.
A sample written with timestamp t inherits the source timestamp t2 associated with the previous sample unless (t - t2) > source timestamp resolution.
If source timestamp resolution is set to com.rti.dds.infrastructure.Duration t.INFINITE, every sample in the batch will share the source timestamp associated with the first sample.
If source timestamp resolution is set to zero, every sample in the batch will
contain its own source timestamp corresponding to the moment when the sample
was written.
The performance of the batching process is better when source timestamp resolution is set to com.rti.dds.infrastructure.Duration t.INFINITE.
8.14.6
Consistency
The setting of com.rti.dds.infrastructure.BatchQosPolicy.source timestamp resolution

(p. 415)
must
be
consistent
with
(p. 415).
If com.rti.dds.infrastructure.BatchQosPolicy.thread safe write
(p. 415)
is
set
to
com.rti.dds.infrastructure.false,
com.rti.dds.infrastructure.BatchQosPolicy.source timestamp resolution (p. 415) must be set to com.rti.dds.infrastructure.Duration t.INFINITE.
8.14.6.1
boolean thread safe write
Determines whether or not the write operation is thread safe.

If this parameter is set to com.rti.dds.infrastructure.true, multiple threads can
call write on the com.rti.dds.publication.DataWriter (p. 557) concurrently.
[default] com.rti.dds.infrastructure.true
416
Class Documentation
8.14.7
Consistency
The setting of com.rti.dds.infrastructure.BatchQosPolicy.thread safe write

(p. 415)
must
be
consistent
with
com.rti.dds.infrastructure.BatchQosPolicy.source timestamp resolution (p. 415). If com.rti.dds.infrastructure.BatchQosPolicy.thread (p. 415)
is
set
to
safe write
com.rti.dds.infrastructure.BatchQosPolicy.source timestamp resolution (p. 415) must be set to com.rti.dds.infrastructure.Duration t.INFINITE.
8.15 BooleanSeq Class Reference
8.15
417
BooleanSeq Class Reference

boolean >.
Inheritance diagram for BooleanSeq::

BooleanSeq ()
Constructs an empty sequence of booleans with an initial maximum of zero.
BooleanSeq (int initialMaximum)

Constructs an empty sequence of booleans with the given initial maximum.
BooleanSeq (boolean[ ] booleans)

Constructs a new sequence containing the given booleans.
boolean addAllBoolean (boolean[ ] elements, int offset, int length)

Append length elements from the given array to this sequence, starting at
index offset in that array.
boolean addAllBoolean (boolean[ ] elements)

void addBoolean (boolean element)
Append the element to the end of the sequence.
void addBoolean (int index, boolean element)

Shift all elements in the sequence starting from the given index and add the
element to the given index.
boolean getBoolean (int index)

Returns the boolean at the given index.
boolean setBoolean (int index, boolean element)

Set the new boolean at the given index and return the old boolean.
void setBoolean (int dstIndex, boolean[ ] elements, int srcIndex, int

length)
Copy a portion of the given array into this sequence.
boolean[ ] toArrayBoolean (boolean[ ] array)

418
Class Documentation
Return an array containing copy of the contents of this sequence.
int getMaximum ()
Get the current maximum number of elements that can be stored in this
sequence.
Object get (int index)

A wrapper for getBoolean(int) ( p. 419) that returns a java.lang.Boolean.
Object set (int index, Object element)

A wrapper for setBoolean() ( p. 420).

A wrapper for addBoolean(int, int).
8.15.1

boolean >.
Instantiates:
<<generic>> ( p. 279) com.rti.dds.infrastructure.com.rti.dds.util.Sequence
See also:
boolean
8.15.2
8.15.2.1
BooleanSeq ()
Constructs an empty sequence of booleans with an initial maximum of zero.

8.15.2.2
BooleanSeq (int initialMaximum)
Constructs an empty sequence of booleans with the given initial maximum.

8.15.2.3
BooleanSeq (boolean[ ] booleans)
Constructs a new sequence containing the given booleans.

419
Parameters:
booleans the initial contents of this sequence
Exceptions:
NullPointerException if the input array is null
8.15.3
8.15.3.1
boolean addAllBoolean (boolean[ ] elements, int offset,

int length)
Append length elements from the given array to this sequence, starting at index
offset in that array.
Exceptions:
NullPointerException if the given array is null.
8.15.3.2
boolean addAllBoolean (boolean[ ] elements)
Exceptions:
NullPointerException if the given array is null
8.15.3.3
void addBoolean (boolean element)

8.15.3.4
void addBoolean (int index, boolean element)
8.15.3.5
boolean getBoolean (int index)
Returns the boolean at the given index.

Exceptions:
IndexOutOfBoundsException if the index is out of bounds.
420
Class Documentation
8.15.3.6
boolean setBoolean (int index, boolean element)
Set the new boolean at the given index and return the old boolean.
Exceptions:
8.15.3.7
void setBoolean (int dstIndex, boolean[ ] elements, int

srcIndex, int length)

Parameters:
dstIndex the index at which to start copying into this sequence.
elements an array of primitive elements.
srcIndex the index at which to start copying from the given array.
length the number of elements to copy.
Exceptions:
IndexOutOfBoundsException if copying would cause access of data
outside array bounds.
8.15.3.8
boolean [ ] toArrayBoolean (boolean[ ] array)

Parameters:
array The array into which this sequence should be copied. It may be
null. If it is, or if array length is too small, the array will be ignored,
and a new array of the necessary length will be created and copied
into instead.
Returns:
A non-null array containing a copy of the contents of this sequence.

8.15.3.9
421
int getMaximum ()
Get the current maximum number of elements that can be stored in this sequence.
The maximum of the sequence represents the maximum number of elements that
the underlying buffer can hold. It does not represent the current number of
elements.
The maximum is a non-negative number. It is initialized when the sequence is
first created.
The maximum can be changed implicitly by adding an element
or explicitly by calling
to the sequence with add() (p. 422),
Returns:
the current maximum of the sequence.
See also:
8.15.3.10
Object get (int index) [virtual]
A wrapper for getBoolean(int) (p. 419) that returns a java.lang.Boolean.

See also:
java.util.List.get(int)
Implements AbstractPrimitiveSequence (p. 385).
8.15.3.11
Object set (int index, Object element) [virtual]
A wrapper for setBoolean() (p. 420).

Exceptions:
ClassCastException if the element is not of type Boolean.
See also:
java.util.List.set(int, java.lang.Object)
422
Class Documentation
8.15.3.12
void add (int index, Object element) [virtual]
A wrapper for addBoolean(int, int).

Exceptions:
ClassCastException if the element is not of type Boolean.
See also:
8.16 Bounds Class Reference
8.16
Bounds Class Reference
Inheritance diagram for Bounds::
8.16.1
423
424
Class Documentation
8.17
BuiltinTopicKey t Class Reference
The key type of the built-in topic (p. 359) types.

Inheritance diagram for BuiltinTopicKey t::

void copy from (BuiltinTopicKey t other)
Copy value of a data type from source.
Public Attributes
final int[ ] value
An array of four integers that uniquely
com.rti.dds.infrastructure.Entity ( p. 931).
8.17.1
represents
remote
The key type of the built-in topic (p. 359) types.

Each remote com.rti.dds.infrastructure.Entity (p. 931) to be discovered is
can be uniquely identified by this key. This is the key of all the built-in topic
(p. 359) data types.
See also:
builtin.TopicBuiltinTopicData (p. 1552)
8.17.2
8.17.2.1
void copy from (BuiltinTopicKey t other)
Exceptions:
NullPointerException if other is null.
8.17 BuiltinTopicKey t Class Reference

8.17.2.2
425

Copy data into this object from another. This copy is intended to be a deep
copy, so that all data members (recursively) are copied (not just resetting Object
references).
This operation returns the object that is copied if copy is successful.
Parameters:
src <<in>> ( p. 279) The Object which contains the data to be copied.
Returns:
Generally, return this but special cases (such as Enum) exist.
Exceptions:
ClassCastException If src is not the same type as this.
8.17.3
8.17.3.1
final int [ ] value
An array of four integers that uniquely

represents
remote
426
Class Documentation
8.18
BuiltinTopicReaderResourceLimits t
Class Reference
Built-in topic (p. 359) readers resource limits.

Inherits Struct.

BuiltinTopicReaderResourceLimits t ()
Constructor with default initial and maximum values.
BuiltinTopicReaderResourceLimits t (int initial samples, int

max samples, int initial infos, int max infos, int initial outstanding reads, int max outstanding reads, int max samples per read, boolean
disable fragmentation support, int max fragmented samples, int
initial fragmented samples, int max fragmented samples per remote writer, int max fragments per sample, boolean dynamically allocate fragmented samples)
Constructor with the given initial and maximum values.
Public Attributes
int initial samples
Initial number of samples.
int max samples

Maximum number of samples.
int initial infos

Initial number of sample infos.
int max infos

Maximum number of sample infos.
boolean disable fragmentation support = false

int max fragmented samples = 1024
int initial fragmented samples = 4
int max fragmented samples per remote writer = 256
int max fragments per sample = 512
boolean dynamically allocate fragmented samples = true
8.18 BuiltinTopicReaderResourceLimits t Class Reference
8.18.1
427
Built-in topic (p. 359) readers resource limits.

Defines the resources that can be used for a built-in-topic data reader.
A built-in topic (p. 359) data reader subscribes reliably to built-in topics containing declarations of new entities or updates to existing entities in the domain
(p. 328). Keys are used to differentiate among entities of the same type. RTI
Connext assigns a unique key to each entity in a domain (p. 328).
Properties:
RxO (p. 101) = N/A
QoS:
8.18.2
8.18.2.1
BuiltinTopicReaderResourceLimits t ()
Constructor with default initial and maximum values.

8.18.2.2
BuiltinTopicReaderResourceLimits t (int
initial samples, int max samples, int initial infos,
int max infos, int initial outstanding reads, int
max outstanding reads, int max samples per read,
boolean disable fragmentation support, int
max fragmented samples, int initial fragmented samples,
int max fragmented samples per remote writer,
int max fragments per sample, boolean
dynamically allocate fragmented samples)
Constructor with the given initial and maximum values.
8.18.3
8.18.3.1
int initial samples
Initial number of samples.

This should be a value between 1 and initial number of instance of the built-intopic reader, depending on how many instances are sending data concurrently.
428
Class Documentation
[default] 64
[range] [1, 1 million], <= max samples
8.18.3.2
int max samples
Maximum number of samples.

This should be a value between 1 and max number of instance of the built-intopic reader, depending on how many instances are sending data concurrently.
Also, it should not be less than initial samples.
[range] [1, 1 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), >= initial samples
8.18.3.3
int initial infos
Initial number of sample infos.

The initial number of info units that a built-in topic (p. 359)
com.rti.dds.subscription.DataReader (p. 487) can have.
Info units
are used to store com.rti.dds.subscription.SampleInfo (p. 1398).
[default] 64
[range] [1, 1 million] <= max infos
8.18.3.4
int max infos
Maximum number of sample infos.

The maximum number of info units that a built-in topic (p. 359)
com.rti.dds.subscription.DataReader (p. 487) can use to store
com.rti.dds.subscription.SampleInfo (p. 1398).
[range] [1, 1 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), >= initial infos
8.18.3.5
DiscoveryBuiltinReaderFragmentationResourceLimits t disable fragmentation support

8.18 BuiltinTopicReaderResourceLimits t Class Reference

8.18.3.6
429
DiscoveryBuiltinReaderFragmentationResourceLimits t max fragmented samples

8.18.3.7
DiscoveryBuiltinReaderFragmentationResourceLimits t initial fragmented samples

8.18.3.8
DiscoveryBuiltinReaderFragmentationResourceLimits t max fragmented samples per remote writer

8.18.3.9
DiscoveryBuiltinReaderFragmentationResourceLimits t max fragments per sample

8.18.3.10
boolean dynamically allocate fragmented samples = true
DiscoveryBuiltinReaderFragmentationResourceLimits t dynamically allocate fragmented samples
430
Class Documentation
8.19
Bytes Class Reference

Inheritance diagram for Bytes::

Bytes ()
Default Constructor.
Bytes (Bytes src)

Copy constructor.
Bytes (int theLength)

Constructor that specifies the size of the allocated bytes array.
Bytes (byte[ ] src)

Copy src into this object.
Public Attributes
int length
Number of bytes to serialize.
int offset
Offset from which to start serializing bytes .
byte[ ] value
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes array value.
8.19.1

8.19 Bytes Class Reference
8.19.2
8.19.2.1
Bytes ()
431
The default constructor initializes the newly created object with null value, zero
length, and zero offset.
8.19.2.2
Bytes (Bytes src)
Copy constructor.
Parameters:
src <<in>> ( p. 279) Object to copy from.
Exceptions:
NullPointerException if src is null.
8.19.2.3
Bytes (int theLength)
Constructor that specifies the size of the allocated bytes array.

After this method is called, length and offset are set to zero.
Parameters:
size <<in>> ( p. 279) Size of the allocated bytes array.
Exceptions:
IllegalArgumentException if size is negative
8.19.2.4
Bytes (byte[ ] src)
Create a new Bytes (p. 430) object to wrap the given array.
The value field will point to the given array. The offset will be set to 0. The
length will be set to the length of the array unless the array is null, in which
case the length will be set to 0 also.
432
Class Documentation
8.19.3
8.19.3.1

This method performs a deep copy of src and it allocates memory for the value
if required.
Parameters:
Returns:
this if success. Otherwise, null.
Exceptions:
8.19.4
8.19.4.1
int length

8.19.4.2
int offset

The first position of the bytes array has offset 0.
8.19.4.3
byte [ ] value
8.20 BytesDataReader Class Reference
8.20
433
BytesDataReader Class Reference
Instantiates
DataReader
<<interface>>
( p. 279)
<
Inheritance diagram for BytesDataReader::

void read (BytesSeq received data, SampleInfoSeq info seq, int max samples, int sample states, int view states, int instance states)
Access
a
collection
of
data
samples
from
the
void take (BytesSeq received data, SampleInfoSeq info seq, int max samples, int sample states, int view states, int instance states)
Access
a
collection
of
data-samples
from
the
void read w condition (BytesSeq received data, SampleInfoSeq

info seq, int max samples, ReadCondition condition)
Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesDataReader.read
the
samples
that
match
the
criteria
specified
in
the
com.rti.dds.subscription.ReadCondition ( p. 1313).
void take w condition (BytesSeq received data, SampleInfoSeq

Analogous to com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesDataReader.read w condition
except
it
accesses
samples
via
the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesDataReader.take
operation.
void read next sample (Bytes received data, SampleInfo sample info)
Copies the next not-previously-accessed data
value
from
the
void take next sample (Bytes received data, SampleInfo sample info)
value
from
the
void return loan (BytesSeq received data, SampleInfoSeq info seq)

434
Class Documentation
Indicates to the com.rti.dds.subscription.DataReader ( p. 487) that
the application is done accessing the collection of received data and
info seq obtained by some earlier invocation of read or take on the
8.20.1
Instantiates
DataReader
<<interface>>
( p. 279)
<
See also:
com.rti.ndds.example.FooDataReader (p. 979)
com.rti.dds.subscription.DataReader (p. 487)
8.20.2
8.20.2.1
void read (BytesSeq received data, SampleInfoSeq

info seq, int max samples, int sample states, int
view states, int instance states)
Access
a
collection
of
data
samples
from
the
See also:
com.rti.ndds.example.FooDataReader.read (p. 981)
8.20.2.2
void take (BytesSeq received data, SampleInfoSeq

Access
a
collection
of
data-samples
from
the
See also:
com.rti.ndds.example.FooDataReader.take (p. 983)
8.20 BytesDataReader Class Reference

8.20.2.3
435
void read w condition (BytesSeq received data,

SampleInfoSeq info seq, int max samples, ReadCondition
condition)
Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesDataReader.read

the
samples
that
match
the
criteria
specified
in
the
com.rti.dds.subscription.ReadCondition (p. 1313).
See also:
com.rti.ndds.example.FooDataReader.read w condition (p. 990)
8.20.2.4
void take w condition (BytesSeq received data,

SampleInfoSeq info seq, int max samples, ReadCondition
condition)
Analogous to com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesDataReader.read w condition

except
it
accesses
samples
via
the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesDataReader.take
operation.
See also:
com.rti.ndds.example.FooDataReader.take w condition (p. 991)
8.20.2.5
void read next sample (Bytes received data, SampleInfo

sample info)
Copies
the
next
not-previously-accessed data
value
from
the
See also:
com.rti.ndds.example.FooDataReader.read next sample (p. 993)
8.20.2.6
void take next sample (Bytes received data, SampleInfo

sample info)
Copies
the
next
value
from
the
See also:
com.rti.ndds.example.FooDataReader.take next sample (p. 994)
436
Class Documentation
8.20.2.7
void return loan (BytesSeq received data, SampleInfoSeq

info seq)
Indicates to the com.rti.dds.subscription.DataReader (p. 487) that

See also:
com.rti.ndds.example.FooDataReader.return loan (p. 1008)
8.21 BytesDataWriter Class Reference
8.21
437
BytesDataWriter Class Reference
<<interface>>
( p. 279)
Instantiates
DataWriter
<
Inheritance diagram for BytesDataWriter::

void write (Bytes instance data, InstanceHandle t handle)
Modifies the value of a com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes
data instance.
void write (byte[ ] octets, int offset, int length, InstanceHandle t handle)
<<eXtension>>
(p. 278)
Modifies
the
value
of
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes data instance.
void write (ByteSeq octets, InstanceHandle t handle)

<<eXtension>>
(p. 278)
Modifies
the
value
of
void write w timestamp (Bytes instance data, InstanceHandle t

handle, Time t source timestamp)
Performs the same function as com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesDataWriter.write
except that it also provides the value for the source timestamp.
void write w timestamp (byte[ ] octets, int offset, int length, InstanceHandle t handle, Time t source timestamp)
<<eXtension>>
(p. 278)
Performs
the
same
function
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesDataWriter.BytesDataWriter.write
void write w timestamp (ByteSeq octets, InstanceHandle t handle,

Time t source timestamp)
<<eXtension>>
(p. 278)
Performs
the
same
function
as
438
Class Documentation
8.21.1
<<interface>>
( p. 279)
Instantiates
DataWriter
<
See also:
com.rti.ndds.example.FooDataWriter (p. 1012)
8.21.2
8.21.2.1
void write (Bytes instance data, InstanceHandle t handle)
Modifies the value of a com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes

data instance.
See also:
com.rti.ndds.example.FooDataWriter.write (p. 1021)
8.21.2.2
void write (byte[ ] octets, int offset, int length,

InstanceHandle t handle)
Modifies
the
value
of
<<eXtension>>
( p. 278)
Parameters:
octets <<in>> ( p. 279) Array of bytes to be published.
offset <<in>> ( p. 279) Offset from which to start publishing.
length <<in>> ( p. 279) Number of bytes to be published.
handle <<in>>
( p. 279)
The
special
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL should be used always.
value
See also:
8.21.2.3
void write (ByteSeq octets, InstanceHandle t handle)
<<eXtension>>
( p. 278)
Modifies
the
value
of
8.21 BytesDataWriter Class Reference
439
Parameters:
octets <<in>> ( p. 279) Sequence of bytes to be published.
handle <<in>>
( p. 279)
The
special
value
See also:
8.21.2.4
void write w timestamp (Bytes instance data,

InstanceHandle t handle, Time t source timestamp)
Performs the same function as com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesDataWriter.write

See also:
com.rti.ndds.example.FooDataWriter.write w timestamp (p. 1024)
8.21.2.5
void write w timestamp (byte[ ] octets, int offset,

int length, InstanceHandle t handle, Time t
source timestamp)
<<eXtension>>
( p. 278)
Performs
the
same
function
as
Parameters:
handle <<in>>
( p. 279)
The
special
value
source timestamp <<in>> ( p. 279) The timestamp value must be
greater than or equal to the timestamp value used in the last writer
operation. See com.rti.ndds.example.FooDataWriter.write w timestamp (p. 1024). Cannot be NULL.
See also:
440
Class Documentation
8.21.2.6
void write w timestamp (ByteSeq octets,

<<eXtension>>
( p. 278)
Performs
the
same
function
as
Parameters:
handle <<in>>
( p. 279)
The
special
value

See also:
8.22 ByteSeq Class Reference
8.22
441
ByteSeq Class Reference

byte >.
Inheritance diagram for ByteSeq::

ByteSeq ()
Constructs an empty sequence of bytes with an initial maximum of zero.
ByteSeq (int initialMaximum)

Constructs an empty sequence of bytes with the given initial maximum.
ByteSeq (byte[ ] bytes)

Construct a new sequence containing the given bytes.
boolean addAllByte (byte[ ] elements, int offset, int length)

boolean addAllByte (byte[ ] elements)

void addByte (byte element)
void addByte (int index, byte element)

byte getByte (int index)

Returns the byte at the given index.
byte setByte (int index, byte element)

Set the new byte at the given index and return the old byte.
void setByte (int dstIndex, byte[ ] elements, int srcIndex, int length)
byte[ ] toArrayByte (byte[ ] array)

442
Class Documentation
int getMaximum ()
sequence.

A wrapper for getByte(int) ( p. 443) that returns a java.lang.Byte.

A wrapper for setByte() ( p. 444).

A wrapper for addByte(int, int).
8.22.1

byte >.
Instantiates:
See also:
byte
8.22.2
8.22.2.1
ByteSeq ()
Constructs an empty sequence of bytes with an initial maximum of zero.

8.22.2.2
ByteSeq (int initialMaximum)
Constructs an empty sequence of bytes with the given initial maximum.

8.22.2.3
ByteSeq (byte[ ] bytes)
Construct a new sequence containing the given bytes.

443
Parameters:
bytes the initial contents of this sequence
Exceptions:
8.22.3
8.22.3.1
boolean addAllByte (byte[ ] elements, int offset, int

length)
Exceptions:
8.22.3.2
boolean addAllByte (byte[ ] elements)
Exceptions:
8.22.3.3
void addByte (byte element)

8.22.3.4
void addByte (int index, byte element)
8.22.3.5
byte getByte (int index)
Returns the byte at the given index.

Exceptions:
444
Class Documentation
8.22.3.6
byte setByte (int index, byte element)
Set the new byte at the given index and return the old byte.
Exceptions:
8.22.3.7
void setByte (int dstIndex, byte[ ] elements, int srcIndex,

int length)

Parameters:
Exceptions:
8.22.3.8
byte [ ] toArrayByte (byte[ ] array)

Parameters:
into instead.
Returns:

8.22.3.9
445
int getMaximum ()
elements.
first created.
Returns:
See also:
8.22.3.10
A wrapper for getByte(int) (p. 443) that returns a java.lang.Byte.

See also:
8.22.3.11
A wrapper for setByte() (p. 444).

Exceptions:
ClassCastException if the element is not of type Byte.
See also:
446
Class Documentation
8.22.3.12
A wrapper for addByte(int, int).

Exceptions:
ClassCastException if the element is not of type Byte.
See also:
8.23 BytesSeq Class Reference
8.23
447
BytesSeq Class Reference

Inheritance diagram for BytesSeq::

BytesSeq ()
Constructs an empty sequence of com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes
objects with an initial maximum of zero.
BytesSeq (int initialMaximum)

objects with the given initial maximum.
BytesSeq (Collection elements)

Constructs
a
new
sequence
containing
the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes objects.
given
Package Attributes
transient Sequence loanedInfoSequence = null
8.23.1

Instantiates:
See also:
448
Class Documentation
8.23.2
8.23.2.1
BytesSeq ()

8.23.2.2
BytesSeq (int initialMaximum)

8.23.2.3
BytesSeq (Collection elements)
Constructs
a
new
sequence
containing
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes objects.
the
given
Parameters:
elements the initial contents of this sequence.
Exceptions:
NullPointerException if the input collection is null
8.23.3
8.23.3.1
Copy data into this object from another. The result of this method is that
both this and src will be the same size and contain the same data.
Parameters:
src The Object which contains the data to be copied
Returns:
this
Exceptions:
ClassCastException If src is not a Sequence OR if one of the objects
contained in the Sequence is not of the expected type.
8.23 BytesSeq Class Reference
449
See also:
com.rti.dds.infrastructure.Copyable.copy from
(p. 480)(java.lang.Object)
8.23.4
8.23.4.1
transient Sequence loanedInfoSequence = null [package]
When a memory loan has been taken out in the lower layers of NDDS, store a
pointer to the native sequence here. That way, when we call finish(), we can
give the memory back.
450
Class Documentation
8.24
BytesTypeSupport Class Reference
<<interface>> ( p. 279) com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes

type support.
Inheritance diagram for BytesTypeSupport::
Static Public Member Functions

static void register type (DomainParticipant participant, String
type name)
Allows an application to communicate to RTI Connext the existence of the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes data type.
static void unregister type (DomainParticipant participant, String

type name)
Allows
an
application
to
unregister
the
data
type
from
RTI Connext. After calling unregister type, no further communication using
this type is possible.
static String get type name ()

Get the default name for the com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes
type.
8.24.1
<<interface>> ( p. 279) com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes

type support.
8.24.2
8.24.2.1
static void register type (DomainParticipant participant,

String type name) [static]

com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes data type.
By default,
The com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes
built-in
type
is
automatically
registered
when
a
DomainParticipant
is
created
using
the
type name
returned
by
8.24 BytesTypeSupport Class Reference
451
com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesTypeSupport.get type name. Therefore, the usage of this function is optional and it is only
required when the automatic built-in type registration is disabled using the
participant property dds.builtin type.auto register.
This
method
can
also
be
used
to
register
the
same
com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesTypeSupport with a
com.rti.dds.domain.DomainParticipant (p. 654) using different values for
the type name.
is
called
multiple
times
with
the
same
If
register type
com.rti.dds.domain.DomainParticipant (p. 654) and type name, the
second (and subsequent) registrations are ignored by the operation.
Parameters:
participant <<in>> ( p. 279) the com.rti.dds.domain.DomainParticipant
to
register
the
data
type
(p. 654)
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes with. Cannot
be null.
type name <<in>> ( p. 279) the type name under with the data
type
is
registered with the participant; this type name is used when
creating a new com.rti.dds.topic.Topic (p. 1545).
(See
com.rti.dds.domain.DomainParticipant.create topic (p. 697).)
The name may not be null or longer than 255 characters.
Exceptions:
One of
the
Standard
Return
Codes
com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET
(p. 1363)
com.rti.dds.infrastructure.RETCODE OUT OF RESOURCES (p. 1362).
(p. 108),
or
MT Safety:
UNSAFE on the FIRST call. It is not safe for two threads to simultaneously
make the first call to register a type. Subsequent calls are thread safe.
See also:
452
Class Documentation
8.24.2.2
static void unregister type (DomainParticipant

participant, String type name) [static]
Allows an application to unregister the com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes

data type from RTI Connext. After calling unregister type, no further communication using this type is possible.
Precondition:
The
type
with type name is registered with the participant and all
com.rti.dds.topic.Topic (p. 1545) objects referencing the type have
been destroyed. If the type is not registered with the participant, or if any
com.rti.dds.topic.Topic (p. 1545) is associated with the type, the operation will fail with com.rti.dds.infrastructure.RETCODE ERROR
(p. 1356).
Postcondition:
All information about the type is removed from RTI Connext. No further
communication using this type is possible.
Parameters:
(p. 654)
to
unregister
the
data
type
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes from. Cannot
be null.
type com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes is registered with the participant. The name should match a name that has
been previously used to register a type with the participant. Cannot
be null.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1355) or com.rti.dds.infrastructure.RETCODE ERROR
(p. 1356)
MT Safety:
SAFE.
See also:
com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesTypeSupport.register type
8.24 BytesTypeSupport Class Reference

8.24.2.3
453
static String get type name () [static]
Get the default name for the com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes

type.
Can be used for calling com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesTypeSupport.register type or creating com.rti.dds.topic.Topic (p. 1545).
Returns:
default name for the com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes
type.
See also:
com.rti.dds.type.builtin.com.rti.dds.type.builtin.BytesTypeSupport.register type
454
Class Documentation
8.25
ChannelSettings t Class Reference

Inherits Struct.

ChannelSettings t ()
Constructor.
ChannelSettings t (ChannelSettings t src)

Constructor.
ChannelSettings t (TransportMulticastSettingsSeq multicast settings, String filter expression)

Constructor.
Public Attributes
TransportMulticastSettingsSeq multicast settings
A sequence of com.rti.dds.infrastructure.TransportMulticastSettings t
( p. 1594) 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.
8.25.1

QoS:
com.rti.dds.infrastructure.MultiChannelQosPolicy (p. 1187)
8.25.2
8.25.2.1
ChannelSettings t ()
Constructor.
8.25 ChannelSettings t Class Reference

8.25.2.2
455
ChannelSettings t (ChannelSettings t src)
Constructor.
Parameters:
src <<in>> ( p. 279) Settings used to initialized the new settings.
8.25.2.3
ChannelSettings t (TransportMulticastSettingsSeq
multicast settings, String filter expression)
Constructor.
Parameters:
multicast settings <<in>> ( p. 279) Multicast settings.
filter expression <<in>> ( p. 279) Filter expression.
8.25.3
8.25.3.1
TransportMulticastSettingsSeq multicast settings
Initial value:
new TransportMulticastSettingsSeq()
A sequence of com.rti.dds.infrastructure.TransportMulticastSettings t
(p. 1594) 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)
8.25.3.2
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.
456
Class Documentation
The syntax of the expression will depend on the value

com.rti.dds.infrastructure.MultiChannelQosPolicy.filter name
(p. 1189)
of
The
filter
expression
length
(including
NULLterminated
character)
cannot
be
greater
than
com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.channel filter expression max length (p. 793).
See also:
[default] NULL (invalid value)
8.26 ChannelSettingsSeq Class Reference
8.26
457
ChannelSettingsSeq Class Reference

(p. 454) >.
Inherits ArraySequence.
8.26.1

(p. 454) >.
A sequence of com.rti.dds.infrastructure.ChannelSettings t (p. 454) used
to configure the channels properties. If the length of the sequence is zero,
the com.rti.dds.infrastructure.MultiChannelQosPolicy (p. 1187) has no
effect.
Instantiates:
See also:
com.rti.dds.infrastructure.ChannelSettings t (p. 454)
458
Class Documentation
8.27
CharSeq Class Reference

char >.
Inheritance diagram for CharSeq::

CharSeq ()
Constructs an empty sequence of single-byte (serialized) characters with an
initial maximum of zero.
CharSeq (int initialMaximum)

Constructs an empty sequence of single-byte (serialized) characters with the
given initial maximum.
CharSeq (char[ ] chars)

Constructs a new sequence containing the given single-byte (serialized) characters.
final boolean addAllChar (char[ ] elements, int offset, int length)

final boolean addAllChar (char[ ] elements)

Append the elements of the given array into this sequence.
final void addChar (char element)

final void addChar (int index, char element)

final char getChar (int index)

Returns the character at the given index.
final char setChar (int index, char element)

Set the new character at the given index and return the old character.
8.27 CharSeq Class Reference
459
final void setChar (int dstIndex, char[ ] elements, int srcIndex, int
length)
final char[ ] toArrayChar (char[ ] array)

final int getMaximum ()

sequence.
final Object get (int index)

A wrapper for getChar(int) ( p. 461) that returns a java.lang.Character.
final Object set (int index, Object element)

A wrapper for setChar() ( p. 461).
final void add (int index, Object element)

A wrapper for addChar(int, int).
8.27.1

char >.
Instantiates:
See also:
char
8.27.2
8.27.2.1
CharSeq ()
Constructs an empty sequence of single-byte (serialized) characters with an

initial maximum of zero.
460
Class Documentation
8.27.2.2
CharSeq (int initialMaximum)
Constructs an empty sequence of single-byte (serialized) characters with the

given initial maximum.
8.27.2.3
CharSeq (char[ ] chars)
Constructs a new sequence containing the given single-byte (serialized) characters.

Parameters:
chars the initial contents of this sequence
8.27.3
8.27.3.1
final boolean addAllChar (char[ ] elements, int offset, int

length)
Exceptions:
8.27.3.2
final boolean addAllChar (char[ ] elements)
Append the elements of the given array into this sequence.

Exceptions:
8.27.3.3
final void addChar (char element)

8.27.3.4
final void addChar (int index, char element)

8.27.3.5
461
final char getChar (int index)
Returns the character at the given index.

Exceptions:
8.27.3.6
final char setChar (int index, char element)
Set the new character at the given index and return the old character.
Exceptions:
8.27.3.7
final void setChar (int dstIndex, char[ ] elements, int


Parameters:
Exceptions:
8.27.3.8
final char [ ] toArrayChar (char[ ] array)

Parameters:
into instead.
462
Class Documentation
Returns:
8.27.3.9
elements.
first created.
Returns:
See also:
8.27.3.10
final Object get (int index) [virtual]
A wrapper for getChar(int) (p. 461) that returns a java.lang.Character.

See also:
8.27.3.11
final Object set (int index, Object element) [virtual]
A wrapper for setChar() (p. 461).

Exceptions:
ClassCastException if the element is not of type Character.

See also:
8.27.3.12
final void add (int index, Object element) [virtual]
A wrapper for addChar(int, int).

Exceptions:
ClassCastException if the element is not of type Character.
See also:
463
464
Class Documentation
8.28
Condition Interface Reference
<<interface>> ( p. 279) Root class for all the conditions that may be attached
to a com.rti.dds.infrastructure.WaitSet (p. 1709).
Inheritance diagram for Condition::
Package Functions
boolean get trigger value ()
Retrieve the trigger value.
8.28.1
<<interface>> ( p. 279) Root class for all the conditions that may be attached
to a com.rti.dds.infrastructure.WaitSet (p. 1709).
This basic class is specialised in three classes:
com.rti.dds.infrastructure.GuardCondition
com.rti.dds.infrastructure.StatusCondition
(p. 1448),
(p. 1041),
and
A com.rti.dds.infrastructure.Condition (p. 464) has a trigger value that

can be com.rti.dds.infrastructure.true or com.rti.dds.infrastructure.false and is
set automatically by RTI Connext.
See also:
com.rti.dds.infrastructure.WaitSet (p. 1709)
8.28.2
8.28.2.1
boolean get trigger value () [package]

Returns:
the trigger value.
Implemented in GuardCondition (p. 1042).
8.29 ConditionSeq Class Reference
8.29
465
ConditionSeq Class Reference

com.rti.dds.infrastructure.Condition (p. 464) >.
Inherits AbstractNativeSequence.

ConditionSeq (Collection conditions)
Create a Condition ( p. 464) Sequence with the given contents. The size and
the maximum of the new sequence will match the size of the given collection.
ConditionSeq ()
Create a empty Condition ( p. 464) Sequence with a initial maximum of
zero.
ConditionSeq (int initial maximum)

Create a Condition ( p. 464) Sequence with the specified initial maximum.
int getMaximum ()
sequence.
8.29.1

com.rti.dds.infrastructure.Condition (p. 464) >.
Instantiates:
See also:
8.29.2
8.29.2.1
ConditionSeq (Collection conditions)
Create a Condition (p. 464) Sequence with the given contents. The size and
the maximum of the new sequence will match the size of the given collection.
466
Class Documentation
Parameters:
conditions The initial contents of the sequence
Exceptions:
NullPointerException if the given collection is null
8.29.2.2
ConditionSeq ()
Create a empty Condition (p. 464) Sequence with a initial maximum of zero.
8.29.2.3
ConditionSeq (int initial maximum)
Create a Condition (p. 464) Sequence with the specified initial maximum.
Parameters:
initial maximum The initial maximum of the sequence.
8.29.3
8.29.3.1
int getMaximum ()
elements.
first created.
Returns:
See also:
8.30 ContentFilter Interface Reference
8.30
467
ContentFilter Interface Reference
<<interface>> ( p. 279) Interface to be used by a custom filter of a

com.rti.dds.topic.ContentFilteredTopic (p. 471)
Inheritance diagram for ContentFilter::

void compile (ObjectHolder new compile data, String expression,
StringSeq parameters, TypeCode type code, String type class name,
Object old compile data)
Compile an instance of the content filter according to the filter expression
and parameters of the given data type.
boolean evaluate (Object compile data, Object sample, FilterSampleInfo meta data)
Evaluate whether the sample is passing the filter or not according to the
sample content.
void finalize (Object compile data)

A previously compiled instance of the content filter is no longer in use and
resources can now be cleaned up.
8.30.1
<<interface>> ( p. 279) Interface to be used by a custom filter of a

Entity:
This
is
the
interface
that
can
be
implemented
by
an
application-provided
class
and
then
registered
with
the
com.rti.dds.domain.DomainParticipant (p. 654) such that samples
can be filtered for a com.rti.dds.topic.ContentFilteredTopic (p. 471) with
the given filter name.
Note: the API for using a custom content filter is subject to change in a future
release.
468
Class Documentation
See also:
(p. 728)
8.30.2
8.30.2.1
void compile (ObjectHolder new compile data, String

expression, StringSeq parameters, TypeCode type code,
String type class name, Object old compile data)
Compile an instance of the content filter according to the filter expression and
parameters of the given data type.
This method is called when an instance of the locally registered content filter
is created or when the expression parameter for the locally registered content
filter instance is changed.
An instance of the locally registered content filter is created every time a local
com.rti.dds.topic.ContentFilteredTopic (p. 471) with the matching filter
name is created, or when a com.rti.dds.subscription.DataReader (p. 487)
with a matching filter name is discovered.
It is possible for multiple threads to be calling into this function at the same
time. However, this function will never be called on a content filter that has
been unregistered.
Parameters:
new compile data <<out>> ( p. 279) User specified opaque pointer
of this instance of the content filter. This value is then passed
to the com.rti.dds.topic.ContentFilter.evaluate (p. 469) and
com.rti.dds.topic.ContentFilter.finalize (p. 470) functions for
this instance of the content filter. Can be set to NULL.
expression <<in>> ( p. 279) An ASCIIZ string with the filter expression. The memory used by this string is owned by RTI Connext and
must not be freed. If you want to manipulate this string, you must
first make a copy of it.
parameters <<in>> ( p. 279) A string sequence with the expression parameters the com.rti.dds.topic.ContentFilteredTopic
The string sequence is
(p. 471) was created with.
equal (but not identical) to the string sequence passed
to
com.rti.dds.domain.DomainParticipant.create contentfilteredtopic (p. 701).
Note that the sequence passed
to the compile function is owned by RTI Connext and must not be
referenced outside the compile function.
8.30 ContentFilter Interface Reference
469
type code <<in>> ( p. 279) A pointer to the type code for

of
the
the
related
(p. 1545)
com.rti.dds.topic.ContentFilteredTopic (p. 471).
A type code is a description of a type in terms of which types it contains
(such as long, string, etc.) and the corresponding member field names
in the data type structure. The type code can be used to write custom
content filters that can be used with any type. This parameter is
always NULL in Java.
type class name <<in>> ( p. 279) Fully qualified class name of the related com.rti.dds.topic.Topic (p. 1545).
old compile data <<in>> ( p. 279) The previous new compile data
value from a previous call to this instance of a content filter. If
the compile function is called more than once for an instance of a
com.rti.dds.topic.ContentFilteredTopic (p. 471), e.g., if the expression parameters are changed, then the new compile data value returned by the previous invocation is passed in the old compile data
parameter (which can be NULL). If this is a new instance of the filter, NULL is passed. This parameter is useful for freeing or reusing
resources previously allocated for this
Exceptions:
One of the Standard Return Codes (p. 108)
8.30.2.2
boolean evaluate (Object compile data, Object sample,

FilterSampleInfo meta data)
Evaluate whether the sample is passing the filter or not according to the sample
content.
This method is called when a sample for a locally created
(p. 487)
associated
with the filter is received, or when a sample for a discovered
com.rti.dds.subscription.DataReader (p. 487) assocated with the filter needs to be sent.
been unregistered.
Parameters:
compile data <<in>> ( p. 279) The last return value of the
com.rti.dds.topic.ContentFilter.compile
(p. 468)
function
for this instance of the content filter. Can be NULL.
470
Class Documentation
sample <<in>> ( p. 279) Pointer to a deserialized sample to be filtered
Returns:
The function must return 0 if the sample should be filtered out, non zero
otherwise
8.30.2.3
void finalize (Object compile data)
A previously compiled instance of the content filter is no longer in use and

resources can now be cleaned up.
This method is called when an instance of the locally registered content filter is
deleted.
An instance of the locally registered content filter is deleted every time a local
com.rti.dds.topic.ContentFilteredTopic (p. 471) with the matching filter
name is deleted, or when a com.rti.dds.subscription.DataReader (p. 487)
with a matching filter name is removed due to discovery.
This method is also called on all instances of the discovered
(p. 487)
with
a
matching
filter
name
if
the
filter
is
unregistered
with
com.rti.dds.domain.DomainParticipant.unregister contentfilter
(p. 729)
been unregistered.
Parameters:
compile data <<in>> ( p. 279) The last return value of the
com.rti.dds.topic.ContentFilter.compile
(p. 468)
function
for this instance of the content filter. Can be NULL.
8.31 ContentFilteredTopic Interface Reference
8.31
471
ContentFilteredTopic Interface Reference
<<interface>> ( p. 279) Specialization of com.rti.dds.topic.TopicDescription

(p. 1561) that allows for content-based subscriptions.
Inheritance diagram for ContentFilteredTopic::

String get filter expression ()
Get the filter expression.
void get expression parameters (StringSeq parameters)

Get the expression parameters.
void set expression parameters (StringSeq parameters)

Set the expression parameters.
Topic get related topic ()

Get the related topic.
void append to expression parameter (int index, String val)

<<eXtension>> (p. 278) Appends a string term to the specified parameter
string.
void remove from expression parameter (int index, String val)

<<eXtension>> (p. 278) Removes a string term from the specified parameter string.
8.31.1
<<interface>> ( p. 279) Specialization of com.rti.dds.topic.TopicDescription

(p. 1561) that allows for content-based subscriptions.
It describes a more sophisticated subscription (p. 353) that indicates a
com.rti.dds.subscription.DataReader (p. 487) does not want to necessarily
see all values of each instance published under the com.rti.dds.topic.Topic
(p. 1545). Rather, it wants to see only the values whose contents satisfy certain
criteria. This class therefore can be used to request content-based subscriptions.
The selection of the content is done using the filter expression with parameters expression parameters.
472
Class Documentation
The filter expression attribute is a string that specifies the criteria to
select the data samples of interest. It is similar to the WHERE part of an
SQL clause.
The expression parameters attribute is a sequence of strings that give
values to the parameters (i.e. %n tokens) in the filter expression.
The number of supplied parameters must fit with the requested values in
the filter expression (i.e. the number of n tokens).
Queries and Filters Syntax (p. 286) describes the syntax of filter expression and expression parameters.
Note on Content-Based Filtering and Sparse Value Types
If you are a user of the Dynamic Data (p. 175) API, you may define sparse
value types; that is, types for which every data sample need not include a value
for every field defined in the type. (See com.rti.dds.typecode.TCKind.TK SPARSE (p. 1529) and com.rti.dds.typecode.TypeCodeFactory.create sparse tc (p. 1653).) In order for a filter expression on a field to be
well defined, that field must be present in the data sample. That means
that you will only be able to perform a content-based filter on fields
that are marked as com.rti.dds.typecode.TypeCode.KEY MEMBER
(p. 1645) or com.rti.dds.typecode.TypeCode.NONKEY REQUIRED MEMBER (p. 1646).
8.31.2
8.31.2.1
String get filter expression ()
Get the filter expression.

associated
Return
the
filter expression
with
the
Returns:
the filter expression.
8.31.2.2

Return
the
associated
with
the
expression parameters is either specified on the last successful call to
com.rti.dds.topic.ContentFilteredTopic.set expression parameters
473
(p. 473) or, if that method is never called, the parameters specified when the
com.rti.dds.topic.ContentFilteredTopic (p. 471) was created.
Parameters:
parameters <<inout>> ( p. 279) the filter expression parameters. Cannot be NULL.
Exceptions:
See also:
com.rti.dds.domain.DomainParticipant.create contentfilteredtopic (p. 701)
com.rti.dds.topic.ContentFilteredTopic.set expression parameters (p. 473)
8.31.2.3

associated
Change
the
with
the
Parameters:
parameters <<in>> ( p. 279) the filter expression parameters Cannot be
NULL.. Length of sequence cannot be greater than 100.
Exceptions:
8.31.2.4
Topic get related topic ()
Get the related topic.

Return the com.rti.dds.topic.Topic (p. 1545) specified when
com.rti.dds.topic.ContentFilteredTopic (p. 471) was created.
the
Returns:
The
(p. 1545)
assocated
with
the
474
Class Documentation
8.31.2.5
void append to expression parameter (int index, String

val)
<<eXtension>> ( p. 278) Appends a string term to the specified parameter

string.
Appends the input string to the end of the specified parameter string, separated
by a comma. If the original parameter string is enclosed in quotation marks (),
the resultant string will also be enclosed in quotation marks.
This method can be used in expression parameters associated with MATCH
operators in order to add a pattern to the match pattern list. For example, if
the filter expression parameter value is:
IBM
Then append to expression parameter(0, MSFT) would generate the new
value:
IBM,MSFT
Parameters:
index <<in>> ( p. 279) The index of the parameter string to
be modified.
The first index is index 0.
When using the
com.rti.dds.domain.DomainParticipant.STRINGMATCHFILTER NAME (p. 155) filter, index must be 0.
val <<in>> ( p. 279) The string term to be appended to the parameter
string.
Exceptions:
8.31.2.6
void remove from expression parameter (int index, String

val)
<<eXtension>> ( p. 278) Removes a string term from the specified parameter

string.
Removes the input string from the specified parameter string. To be found and
removed, the input string must exist as a complete term, bounded by comma
separators or the strong boundary. If the original parameter string is enclosed
in quotation marks (), the resultant string will also be enclosed in quotation
marks. If the removed term was the last entry in the string, the result will be
a string of empty quotation marks.
This method can be used in expression parameters associated with MATCH
475
operators in order to remove a pattern from the match pattern list. For example,
if the filter expression paremeter value is:
IBM,MSFT
Then remove from expression parameter(0, IBM) would generate the expression:
MSFT
Parameters:
index <<in>> ( p. 279) The index of the parameter string to
be modified.
The first index is index 0.
When using the
com.rti.dds.domain.DomainParticipant.STRINGMATCHFILTER NAME (p. 155) filter, index must be 0.
val <<in>> ( p. 279) The string term to be removed from the parameter
string.
Exceptions:
476
Class Documentation
8.32
ContentFilterProperty t Class Reference
<<eXtension>> ( p. 278) Type used to provide all the required information

Inherits Struct.

ContentFilterProperty t ()
Constructor.
Public Attributes
String content filter topic name
Name of the Content-filtered Topic associated with the Reader.
String related topic name

Name of the Topic related to the Content-filtered Topic.
String filter class name

Identifies the filter class this filter belongs to. RTPS can support multiple
filter classes (SQL, regular expressions, custom filters, etc).

The actual filter expression. Must be a valid expression for the filter class
specified using filterClassName.
final StringSeq expression parameters

Defines the value for each parameter in the filter expression.
8.32.1
<<eXtension>> ( p. 278) Type used to provide all the required information

8.32.2
8.32.2.1
ContentFilterProperty t ()
Constructor.
8.32 ContentFilterProperty t Class Reference
8.32.3
8.32.3.1
String content filter topic name
477
Name of the Content-filtered Topic associated with the Reader.

8.32.3.2
String related topic name
Name of the Topic related to the Content-filtered Topic.

8.32.3.3
String filter class name
Identifies the filter class this filter belongs to. RTPS can support multiple filter
classes (SQL, regular expressions, custom filters, etc).
8.32.3.4
The actual filter expression. Must be a valid expression for the filter class
specified using filterClassName.
8.32.3.5
final StringSeq expression parameters
Defines the value for each parameter in the filter expression.
478
Class Documentation
8.33
Cookie t Class Reference
<<eXtension>> ( p. 278) Sequence of bytes identifying a written data sample,

used when writing with parameters.
Inherits Struct.
Public Attributes
final ByteSeq value
8.33.1
<<eXtension>> ( p. 278) Sequence of bytes identifying a written data sample,

used when writing with parameters.
8.33.2
8.33.2.1
final ByteSeq value
[default] Empty (zero-sized)
[range] Octet sequence of length [0,com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy.cooki

max length]
8.34 CookieSeq Class Reference
8.34
CookieSeq Class Reference
8.34.1
479
480
Class Documentation
8.35
Copyable Interface Reference
<<eXtension>> ( p. 278) <<interface>> ( p. 279) Interface for all the userdefined data type classes that support copy.
Inheritance diagram for Copyable::

8.35.1
<<eXtension>> ( p. 278) <<interface>> ( p. 279) Interface for all the userdefined data type classes that support copy.
A class implements the com.rti.dds.infrastructure.Copyable (p. 480) interface to indicate that it allows its entire state to be replaced with the state of
another object. This state copy is a deep copy, such that subsequent changes
to any part of one object will not be observed in the other.
Therefore, in general, object references in this object cannot simply be reassigned to those in the source object. (Strings are an exception to this rule,
because they are immutable.)
8.35.2
8.35.2.1

references).
Parameters:
8.35 Copyable Interface Reference
481
Returns:
Exceptions:
Implemented in DynamicData (p. 831), InstanceHandle t (p. 1056),
StringSeq (p. 1468), Time t (p. 1539), WriteParams t (p. 1734), SampleInfo (p. 1403), BuiltinTopicKey t (p. 425), Bytes (p. 432), BytesSeq
(p. 448), KeyedBytes (p. 1071), KeyedBytesSeq (p. 1092), KeyedString (p. 1099), KeyedStringSeq (p. 1118), AbstractPrimitiveSequence
(p. 389), Enum (p. 945), Foo (p. 977), and FooSeq (p. 1035).
482
Class Documentation
8.36
DatabaseQosPolicy Class Reference
Various threads and resource limits settings used by RTI Connext to control its
internal database.
Inheritance diagram for DatabaseQosPolicy::
Public Attributes
Database thread settings.
final Duration t shutdown timeout

The maximum wait time during a shutdown.
final Duration t cleanup period

The database thread will wake up at this rate to clean up the database.
final Duration t shutdown cleanup period

The clean-up period used during database shut-down.
int initial records

The initial number of total records.
int max skiplist level

The maximum level of the skiplist.
int initial weak references

The initial number of weak references.
int max weak references

The maximum number of weak references.
8.36.1
Various threads and resource limits settings used by RTI Connext to control its
internal database.
RTI uses an internal in-memory database to store information about entities created locally as well as remote entities found during the discovery process. This database uses a background thread to garbage-collect records related
8.36 DatabaseQosPolicy Class Reference
483
to deleted entities. When the com.rti.dds.domain.DomainParticipant

(p. 654) that maintains this database is deleted, it shuts down this thread.
The Database QoS policy is used to configure how RTI Connext manages its
database, including how often it cleans up, the priority of the database thread,
and limits on resources that may be allocated by the database.
You
may
be
interested
in
modifying
the
com.rti.dds.infrastructure.DatabaseQosPolicy.shutdown timeout
(p. 484) and com.rti.dds.infrastructure.DatabaseQosPolicy.shutdown cleanup period (p. 484) parameters to decrease the time it takes to delete a
com.rti.dds.domain.DomainParticipant (p. 654) when your application is
shutting down.
The com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy
(p. 778) controls the memory allocation for elements stored in the database.
This QoS policy is an extension to the DDS standard.
Entity:
Properties:
RxO (p. 101) = N/A
Changeable (p. 102) NO (p. 102)
8.36.2
8.36.2.1
Database thread settings.

There is only one database thread: the clean-up thread.
[default] priority low.
For Windows: -3
For LynxOS: 10
For INTEGRITY: 60
For VxWorks: 120
484
Class Documentation

For LynxOS: 161024
For INTEGRITY: 201024
For VxWorks: 161024
[default] mask com.rti.dds.infrastructure.ThreadSettingsKind.THREAD SETTINGS STDIO (p. 1535)
8.36.2.2
final Duration t shutdown timeout
The maximum wait time during a shutdown.

The domain (p. 328) participant will exit after the timeout, even if the database
has not been fully cleaned up.
[default] 15 seconds
8.36.2.3
final Duration t cleanup period
The database thread will wake up at this rate to clean up the database.
[range] [0,1 year]
8.36.2.4
final Duration t shutdown cleanup period
The clean-up period used during database shut-down.

[default] 1 second
[range] [0,1 year]
8.36.2.5
int initial records
The initial number of total records.

[default] 1024
8.36 DatabaseQosPolicy Class Reference
485
[range] [1,10 million]

8.36.2.6
int max skiplist level
The maximum level of the skiplist.

The skiplist is used to keep records in the database. Usually, the search time is
log2(N), where N is the total number of records in one skiplist. However, once N
exceeds 2 n, where n is the maximum skiplist level, the search time will become
more and more linear. Therefore, the maximum level should be set such that
2 n is larger than the maximum(N among all skiplists). Usually, the maximum
N is the maximum number of remote and local writers or readers.
[default] 14
[range] [1,31]
8.36.2.7
int initial weak references
The initial number of weak references.

See
com.rti.dds.infrastructure.DatabaseQosPolicy.max weak references (p. 485) for more information about what a weak reference
is.
If the QoS set contains an initial weak references value that is too small to
ever grow to com.rti.dds.infrastructure.DatabaseQosPolicy.max weak references (p. 485) using RTI Connext internal algorithm, this value will be
adjusted upwards as necessary. Subsequent accesses of this value will reveal the
actual initial value used.
Changing the value of this field is an advanced feature; it is recommended that
you consult with RTI support personnel before doing so.
[default] 2049, which is the minimum initial value imposed by REDA when the
maximum is unlimited. If a lower value is specified, it will simply be increased
to 2049 automatically.
[range] [1, 100 million], <= max weak references
See also:
com.rti.dds.infrastructure.DatabaseQosPolicy.max weak references (p. 485)
8.36.2.8
int max weak references
The maximum number of weak references.

486
Class Documentation
A weak reference is an internal data structure that refers to a record within RTI
Connext internal database. This field configures the maximum number of such
references that RTI Connext may create.
The actual number of weak references is permitted to grow from an initial value
(indicated by com.rti.dds.infrastructure.DatabaseQosPolicy.initial weak references (p. 485)) to this maximum. To prevent RTI Connext from allocating any weak references after the system has reached a steady state, set the
initial and maximum values equal to one another. To indicate that the number
of weak references should continue to grow as needed indefinitely, set this field
to
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106). Be aware that although a single weak reference
occupies very little memory, allocating a very large number of them can have a
significant impact on your overall memory usage.
Tuning this value precisely is difficult without intimate knowledge of the structure of RTI Connext database; doing so is an advanced feature not required
by most applications. The default value has been chosen to be sufficient for
reasonably large systems. If you believe you may need to modify this value,
please consult with RTI support personnel for assistance.
[range] [1, 100 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), >= initial weak references
See also:
com.rti.dds.infrastructure.DatabaseQosPolicy.initial weak references (p. 485)
8.37 DataReader Interface Reference
8.37
487
DataReader Interface Reference
<<interface>> ( p. 279) Allows the application to: (1) declare the data it
wishes to receive (i.e. make a subscription (p. 353)) and (2) access the data
received by the attached com.rti.dds.subscription.Subscriber (p. 1476).
Inheritance diagram for DataReader::

ReadCondition create readcondition (int sample states, int view states, int instance states)
Creates a com.rti.dds.subscription.ReadCondition ( p. 1313).
QueryCondition create querycondition (int sample states, int view states, int instance states, String query expression, StringSeq query parameters)
Creates a com.rti.dds.subscription.QueryCondition ( p. 1311).
void delete readcondition (ReadCondition condition)

Deletes a com.rti.dds.subscription.ReadCondition ( p. 1313) or
com.rti.dds.subscription.QueryCondition ( p. 1311) attached to the
void set qos (DataReaderQos qos)

Sets the reader QoS.
void set qos with profile (String library name, String profile name)
<<eXtension>> (p. 278) Change the QoS of this reader using the input
XML QoS profile.
void get qos (DataReaderQos qos)

Gets the reader QoS.
void set listener (DataReaderListener l, int mask)

Sets the reader listener.
DataReaderListener get listener ()

Get the reader listener.
void call listenerT (int mask)

488
Class Documentation
Calls the reader listener.
void get sample rejected status (SampleRejectedStatus status)

Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE REJECTED STATUS communication status.
void get liveliness changed status (LivelinessChangedStatus status)

Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS CHANGED STATUS communication status.
void get requested deadline missed status (RequestedDeadlineMissedStatus status)

Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED DEADLINE MISSED STATUS communication status.
void get requested incompatible qos status (RequestedIncompatibleQosStatus status)

Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED INCOMPATIBLE QOS STATUS communication status.
void get sample lost status (SampleLostStatus status)

Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE LOST STATUS STATUS communication status.
void get subscription matched status (SubscriptionMatchedStatus status)

Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.SUBSCRIPTION MATCHED STATUS communication status.
void get datareader cache status (DataReaderCacheStatus status)

<<eXtension>> (p. 278) Get the datareader cache status for this reader.
void get datareader protocol status (DataReaderProtocolStatus

status)
<<eXtension>> (p. 278) Get the datareader protocol status for this reader.
void
get matched publication datareader protocol status
(DataReaderProtocolStatus status, InstanceHandle t publication handle)
<<eXtension>> (p. 278) Get the datareader protocol status for this reader,
per matched publication ( p. 349) identified by the publication handle.
489
void get matched publications (InstanceHandleSeq publication handles)

Retrieve the list of publications currently associated
with
this
void get matched publication data (PublicationBuiltinTopicData

publication data, InstanceHandle t publication handle)
This operation retrieves the information on a publication ( p. 349) that
is currently associated with the com.rti.dds.subscription.DataReader
( p. 487).
TopicDescription get topicdescription ()

Returns the com.rti.dds.topic.TopicDescription ( p. 1561) associated
with the com.rti.dds.subscription.DataReader ( p. 487).
Subscriber get subscriber ()

Returns the com.rti.dds.subscription.Subscriber ( p. 1476) to which the
com.rti.dds.subscription.DataReader ( p. 487) belongs.
void delete contained entities ()

Deletes all the entities that were created by means of the create operations
on the com.rti.dds.subscription.DataReader ( p. 487).
void wait for historical data (Duration t max wait)

Waits
until
all
historical
data
is
received
for
com.rti.dds.subscription.DataReader ( p. 487) entities that have a
non-VOLATILE Durability Qos kind.
void acknowledge sample (SampleInfo sample info)

Acknowledge a single sample explicitly.
void acknowledge all ()

Acknowledge all previously accessed samples.
void acknowledge sample (SampleInfo sample info, AckResponseData t response data)

[Not supported.] Acknowledge a single sample explicitly
void acknowledge all (AckResponseData t response data)

[Not supported.] Acknowledge all previously accessed samples
void read untyped (List received data, SampleInfoSeq info seq, int
max samples, int sample states, int view states, int instance states)
Read data samples, if any are available.
490
Class Documentation
void take untyped (List received data, SampleInfoSeq info seq, int
Take data samples, if any are available.
void read w condition untyped (List received data, SampleInfoSeq

info seq, int max samples, ReadCondition read condition)
void take w condition untyped (List received data, SampleInfoSeq

info seq, int max samples, ReadCondition read condition)
void read next sample untyped (Object received data, SampleInfo

sample info)
void take next sample untyped (Object received data, SampleInfo

sample info)
void read instance untyped (List received data, SampleInfoSeq

info seq, int max samples, InstanceHandle t a handle, int sample states, int view states, int instance states)
void take instance untyped (List received data, SampleInfoSeq

void read instance w condition untyped (List received data, SampleInfoSeq info seq, int max samples, InstanceHandle t a handle,
ReadCondition read condition)
void take instance w condition untyped (List received data, SampleInfoSeq info seq, int max samples, InstanceHandle t a handle,
void read next instance untyped (List received data, SampleInfoSeq info seq, int max samples, InstanceHandle t a handle, int sample states, int view states, int instance states)
491
void take next instance untyped (List received data, SampleInfoSeq info seq, int max samples, InstanceHandle t a handle, int sample states, int view states, int instance states)
void read next instance w condition untyped (List received data,

SampleInfoSeq info seq, int max samples, InstanceHandle t a handle,
void take next instance w condition untyped (List received data,

void return loan untyped (List received data, SampleInfoSeq info seq)
Return loaned sample data and meta-data.
void get key value untyped (Object key holder, InstanceHandle t

handle)
Fill in the key fields of the given data sample.
InstanceHandle t lookup instance untyped (Object key value)
8.37.1
<<interface>> ( p. 279) Allows the application to: (1) declare the data it
wishes to receive (i.e. make a subscription (p. 353)) and (2) access the data
received by the attached com.rti.dds.subscription.Subscriber (p. 1476).
QoS:
com.rti.dds.subscription.DataReaderQos (p. 536)
Status:
com.rti.dds.infrastructure.StatusKind.StatusKind.DATA AVAILABLE STATUS;
com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS CHANGED STATUS, com.rti.dds.subscription.LivelinessChangedStatus
(p. 1135);
492
Class Documentation
com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED DEADLINE MISSED STATUS, com.rti.dds.subscription.RequestedDeadlineMissedStatus

(p. 1344);
com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED INCOMPATIBLE QOS STATUS, com.rti.dds.subscription.RequestedIncompatibleQosStatu
(p. 1346);
com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE LOST com.rti.dds.subscription.SampleLostStatus
STATUS STATUS,
(p. 1410);
com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE REJECTED STATUS, com.rti.dds.subscription.SampleRejectedStatus
(p. 1418);
com.rti.dds.infrastructure.StatusKind.StatusKind.SUBSCRIPTION MATCHED STATUS, com.rti.dds.subscription.SubscriptionMatchedStatus<BR>
Listener:
com.rti.dds.subscription.DataReaderListener (p. 518)
A
(p. 487)
refers
to
exactly
one
(p. 1561)
(either
a
(p. 1545),
a
or
a
(p. 471)
com.rti.dds.topic.MultiTopic (p. 1190)) that identifies the data to be
read.
The subscription (p. 353) has a unique resulting type. The data-reader may
give access to several instances of the resulting type, which can be distinguished
from each other by their key.
com.rti.dds.subscription.DataReader (p. 487) is an abstract class. It
must be specialised for each particular application data-type (see USER DATA (p. 132)).
The additional methods or functions that must be
defined in the auto-generated class for a hypothetical application type
com.rti.ndds.example.Foo (p. 977) are specified in the generic type
com.rti.ndds.example.FooDataReader (p. 979).
The
following
operations
may
be
called
even
if
the
com.rti.dds.subscription.DataReader (p. 487) is not enabled.
Other
operations will fail with the value com.rti.dds.infrastructure.RETCODE NOT ENABLED
(p. 1361)
if
called
on
a
disabled
com.rti.dds.subscription.DataReader (p. 487):
The base-class operations com.rti.dds.subscription.DataReader.set qos
(p. 495),
com.rti.dds.subscription.DataReader.get qos
(p. 497),
com.rti.dds.subscription.DataReader.set listener
(p. 497),
com.rti.dds.subscription.DataReader.get listener
(p. 497),
com.rti.dds.infrastructure.Entity.enable
(p. 935),
493
com.rti.dds.infrastructure.Entity.get statuscondition
(p. 936)
and com.rti.dds.infrastructure.Entity.get status changes (p. 936)
com.rti.dds.subscription.DataReader.get liveliness changed com.rti.dds.subscription.DataReader.get status
(p. 498)
requested deadline missed status
(p. 499)
com.rti.dds.subscription.DataReader.get requested incompatible qos status
(p. 499)
com.rti.dds.subscription.DataReader.get sample lost status
(p. 499)
com.rti.dds.subscription.DataReader.get sample rejected status (p. 498) com.rti.dds.subscription.DataReader.get subscription matched status (p. 500)
All sample-accessing operations, namely: com.rti.ndds.example.FooDataReader.read
(p. 983),
(p. 981),
(p. 990),
and com.rti.ndds.example.FooDataReader.take w condition (p. 991)
may fail with the error com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET
(p. 1363)
as
described
in
com.rti.dds.subscription.Subscriber.begin access (p. 1497).
See also:
Operations Allowed in Listener Callbacks (p. 1132)
8.37.2
8.37.2.1
ReadCondition create readcondition (int sample states,

int view states, int instance states)
Creates a com.rti.dds.subscription.ReadCondition (p. 1313).

The returned com.rti.dds.subscription.ReadCondition (p. 1313) will be attached and belong to the com.rti.dds.subscription.DataReader (p. 487).
Parameters:
sample states <<in>> ( p. 279) sample state of the data samples that
are of interest
view states <<in>> ( p. 279) view state of the data samples that are of
interest
instance states <<in>> ( p. 279) instance state of the data samples that
are of interest
Returns:
return com.rti.dds.subscription.ReadCondition (p. 1313) created. Returns NULL in case of failure.
494
Class Documentation
8.37.2.2
QueryCondition create querycondition (int sample states,

int view states, int instance states, String
query expression, StringSeq query parameters)
Creates a com.rti.dds.subscription.QueryCondition (p. 1311).

The returned com.rti.dds.subscription.QueryCondition (p. 1311) will be
attached and belong to the com.rti.dds.subscription.DataReader (p. 487).
Queries and Filters Syntax (p. 286) describes the syntax of query expression and query parameters.
Parameters:
sample states <<in>> ( p. 279) sample state of the data samples that
are of interest
view states <<in>> ( p. 279) view state of the data samples that are of
interest
instance states <<in>> ( p. 279) instance state of the data samples that
are of interest
query expression <<in>> ( p. 279) Expression for the query. Cannot
be NULL.
query parameters <<in>> ( p. 279) Parameters for the query expression. Cannot be NULL.
Returns:
return com.rti.dds.subscription.QueryCondition (p. 1311) created.
Returns NULL in case of failure.
8.37.2.3
void delete readcondition (ReadCondition condition)
Deletes
a
(p. 1313)
com.rti.dds.subscription.QueryCondition (p. 1311) attached to
or
the
Since com.rti.dds.subscription.QueryCondition (p. 1311) specializes

com.rti.dds.subscription.ReadCondition (p. 1313), it can also be used to
delete a com.rti.dds.subscription.QueryCondition (p. 1311).
Precondition:
The
(p. 1313)
must
be
attached
to
the
(p. 487),
or
the
operation
will
fail
with
the
error
com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
495
Parameters:
condition <<in>> ( p. 279) Condition to be deleted.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363)
8.37.2.4
void set qos (DataReaderQos qos)
Sets the reader QoS.

This operation modifies the QoS of the com.rti.dds.subscription.DataReader
(p. 487).
The
com.rti.dds.subscription.DataReaderQos.user data
(p. 539),
com.rti.dds.subscription.DataReaderQos.deadline
(p. 539),
com.rti.dds.subscription.DataReaderQos.latency budget
(p. 539),
com.rti.dds.subscription.DataReaderQos.time based filter
(p. 540),
com.rti.dds.subscription.DataReaderQos.reader data lifecycle (p. 540)
can be changed. The other policies are immutable.
Parameters:
qos <<in>> ( p. 279) The com.rti.dds.subscription.DataReaderQos
(p. 536) to be set to. Policies must be consistent. Immutable policies
cannot be changed after com.rti.dds.subscription.DataReader
(p. 487)
is
enabled.
The
special
value
com.rti.dds.subscription.Subscriber.DATAREADER QOS DEFAULT (p. 196) can be used to indicate that
the
QoS
of
the
(p. 487) should be changed to match the current default
com.rti.dds.subscription.DataReaderQos (p. 536) set in the
com.rti.dds.subscription.Subscriber (p. 1476). Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
com.rti.dds.infrastructure.RETCODE IMMUTABLE POLICY (p. 1358), or com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY (p. 1359).
See also:
com.rti.dds.subscription.DataReaderQos (p. 536) for rules on consistency among QoS
496
Class Documentation
set qos (abstract) (p. 932)
8.37.2.5
void set qos with profile (String library name, String

profile name)
<<eXtension>> ( p. 278) Change the QoS of this reader using the input XML
QoS profile.
This operation modifies the QoS of the com.rti.dds.subscription.DataReader
(p. 487).
The
com.rti.dds.subscription.DataReaderQos.user data
(p. 539),
com.rti.dds.subscription.DataReaderQos.deadline
(p. 539),
com.rti.dds.subscription.DataReaderQos.latency budget
(p. 539),
com.rti.dds.subscription.DataReaderQos.time based filter
(p. 540),
com.rti.dds.subscription.DataReaderQos.reader data lifecycle (p. 540)
Parameters:
library name <<in>> ( p. 279) Library name containing the XML QoS
profile. If library name is null RTI Connext will use the default
library (see com.rti.dds.subscription.Subscriber.set default library (p. 1494)).
profile name <<in>> ( p. 279) XML QoS Profile name.
If profile name is null RTI Connext will use the default profile (see
com.rti.dds.subscription.Subscriber.set default profile
(p. 1495)).
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
See also:

8.37.2.6
497
void get qos (DataReaderQos qos)
Gets the reader QoS.

This method may potentially allocate memory depending on the sequences contained in some QoS policies.
Parameters:
qos <<inout>> ( p. 279) The com.rti.dds.subscription.DataReaderQos
(p. 536) to be filled up. Cannot be NULL.
Exceptions:
See also:
get qos (abstract) (p. 933)
8.37.2.7
void set listener (DataReaderListener l, int mask)
Sets the reader listener.

Parameters:
l <<in>> ( p. 279) com.rti.dds.subscription.DataReaderListener
(p. 518) to set to
mask <<in>> ( p. 279) com.rti.dds.infrastructure.StatusMask associated
with the com.rti.dds.subscription.DataReaderListener (p. 518).
Exceptions:
See also:
set listener (abstract) (p. 934)
8.37.2.8
DataReaderListener get listener ()
Get the reader listener.

Returns:
com.rti.dds.subscription.DataReaderListener
(p. 518)
of
the
498
Class Documentation
See also:
get listener (abstract) (p. 934)
8.37.2.9
Calls the reader listener.

See also:
8.37.2.10
void get sample rejected status (SampleRejectedStatus

status)
Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE REJECTED STATUS communication status.

Parameters:
status <<inout>> ( p. 279) com.rti.dds.subscription.SampleRejectedStatus
(p. 1418) to be filled in. Cannot be NULL.
Exceptions:
8.37.2.11
void get liveliness changed status

(LivelinessChangedStatus status)
Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS CHANGED STATUS communication status.

Parameters:
status <<inout>> ( p. 279) com.rti.dds.subscription.LivelinessChangedStatus
Exceptions:

8.37.2.12
499
void get requested deadline missed status

(RequestedDeadlineMissedStatus status)
Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED DEADLINE MISSED STATUS communication status.

Parameters:
status <<inout>> ( p. 279) com.rti.dds.subscription.RequestedDeadlineMissedStatus
Exceptions:
8.37.2.13
void get requested incompatible qos status

(RequestedIncompatibleQosStatus status)
Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED INCOMPATIBLE QOS STATUS communication status.

Parameters:
status <<inout>> ( p. 279) com.rti.dds.subscription.RequestedIncompatibleQosStatus
Exceptions:
8.37.2.14
void get sample lost status (SampleLostStatus status)
Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE LOST STATUS STATUS communication status.

Parameters:
status <<inout>> ( p. 279) com.rti.dds.subscription.SampleLostStatus
Exceptions:
500
Class Documentation
8.37.2.15
void get subscription matched status

(SubscriptionMatchedStatus status)
Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.SUBSCRIPTION MATCHED STATUS communication status.

Parameters:
status <<inout>> ( p. 279) com.rti.dds.subscription.SubscriptionMatchedStatus
Exceptions:
8.37.2.16
void get datareader cache status

(DataReaderCacheStatus status)
<<eXtension>> ( p. 278) Get the datareader cache status for this reader.
Parameters:
status <<inout>> ( p. 279) com.rti.dds.subscription.DataReaderCacheStatus
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
com.rti.dds.infrastructure.RETCODE NOT ENABLED
(p. 1361).
8.37.2.17
or
void get datareader protocol status

(DataReaderProtocolStatus status)
<<eXtension>> ( p. 278) Get the datareader protocol status for this reader.
Parameters:
status <<inout>> ( p. 279) com.rti.dds.subscription.DataReaderProtocolStatus
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361).
or

8.37.2.18
501
void get matched publication datareader protocol status

(DataReaderProtocolStatus status, InstanceHandle t
publication handle)
<<eXtension>> ( p. 278) Get the datareader protocol status for this reader,
per matched publication (p. 349) identified by the publication handle.
Note: Status for a remote entity is only kept while the entity is alive. Once a
remote entity is no longer alive, its status is deleted.
Parameters:
status <<inout>> ( p. 279). The information to be filled in on the associated publication (p. 349). Cannot be NULL.
publication handle <<in>> ( p. 279). Handle to a specific publication
(p. 349) associated with the com.rti.dds.publication.DataWriter
(p. 557).
Cannot be NULL..
Must correspond to
a
publication
(p. 349)
currently
associated
with
the
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361)
8.37.2.19
or
void get matched publications (InstanceHandleSeq

publication handles)
Retrieve the list of publications currently associated

with
this
Matching publications are those in the same domain (p. 328) that
have a matching com.rti.dds.topic.Topic (p. 1545), compatible QoS
common partition that the com.rti.dds.domain.DomainParticipant
(p. 654) has not indicated should be ignored by means of the
com.rti.dds.domain.DomainParticipant.ignore publication (p. 716) operation.
The handles returned in the publication handles list are the ones
that are used by the DDS implementation to locally identify the corresponding matched com.rti.dds.publication.DataWriter (p. 557) entities. These handles match the ones that appear in the instance handle
field of the com.rti.dds.subscription.SampleInfo (p. 1398) when reading the builtin.PublicationBuiltinTopicDataTypeSupport.PUBLICATION TOPIC NAME builtin (p. 358) topic (p. 359)
502
Class Documentation
Parameters:
publication handles <<inout>> ( p. 279). The sequence will be grown
if the sequence has ownership and the system has the corresponding resources. Use a sequence without ownership to avoid dynamic
memory allocation. If the sequence is too small to store all the
matches and the system can not resize the sequence, this method
will fail with com.rti.dds.infrastructure.RETCODE OUT OF RESOURCES (p. 1362).
The maximum number of matches possible is configured with
(p. 778). You can use a zero-maximum sequence without ownership to quickly
check whether there are any matches without allocating any memory. Cannot
be NULL..
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
com.rti.dds.infrastructure.RETCODE OUT OF RESOURCES (p. 1362) if the sequence is too small and the system
can not resize it, or com.rti.dds.infrastructure.RETCODE NOT ENABLED (p. 1361)
8.37.2.20
void get matched publication data

(PublicationBuiltinTopicData publication data,
InstanceHandle t publication handle)
This operation retrieves the information on a publication (p. 349) that is currently associated with the com.rti.dds.subscription.DataReader (p. 487).
Publication with a matching com.rti.dds.topic.Topic (p. 1545), compatible
QoS and common partition that the application has not indicated should be ignored by means of the com.rti.dds.domain.DomainParticipant.ignore publication (p. 716) operation.
The publication handle must correspond to a publication (p. 349) currently
associated with the com.rti.dds.subscription.DataReader (p. 487). Otherwise, the operation will fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER
(p. 1355).
Use
the
operation
com.rti.dds.subscription.DataReader.get matched publications
(p. 501) to find the publications that are currently matched with the
Note: This operation does not retrieve the following information in
builtin.PublicationBuiltinTopicData:
builtin.PublicationBuiltinTopicData.type code (p. 1254)
503
builtin.PublicationBuiltinTopicData.property (p. 1254)

The
above
information
is
available
com.rti.dds.subscription.DataReaderListener.on data available() (p. 520) (if a reader listener is installed
builtin.PublicationBuiltinTopicDataDataReader).
through
on
the
Parameters:
publication data <<inout>> ( p. 279). The information to be filled in
on the associated publication (p. 349). Cannot be NULL.
publication handle <<in>> ( p. 279). Handle to a specific publication
(p. 557).
Cannot be NULL..
Must correspond to
currently
associated
with
the
a
publication
(p. 349)
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361)
8.37.2.21
or
TopicDescription get topicdescription ()
Returns the com.rti.dds.topic.TopicDescription (p. 1561) associated with

the com.rti.dds.subscription.DataReader (p. 487).
Returns that same com.rti.dds.topic.TopicDescription (p. 1561) that was
used to create the com.rti.dds.subscription.DataReader (p. 487).
Returns:
com.rti.dds.topic.TopicDescription (p. 1561) associated with the
8.37.2.22
Subscriber get subscriber ()
Returns the com.rti.dds.subscription.Subscriber (p. 1476) to which the

com.rti.dds.subscription.DataReader (p. 487) belongs.
Returns:
(p. 1476)
to
com.rti.dds.subscription.DataReader (p. 487) belongs.
which
the
504
Class Documentation
8.37.2.23
Deletes all the entities that were created by means of the create operations
on the com.rti.dds.subscription.DataReader (p. 487).
Deletes all contained com.rti.dds.subscription.ReadCondition (p. 1313)
and com.rti.dds.subscription.QueryCondition (p. 1311) objects.
The operation will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363) if the any of the contained entities
is in a state where it cannot be deleted.
Once
com.rti.dds.subscription.DataReader.delete contained entities (p. 504) completes successfully, the application may delete the
com.rti.dds.subscription.DataReader (p. 487), knowing that it has
no contained com.rti.dds.subscription.ReadCondition (p. 1313) and
com.rti.dds.subscription.QueryCondition (p. 1311) objects.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.37.2.24
void wait for historical data (Duration t max wait)
Waits
until
all
historical
non-VOLATILE Durability Qos kind.
data
(p. 487)
is
received
for
entities that have a
This operation is intended only for com.rti.dds.subscription.DataReader

(p. 487) entities that have a non-VOLATILE Durability QoS kind.
As
soon
as
an
application
enables
a
non-VOLATILE
com.rti.dds.subscription.DataReader (p. 487), it will start receiving
both historical data (i.e., the data that was written prior to the time the
com.rti.dds.subscription.DataReader (p. 487) joined the domain (p. 328))
as well as any new data written by the com.rti.dds.publication.DataWriter
(p. 557) entities. There are situations where the application logic may require
the application to wait until all historical data is received. This is the purpose
of the com.rti.dds.subscription.DataReader.wait for historical data
(p. 504) operations.
The
operation
com.rti.dds.subscription.DataReader.wait for historical data (p. 504) blocks the calling thread until either all historical
data is received, or else duration specified by the max wait parameter clapses,
whichever happens first. A successful completion indicates that all the historical data was received; timing out indicates that max wait elapsed before
505
all the data was received.

Parameters:
max wait <<in>> ( p. 279) Timeout value. Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
com.rti.dds.infrastructure.RETCODE TIMEOUT
(p. 1364)
or com.rti.dds.infrastructure.RETCODE NOT ENABLED
(p. 1361).
8.37.2.25
void acknowledge sample (SampleInfo sample info)
Acknowledge a single sample explicitly.
Applicable only when com.rti.dds.infrastructure.ReliabilityQosPolicy.acknowledgment kind (p. 1328) = com.rti.dds.infrastructure.ReliabilityQosPolicyAcknowledgmentModeKind.ReliabilityQosPolicyAckn

EXPLICIT ACKNOWLEDGMENT MODE
Parameters:
sample info <<in>> ( p. 279) com.rti.dds.subscription.SampleInfo
(p. 1398) identifying the sample being acknowledged.
Exceptions:
8.37.2.26
void acknowledge all ()
Acknowledge all previously accessed samples.
Applicable only when com.rti.dds.infrastructure.ReliabilityQosPolicy.acknowledgment kind (p. 1328) = com.rti.dds.infrastructure.ReliabilityQosPolicyAcknowledgmentModeKind.ReliabilityQosPolicyAckn

Exceptions:
506
Class Documentation
8.37.2.27
void acknowledge sample (SampleInfo sample info,

AckResponseData t response data)
[Not supported.] Acknowledge a single sample explicitly
Applicable only when com.rti.dds.infrastructure.ReliabilityQosPolicy.acknowledgment kind (p. 1328) = com.rti.dds.infrastructure.ReliabilityQosPolicyAcknowledgmentModeKind.ReliabilityQ

Parameters:
sample info <<in>> ( p. 279) com.rti.dds.subscription.SampleInfo
(p. 1398) identifying the sample being acknowledged.
response data <<in>>
( p. 279)
Response
data
sent
to
com.rti.dds.publication.DataWriter (p. 557) upon acknowledgment
Exceptions:
8.37.2.28
void acknowledge all (AckResponseData t response data)
[Not supported.] Acknowledge all previously accessed samples
Applicable only when com.rti.dds.infrastructure.ReliabilityQosPolicy.acknowledgment kind (p. 1328) = com.rti.dds.infrastructure.ReliabilityQosPolicyAcknowledgmentModeKind.ReliabilityQ

Parameters:
response data <<in>>
( p. 279)
Response
data
sent
to
com.rti.dds.publication.DataWriter (p. 557) upon acknowledgment
Exceptions:
8.37.2.29
void read untyped (List received data, SampleInfoSeq


This method allows type-independent code to work with a variety of concrete
com.rti.ndds.example.FooDataReader (p. 979) classes in a consistent way.
507
Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataReader.read (p. 981) method instead
of this one. See that method for detailed documentation.
See also:
com.rti.dds.subscription.DataReader.take untyped (p. 507)
8.37.2.30
void take untyped (List received data, SampleInfoSeq


Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataReader.take (p. 983) method instead
See also:
com.rti.dds.subscription.DataReader.read untyped (p. 506)
8.37.2.31
void read w condition untyped (List received data,

SampleInfoSeq info seq, int max samples,

Statically
type-safe
code
should
use
the
appropriate
(p. 990)
method instead of this one. See that method for detailed documentation.
See also:
com.rti.dds.subscription.DataReader.take w condition untyped
(p. 508)
508
Class Documentation
8.37.2.32
void take w condition untyped (List received data,


Statically
type-safe
code
should
use
the
appropriate
(p. 991)
See also:
com.rti.dds.subscription.DataReader.read w condition untyped
(p. 507)
8.37.2.33
void read next sample untyped (Object received data,

SampleInfo sample info)

Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataReader.read next sample
(p. 993)
See also:
com.rti.dds.subscription.DataReader.take next sample untyped
(p. 508)
8.37.2.34
void take next sample untyped (Object received data,


Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataReader.take next sample
(p. 994)
509
See also:
com.rti.dds.subscription.DataReader.read next sample untyped
(p. 508)
8.37.2.35
void read instance untyped (List received data,

InstanceHandle t a handle, int sample states, int

Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataReader.read instance (p. 995) method
instead of this one. See that method for detailed documentation.
See also:
com.rti.dds.subscription.DataReader.take instance untyped
(p. 509)
com.rti.ndds.example.FooDataReader.read instance (p. 995)
8.37.2.36
void take instance untyped (List received data,


Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataReader.take instance (p. 997) method
See also:
com.rti.dds.subscription.DataReader.read instance untyped
(p. 509)
com.rti.ndds.example.FooDataReader.take instance (p. 997)
510
Class Documentation
8.37.2.37
void read instance w condition untyped (List

received data, SampleInfoSeq info seq, int max samples,
InstanceHandle t a handle, ReadCondition
read condition)

Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataReader.read next instance w condition (p. 1004) method instead of this one. See that method for
detailed documentation.
See also:
com.rti.dds.subscription.DataReader.take next instance w condition untyped (p. 512)
com.rti.ndds.example.FooDataReader.read next instance w condition (p. 1004)
8.37.2.38
void take instance w condition untyped (List

read condition)

Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataReader.take next instance w condition (p. 1006) method instead of this one. See that method for
See also:
com.rti.dds.subscription.DataReader.read next instance w condition untyped (p. 511)
com.rti.ndds.example.FooDataReader.take next instance w condition (p. 1006)

8.37.2.39
511
void read next instance untyped (List received data,


Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataReader.read next instance
(p. 999)
See also:
com.rti.dds.subscription.DataReader.take next instance untyped
(p. 511)
com.rti.ndds.example.FooDataReader.read next instance (p. 999)
8.37.2.40
void take next instance untyped (List received data,


Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataReader.take next instance
(p. 1002)
See also:
com.rti.dds.subscription.DataReader.read next instance untyped (p. 511)
com.rti.ndds.example.FooDataReader.take next instance (p. 1002)
8.37.2.41
void read next instance w condition untyped (List

read condition)

512
Class Documentation

Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataReader.read next instance w condition (p. 1004) method instead of this one. See that method for
See also:
com.rti.dds.subscription.DataReader.take next instance w condition untyped (p. 512)
8.37.2.42
void take next instance w condition untyped (List

read condition)

Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataReader.take next instance w condition (p. 1006) method instead of this one. See that method for
See also:
com.rti.dds.subscription.DataReader.read next instance w condition untyped (p. 511)
8.37.2.43
void return loan untyped (List received data,

SampleInfoSeq info seq)
Return loaned sample data and meta-data.

Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataReader.return loan (p. 1008) method
513
See also:
8.37.2.44
void get key value untyped (Object key holder,


Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataReader.get key value (p. 1009) method
See also:
com.rti.ndds.example.FooDataReader.get key value (p. 1009)
8.37.2.45
InstanceHandle t lookup instance untyped (Object

key value)
514
Class Documentation
8.38
DataReaderAdapter Class Reference
<<eXtension>> ( p. 278) A listener adapter in the spirit of the Java AWT

listener adapters. (The Adapter provides empty implementations for the listener
methods)
Inheritance diagram for DataReaderAdapter::

void on requested deadline missed (DataReader reader,
questedDeadlineMissedStatus status)
Re-
Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED DEADLINE MISSED STATUS communication status.
void on requested incompatible qos (DataReader reader, RequestedIncompatibleQosStatus status)

Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED INCOMPATIBLE QOS STATUS communication status.
void on sample rejected (DataReader reader, SampleRejectedStatus status)

Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE REJECTED STATUS communication status.
void on liveliness changed

ChangedStatus status)
(DataReader
reader,
Liveliness-
Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS CHANGED STATUS communication status.
void on data available (DataReader reader)

Handle
the
com.rti.dds.infrastructure.StatusKind.StatusKind.DATA AVAILABLE STATUS communication status.
void on sample lost (DataReader reader, SampleLostStatus status)

Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE LOST STATUS STATUS communication status.
void on subscription matched (DataReader reader, SubscriptionMatchedStatus status)

Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.SUBSCRIPTION MATCHED STATUS communication status.
8.38 DataReaderAdapter Class Reference
8.38.1
515

methods)
Clients who do not wish to implement all listener methods can subclass this
class and override only the methods of interest.
8.38.2
8.38.2.1

RequestedDeadlineMissedStatus status)

Implements DataReaderListener (p. 519).
8.38.2.2
void on requested incompatible qos (DataReader reader,

RequestedIncompatibleQosStatus status)

8.38.2.3
void on sample rejected (DataReader reader,

SampleRejectedStatus status)

8.38.2.4
void on liveliness changed (DataReader reader,

LivelinessChangedStatus status)

516
Class Documentation
8.38.2.5
Handle
the
8.38.2.6
void on sample lost (DataReader reader,

SampleLostStatus status)

8.38.2.7
void on subscription matched (DataReader reader,

SubscriptionMatchedStatus status)

8.39 DataReaderCacheStatus Class Reference
8.39
517
DataReaderCacheStatus Class Reference
<<eXtension>> ( p. 278) The status of the readers cache.

Inherits Status.
Public Attributes
long sample count peak
The highest number of samples in the readers queue over the lifetime of the
reader.
long sample count

The number of samples in the readers queue.
8.39.1

Entity:
8.39.2
8.39.2.1
The highest number of samples in the readers queue over the lifetime of the
reader.
8.39.2.2
long sample count
The number of samples in the readers queue.

includes samples that may not yet be available to be read or taken by the user,
due to samples being received out of order or PRESENTATION (p. 90)
518
Class Documentation
8.40
DataReaderListener Interface Reference
<<interface>> ( p. 279) com.rti.dds.infrastructure.Listener (p. 1130) for

reader status.
Inheritance diagram for DataReaderListener::

questedDeadlineMissedStatus status)
Re-
void on requested incompatible qos (DataReader reader, RequestedIncompatibleQosStatus status)

void on sample rejected (DataReader reader, SampleRejectedStatus status)

void on liveliness changed

ChangedStatus status)
(DataReader
reader,
Liveliness-

Handle
the
void on sample lost (DataReader reader, SampleLostStatus status)

void on subscription matched (DataReader reader, SubscriptionMatchedStatus status)

8.40 DataReaderListener Interface Reference
8.40.1
519

reader status.
Entity:
Status:
(p. 1135);
(p. 1344);
com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED INCOMPATIBLE QOS STATUS, com.rti.dds.subscription.RequestedIncompatibleQosStatus
(p. 1346);
com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE LOST com.rti.dds.subscription.SampleLostStatus
STATUS STATUS,
(p. 1410);
(p. 1418);
com.rti.dds.infrastructure.StatusKind.StatusKind.SUBSCRIPTION MATCHED STATUS, com.rti.dds.subscription.SubscriptionMatchedStatus
(p. 1519);
See also:
Status Kinds (p. 110)
8.40.2
8.40.2.1

RequestedDeadlineMissedStatus status)

Implemented in DataReaderAdapter (p. 515).
520
Class Documentation
8.40.2.2
void on requested incompatible qos (DataReader reader,

RequestedIncompatibleQosStatus status)

8.40.2.3
void on sample rejected (DataReader reader,

SampleRejectedStatus status)

8.40.2.4
void on liveliness changed (DataReader reader,

LivelinessChangedStatus status)

8.40.2.5
Handle
the
8.40.2.6
void on sample lost (DataReader reader,

SampleLostStatus status)

8.40.2.7
void on subscription matched (DataReader reader,

SubscriptionMatchedStatus status)

8.41 DataReaderProtocolQosPolicy Class Reference
8.41
521
DataReaderProtocolQosPolicy Class Reference
Along with com.rti.dds.infrastructure.WireProtocolQosPolicy (p. 1723)

and com.rti.dds.infrastructure.DataWriterProtocolQosPolicy (p. 592),
this QoS policy configures the DDS on-the-network protocol (RTPS).
Inheritance diagram for DataReaderProtocolQosPolicy::
Public Attributes
GUID t virtual guid
The virtual GUID (Global Unique Identifier).
int rtps object id

The RTPS Object ID.
boolean expects inline qos

Specifies whether this DataReader expects inline QoS with every sample.
boolean disable positive acks

Whether the reader sends positive acknowledgements to writers.
boolean propagate dispose of unregistered instances

Indicates whether or not an instance can move to the
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE DISPOSED INSTANCE STATE state without being in the
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.ALIVE INTANCE STATE state.
final RtpsReliableReaderProtocol t rtps reliable reader

The reliable protocol defined in RTPS.
8.41.1
Along with com.rti.dds.infrastructure.WireProtocolQosPolicy (p. 1723)

and com.rti.dds.infrastructure.DataWriterProtocolQosPolicy (p. 592),
this QoS policy configures the DDS on-the-network protocol (RTPS).
DDS has a standard protocol for packet (user and meta data) exchange between applications using DDS for communications. This QoS policy and
522
Class Documentation
com.rti.dds.infrastructure.DataReaderProtocolQosPolicy (p. 521) give

you control over configurable portions of the protocol, including the configuration of the reliable data delivery mechanism of the protocol on a per DataWriter
or DataReader basis.
These configuration parameters control timing, timeouts, and give you the ability to tradeoff between speed of data loss detection and repair versus network
and CPU bandwidth used to maintain reliability.
It
is
important
to
tune
the
reliability
protocol
(on
a
and
per
(p. 557)
com.rti.dds.subscription.DataReader (p. 487) basis) to meet the requirements of the end-user application so that data can be sent between
DataWriters and DataReaders in an efficient and optimal manner in the
presence of data loss.
You can also use this QoS policy to control how RTI Connext responds
to slow reliable DataReaders or ones that disconnect or are otherwise lost. See com.rti.dds.infrastructure.ReliabilityQosPolicy (p. 1324)
for more information on the per-DataReader/DataWriter reliability configuration. com.rti.dds.infrastructure.HistoryQosPolicy (p. 1046) and
com.rti.dds.infrastructure.ResourceLimitsQosPolicy (p. 1348) also play
an important role in the DDS reliable protocol.
Entity:
Properties:
RxO (p. 101) = N/A
8.41.2
8.41.2.1
GUID t virtual guid

The virtual GUID is used to uniquely identify different incarnations of the same
The association between a com.rti.dds.subscription.DataReader (p. 487)
and its persisted state is done using the virtual GUID.
[default] com.rti.dds.infrastructure.GUID t.AUTO

8.41.2.2
523
int rtps object id
The RTPS Object ID.

This value is used to determine the RTPS object ID of a data reader according
to the DDS-RTPS Interoperability Wire Protocol.
Only the last 3 bytes are used; the most significant byte is ignored.
If the default value is specified, RTI Connext will automatically assign the object
ID based on a counter value (per participant) starting at 0x00800000. That
value is incremented for each new data reader.
A rtps object id value in the interval [0x00800000,0x00ffffff] may collide with the
automatic values assigned by RTI Connext. In those cases, the recomendation
is not to use automatic object ID assigment.
[default] com.rti.dds.infrastructure.WireProtocolQosPolicy.RTPS AUTO ID (p. 1728)
[range] [0,0x00ffffff]
8.41.2.3
boolean expects inline qos
Specifies whether this DataReader expects inline QoS with every sample.
In RTI Connext, a com.rti.dds.subscription.DataReader (p. 487)
nominally relies on Discovery to propagate QoS on a matched
Alternatively,
a
com.rti.dds.subscription.DataReader (p. 487) may get information
on a matched com.rti.dds.publication.DataWriter (p. 557) through QoS
sent inline with a sample.
Asserting com.rti.dds.infrastructure.DataReaderProtocolQosPolicy.expects inline qos
(p. 523)
indicates
to
a
matching
(p. 557)
that
this
com.rti.dds.subscription.DataReader (p. 487) expects to receive inline QoS with every sample.
The complete set of inline QoS that a
com.rti.dds.publication.DataWriter (p. 557) may send inline is specified
by the Real-Time Publish-Subscribe (RTPS) Wire Interoperability Protocol.
Because RTI Connext com.rti.dds.publication.DataWriter (p. 557) and
com.rti.dds.subscription.DataReader (p. 487) cache Discovery information, inline QoS are largely redundant and thus unecessary. Only for other stateless implementations whose com.rti.dds.subscription.DataReader (p. 487)
does not cache Discovery information is inline QoS necessary.
Also note that inline QoS are additional wire-payload that consume additional
bandwidth and serialization and deserialization time.
524
Class Documentation
8.41.2.4
Whether the reader sends positive acknowledgements to writers.

If set to com.rti.dds.infrastructure.true, the reader does not send positive acknowledgments (ACKs) in response to Heartbeat messages. The reader will send
negative acknowledgements (NACKs) when a Heartbeat advertises samples that
it has not received.
Otherwise,
if
set
to
(the
default), the reader will send ACKs to writers that expect ACKs
(com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.disable positive acks
(p. 594)
=
com.rti.dds.infrastructure.false)
and
it
will
not
send
ACKs
to
writers
that
disable
ACKs
(com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.disable positive acks (p. 594) = com.rti.dds.infrastructure.true)
8.41.2.5
boolean propagate dispose of unregistered instances
Indicates
whether
or
not
an
instance
can
move
to
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE DISPOSED INSTANCE STATE state without being in
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.ALIVE INTANCE STATE state.
the
the
This field only applies to keyed readers.

When the field is set to com.rti.dds.infrastructure.true, the DataReader will
receive dispose notifications even if the instance is not alive.
To
guarantee
the
key
availability
through
the
usage
of
the
API
com.rti.ndds.example.FooDataReader.get key value (p. 1009),
this option should be used in combination
com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.serialize key with dispose (p. 595) on the DataWriter that should be set to
com.rti.dds.infrastructure.true.
8.41.2.6
final RtpsReliableReaderProtocol t rtps reliable reader
Initial value:
new RtpsReliableReaderProtocol_t()

525
[default] min heartbeat response delay 0 seconds; max heartbeat response delay 0.5 seconds
526
Class Documentation
8.42
DataReaderProtocolStatus
ence
Class
Refer-
<<eXtension>> ( p. 278) The status of a readers internal protocol related

Inherits Status.
Public Attributes
long received sample count
The number of user samples from a remote DataWriter received for the first
time by a local DataReader ( p. 487).
long received sample count change

The incremental change in the number of user samples from a remote
DataWriter received for the first time by a local DataReader ( p. 487) since
the last time the status was read.
long received sample bytes

The number of bytes of user samples from a remote DataWriter received for
the first time by a local DataReader ( p. 487).
long received sample bytes change

The incremental change in the number of bytes of user samples from a remote
DataWriter received for the first time by a local DataReader ( p. 487) since
long duplicate sample count

The number of samples from a remote DataWriter received, not for the first
time, by a local DataReader ( p. 487).
long duplicate sample count change

The incremental change in the number of samples from a remote DataWriter
received, not for the first time, by a local DataReader ( p. 487) since the last
time the status was read.
long duplicate sample bytes

The number of bytes of samples from a remote DataWriter received, not for
the first time, by a local DataReader ( p. 487).
long duplicate sample bytes change

8.42 DataReaderProtocolStatus Class Reference
527
The incremental change in the number of bytes of samples from a remote

DataWriter received, not for the first time, by a local DataReader ( p. 487)
since the last time the status was read.
long filtered sample count

The number of user samples filtered by the local DataReader ( p. 487) due
to Content-Filtered Topics or Time-Based Filter.
long filtered sample count change

The incremental change in the number of user samples filtered by the local
DataReader ( p. 487) due to Content-Filtered Topics or Time-Based Filter
long filtered sample bytes

The number of bytes of user samples filtered by the local DataReader
( p. 487) due to Content-Filtered Topics or Time-Based Filter.
long filtered sample bytes change

The incremental change in the number of bytes of user samples filtered by the
local DataReader ( p. 487) due to Content-Filtered Topics or Time-Based
Filter since the last time the status was read.
long received heartbeat count

The number of Heartbeats from a remote DataWriter received by a local
DataReader ( p. 487).
long received heartbeat count change

The incremental change in the number of Heartbeats from a remote
DataWriter received by a local DataReader ( p. 487) since the last time the
status was read.
long received heartbeat bytes

The number of bytes of Heartbeats from a remote DataWriter received by a
local DataReader ( p. 487).
long received heartbeat bytes change

The incremental change in the number of bytes of Heartbeats from a remote
DataWriter received by a local DataReader ( p. 487) since the last time the
status was read.
long sent ack count

The number of ACKs sent from a local DataReader ( p. 487) to a matching
remote DataWriter.
long sent ack count change

528
Class Documentation
The incremental change in the number of ACKs sent from a local
DataReader ( p. 487) to a matching remote DataWriter since the last time
the status was read.
long sent ack bytes

The number of bytes of ACKs sent from a local DataReader ( p. 487) to a
matching remote DataWriter.
long sent ack bytes change

The incremental change in the number of bytes of ACKs sent from a local
long sent nack count

The number of NACKs sent from a local DataReader ( p. 487) to a matching
remote DataWriter.
long sent nack count change

The incremental change in the number of NACKs sent from a local
long sent nack bytes

The number of bytes of NACKs sent from a local DataReader ( p. 487) to
a matching remote DataWriter.
long sent nack bytes change

The incremental change in the number of bytes of NACKs sent from a local
long received gap count

The number of GAPs received from remote DataWriter to this DataReader
( p. 487).
long received gap count change

The incremental change in the number of GAPs received from remote
DataWriter to this DataReader ( p. 487) since the last time the status was
read.
long received gap bytes

The number of bytes of GAPs received from remote DataWriter to this
DataReader ( p. 487).
long received gap bytes change

529
The incremental change in the number of bytes of GAPs received from remote
DataWriter to this DataReader ( p. 487) since the last time the status was
read.
long rejected sample count

The number of times a sample is rejected due to exceptions in the receive
path.
long rejected sample count change

The incremental change in the number of times a sample is rejected due to
exceptions in the receive path since the last time the status was read.
SequenceNumber t first available sample sequence number

Sequence number of the first available sample in a matched Datawriters reliability queue.
SequenceNumber t last available sample sequence number

Sequence number of the last available sample in a matched Datawriters reliability queue.
SequenceNumber t last committed sample sequence number

Sequence number of the newest sample received from the matched DataWriter
committed to the DataReaders queue.
int uncommitted sample count

Number of received samples that are not yet available to be read or taken,
due to being received out of order.
8.42.1

Entity:
8.42.2
8.42.2.1
long received sample count
The number of user samples from a remote DataWriter received for the first
time by a local DataReader (p. 487).
530
Class Documentation
8.42.2.2
long received sample count change
The incremental change in the number of user samples from a remote DataWriter
received for the first time by a local DataReader (p. 487) since the last time
8.42.2.3
long received sample bytes
The number of bytes of user samples from a remote DataWriter received for the
first time by a local DataReader (p. 487).
8.42.2.4
long received sample bytes change
The incremental change in the number of bytes of user samples from a remote
DataWriter received for the first time by a local DataReader (p. 487) since the
last time the status was read.
8.42.2.5
long duplicate sample count
The number of samples from a remote DataWriter received, not for the first
time, by a local DataReader (p. 487).
Such samples can be redundant, out-of-order, etc. and are not stored in the
readers queue.
8.42.2.6
long duplicate sample count change
The incremental change in the number of samples from a remote DataWriter

received, not for the first time, by a local DataReader (p. 487) since the last
readers queue.
8.42.2.7
long duplicate sample bytes
The number of bytes of samples from a remote DataWriter received, not for the
first time, by a local DataReader (p. 487).
readers queue.

8.42.2.8
531
long duplicate sample bytes change
The incremental change in the number of bytes of samples from a remote

DataWriter received, not for the first time, by a local DataReader (p. 487)
readers queue.
8.42.2.9
The number of user samples filtered by the local DataReader (p. 487) due to
Content-Filtered Topics or Time-Based Filter.
8.42.2.10
The incremental change in the number of user samples filtered by the local
DataReader (p. 487) due to Content-Filtered Topics or Time-Based Filter since
8.42.2.11
The number of bytes of user samples filtered by the local DataReader (p. 487)
due to Content-Filtered Topics or Time-Based Filter.
8.42.2.12
The incremental change in the number of bytes of user samples filtered by the
local DataReader (p. 487) due to Content-Filtered Topics or Time-Based Filter
8.42.2.13
long received heartbeat count
The number of Heartbeats from a remote DataWriter received by a local

DataReader (p. 487).
8.42.2.14
long received heartbeat count change
The incremental change in the number of Heartbeats from a remote DataWriter

received by a local DataReader (p. 487) since the last time the status was read.
532
Class Documentation
8.42.2.15
long received heartbeat bytes
The number of bytes of Heartbeats from a remote DataWriter received by a

local DataReader (p. 487).
8.42.2.16
long received heartbeat bytes change
The incremental change in the number of bytes of Heartbeats from a remote

DataWriter received by a local DataReader (p. 487) since the last time the
status was read.
8.42.2.17
long sent ack count
The number of ACKs sent from a local DataReader (p. 487) to a matching
remote DataWriter.
8.42.2.18
long sent ack count change
The incremental change in the number of ACKs sent from a local DataReader
(p. 487) to a matching remote DataWriter since the last time the status was
read.
8.42.2.19
long sent ack bytes
The number of bytes of ACKs sent from a local DataReader (p. 487) to a
8.42.2.20
long sent ack bytes change
The incremental change in the number of bytes of ACKs sent from a local
DataReader (p. 487) to a matching remote DataWriter since the last time the
status was read.
8.42.2.21
long sent nack count
The number of NACKs sent from a local DataReader (p. 487) to a matching
remote DataWriter.

8.42.2.22
533
long sent nack count change
The incremental change in the number of NACKs sent from a local DataReader
(p. 487) to a matching remote DataWriter since the last time the status was read.
8.42.2.23
long sent nack bytes
The number of bytes of NACKs sent from a local DataReader (p. 487) to a
8.42.2.24
long sent nack bytes change
The incremental change in the number of bytes of NACKs sent from a local
DataReader (p. 487) to a matching remote DataWriter since the last time the
status was read.
8.42.2.25
long received gap count
The number of GAPs received from remote DataWriter to this DataReader

(p. 487).
8.42.2.26
long received gap count change
The incremental change in the number of GAPs received from remote

DataWriter to this DataReader (p. 487) since the last time the status was
read.
8.42.2.27
long received gap bytes
The number of bytes of GAPs received from remote DataWriter to this

DataReader (p. 487).
8.42.2.28
long received gap bytes change
The incremental change in the number of bytes of GAPs received from remote
DataWriter to this DataReader (p. 487) since the last time the status was
read.
8.42.2.29
The number of times a sample is rejected due to exceptions in the receive path.
534
Class Documentation
8.42.2.30

exceptions in the receive path since the last time the status was read.
8.42.2.31
Sequence number of the first available sample in a matched Datawriters reliability queue.
Applicable only for reliable DataReaders, and when retrieving matched
DataWriter statuses.
Updated upon receiving Heartbeat submessages from a matched reliable
DataWriter.
8.42.2.32
Sequence number of the last available sample in a matched Datawriters reliability queue.
Applicable only for reliable DataReaders, and when retrieving matched
DataWriter statuses.
Updated upon receiving Heartbeat submessages from a matched reliable
DataWriter.
8.42.2.33
SequenceNumber t last committed sample sequence number
Sequence number of the newest sample received from the matched DataWriter
committed to the DataReaders queue.
Applicable only when retrieving matched DataWriter statuses.
For best-effort DataReaders, this is the sequence number of the latest sample
received.
For reliable DataReaders, this is the sequence number of the latest sample that
is available to be read or taken from the DataReaders queue.
8.42.2.34
int uncommitted sample count
Number of received samples that are not yet available to be read or taken, due
to being received out of order.

Applicable only when retrieving matched DataWriter statuses.
535
536
Class Documentation
8.43
DataReaderQos Class Reference
QoS policies supported by a com.rti.dds.subscription.DataReader (p. 487)

entity.
Inheritance diagram for DataReaderQos::
Public Attributes
final DurabilityQosPolicy durability
Durability policy, DURABILITY ( p. 68).
final DeadlineQosPolicy deadline

Deadline policy, DEADLINE ( p. 52).
final LatencyBudgetQosPolicy latency budget

Latency budget policy, LATENCY BUDGET ( p. 80).
final LivelinessQosPolicy liveliness

Liveliness policy, LIVELINESS ( p. 82).
final ReliabilityQosPolicy reliability

Reliability policy, RELIABILITY ( p. 105).
final DestinationOrderQosPolicy destination order

Destination order policy, DESTINATION ORDER ( p. 53).
final HistoryQosPolicy history

History policy, HISTORY ( p. 79).
final ResourceLimitsQosPolicy resource limits

Resource limits policy, RESOURCE LIMITS ( p. 106).
final UserDataQosPolicy user data

User data policy, USER DATA ( p. 132).
final OwnershipQosPolicy ownership

Ownership policy, OWNERSHIP ( p. 87).
final TimeBasedFilterQosPolicy time based filter

Time-based filter policy, TIME BASED FILTER ( p. 117).
8.43 DataReaderQos Class Reference
537
final ReaderDataLifecycleQosPolicy reader data lifecycle

Reader data lifecycle policy, READER DATA LIFECYCLE ( p. 103).
final DataReaderResourceLimitsQosPolicy
limits
reader resource -
<<eXtension>>
(p. 278)
( p. 487) resource limits policy, DATA READER RESOURCE LIMITS
( p. 48). This policy is an extension to the DDS standard.
final DataReaderProtocolQosPolicy protocol

<<eXtension>>
(p. 278)
( p. 487) protocol policy, DATA READER PROTOCOL ( p. 47)
final TransportSelectionQosPolicy transport selection

<<eXtension>> (p. 278) Transport selection policy, TRANSPORT SELECTION ( p. 127).
final TransportUnicastQosPolicy unicast

<<eXtension>> (p. 278) Unicast transport policy, TRANSPORT UNICAST ( p. 128).
final TransportMulticastQosPolicy multicast

<<eXtension>> (p. 278) Multicast transport policy, TRANSPORT MULTICAST ( p. 123).
final PropertyQosPolicy property

<<eXtension>> (p. 278) Property policy, PROPERTY ( p. 92).
final AvailabilityQosPolicy availability

<<eXtension>> (p. 278) Availability policy, AVAILABILITY ( p. 43).
final EntityNameQosPolicy subscription name

<<eXtension>> (p. 278) EntityName policy, ENTITY NAME ( p. 74).
final TypeConsistencyEnforcementQosPolicy type consistency

Type consistency enforcement
ENFORCEMENT ( p. 129).
policy,
TYPE CONSISTENCY -
final TypeSupportQosPolicy type support

<<eXtension>> (p. 278) type support data, TYPESUPPORT ( p. 130).
538
Class Documentation
8.43.1
QoS policies supported by a com.rti.dds.subscription.DataReader (p. 487)

entity.
You must set certain members in a consistent manner:
com.rti.dds.subscription.DataReaderQos.deadline.period
>=
com.rti.dds.subscription.DataReaderQos.time based filter.minimum separation
com.rti.dds.subscription.DataReaderQos.history.depth
<=
com.rti.dds.subscription.DataReaderQos.resource limits.max samples per instance
com.rti.dds.subscription.DataReaderQos.resource limits.max samples per instance <= com.rti.dds.subscription.DataReaderQos.resource limits.max samples
com.rti.dds.subscription.DataReaderQos.resource limits.initial samples <= com.rti.dds.subscription.DataReaderQos.resource limits.max samples
com.rti.dds.subscription.DataReaderQos.resource limits.initial instances
com.rti.dds.subscription.DataReaderQos.resource limits.max instances
<=
com.rti.dds.subscription.DataReaderQos.reader resource limits.initial remote writers per instance <= com.rti.dds.subscription.DataReaderQos.reader resource limits.max remote writers per instance
com.rti.dds.subscription.DataReaderQos.reader resource limits.initial infos <=
com.rti.dds.subscription.DataReaderQos.reader resource limits.max infos
com.rti.dds.subscription.DataReaderQos.reader resource limits.max remote writers per instance <= com.rti.dds.subscription.DataReaderQos.reader resource limits.max remote writers
com.rti.dds.subscription.DataReaderQos.reader resource limits.max samples per remote writer
<=
com.rti.dds.subscription.DataReaderQos.resource limits.max samples
length
of
com.rti.dds.subscription.DataReaderQos.user data.value
<=
com.rti.dds.domain.DomainParticipantQos.resource limits.reader user data max length
If any of the above are not true, com.rti.dds.subscription.DataReader.set qos (p. 495) and com.rti.dds.subscription.DataReader.set qos with profile (p. 496) will fail with com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY (p. 1359)
8.43.2
8.43.2.1
Durability policy, DURABILITY (p. 68).
8.43.2.2
Deadline policy, DEADLINE (p. 52).
8.43.2.3
Latency budget policy, LATENCY BUDGET (p. 80).
8.43.2.4
Liveliness policy, LIVELINESS (p. 82).
8.43.2.5
Reliability policy, RELIABILITY (p. 105).
8.43.2.6
Destination order policy, DESTINATION ORDER (p. 53).
8.43.2.7
History policy, HISTORY (p. 79).
8.43.2.8
Resource limits policy, RESOURCE LIMITS (p. 106).
8.43.2.9
User data policy, USER DATA (p. 132).

539
540
Class Documentation
8.43.2.10
Ownership policy, OWNERSHIP (p. 87).

8.43.2.11
Time-based filter policy, TIME BASED FILTER (p. 117).

8.43.2.12
final ReaderDataLifecycleQosPolicy reader data lifecycle
Reader data lifecycle policy, READER DATA LIFECYCLE (p. 103).

8.43.2.13
final DataReaderResourceLimitsQosPolicy
reader resource limits
<<eXtension>> ( p. 278) com.rti.dds.subscription.DataReader (p. 487)

resource limits policy, DATA READER RESOURCE LIMITS (p. 48).
This policy is an extension to the DDS standard.
8.43.2.14
final DataReaderProtocolQosPolicy protocol
<<eXtension>> ( p. 278) com.rti.dds.subscription.DataReader (p. 487)

protocol policy, DATA READER PROTOCOL (p. 47)
8.43.2.15
<<eXtension>> ( p. 278) Transport selection policy, TRANSPORT SELECTION (p. 127).

Specifies
the
transports
available
for
8.43.2.16
use
by
the
<<eXtension>> ( p. 278) Unicast transport policy,

UNICAST (p. 128).
TRANSPORT -
Specifies the unicast transport interfaces and ports on which messages can be
received.
The
unicast
interfaces
are
used
to
receive
messages
from
com.rti.dds.publication.DataWriter (p. 557) entities in the domain
(p. 328).

8.43.2.17
541
final TransportMulticastQosPolicy multicast
<<eXtension>> ( p. 278) Multicast transport policy, TRANSPORT MULTICAST (p. 123).

Specifies the multicast group addresses and ports on which messages can be
received.
The multicast addresses are used to receive messages from
com.rti.dds.publication.DataWriter (p. 557) entities in the domain
(p. 328).
8.43.2.18
<<eXtension>> ( p. 278) Property policy, PROPERTY (p. 92).

8.43.2.19
<<eXtension>> ( p. 278) Availability policy, AVAILABILITY (p. 43).

8.43.2.20
<<eXtension>> ( p. 278) EntityName policy, ENTITY NAME (p. 74).

8.43.2.21
final TypeConsistencyEnforcementQosPolicy
type consistency
Type
consistency
enforcement
ENFORCEMENT (p. 129).
8.43.2.22
policy,
TYPE CONSISTENCY -
<<eXtension>> ( p. 278) type support data, TYPESUPPORT (p. 130).

Optional value that is passed to a type plugins on endpoint attached and deserialization functions.
542
Class Documentation
8.44
DataReaderResourceLimitsQosPolicy
Class Reference
Various settings that configure how a com.rti.dds.subscription.DataReader

(p. 487) allocates and uses physical memory for internal resources.
Inheritance diagram for DataReaderResourceLimitsQosPolicy::
Public Attributes
int max remote writers
The
maximum
number
of
remote
writers
from
which
a
com.rti.dds.subscription.DataReader ( p. 487) may read, including
all instances.
int max remote writers per instance

The
maximum
number
of
remote
writers
from
which
a
com.rti.dds.subscription.DataReader ( p. 487) may read a single
instance.
int max samples per remote writer

The maximum number of out-of-order samples from a given
that
a
remote
( p. 557)
com.rti.dds.subscription.DataReader ( p. 487) may store when maintaining a reliable connection to the com.rti.dds.publication.DataWriter
( p. 557).
int max infos

The
maximum
number
of
info
com.rti.dds.subscription.DataReader ( p. 487)
com.rti.dds.subscription.SampleInfo ( p. 1398).
units
that
a
can use to store
int initial remote writers

The
initial
number
of
remote
writers
from
which
a
all instances.
int initial remote writers per instance

The
initial
number
of
remote
writers
from
which
a
com.rti.dds.subscription.DataReader ( p. 487) may read a single
instance.
int initial infos

8.44 DataReaderResourceLimitsQosPolicy Class Reference
543
The
initial
number
of
info
units
that
a
com.rti.dds.subscription.DataReader ( p. 487) can have, which are
used to store com.rti.dds.subscription.SampleInfo ( p. 1398).
int initial outstanding reads

The initial number of outstanding calls to read/take (or one of
their variants) on the same com.rti.dds.subscription.DataReader
( p. 487) for which memory has not been returned by calling
com.rti.ndds.example.FooDataReader.return loan ( p. 1008).
int max outstanding reads

The maximum number of outstanding read/take calls (or one of
( p. 487) for which memory has not been returned by calling
com.rti.ndds.example.FooDataReader.return loan ( p. 1008).
int max samples per read

The maximum number of data samples that the application can receive from the middleware in a single call to
( p. 981)
or
If more data
com.rti.ndds.example.FooDataReader.take ( p. 983).
exists in the middleware, the application will need to issue multiple
read/take calls.
boolean disable fragmentation support

Determines whether the com.rti.dds.subscription.DataReader ( p. 487)
can receive fragmented samples.
int max fragmented samples

The
maximum
number
of
samples
for
which
the
com.rti.dds.subscription.DataReader ( p. 487) may store fragments
at a given point in time.
int initial fragmented samples

The
initial
number
of
samples
for
which
com.rti.dds.subscription.DataReader ( p. 487) may store fragments.
int max fragmented samples per remote writer

The maximum number of samples per remote writer for which a
com.rti.dds.subscription.DataReader ( p. 487) may store fragments.
int max fragments per sample

Maximum number of fragments for a single sample.
boolean dynamically allocate fragmented samples

544
Class Documentation
Determines whether the com.rti.dds.subscription.DataReader ( p. 487)
pre-allocates storage for storing fragmented samples.
int max total instances

Maximum number of instances for which a DataReader will keep state.
int max remote virtual writers

The maximum number of remote virtual writers from
com.rti.dds.subscription.DataReader ( p. 487) may read,
all instances.
which a
including
int initial remote virtual writers

The initial number of remote virtual writers from which a
all instances.
int max remote virtual writers per instance

The maximum number of virtual remote writers that can be associated with
an instance.
int initial remote virtual writers per instance

The initial number of virtual remote writers per instance.
int max remote writers per sample

The maximum number of remote writers allowed to write the same sample.
int max query condition filters

The maximum number of query condition filters a reader is allowed.
int max app ack response length

Maximum length of application-level acknowledgment response data.
Static Public Attributes

static final int AUTO MAX TOTAL INSTANCES
<<eXtension>>
(p. 278)
This
value
is
used
to
make
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max total instances ( p. 551) equal to com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max instances ( p. 1352).
8.44.1
545
Various settings that configure how a com.rti.dds.subscription.DataReader

DataReaders must allocate internal structures to handle the maximum
number of DataWriters that may connect to it, whether or not a
com.rti.dds.subscription.DataReader (p. 487) handles data fragmentation
and how many data fragments that it may handle (for data samples larger than
the MTU of the underlying network transport), how many simultaneous outstanding loans of internal memory holding data samples can be provided to user
code, as well as others.
Most of these internal structures start at an initial size and, by default, will grow
as needed by dynamically allocating additional memory. You may set fixed,
maximum sizes for these internal structures if you want to bound the amount
of memory that can be used by a com.rti.dds.subscription.DataReader
(p. 487). By setting the initial size to the maximum size, you will prevent
RTI Connext from dynamically allocating any memory after the creation of the
Entity:
Properties:
RxO (p. 101) = N/A
8.44.2
8.44.2.1
int max remote writers
The
maximum
number
of
remote
writers
from
which
a
com.rti.dds.subscription.DataReader (p. 487) may read, including all
instances.
[range] [1, 1 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), >= initial remote writers, >= max remote writers per instance
For unkeyed types, this value has to be equal to max remote writers per instance if max remote writers per instance is not equal to
546
Class Documentation

Note:
For
efficiency,
set
max remote writers
>=
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max remote writers per instance (p. 546).
8.44.2.2
int max remote writers per instance
The
maximum
number
of
remote
writers
from
which
a
com.rti.dds.subscription.DataReader (p. 487) may read a single instance.
[range] [1, 1024] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED
(p. 106),
<=
max remote writers
or
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), >= initial remote writers per instance
For unkeyed types, this value has to be equal to max remote writers if it is
not com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106).
Note:
For efficiency,
set max remote writers per instance <=
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max remote writers (p. 545)
8.44.2.3
int max samples per remote writer
The maximum number of out-of-order samples from a given

that
a
remote
(p. 557)
com.rti.dds.subscription.DataReader (p. 487) may store when maintaining a reliable connection to the com.rti.dds.publication.DataWriter
(p. 557).
[range] [1, 100 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), <= com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples (p. 1351)

8.44.2.4
547
int max infos
The
maximum
number
of
info
units
that
a
can use to store
When read/take is called on a DataReader, the DataReader passes a sequence of

data samples and an associated sample info sequence. The sample info sequence
contains additional information for each data sample.
max infos determines the resources allocated for storing sample info. This memory is loaned to the application when passing a sample info sequence.
Note that sample info is a snapshot, generated when read/take is called.
max infos should not be less than max samples.
[range] [1, 1 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), >= initial infos
8.44.2.5
int initial remote writers
The
initial
number
of
remote
writers
from
which
a
instances.
[default] 2
[range] [1, 1 million], <= max remote writers
For unkeyed types this value has to be equal to initial remote writers per instance.
>=
Note:
For
efficiency,
set
initial remote writers
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.initial remote writers per instance (p. 547).
8.44.2.6
int initial remote writers per instance
The
initial
number
of
remote
writers
from
which
a
com.rti.dds.subscription.DataReader (p. 487) may read a single instance.
[default] 2
[range] [1,1024], <= max remote writers per instance
For unkeyed types this value has to be equal to initial remote writers.
548
Class Documentation
Note:
For efficiency,
set initial remote writers per instance <=
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.initial remote writers (p. 547).
8.44.2.7
int initial infos
The
initial
number
of
info
units
that
com.rti.dds.subscription.DataReader (p. 487) can have, which
used to store com.rti.dds.subscription.SampleInfo (p. 1398).
a
are
[default] 32
[range] [1,1 million], <= max infos
8.44.2.8
int initial outstanding reads
The initial number of outstanding calls to read/take (or one of

(p. 487) for which memory has not been returned by calling
[default] 2
[range] [1, 65536], <= max outstanding reads
8.44.2.9
int max outstanding reads
The maximum number of outstanding read/take calls (or one of

(p. 487) for which memory has not been returned by calling
[range] [1, 65536] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), >= initial outstanding reads
8.44.2.10
int max samples per read
The maximum number of data samples that the application can receive from the
middleware in a single call to com.rti.ndds.example.FooDataReader.read
(p. 981) or com.rti.ndds.example.FooDataReader.take (p. 983). If more
data exists in the middleware, the application will need to issue multiple
read/take calls.
549
When reading data using listeners, the expected number of samples available
for delivery in a single take call is typically small: usually just one, in the
case of unbatched data, or the number of samples in a single batch, in the case
of batched data. (See com.rti.dds.infrastructure.BatchQosPolicy (p. 412)
for more information about this feature.) When polling for data or using
a com.rti.dds.infrastructure.WaitSet (p. 1709), however, multiple samples
(or batches) could be retrieved at once, depending on the data rate.
A larger value for this parameter makes the API simpler to use at the expense
of some additional memory consumption.
[default] 1024
[range] [1,65536]
8.44.2.11
boolean disable fragmentation support
Determines whether the com.rti.dds.subscription.DataReader (p. 487) can

receive fragmented samples.
When fragmentation support is not needed, disabling fragmentation support
will save some memory resources.
8.44.2.12
int max fragmented samples
The
maximum
number
of
samples
for
which
the
com.rti.dds.subscription.DataReader (p. 487) may store fragments at
a given point in time.
At any given time, a com.rti.dds.subscription.DataReader (p. 487)
may store fragments for up to max fragmented samples samples while
waiting for the remaining fragments.
These samples need not have
consecutive sequence numbers and may have been sent by different
Once all fragments of a sample have been received, the sample is treated
as a regular sample and becomes subject to standard QoS settings such
as com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples
(p. 1351).
The middleware will drop fragments if the max fragmented samples limit has
been reached. For best-effort communication, the middleware will accept a
fragment for a new sample, but drop the oldest fragmented sample from the
same remote writer. For reliable communication, the middleware will drop
fragments for any new samples until all fragments for at least one older sample
from that writer have been received.
550
Class Documentation
Only applies if com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.disable fragmentation support (p. 549) is com.rti.dds.infrastructure.false.

[default] 1024
[range] [1, 1 million]
8.44.2.13
int initial fragmented samples
The
initial
number
of
samples
for
which
com.rti.dds.subscription.DataReader (p. 487) may store fragments.

[default] 4
[range] [1,1024], <= max fragmented samples
8.44.2.14
int max fragmented samples per remote writer
The maximum number of samples per remote writer for which a

com.rti.dds.subscription.DataReader (p. 487) may store fragments.
Logical limit so a single remote writer cannot consume all available resources.
[default] 256
[range] [1, 1 million], <= max fragmented samples
8.44.2.15
int max fragments per sample
Maximum number of fragments for a single sample.

[default] 512
[range] [1, 1 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106)
8.44.2.16
boolean dynamically allocate fragmented samples
Determines whether the com.rti.dds.subscription.DataReader (p. 487) preallocates storage for storing fragmented samples.
551
By
default,
the
middleware
will
allocate
memory
upfront
for
storing
fragments
for
up
to
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.initial fragmented samples (p. 550) samples. This memory may grow up to
com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max fragmented samples (p. 549) if needed.
If
dynamically allocate fragmented samples
is
set
to
com.rti.dds.infrastructure.true, the middleware does not allocate memory
upfront, but instead allocates memory from the heap upon receiving the first
fragment of a new sample. The amount of memory allocated equals the amount
of memory needed to store all fragments in the sample. Once all fragments of a
sample have been received, the sample is deserialized and stored in the regular
receive queue. At that time, the dynamically allocated memory is freed again.
This QoS setting may be useful for large, but variable-sized data types where
upfront memory allocation for multiple samples based on the maximum possible
sample size may be expensive. The main disadvantage of not pre-allocating
memory is that one can no longer guarantee the middleware will have sufficient
resources at run-time.
8.44.2.17
int max total instances
Maximum number of instances for which a DataReader will keep state.

The maximum number of instances actively managed by a DataReader is determined by com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max instances (p. 1352).
These instances have associated DataWriters or samples in the
DataReaders queue and are visible to the user through operations
such
as
(p. 983),
com.rti.ndds.example.FooDataReader.read (p. 981),
and
com.rti.ndds.example.FooDataReader.get key value (p. 1009).
The features Durable Reader State, MultiChannel DataWriters and RTI Persistence Service require RTI Connext to keep some internal state even for instances
without DataWriters or samples in the DataReaders queue. The additional
state is used to filter duplicate samples that could be coming from different
DataWriter channels or from multiple executions of RTI Persistence Service.
The total maximum number of instances that will be managed by the middleware, including instances without associated DataWriters or samples, is determined by max total instances.
552
Class Documentation
When a new instance is received, RTI Connext will check the resource limit com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max instances (p. 1352). If the limit is exceeded, RTI Connext will drop the sample
and report it as lost and rejected. If the limit is not exceeded, RTI Connext
will check max total instances. If max total instances is exceeded, RTI Connext
will replace an existing instance without DataWriters and samples with the new
one. The application could receive duplicate samples for the replaced instance
if it becomes alive again.
[default] com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.AUTO MAX TOTAL INSTANCES (p. 48)
[range] [1, 1 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106) or com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.AU

MAX TOTAL INSTANCES (p. 48), >= com.rti.dds.infrastructure.ResourceLimitsQosPolicy
instances (p. 1352)
8.44.2.18
int max remote virtual writers
The maximum number of remote virtual writers from which a

instances.

PRESENTATION QOS,
this
value
determines
the
maximum
number of DataWriter groups that can be managed by the
(p. 1476)
containing
this
Since the com.rti.dds.subscription.Subscriber (p. 1476) may contain more
than one com.rti.dds.subscription.DataReader (p. 487), only the setting of
the first applies.
[range] [1, 1 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), >= initial remote virtual writers, >= max remote virtual writers per instance
8.44.2.19
int initial remote virtual writers
The initial number of remote virtual writers from which a

instances.
[default] 2
553
[range] [1, 1 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), <= max remote virtual writers
8.44.2.20
int max remote virtual writers per instance
The maximum number of virtual remote writers that can be associated with an
instance.
[range] [1, 1024] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), >= initial remote virtual writers per instance
For unkeyed types, this value is ignored.
The features of Durable Reader State and MultiChannel DataWriters, and RTI
Persistence Service require RTI Connext to keep some internal state per virtual
writer and instance that is used to filter duplicate samples. These duplicate
samples could be coming from different DataWriter channels or from multiple
executions of RTI Persistence Service.
Once an association between a remote virtual writer and an instance is established, it is permanent it will not disappear even if the physical writer
incarnating the virtual writer is destroyed.
If max remote virtual writers per instance is exceeded for an instance, RTI
Connext will not associate this instance with new virtual writers. Duplicates
samples from these virtual writers will not be filtered on the reader.
If you are not using Durable Reader State, MultiChannel DataWriters or RTI
Persistence Service in your system, you can set this property to 1 to optimize
resources.
8.44.2.21
int initial remote virtual writers per instance
The initial number of virtual remote writers per instance.

[default] 2
[range] [1, 1024], <= max remote virtual writers per instance
For unkeyed types, this value is ignored.
8.44.2.22
int max remote writers per sample
The maximum number of remote writers allowed to write the same sample.
One scenario in which two DataWriters may write the same sample is Persistence
554
Class Documentation
Service. The DataReader may receive the same sample coming from the original
DataWriter and from a Persistence Service DataWriter. [default] 3
[range] [1, 1024]
8.44.2.23
int max query condition filters
The maximum number of query condition filters a reader is allowed.

[default] 4
[range] [0, 32]
This value determines the maximum number of unique query condition content
filters that a reader may create.
Each query condition content filter is comprised of both its query expression
and query parameters. Two query conditions that have the same query expression will require unique query condition filters if their query paramters
differ. Query conditions that differ only in their state masks will share the same
query condition filter.
8.44.2.24
int max app ack response length
Maximum length of application-level acknowledgment response data.

The maximum length of response data in an application-level acknowledgment.
When set to zero, no response data is sent with application-level acknowledgments.
[default] 0
[range] [0, 65536]
8.45 DataReaderSeq Class Reference
8.45
555
DataReaderSeq Class Reference
Declares IDL sequence < com.rti.dds.subscription.DataReader (p. 487) >

.

DataReaderSeq (Collection readers)
int getMaximum ()
sequence.
8.45.1
Declares IDL sequence < com.rti.dds.subscription.DataReader (p. 487) >

.
See also:
8.45.2
8.45.2.1
DataReaderSeq (Collection readers)
Exceptions:
8.45.3
8.45.3.1
int getMaximum ()
elements.
first created.
556
Class Documentation

Returns:
See also:
8.46 DataWriter Interface Reference
8.46
557
DataWriter Interface Reference
<<interface>> ( p. 279) Allows an application to set the value of the data to

be published under a given com.rti.dds.topic.Topic (p. 1545).
Inheritance diagram for DataWriter::

void set qos (DataWriterQos qos)
Sets the writer QoS.
<<eXtension>> (p. 278) Change the QoS of this writer using the input
XML QoS profile.
void get qos (DataWriterQos qos)

Gets the writer QoS.
void set listener (DataWriterListener l, int mask)

Sets the writer listener.
DataWriterListener get listener ()

Get the writer listener.
void get liveliness lost status (LivelinessLostStatus status)

Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS LOST STATUS communication status.
void get offered deadline missed status (OfferedDeadlineMissedStatus status)

Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED DEADLINE MISSED STATUS communication status.
void get offered incompatible qos status (OfferedIncompatibleQosStatus status)

Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED INCOMPATIBLE QOS STATUS communication status.
void get publication matched status (PublicationMatchedStatus

status)
558
Class Documentation
Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.PUBLICATION MATCHED STATUS communication status.
void get reliable writer cache changed status (ReliableWriterCacheChangedStatus status)

<<eXtension>> (p. 278) Get the reliable cache status for this writer.
void get reliable reader activity changed status (ReliableReaderActivityChangedStatus status)

<<eXtension>> (p. 278) Get the reliable reader activity changed status for
this writer.
void get datawriter cache status (DataWriterCacheStatus status)

<<eXtension>> (p. 278) Get the datawriter cache status for this writer.
void get datawriter protocol status (DataWriterProtocolStatus

status)
<<eXtension>> (p. 278) Get the datawriter protocol status for this writer.
void
get matched subscription datawriter protocol status
(DataWriterProtocolStatus status, InstanceHandle t subscription handle)
<<eXtension>> (p. 278) Get the datawriter protocol status for this writer,
per matched subscription ( p. 353) identified by the subscription handle.
void get matched subscription datawriter protocol status by locator (DataWriterProtocolStatus status, Locator t locator)
<<eXtension>> (p. 278) Get the datawriter protocol status for this writer,
per matched subscription ( p. 353) identified by the locator.
void get matched subscription locators (LocatorSeq locators)

<<eXtension>> (p. 278) Retrieve the list of locators for subscriptions
currently associated with this com.rti.dds.publication.DataWriter
( p. 557).
void get matched subscriptions (InstanceHandleSeq subscription handles)

Retrieve the list of subscriptions currently
associated
with
this
void get matched subscription data (SubscriptionBuiltinTopicData subscription data, InstanceHandle t subscription handle)
559
This operation retrieves the information on a subscription ( p. 353) that

is currently associated with the com.rti.dds.publication.DataWriter
( p. 557).
Topic get topic ()

This operation returns the com.rti.dds.topic.Topic ( p. 1545) associated
with the com.rti.dds.publication.DataWriter ( p. 557).
Publisher get publisher ()

This operation returns the com.rti.dds.publication.Publisher ( p. 1262) to
which the com.rti.dds.publication.DataWriter ( p. 557) belongs.
void wait for acknowledgments (Duration t max wait)

Blocks the calling thread until all data written by reliable
com.rti.dds.publication.DataWriter ( p. 557) entity is acknowledged, or
until timeout expires.
void wait for asynchronous publishing (Duration t max wait)

<<eXtension>> (p. 278) Blocks the calling thread until asynchronous sending is complete.
void assert liveliness ()

This
operation
manually
asserts
the
liveliness
of
this
void flush ()
<<eXtension>> (p. 278) Flushes the batch in progress in the context of the
calling thread.
InstanceHandle t register instance untyped (Object instance data)

Register a new instance with this writer.
InstanceHandle t register instance w timestamp untyped (Object instance data, Time t source timestamp)
Register a new instance with this writer using the given time instead of the
current time.
void unregister instance untyped (Object instance data, InstanceHandle t handle)

Unregister a new instance from this writer.
void unregister instance w timestamp untyped (Object instance data, InstanceHandle t handle, Time t source timestamp)
560
Class Documentation
Unregister a new instance from this writer using the given time instead of
the current time.
void write untyped (Object instance data, InstanceHandle t handle)

Publish a data sample.
void write w timestamp untyped (Object instance data, InstanceHandle t handle, Time t source timestamp)
Publish a data sample using the given time instead of the current time.
void dispose untyped (Object instance data, InstanceHandle t handle)

Dispose a data sample.
void dispose w timestamp untyped (Object instance data, InstanceHandle t handle, Time t source timestamp)
Dispose a data sample using the given time instead of the current time.
void get key value untyped (Object key holder, InstanceHandle t

handle)
InstanceHandle t lookup instance untyped (Object key value)

Given a sample with the given key field values, return the handle corresponding to its instance.
8.46.1
<<interface>> ( p. 279) Allows an application to set the value of the data to

be published under a given com.rti.dds.topic.Topic (p. 1545).
QoS:
com.rti.dds.publication.DataWriterQos (p. 610)
Status:
com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS LOST STATUS, com.rti.dds.publication.LivelinessLostStatus (p. 1138);
com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED DEADLINE MISSED STATUS, com.rti.dds.publication.OfferedDeadlineMissedStatus
(p. 1195);
561
com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED INCOMPATIBLE QOS STATUS, com.rti.dds.publication.OfferedIncompatibleQosStatus

(p. 1197);
com.rti.dds.infrastructure.StatusKind.StatusKind.PUBLICATION MATCHED STATUS, com.rti.dds.publication.PublicationMatchedStatus
(p. 1259);
com.rti.dds.infrastructure.StatusKind.StatusKind.RELIABLE READER ACTIVITY CHANGED STATUS,
com.rti.dds.publication.ReliableReaderActivityChangedStatus
(p. 1333);
com.rti.dds.infrastructure.StatusKind.StatusKind.RELIABLE WRITER CACHE CHANGED STATUS, com.rti.dds.publication.ReliableWriterCacheChangedStatus<BR>
Listener:
com.rti.dds.publication.DataWriterListener (p. 586)
A com.rti.dds.publication.DataWriter (p. 557) is attached to exactly one
com.rti.dds.publication.Publisher (p. 1262), that acts as a factory for it.
A com.rti.dds.publication.DataWriter (p. 557) is bound to exactly one
com.rti.dds.topic.Topic (p. 1545) and therefore to exactly one data
type.
The com.rti.dds.topic.Topic (p. 1545) must exist prior to the
com.rti.dds.publication.DataWriter (p. 557)s creation.
It
com.rti.dds.publication.DataWriter (p. 557) is an abstract class.
must be specialized for each particular application data-type (see USER DATA (p. 132)).
The additional methods or functions that must be
defined in the auto-generated class for a hypothetical application type
com.rti.ndds.example.Foo (p. 977) are specified in the example type
The
following
operations
may
be
called
even
if
the
com.rti.dds.publication.DataWriter (p. 557) is not enabled.
Other
operations will fail with com.rti.dds.infrastructure.RETCODE NOT ENABLED
(p. 1361)
if
called
on
a
disabled
com.rti.dds.publication.DataWriter (p. 557):
The base-class operations com.rti.dds.publication.DataWriter.set qos
(p. 562),
com.rti.dds.publication.DataWriter.get qos
(p. 564),
com.rti.dds.publication.DataWriter.set listener
(p. 564),
com.rti.dds.publication.DataWriter.get listener
(p. 565),
(p. 935),
(p. 936)
and com.rti.dds.infrastructure.Entity.get status changes (p. 936)
com.rti.dds.publication.DataWriter.get liveliness lost status
(p. 565)
com.rti.dds.publication.DataWriter.get offered deadline missed status
(p. 565)
562
Class Documentation
com.rti.dds.publication.DataWriter.get (p. 566)
offered incompatible qos status
com.rti.dds.publication.DataWriter.get publication matched com.rti.dds.publication.DataWriter.get status
(p. 566)
reliable writer cache changed status
(p. 566)
com.rti.dds.publication.DataWriter.get reliable reader activity changed status (p. 567)
Several com.rti.dds.publication.DataWriter (p. 557) may operate in different threads. If they share the same com.rti.dds.publication.Publisher
(p. 1262), the middleware guarantees that its operations are thread-safe.
See also:
8.46.2
8.46.2.1
void set qos (DataWriterQos qos)
Sets the writer QoS.

This operation modifies the QoS of the com.rti.dds.publication.DataWriter
(p. 557).
The
com.rti.dds.publication.DataWriterQos.user data
com.rti.dds.publication.DataWriterQos.deadline
com.rti.dds.publication.DataWriterQos.latency budget
com.rti.dds.publication.DataWriterQos.ownership strength
com.rti.dds.publication.DataWriterQos.transport priority
com.rti.dds.publication.DataWriterQos.lifespan
(p. 614)
com.rti.dds.publication.DataWriterQos.writer data lifecycle
(p. 614),
(p. 613),
(p. 613),
(p. 614),
(p. 614),
and
(p. 614)
Parameters:
qos <<in>> ( p. 279) The com.rti.dds.publication.DataWriterQos
(p. 610) to be set to.
Policies must be consistent.
Immutable policies cannot be changed after
com.rti.dds.publication.DataWriter (p. 557) is enabled. The special value com.rti.dds.publication.Publisher.DATAWRITER QOS DEFAULT (p. 182) can be used to indicate that
the
QoS
of
the
com.rti.dds.publication.DataWriterQos (p. 610) set in the
com.rti.dds.publication.Publisher (p. 1262). Cannot be NULL.
563
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
com.rti.dds.infrastructure.RETCODE IMMUTABLE POLICY (p. 1358) or com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY (p. 1359)
See also:
com.rti.dds.publication.DataWriterQos (p. 610) for rules on consistency among QoS
8.46.2.2

profile name)
<<eXtension>> ( p. 278) Change the QoS of this writer using the input XML
QoS profile.
This operation modifies the QoS of the com.rti.dds.publication.DataWriter
(p. 557).
The
com.rti.dds.publication.DataWriterQos.user data
com.rti.dds.publication.DataWriterQos.deadline
com.rti.dds.publication.DataWriterQos.latency budget
com.rti.dds.publication.DataWriterQos.ownership strength
com.rti.dds.publication.DataWriterQos.transport priority
com.rti.dds.publication.DataWriterQos.lifespan
(p. 614)
com.rti.dds.publication.DataWriterQos.writer data lifecycle
(p. 614),
(p. 613),
(p. 613),
(p. 614),
(p. 614),
and
(p. 614)
Parameters:
library name <<in>> ( p. 279) Library name containing the XML
QoS profile.
If library name is null RTI Connext will use
the default library (see com.rti.dds.publication.Publisher.set default library (p. 1277)).
If profile name is null RTI Connext will use the default profile (see com.rti.dds.publication.Publisher.set default profile
(p. 1278)).
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
com.rti.dds.infrastructure.RETCODE IMMUTABLE Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
564
Class Documentation
POLICY (p. 1358) or com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY (p. 1359)
See also:
8.46.2.3
void get qos (DataWriterQos qos)
Gets the writer QoS.

Parameters:
qos <<inout>> ( p. 279) The com.rti.dds.publication.DataWriterQos
(p. 610) to be filled up. Cannot be NULL.
Exceptions:
See also:
8.46.2.4
void set listener (DataWriterListener l, int mask)
Sets the writer listener.

Parameters:
l <<in>> ( p. 279) com.rti.dds.publication.DataWriterListener
(p. 586) to set to
with the com.rti.dds.publication.DataWriterListener (p. 586).
Exceptions:
See also:

8.46.2.5
565
DataWriterListener get listener ()
Get the writer listener.

Returns:
(p. 586)
of
the
See also:
8.46.2.6
void get liveliness lost status (LivelinessLostStatus status)
Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS LOST STATUS communication status.

Parameters:
status <<inout>> ( p. 279) com.rti.dds.publication.LivelinessLostStatus
Exceptions:
8.46.2.7
void get offered deadline missed status

(OfferedDeadlineMissedStatus status)
Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED DEADLINE MISSED STATUS communication status.

Parameters:
status <<inout>> ( p. 279) com.rti.dds.publication.OfferedDeadlineMissedStatus
Exceptions:
566
Class Documentation
8.46.2.8
void get offered incompatible qos status

(OfferedIncompatibleQosStatus status)
Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED INCOMPATIBLE QOS STATUS communication status.

Parameters:
status <<inout>> ( p. 279) com.rti.dds.publication.OfferedIncompatibleQosStatus
Exceptions:
8.46.2.9
void get publication matched status

(PublicationMatchedStatus status)
Accesses the com.rti.dds.infrastructure.StatusKind.StatusKind.PUBLICATION MATCHED STATUS communication status.

Parameters:
status <<inout>> ( p. 279) com.rti.dds.publication.PublicationMatchedStatus
Exceptions:
8.46.2.10
void get reliable writer cache changed status

(ReliableWriterCacheChangedStatus status)
<<eXtension>> ( p. 278) Get the reliable cache status for this writer.
Parameters:
status <<inout>> ( p. 279) com.rti.dds.publication.ReliableWriterCacheChangedStatus
Exceptions:

8.46.2.11
567
void get reliable reader activity changed status

(ReliableReaderActivityChangedStatus status)
<<eXtension>> ( p. 278) Get the reliable reader activity changed status for
this writer.
Parameters:
status <<inout>> ( p. 279) com.rti.dds.publication.ReliableReaderActivityChangedStatus
Exceptions:
8.46.2.12
void get datawriter cache status (DataWriterCacheStatus

status)
<<eXtension>> ( p. 278) Get the datawriter cache status for this writer.
Parameters:
status <<inout>> ( p. 279) com.rti.dds.publication.DataWriterCacheStatus
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361).
8.46.2.13
or
void get datawriter protocol status

(DataWriterProtocolStatus status)
<<eXtension>> ( p. 278) Get the datawriter protocol status for this writer.
Parameters:
status <<inout>> ( p. 279) com.rti.dds.publication.DataWriterProtocolStatus
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361).
or
568
Class Documentation
8.46.2.14
void get matched subscription datawriter protocol status

(DataWriterProtocolStatus status, InstanceHandle t
subscription handle)
<<eXtension>> ( p. 278) Get the datawriter protocol status for this writer,
per matched subscription (p. 353) identified by the subscription handle.
Parameters:
subscription handle <<in>>
( p. 279)
Handle
to
a
specific
subscription
(p. 353)
associated
with
the
Cannot be
NULL.Must correspond to a subscription (p. 353) currently
associated with the com.rti.dds.publication.DataWriter (p. 557).
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361).
8.46.2.15
or
void get matched subscription datawriter protocol status by locator (DataWriterProtocolStatus status,
Locator t locator)
<<eXtension>> ( p. 278) Get the datawriter protocol status for this writer,
per matched subscription (p. 353) identified by the locator.
Parameters:
(p. 598) to be filled in Cannot be NULL.
locator <<in>> ( p. 279) Locator to a specific locator associated with
the com.rti.dds.subscription.DataReader (p. 487). Cannot be
NULL.Must correspond to a locator of one or more subscriptions
currently associated with the com.rti.dds.publication.DataWriter
(p. 557).
569
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361).
8.46.2.16
or
void get matched subscription locators (LocatorSeq

locators)
<<eXtension>> ( p. 278) Retrieve the list of locators for subscriptions currently associated with this com.rti.dds.publication.DataWriter (p. 557).
Matched subscription (p. 353) locators include locators for all those
subscriptions in the same domain (p. 328) that have a matching com.rti.dds.topic.Topic (p. 1545), compatible QoS and common partition
that
the
com.rti.dds.domain.DomainParticipant.ignore subscription
(p. 717)
operation.
The locators returned in the locators list are the ones that are used by
the DDS implementation to communicate with the corresponding matched
Parameters:
locators <<inout>> ( p. 279). Handles of all the matched subscription
(p. 353) locators.
The sequence will be grown if the sequence has ownership and the system has the corresponding resources. Use a sequence without ownership
to avoid dynamic memory allocation.
If the sequence is too small to
store all the matches and the system can not resize the sequence, this
method will fail with com.rti.dds.infrastructure.RETCODE OUT OF RESOURCES (p. 1362). Cannot be NULL..
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
570
Class Documentation
8.46.2.17
void get matched subscriptions (InstanceHandleSeq

subscription handles)
Retrieve the list of subscriptions currently

associated
with
this
Matched subscriptions include all those in the same domain (p. 328) that
have a matching com.rti.dds.topic.Topic (p. 1545), compatible QoS and
common partition that the com.rti.dds.domain.DomainParticipant
com.rti.dds.domain.DomainParticipant.ignore subscription
(p. 717)
operation.
The handles returned in the subscription handles list are the
ones that are used by the DDS implementation to locally identify
the
corresponding
matched
(p. 487) entities.
These handles match the ones that appear in the
com.rti.dds.subscription.SampleInfo.instance handle (p. 1404) field
of the com.rti.dds.subscription.SampleInfo (p. 1398) when reading the
builtin.SubscriptionBuiltinTopicDataTypeSupport.SUBSCRIPTION TOPIC NAME builtin (p. 352) topic (p. 359).
Parameters:
subscription handles <<inout>> ( p. 279). Handles of all the matched
subscriptions.
The sequence will be grown if the sequence has ownership and the system has the corresponding resources. Use a sequence without ownership
to avoid dynamic memory allocation.
If the sequence is too small to
store all the matches and the system can not resize the sequence, this
method will fail with com.rti.dds.infrastructure.RETCODE OUT OF RESOURCES (p. 1362).
The maximum number of matches possible is configured with
(p. 778). You can use a zero-maximum sequence without ownership to quickly
check whether there are any matches without allocating any memory. Cannot
be NULL..
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or

8.46.2.18
571
void get matched subscription data

(SubscriptionBuiltinTopicData subscription data,
InstanceHandle t subscription handle)
This operation retrieves the information on a subscription (p. 353) that is currently associated with the com.rti.dds.publication.DataWriter (p. 557).
The subscription handle must correspond to a subscription (p. 353)
currently associated with the com.rti.dds.publication.DataWriter
Otherwise,
the operation will fail and fail with
(p. 557).
com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355).
Use
com.rti.dds.publication.DataWriter.get matched subscriptions
(p. 570) to find the subscriptions that are currently matched with the
Note: This operation does not retrieve the following information in
builtin.SubscriptionBuiltinTopicData:
builtin.SubscriptionBuiltinTopicData.type code
builtin.SubscriptionBuiltinTopicData.property
builtin.SubscriptionBuiltinTopicData.content filter property
The
above
information
is
available
com.rti.dds.subscription.DataReaderListener.on data available() (p. 520) (if a reader listener is installed
builtin.SubscriptionBuiltinTopicDataDataReader).
through
on
the
Parameters:
subscription data <<inout>> ( p. 279). The information to be filled in
on the associated subscription (p. 353). Cannot be NULL.
subscription handle <<in>>
( p. 279).
Handle
to
a
specific
subscription
(p. 353)
associated
with
the
Cannot be
NULL.. Must correspond to a subscription (p. 353) currently
associated with the com.rti.dds.publication.DataWriter (p. 557).
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1361)
or
572
Class Documentation
8.46.2.19
Topic get topic ()
This operation returns the com.rti.dds.topic.Topic (p. 1545) associated with

This is the same com.rti.dds.topic.Topic (p. 1545) that was used to create
Returns:
com.rti.dds.topic.Topic (p. 1545) that was used to create the
8.46.2.20
Publisher get publisher ()
This operation returns the com.rti.dds.publication.Publisher (p. 1262) to

which the com.rti.dds.publication.DataWriter (p. 557) belongs.
Returns:
(p. 1262)
to
com.rti.dds.publication.DataWriter (p. 557) belongs.
8.46.2.21
which
the
Blocks the calling thread until

or until timeout expires.
all data written by reliable

(p. 557) entity is acknowledged,
This operation blocks the calling thread until either all data written by the reliable com.rti.dds.publication.DataWriter (p. 557) entity is acknowledged by
(a) all reliable com.rti.dds.subscription.DataReader (p. 487) entities that
are matched and alive and (b) by all required subscriptions, or until the duration specified by the max wait parameter elapses, whichever happens first. A
successful completion indicates that all the samples written have been acknowledged by all reliable matched data readers and by all required subscriptions; a
return value of TIMEOUT indicates that max wait elapsed before all the data
was acknowledged.
Note that if a thread is blocked in the call to wait for acknowledgments on a
DataWriter (p. 557) and a different thread writes new samples on the same
DataWriter (p. 557), the new samples must be acknowledged before unblocking
the thread waiting on wait for acknowledgments.
If the com.rti.dds.publication.DataWriter (p. 557) does not have
com.rti.dds.infrastructure.ReliabilityQosPolicy (p. 1324) kind set to RELIABLE, this operation will complete immediately with RETCODE OK.
573
Parameters:
max wait <<in>> ( p. 279) Specifies maximum time to wait for acknowledgements com.rti.dds.infrastructure.Duration t (p. 813) .
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1361), com.rti.dds.infrastructure.RETCODE TIMEOUT
(p. 1364)
8.46.2.22
void wait for asynchronous publishing (Duration t

max wait)
<<eXtension>> ( p. 278) Blocks the calling thread until asynchronous sending is complete.
This operation blocks the calling thread (up to max wait) until all data
written by the asynchronous com.rti.dds.publication.DataWriter
(p. 557) is sent and acknowledged (if reliable) by all matched
A successful
completion indicates that all the samples written have been sent and acknowledged where applicable; a time out indicates that max wait elapsed before all
the data was sent and/or acknowledged.
In other words,
this guarantees that sending to best effort
com.rti.dds.subscription.DataReader (p. 487) is complete in addition to
what com.rti.dds.publication.DataWriter.wait for acknowledgments
(p. 572) provides.
com.rti.dds.infrastructure.PublishModeQosPolicy (p. 1295) kind set to
com.rti.dds.infrastructure.PublishModeQosPolicyKind.PublishModeQosPolicyKind.ASYNCHRONOUS PUBLISH MODE QOS the operation will complete immediately with
com.rti.dds.infrastructure.RETCODE OK.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364)
574
Class Documentation
8.46.2.23
This
operation
manually
asserts
the
liveliness
of
this
This is used in combination with the LIVELINESS (p. 82) policy to indicate to
RTI Connext that the com.rti.dds.publication.DataWriter (p. 557) remains
active.
You only need to use this operation if the LIVELINESS (p. 82) setting is either
com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.MANUAL BY PARTICIPANT LIVELINESS QOS or com.rti.dds.infrastructure.LivelinessQosPolicyKind.Liveliness
BY TOPIC LIVELINESS QOS. Otherwise, it has no effect.
Note: writing data via the com.rti.ndds.example.FooDataWriter.write
(p. 1021)
or
com.rti.ndds.example.FooDataWriter.write w timestamp
(p. 1024)
operation
asserts
liveliness
on
the
(p. 557)
itself,
and
its
Consequently the
use of assert liveliness() (p. 574) is only needed if the application is not
writing data regularly.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361)
or
See also:
com.rti.dds.infrastructure.LivelinessQosPolicy (p. 1140)
8.46.2.24
void flush ()
<<eXtension>> ( p. 278) Flushes the batch in progress in the context of the

calling thread.
After being flushed, the batch is available to be sent on the network.
PUBLISH MODE QOS, the batch will be sent on the network immediately (in
the context of the calling thread).
If
the
(p. 557)
does
have
575
com.rti.dds.infrastructure.PublishModeQosPolicyKind.PublishModeQosPolicyKind.ASYNCHRONOUS PUBLISH MODE QOS, the batch will be sent in the context of the asynchronous publishing thread.
This
operation
may
block
in
the
same
com.rti.ndds.example.FooDataWriter.write (p. 1021).
conditions
as
If this operation does block, the RELIABILITY max blocking time configures
the maximum time the write operation may block (waiting for space to become
available). If max blocking time elapses before the DDS DataWriter is able to
store the modification without exceeding the limits, the operation will fail with
DDS RETCODE TIMEOUT.
MT Safety:
flush()
(p. 574)
is
only
thread-safe
with
batching
(p. 415) is TRUE.
if
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
com.rti.dds.infrastructure.RETCODE (p. 1364),
OUT OF RESOURCES
(p. 1362)
or
(p. 1361).
8.46.2.25
InstanceHandle t register instance untyped (Object

instance data)

com.rti.ndds.example.FooDataWriter (p. 1012) classes in a consistent way.
Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataWriter.register instance
(p. 1014)
See also:
com.rti.dds.publication.DataWriter.unregister instance untyped
(p. 576)
com.rti.ndds.example.FooDataWriter.register instance (p. 1014)
Implemented in DynamicDataWriter (p. 910).
576
Class Documentation
8.46.2.26
InstanceHandle t register instance w timestamp untyped

(Object instance data, Time t source timestamp)
Register a new instance with this writer using the given time instead of the
current time.
Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataWriter.register instance w timestamp
(p. 1015) method instead of this one. See that method for detailed documentation.
See also:
com.rti.dds.publication.DataWriter.unregister instance w timestamp untyped (p. 576)
8.46.2.27
void unregister instance untyped (Object instance data,


Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataWriter.unregister instance
(p. 1016)
See also:
com.rti.dds.publication.DataWriter.register instance untyped
(p. 575)
(p. 1016)
8.46.2.28
void unregister instance w timestamp untyped (Object

instance data, InstanceHandle t handle, Time t
source timestamp)
Unregister a new instance from this writer using the given time instead of the
current time.
577

Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataWriter.FooDataWriter.unregister instance w timestamp method instead of this one. See that method for detailed
documentation.
See also:
com.rti.dds.publication.DataWriter.register instance w timestamp untyped (p. 576)
com.rti.ndds.example.FooDataWriter.FooDataWriter.unregister instance w timestamp
8.46.2.29
void write untyped (Object instance data,


Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataWriter.write (p. 1021) method instead of
this one. See that method for detailed documentation.
See also:
com.rti.dds.publication.DataWriter.write w timestamp untyped
(p. 577)
8.46.2.30
void write w timestamp untyped (Object instance data,

Publish a data sample using the given time instead of the current time.
Statically
type-safe
code
should
use
the
appropriate
(p. 1024)
578
Class Documentation
See also:
com.rti.dds.publication.DataWriter.write untyped (p. 577)
8.46.2.31
void dispose untyped (Object instance data,

Dispose a data sample.

Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataWriter.dispose (p. 1027) method instead
See also:
com.rti.dds.publication.DataWriter.dispose w timestamp untyped (p. 578)
com.rti.ndds.example.FooDataWriter.dispose (p. 1027)
8.46.2.32
void dispose w timestamp untyped (Object

source timestamp)
Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataWriter.dispose w timestamp (p. 1029)
See also:
com.rti.dds.publication.DataWriter.dispose untyped (p. 578)
com.rti.ndds.example.FooDataWriter.dispose w timestamp
(p. 1029)
8.46.2.33
void get key value untyped (Object key holder,


579

Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataWriter.get key value (p. 1031) method
See also:
com.rti.ndds.example.FooDataWriter.get key value (p. 1031)
8.46.2.34
InstanceHandle t lookup instance untyped (Object

key value)
Given a sample with the given key field values, return the handle corresponding
to its instance.
Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataWriter.lookup instance (p. 1032) method
See also:
com.rti.ndds.example.FooDataWriter.lookup instance (p. 1032)
580
Class Documentation
8.47
DataWriterAdapter Class Reference

methods or functions.)
Inheritance diagram for DataWriterAdapter::

void on offered deadline missed (DataWriter writer, OfferedDeadlineMissedStatus status)
Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED DEADLINE MISSED STATUS status.
void on offered incompatible qos (DataWriter writer, OfferedIncompatibleQosStatus status)

Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED INCOMPATIBLE QOS STATUS status.
void on liveliness lost (DataWriter writer, LivelinessLostStatus

status)
Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.LIVELINESS LOST STATUS status.
void on publication matched (DataWriter writer, PublicationMatchedStatus status)

Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.PUBLICATION MATCHED STATUS status.
void on reliable writer cache changed (DataWriter writer, ReliableWriterCacheChangedStatus status)

<<eXtension>> (p. 278) A change has occurred in the writers cache of
unacknowledged samples.
void on reliable reader activity changed (DataWriter writer, ReliableReaderActivityChangedStatus status)

<<eXtension>> (p. 278) A matched reliable reader has become active or
become inactive.
void on instance replaced (DataWriter writer, InstanceHandle t

handle)
8.47 DataWriterAdapter Class Reference
581
Notifies when an instance is replaced in DataWriter ( p. 557) queue.
8.47.1

methods or functions.)
8.47.2
8.47.2.1
void on offered deadline missed (DataWriter writer,

OfferedDeadlineMissedStatus status)

This
callback
is
called
when
the
deadline
that
the
com.rti.dds.publication.DataWriter (p. 557) has committed through
its DEADLINE (p. 52) qos policy was not respected for a specific instance.
This callback is called for each deadline period elapsed during which the
com.rti.dds.publication.DataWriter (p. 557) failed to provide data for an
instance.
Parameters:
writer <<out>>
( p. 279)
Locally
created
com.rti.dds.publication.DataWriter (p. 557) that triggers
the listener callback
status <<out>> ( p. 279) Current deadline missed status of locally created com.rti.dds.publication.DataWriter (p. 557)
Implements DataWriterListener (p. 587).
8.47.2.2
void on offered incompatible qos (DataWriter writer,

OfferedIncompatibleQosStatus status)

This callback is called when the com.rti.dds.publication.DataWriterQos
(p. 610) of the com.rti.dds.publication.DataWriter (p. 557) was incompatible with what was requested by a com.rti.dds.subscription.DataReader
582
Class Documentation
(p. 487). This callback is called when a com.rti.dds.publication.DataWriter

(p. 557) has discovered a com.rti.dds.subscription.DataReader (p. 487)
for the same com.rti.dds.topic.Topic (p. 1545) and common partition,
but with a requested QoS that is incompatible with that offered by the
Parameters:
writer <<out>>
( p. 279)
Locally
created
status <<out>> ( p. 279) Current incompatible qos status of locally created com.rti.dds.publication.DataWriter (p. 557)
8.47.2.3
void on liveliness lost (DataWriter writer,

LivelinessLostStatus status)

This
callback
is
called
when
the
liveliness
that
the
its LIVELINESS (p. 82) qos policy was not respected;
this
(p. 487)
entities
will
consider the com.rti.dds.publication.DataWriter (p. 557) as no longer
alive/active. This callback will not be called when an already not alive
com.rti.dds.publication.DataWriter (p. 557) simply renames not alive for
another liveliness period.
Parameters:
writer <<out>>
( p. 279)
Locally
created
status <<out>> ( p. 279) Current liveliness lost status of locally created
8.47.2.4
void on publication matched (DataWriter writer,

PublicationMatchedStatus status)

8.47 DataWriterAdapter Class Reference
583
This callback is called when the com.rti.dds.publication.DataWriter

(p. 557) has found a com.rti.dds.subscription.DataReader (p. 487) that
matches the com.rti.dds.topic.Topic (p. 1545), has a common partition and compatible QoS, or has ceased to be matched with a
com.rti.dds.subscription.DataReader (p. 487) that was previously considered to be matched.
Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers
status <<out>> ( p. 279) Current publication (p. 349) match status of

locally created com.rti.dds.publication.DataWriter (p. 557)
8.47.2.5
void on reliable writer cache changed (DataWriter writer,

ReliableWriterCacheChangedStatus status)
<<eXtension>> ( p. 278) A change has occurred in the writers cache of unacknowledged samples.
Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers
status <<out>> ( p. 279) Current reliable writer cache changed status of

8.47.2.6
void on reliable reader activity changed (DataWriter

writer, ReliableReaderActivityChangedStatus status)
<<eXtension>> ( p. 278) A matched reliable reader has become active or

become inactive.
Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers
584
Class Documentation
status <<out>> ( p. 279) Current reliable reader activity changed status
of locally created com.rti.dds.publication.DataWriter (p. 557)

8.47.2.7
void on instance replaced (DataWriter writer,

Notifies when an instance is replaced in DataWriter (p. 557) queue.

This callback is called when an instance is replaced by the
com.rti.dds.publication.DataWriter (p. 557) due to instance resource
limits being reached. This callback returns to the user the handle of the
replaced instance, which can be used to get the key of the replaced instance.
Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers
handle <<out>> ( p. 279) Handle of the replaced instance

8.48 DataWriterCacheStatus Class Reference
8.48
585
DataWriterCacheStatus Class Reference
<<eXtension>> ( p. 278) The status of the writers cache.

Inherits Status.
Public Attributes
Highest number of samples in the writers queue over the lifetime of the
writer.
long sample count

Number of samples in the writers queue.
8.48.1

Entity:
8.48.2
8.48.2.1
Highest number of samples in the writers queue over the lifetime of the writer.
8.48.2.2
long sample count
Number of samples in the writers queue.
586
Class Documentation
8.49
DataWriterListener Interface Reference

writer status.
Inheritance diagram for DataWriterListener::



status)



become inactive.

handle)
Notifies when an instance is replaced in DataWriter ( p. 557) queue.
8.49.1
587

writer status.
Entity:
Status:
(p. 1195);
(p. 1197);
(p. 1259);
(p. 1333);
com.rti.dds.infrastructure.StatusKind.StatusKind.RELIABLE WRITER CACHE CHANGED STATUS, com.rti.dds.publication.ReliableWriterCacheChangedStatus
(p. 1336);
See also:
8.49.2
8.49.2.1


This
callback
is
called
when
the
deadline
that
the
588
Class Documentation

instance.
Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers
Implemented in DomainParticipantAdapter (p. 738), and DataWriterAdapter (p. 581).
8.49.2.2


Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers
8.49.2.3


589
This
callback
is
called
when
the
liveliness
that
the
this
entities
will
concom.rti.dds.subscription.DataReader
(p. 487)
sider the com.rti.dds.publication.DataWriter (p. 557) as no longer
Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers

8.49.2.4


Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers

590
Class Documentation
8.49.2.5

Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers

8.49.2.6


become inactive.
Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers

8.49.2.7

Notifies when an instance is replaced in DataWriter (p. 557) queue.

591
Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers

592
Class Documentation
8.50
DataWriterProtocolQosPolicy Class Reference
Protocol that applies only to com.rti.dds.publication.DataWriter (p. 557)

instances.
Inheritance diagram for DataWriterProtocolQosPolicy::
Public Attributes
GUID t virtual guid
int rtps object id

The RTPS Object ID.
boolean push on write

Whether to push sample out when write is called.

Controls whether or not the writer expects positive acknowledgements from
matching readers.
boolean disable inline keyhash

Controls whether or not a keyhash is propagated on the wire with each sample.
boolean serialize key with dispose

Controls whether or not the serialized key is propagated on the wire with
dispose samples.
final RtpsReliableWriterProtocol t rtps reliable writer

SequenceNumber t initial virtual sequence number

Determines, the initial virtual sequence number for this DataWriter.
8.50.1
Protocol that applies only to com.rti.dds.publication.DataWriter (p. 557)

instances.
8.50 DataWriterProtocolQosPolicy Class Reference
593
DDS has a standard protocol for packet (user and meta data) exchange between applications using DDS for communications. This QoS policy and
com.rti.dds.infrastructure.DataWriterProtocolQosPolicy (p. 592) give
you control over configurable portions of the protocol, including the configuration of the reliable data delivery mechanism of the protocol on a per DataWriter
or DataReader basis.
These configuration parameters control timing, timeouts, and give you the ability to tradeoff between speed of data loss detection and repair versus network
and CPU bandwidth used to maintain reliability.
It
is
important
to
tune
the
reliability
protocol
(on
a
and
per
(p. 557)
com.rti.dds.subscription.DataReader (p. 487) basis) to meet the requirements of the end-user application so that data can be sent between
DataWriters and DataReaders in an efficient and optimal manner in the
presence of data loss.
You can also use this QoS policy to control how RTI Connext responds
to slow reliable DataReaders or ones that disconnect or are otherwise lost. See com.rti.dds.infrastructure.ReliabilityQosPolicy (p. 1324)
for more information on the per-DataReader/DataWriter reliability configuration. com.rti.dds.infrastructure.HistoryQosPolicy (p. 1046) and
com.rti.dds.infrastructure.ResourceLimitsQosPolicy (p. 1348) also play
an important role in the DDS reliable protocol.
Entity:
Properties:
RxO (p. 101) = N/A
8.50.2
8.50.2.1
GUID t virtual guid

The virtual GUID is used to uniquely identify different incarnations of the same
RTI Connext uses the virtual GUID to associate a persisted writer history to a
specific com.rti.dds.publication.DataWriter (p. 557).
594
Class Documentation
The RTI Connext Persistence Service uses the virtual GUID to send samples
on behalf of the original com.rti.dds.publication.DataWriter (p. 557).
[default] com.rti.dds.infrastructure.GUID t.AUTO
8.50.2.2
int rtps object id
The RTPS Object ID.

This value is used to determine the RTPS object ID of a data writer according
to the DDS-RTPS Interoperability Wire Protocol.
Only the last 3 bytes are used; the most significant byte is ignored.
If the default value is specified, RTI Connext will automatically assign the object
ID based on a counter value (per participant) starting at 0x00800000. That
value is incremented for each new data writer.
A rtps object id value in the interval [0x00800000,0x00ffffff] may collide with the
automatic values assigned by RTI Connext. In those cases, the recomendation
is not to use automatic object ID assigment.
[default] com.rti.dds.infrastructure.WireProtocolQosPolicy.RTPS AUTO ID (p. 1728)
[range] [0,0x00ffffff]
8.50.2.3
boolean push on write
Whether to push sample out when write is called.

If set to com.rti.dds.infrastructure.true (the default), the writer will send a
sample every time write is called. Otherwise, the sample is put into the queue
waiting for a NACK from remote reader(s) to be sent out.
8.50.2.4
Controls whether or not the writer expects positive acknowledgements from

matching readers.
If set to com.rti.dds.infrastructure.true, the writer does not expect
readers to send send positive acknowledgments to the writer.
Consequently, instead of keeping a sample queued until all readers have
positively acknowledged it, the writer will keep a sample for at least
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.disable positive acks min sample keep duration (p. 1381), after which the sample
is logically considered as positively acknowledged.
595
If set to com.rti.dds.infrastructure.false (the default), the writer expects

to receive positive acknowledgements from its acknowledging readers
(com.rti.dds.infrastructure.DataReaderProtocolQosPolicy.disable (p. 524)
=
com.rti.dds.infrastructure.false)
and
positive acks
it applies the keep-duration to its non-acknowledging readers
(com.rti.dds.infrastructure.DataReaderProtocolQosPolicy.disable positive acks (p. 524) = com.rti.dds.infrastructure.true).
A writer with both acknowledging and non-acknowledging readers keeps a sample queued until acknowledgements have been received from all acknowledging
readers and the keep-duration has elapsed for non-acknowledging readers.
8.50.2.5
boolean disable inline keyhash
Controls whether or not a keyhash is propagated on the wire with each sample.
This field only applies to keyed writers.
With each key, RTI Connext associates an internal 16-byte representation, called
a keyhash.
When this field is com.rti.dds.infrastructure.false, the keyhash is sent on the
wire with every data instance.
When this field is com.rti.dds.infrastructure.true, the keyhash is not sent on the
wire and the readers must compute the value using the received data.
If the reader is CPU bound, sending the keyhash on the wire may increase
performance, because the reader does not have to get the keyhash from the
data.
If the writer is CPU bound, sending the keyhash on the wire may decrease
performance, because it requires more bandwidth (16 more bytes per sample).
Note: Setting disable inline keyhash to com.rti.dds.infrastructure.true is not
compatible with using RTI Real-Time Connect or RTI Recorder.
8.50.2.6
boolean serialize key with dispose
Controls whether or not the serialized key is propagated on the wire with dispose
samples.
This field only applies to keyed writers.
We recommend setting this field to com.rti.dds.infrastructure.true if there are
DataReaders where com.rti.dds.infrastructure.DataReaderProtocolQosPolicy.propagate dispose of unregistered instances
(p. 524)
is
also
596
Class Documentation
Important:
When this field is com.rti.dds.infrastructure.true, batching
will not be compatible with RTI Connext 4.3e, 4.4b, or 4.4c.
The
com.rti.dds.subscription.DataReader (p. 487) entities will receive incorrect
data and/or encounter deserialization errors.
8.50.2.7
final RtpsReliableWriterProtocol t rtps reliable writer
Initial value:
new RtpsReliableWriterProtocol_t()

[default] low watermark 0;
high watermark 1;
heartbeat period 3.0 seconds;
fast heartbeat period 3.0 seconds;
late joiner heartbeat period 3.0 seconds;
virtual heartbeat period com.rti.dds.infrastructure.Duration t.AUTO;
samples per virtual heartbeat com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106);
max heartbeat retries 10;
inactivate nonprogressing readers com.rti.dds.infrastructure.false;
heartbeats per max samples 8;
min nack response delay 0.0 seconds;
max nack response delay 0.2 seconds;
max bytes per nack response 131072
8.50.2.8
SequenceNumber t initial virtual sequence number
Determines, the initial virtual sequence number for this DataWriter.

By default, the sequence number will be (0,1) for DataWriters that do not use
durable writer history.
For durable writers the sequence number will be the last sequence number they
published in a previous execution plus one.

[default] com.rti.dds.infrastructure.SequenceNumber t.AUTO
597
598
Class Documentation
8.51
DataWriterProtocolStatus
ence
Class
Refer-
<<eXtension>> ( p. 278) The status of a writers internal protocol related

metrics, like the number of samples pushed, pulled, filtered; and status of wire
protocol traffic.
Inherits Status.
Public Attributes
long pushed sample count
The number of user samples pushed on write from a local DataWriter
( p. 557) to a matching remote DataReader.
long pushed sample count change

The incremental change in the number of user samples pushed on write from
a local DataWriter ( p. 557) to a matching remote DataReader since the
long pushed sample bytes

The number of bytes of user samples pushed on write from a local
DataWriter ( p. 557) to a matching remote DataReader.
long pushed sample bytes change

The incremental change in the number of bytes of user samples pushed on
write from a local DataWriter ( p. 557) to a matching remote DataReader

The number of user samples preemptively filtered by a local DataWriter
( p. 557) due to Content-Filtered Topics.

The incremental change in the number of user samples preemptively filtered
by a local DataWriter ( p. 557) due to Content-Filtered Topics since the last

( p. 557) due to Content-Filtered Topics.

8.51 DataWriterProtocolStatus Class Reference
599
The incremental change in the number of user samples preemptively filtered

by a local DataWriter ( p. 557) due to Content-Filtered Topics since the last
long sent heartbeat count

The number of Heartbeats sent between a local DataWriter ( p. 557) and
matching remote DataReader.
long sent heartbeat count change

The incremental change in the number of Heartbeats sent between a local
DataWriter ( p. 557) and matching remote DataReader since the last time
long sent heartbeat bytes

The number of bytes of Heartbeats sent between a local DataWriter ( p. 557)
and matching remote DataReader.
long sent heartbeat bytes change

The incremental change in the number of bytes of Heartbeats sent between a
local DataWriter ( p. 557) and matching remote DataReader since the last
long pulled sample count

The number of user samples pulled from local DataWriter ( p. 557) by
matching DataReaders.
long pulled sample count change

The incremental change in the number of user samples pulled from local
DataWriter ( p. 557) by matching DataReaders since the last time the status
was read.
long pulled sample bytes

The number of bytes of user samples pulled from local DataWriter ( p. 557)
by matching DataReaders.
long pulled sample bytes change

The incremental change in the number of bytes of user samples pulled from
local DataWriter ( p. 557) by matching DataReaders since the last time the
status was read.
long received ack count

The number of ACKs from a remote DataReader received by a local
DataWriter ( p. 557).
long received ack count change

600
Class Documentation
The incremental change in the number of ACKs from a remote DataReader
received by a local DataWriter ( p. 557) since the last time the status was
read.
long received ack bytes

The number of bytes of ACKs from a remote DataReader received by a local
long received ack bytes change

The incremental change in the number of bytes of ACKs from a remote
DataReader received by a local DataWriter ( p. 557) since the last time the
status was read.
long received nack count

The number of NACKs from a remote DataReader received by a local
long received nack count change

The incremental change in the number of NACKs from a remote DataReader
received by a local DataWriter ( p. 557) since the last time the status was
read.
long received nack bytes

The number of bytes of NACKs from a remote DataReader received by a local
long received nack bytes change

The incremental change in the number of bytes of NACKs from a remote
DataReader received by a local DataWriter ( p. 557) since the last time the
status was read.
long sent gap count

The number of GAPs sent from local DataWriter ( p. 557) to matching
remote DataReaders.
long sent gap count change

The incremental change in the number of GAPs sent from local DataWriter
( p. 557) to matching remote DataReaders since the last time the status was
read.
long sent gap bytes

The number of bytes of GAPs sent from local DataWriter ( p. 557) to matching remote DataReaders.
long sent gap bytes change

601
The incremental change in the number of bytes of GAPs sent from local
DataWriter ( p. 557) to matching remote DataReaders since the last time

The number of times a sample is rejected due to exceptions in the send path.

exceptions in the send path since the last time the status was read.
int send window size

Current maximum number of outstanding samples allowed in the
DataWriters queue.

The sequence number of the first available sample currently queued in the
local DataWriter ( p. 557).

The sequence number of the last available sample currently queued in the
local DataWriter ( p. 557).
SequenceNumber t
number
first unacknowledged sample sequence -
The sequence number of the first unacknowledged sample currently queued in

the local DataWriter ( p. 557).
SequenceNumber t
number
first available sample virtual sequence -
The virtual sequence number of the first available sample currently queued in
SequenceNumber t
number
last available sample virtual sequence -
The virtual sequence number of the last available sample currently queued in
SequenceNumber t
sequence number
first unacknowledged sample virtual -
The virtual sequence number of the first unacknowledged sample currently

queued in the local DataWriter ( p. 557).
InstanceHandle t
handle
first unacknowledged sample subscription -
602
Class Documentation
The handle of a remote DataReader that has not acknowledged the first unacknowledged sample of the local DataWriter ( p. 557).
SequenceNumber t
sequence number
first unelapsed keep duration sample -
The sequence number of the first sample whose keep duration has not yet
elapsed.
8.51.1

metrics, like the number of samples pushed, pulled, filtered; and status of wire
protocol traffic.
Entity:
8.51.2
8.51.2.1
long pushed sample count
The number of user samples pushed on write from a local DataWriter (p. 557)
to a matching remote DataReader.
Counts protocol (RTPS) messages pushed by a DataWriter (p. 557) when writing, unregistering, and disposing. The count is the number of sends done internally, and it may be greater than the number of user writes.
For large data, counts whole samples, not fragments.
8.51.2.2
long pushed sample count change
The incremental change in the number of user samples pushed on write from
a local DataWriter (p. 557) to a matching remote DataReader since the last
Counts protocol (RTPS) messages pushed by a DataWriter (p. 557) when writing, unregistering, and disposing.

8.51.2.3
603
long pushed sample bytes
The number of bytes of user samples pushed on write from a local DataWriter
(p. 557) to a matching remote DataReader.
Counts bytes of protocol (RTPS) messages pushed by a DataWriter (p. 557)
when writing, unregistering, and disposing. The count of bytes corresponds to
the number of sends done internally, and it may be greater than the number of
user writes.
For large data, counts bytes of whole samples, not fragments.
8.51.2.4
long pushed sample bytes change
The incremental change in the number of bytes of user samples pushed on write
from a local DataWriter (p. 557) to a matching remote DataReader since the
Counts bytes of protocol (RTPS) messages pushed by a DataWriter (p. 557)
when writing, unregistering, and disposing.
8.51.2.5

(p. 557) due to Content-Filtered Topics.
8.51.2.6
The incremental change in the number of user samples preemptively filtered by

a local DataWriter (p. 557) due to Content-Filtered Topics since the last time
8.51.2.7

(p. 557) due to Content-Filtered Topics.
8.51.2.8
The incremental change in the number of user samples preemptively filtered by

a local DataWriter (p. 557) due to Content-Filtered Topics since the last time
604
Class Documentation
8.51.2.9
long sent heartbeat count
The number of Heartbeats sent between a local DataWriter (p. 557) and
matching remote DataReader.
Because periodic and piggyback heartbeats are sent to remote readers and their
locators differently in different situations, when a reader has more than one locator, this count may be larger than expected, to reflect the sending of Heartbeats
to the multiple locators.
8.51.2.10
long sent heartbeat count change
The incremental change in the number of Heartbeats sent between a local

DataWriter (p. 557) and matching remote DataReader since the last time the
status was read.
8.51.2.11
long sent heartbeat bytes
The number of bytes of Heartbeats sent between a local DataWriter (p. 557)
and matching remote DataReader.
Because periodic and piggyback heartbeats are sent to remote readers and their
locators differently in different situations, when a reader has more than one locator, this count may be larger than expected, to reflect the sending of Heartbeats
to the multiple locators.
8.51.2.12
long sent heartbeat bytes change
The incremental change in the number of bytes of Heartbeats sent between a

local DataWriter (p. 557) and matching remote DataReader since the last time
8.51.2.13
long pulled sample count
The number of user samples pulled from local DataWriter (p. 557) by matching
DataReaders.
Pulled samples are samples sent for repairs, for late joiners,
and all samples sent by the local DataWriter (p. 557) when
com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.push on write (p. 594) is com.rti.dds.infrastructure.false.

8.51.2.14
605
long pulled sample count change
The incremental change in the number of user samples pulled from local
DataWriter (p. 557) by matching DataReaders since the last time the status
was read.
8.51.2.15
long pulled sample bytes
The number of bytes of user samples pulled from local DataWriter (p. 557) by
matching DataReaders.
8.51.2.16
long pulled sample bytes change
The incremental change in the number of bytes of user samples pulled from local
DataWriter (p. 557) by matching DataReaders since the last time the status
was read.
8.51.2.17
long received ack count
The number of ACKs from a remote DataReader received by a local

DataWriter (p. 557).
606
Class Documentation
8.51.2.18
long received ack count change
The incremental change in the number of ACKs from a remote DataReader

received by a local DataWriter (p. 557) since the last time the status was
read.
8.51.2.19
long received ack bytes
The number of bytes of ACKs from a remote DataReader received by a local

8.51.2.20
long received ack bytes change
The incremental change in the number of bytes of ACKs from a remote

DataReader received by a local DataWriter (p. 557) since the last time the
status was read.
8.51.2.21
long received nack count
The number of NACKs from a remote DataReader received by a local

8.51.2.22
long received nack count change
The incremental change in the number of NACKs from a remote DataReader

received by a local DataWriter (p. 557) since the last time the status was read.
8.51.2.23
long received nack bytes
The number of bytes of NACKs from a remote DataReader received by a local

8.51.2.24
long received nack bytes change
The incremental change in the number of bytes of NACKs from a remote

DataReader received by a local DataWriter (p. 557) since the last time the
status was read.

8.51.2.25
607
long sent gap count
The number of GAPs sent from local DataWriter (p. 557) to matching remote
DataReaders.
8.51.2.26
long sent gap count change
The incremental change in the number of GAPs sent from local DataWriter
(p. 557) to matching remote DataReaders since the last time the status was
read.
8.51.2.27
long sent gap bytes
The number of bytes of GAPs sent from local DataWriter (p. 557) to matching
remote DataReaders.
8.51.2.28
long sent gap bytes change
The incremental change in the number of bytes of GAPs sent from local
DataWriter (p. 557) to matching remote DataReaders since the last time the
status was read.
8.51.2.29
The number of times a sample is rejected due to exceptions in the send path.
8.51.2.30

exceptions in the send path since the last time the status was read.
8.51.2.31
int send window size
Current maximum number of outstanding samples allowed in the DataWriters

queue.
Spans the range from com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.min send window size (p. 1383) to com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.max send window size (p. 1384).
608
Class Documentation
8.51.2.32
The sequence number of the first available sample currently queued in the local
Applies only for local DataWriter (p. 557) status.
8.51.2.33
The sequence number of the last available sample currently queued in the local
8.51.2.34
SequenceNumber t first unacknowledged sample sequence number
The sequence number of the first unacknowledged sample currently queued in

the local DataWriter (p. 557).
8.51.2.35
SequenceNumber t first available sample virtual sequence number
The virtual sequence number of the first available sample currently queued in
8.51.2.36
SequenceNumber t last available sample virtual sequence number
The virtual sequence number of the last available sample currently queued in
8.51.2.37
SequenceNumber t first unacknowledged sample virtual sequence number
The virtual sequence number of the first unacknowledged sample currently

queued in the local DataWriter (p. 557).
609

8.51.2.38
InstanceHandle t first unacknowledged sample subscription handle
The handle of a remote DataReader that has not acknowledged the first unacknowledged sample of the local DataWriter (p. 557).
8.51.2.39
SequenceNumber t first unelapsed keep duration sample sequence number
The sequence number of the first sample whose keep duration has not yet
elapsed.
Applicable only when com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.disable positive acks (p. 594) is set.
Sequence
number
of
the
first
sample
kept
in
the
DataWriters
queue
whose
keep duration
(applied
when
com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.disable positive acks (p. 594) is set) has not yet elapsed.
610
Class Documentation
8.52
DataWriterQos Class Reference
QoS policies supported by a com.rti.dds.publication.DataWriter (p. 557)

entity.
Inheritance diagram for DataWriterQos::
Public Attributes
final DurabilityServiceQosPolicy durability service

DurabilityService policy, DURABILITY SERVICE ( p. 69).







final TransportPriorityQosPolicy transport priority

Transport priority policy, TRANSPORT PRIORITY ( p. 126).
final LifespanQosPolicy lifespan

Lifespan policy, LIFESPAN ( p. 81).
8.52 DataWriterQos Class Reference
611


final OwnershipStrengthQosPolicy ownership strength

Ownership strength policy, OWNERSHIP STRENGTH ( p. 88).
final WriterDataLifecycleQosPolicy writer data lifecycle

Writer data lifecycle policy, WRITER DATA LIFECYCLE ( p. 140).
final
DataWriterResourceLimitsQosPolicy
limits
<<eXtension>> (p. 278) Writer resource
WRITER RESOURCE LIMITS ( p. 51).
writer resource -
limits
policy,
DATA -
final DataWriterProtocolQosPolicy protocol

<<eXtension>> (p. 278) com.rti.dds.publication.DataWriter ( p. 557)
protocol policy, DATA WRITER PROTOCOL ( p. 50)

<<eXtension>> (p. 278) Transport plugin selection policy, TRANSPORT SELECTION ( p. 127).

<<eXtension>> (p. 278) Unicast transport policy, TRANSPORT UNICAST ( p. 128).
final PublishModeQosPolicy publish mode

<<eXtension>> (p. 278) Publish mode policy,
( p. 93).
PUBLISH MODE

final BatchQosPolicy batch

<<eXtension>> (p. 278) Batch policy, BATCH ( p. 44).
final MultiChannelQosPolicy multi channel

<<eXtension>> (p. 278) Multi channel policy, MULTICHANNEL
( p. 85).
612
Class Documentation

<<eXtension>> (p. 278) Availability policy, AVAILABILITY ( p. 43).
final EntityNameQosPolicy publication name

<<eXtension>> (p. 278) EntityName policy, ENTITY NAME ( p. 74).

<<eXtension>> (p. 278) Type support data, TYPESUPPORT ( p. 130).
8.52.1
QoS policies supported by a com.rti.dds.publication.DataWriter (p. 557)

entity.
com.rti.dds.publication.DataWriterQos.history.depth
<=
com.rti.dds.publication.DataWriterQos.resource limits.max samples per instance
com.rti.dds.publication.DataWriterQos.resource limits.max samples per instance <= com.rti.dds.publication.DataWriterQos.resource limits.max samples
- com.rti.dds.publication.DataWriterQos.resource limits.initial samples
com.rti.dds.publication.DataWriterQos.resource limits.max samples
<=
- com.rti.dds.publication.DataWriterQos.resource limits.initial instances <=

com.rti.dds.publication.DataWriterQos.resource limits.max instances
- length of com.rti.dds.publication.DataWriterQos.user data.value <=
(p. 776)
com.rti.dds.domain.DomainParticipantQos.resource limits
.writer user data max length
If any of the above are not true, com.rti.dds.publication.DataWriter.set qos (p. 562) and com.rti.dds.publication.DataWriter.set qos with profile (p. 563) and com.rti.dds.publication.Publisher.set default datawriter qos (p. 1267) and com.rti.dds.publication.Publisher.set default datawriter qos with profile
(p. 1268)
will
fail
with
com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY
(p. 1359)
and
com.rti.dds.publication.Publisher.create datawriter
(p. 1269) and com.rti.dds.publication.Publisher.create datawriter with profile (p. 1271) and will return NULL.
Entity:

See also:
QoS Policies (p. 94) allowed ranges within each Qos.
8.52.2
8.52.2.1

8.52.2.2
DurabilityService policy, DURABILITY SERVICE (p. 69).

8.52.2.3

8.52.2.4

8.52.2.5

8.52.2.6

8.52.2.7

8.52.2.8

8.52.2.9

613
614
Class Documentation
8.52.2.10
Transport priority policy, TRANSPORT PRIORITY (p. 126).

8.52.2.11
Lifespan policy, LIFESPAN (p. 81).

8.52.2.12

8.52.2.13

8.52.2.14
Ownership strength policy, OWNERSHIP STRENGTH (p. 88).

8.52.2.15
final WriterDataLifecycleQosPolicy writer data lifecycle
Writer data lifecycle policy, WRITER DATA LIFECYCLE (p. 140).

8.52.2.16
final DataWriterResourceLimitsQosPolicy
writer resource limits
<<eXtension>> ( p. 278) Writer resource limits policy, DATA WRITER RESOURCE LIMITS (p. 51).
8.52.2.17
final DataWriterProtocolQosPolicy protocol
<<eXtension>> ( p. 278) com.rti.dds.publication.DataWriter (p. 557)

protocol policy, DATA WRITER PROTOCOL (p. 50)
8.52.2.18
<<eXtension>> ( p. 278) Transport plugin selection policy, TRANSPORT SELECTION (p. 127).

Specifies
the
transports
available
for
8.52.2.19
615
use
by
the
<<eXtension>> ( p. 278) Unicast transport policy,

UNICAST (p. 128).
TRANSPORT -
Specifies the unicast transport interfaces and ports on which messages can be
received.
The
unicast
interfaces
are
used
to
receive
messages
from
com.rti.dds.subscription.DataReader (p. 487) entities in the domain
(p. 328).
8.52.2.20
final PublishModeQosPolicy publish mode
<<eXtension>> ( p. 278) Publish mode policy, PUBLISH MODE (p. 93).

Determines whether the com.rti.dds.publication.DataWriter (p. 557) publishes data synchronously or asynchronously and how.
8.52.2.21
8.52.2.22
final BatchQosPolicy batch
<<eXtension>> ( p. 278) Batch policy, BATCH (p. 44).
8.52.2.23
final MultiChannelQosPolicy multi channel
<<eXtension>> ( p. 278) Multi channel policy, MULTICHANNEL (p. 85).
8.52.2.24
<<eXtension>> ( p. 278) Availability policy, AVAILABILITY (p. 43).
8.52.2.25
<<eXtension>> ( p. 278) EntityName policy, ENTITY NAME (p. 74).

616
Class Documentation
8.52.2.26
<<eXtension>> ( p. 278) Type support data, TYPESUPPORT (p. 130).

Optional value that is passed to a type plugins on endpoint attached and serialization functions.
8.53 DataWriterResourceLimitsInstanceReplacementKind Class

Reference
617
8.53
Class Reference
are reached.
Inheritance diagram for DataWriterResourceLimitsInstanceReplacementKind::

static final DataWriterResourceLimitsInstanceReplacementKind
UNREGISTERED INSTANCE REPLACEMENT
Allows a com.rti.dds.publication.DataWriter ( p. 557) to reclaim unregistered acknowledged instances.

ALIVE INSTANCE REPLACEMENT
Allows a com.rti.dds.publication.DataWriter ( p. 557) to reclaim alive
acknowledged instances.

DISPOSED INSTANCE REPLACEMENT
Allows a com.rti.dds.publication.DataWriter ( p. 557) to reclaim disposed acknowledged instances.

ALIVE THEN DISPOSED INSTANCE REPLACEMENT
Allows a com.rti.dds.publication.DataWriter ( p. 557) first to reclaim an
alive acknowledged instance, and then if necessary a disposed acknowledged
instance.

DISPOSED THEN ALIVE INSTANCE REPLACEMENT
Allows a com.rti.dds.publication.DataWriter ( p. 557) first to reclaim a
disposed acknowledged instance, and then if necessary an alive acknowledged
instance.

ALIVE OR DISPOSED INSTANCE REPLACEMENT
Allows a com.rti.dds.publication.DataWriter ( p. 557) to reclaim a either
an alive acknowledged instance or a disposed acknowledged instance.
618
Class Documentation
8.53.1
are reached.
When
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max instances (p. 1352) is reached, a com.rti.dds.publication.DataWriter
(p. 557) will try to make room for a new instance by attempting to reclaim an existing instance based on the instance replacement kind specified by
com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy.instance replacement (p. 624).
Only instances whose states match the specified kinds are eligible to be replaced.
In addition, an instance must have had all of its samples fully acknowledged for
it to be considered replaceable.
For all kinds, a com.rti.dds.publication.DataWriter (p. 557) will replace the oldest instance satisfying that kind. For example, when the kind is
com.rti.dds.infrastructure.DataWriterResourceLimitsInstanceReplacementKind.DataWriterResourceLim
INSTANCE REPLACEMENT, a com.rti.dds.publication.DataWriter
(p. 557) will remove the oldest fully acknowledged unregistered instance, if such
an instance exists.
If no replaceable instance exists, the invoked function will either return
with an appropriate out-of-resources return code, or in the case of a
write, it may first block to wait for an instance to be acknowledged.
Otherwise, the com.rti.dds.publication.DataWriter (p. 557) will replace
the old instance with the new instance, and invoke, if available, the
com.rti.dds.publication.DataWriterListener InstanceReplacedCallback to notify
the user about an instance being replaced.
A com.rti.dds.publication.DataWriter (p. 557) checks for replaceable instances in the following order, stopping once a replaceable instance is found:
If com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy.replace empty instances

(p. 625)
is
a
com.rti.dds.publication.DataWriter (p. 557) first tries replacing instances that have no samples. These empty instances can be unregistered, disposed, or alive. Next, a com.rti.dds.publication.DataWriter
(p. 557) tries replacing unregistered instances. Since an unregistered instance indicates that the com.rti.dds.publication.DataWriter (p. 557)
is done modifying it, unregistered instances are replaced before instances of any other state (alive, disposed). This is the same as the
com.rti.dds.infrastructure.DataWriterResourceLimitsInstanceReplacementKind.DataWriterResourceLim
INSTANCE REPLACEMENT
kind.
Then,
a
com.rti.dds.publication.DataWriter (p. 557) tries replacing what is specified by com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy.instance replacement (p. 624). With unregistered instances already checked, this leaves
alive and disposed instances. When both alive and disposed instances may
8.53 DataWriterResourceLimitsInstanceReplacementKind Class

Reference
619
be replaced, the kind specifies whether the particular order matters (e.g.
DISPOSED THEN ALIVE, ALIVE THEN DISPOSED) or not (ALIVE OR DISPOSED).
QoS:
(p. 621)
8.53.2
8.53.2.1
final DataWriterResourceLimitsInstanceReplacementKind
UNREGISTERED INSTANCE REPLACEMENT
[static]
Allows a com.rti.dds.publication.DataWriter (p. 557) to reclaim unregistered acknowledged instances.

By default all instance replacement kinds first attempt to
reclaim
an
unregistered
acknowledged
instance.
Used
in
com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy.instance replacement (p. 624) [default]
8.53.2.2
ALIVE INSTANCE REPLACEMENT [static]
Allows a com.rti.dds.publication.DataWriter (p. 557) to reclaim alive acknowledged instances.

When an unregistered acknowledged instance is not available to reclaim, this
kind allows a com.rti.dds.publication.DataWriter (p. 557) to reclaim an
alive acknowledged instance, where an alive instance is a registered, nondisposed instance. The least recently registered or written alive instance will be
reclaimed.
8.53.2.3
DISPOSED INSTANCE REPLACEMENT [static]
Allows a com.rti.dds.publication.DataWriter (p. 557) to reclaim disposed

acknowledged instances.
kind allows a com.rti.dds.publication.DataWriter (p. 557) to reclaim a disposed acknowledged instance. The least recently disposed instance will be reclaimed.
620
Class Documentation
8.53.2.4
ALIVE THEN DISPOSED INSTANCE REPLACEMENT [static]
Allows a com.rti.dds.publication.DataWriter (p. 557) first to reclaim an

alive acknowledged instance, and then if necessary a disposed acknowledged
instance.
kind allows a com.rti.dds.publication.DataWriter (p. 557) first try reclaiming an alive acknowledged instance. If no instance is reclaimable, then it trys
reclaiming a disposed acknowledged instance. The least recently used (i.e. registered, written, or disposed) instance will be reclaimed.
8.53.2.5
DISPOSED THEN ALIVE INSTANCE REPLACEMENT [static]
Allows a com.rti.dds.publication.DataWriter (p. 557) first to reclaim a disposed acknowledged instance, and then if necessary an alive acknowledged instance.
kind allows a com.rti.dds.publication.DataWriter (p. 557) first try reclaiming a disposed acknowledged instance. If no instance is reclaimable, then it trys
reclaiming an alive acknowledged instance. The least recently used (i.e. disposed, registered, or written) instance will be reclaimed.
8.53.2.6
ALIVE OR DISPOSED INSTANCE REPLACEMENT
[static]
Allows a com.rti.dds.publication.DataWriter (p. 557) to reclaim a either

an alive acknowledged instance or a disposed acknowledged instance.
When an unregistered acknowledged instance is not available to reclaim, this kind allows a com.rti.dds.publication.DataWriter (p. 557)
to reclaim either an alive acknowledged instance or a disposed acknowledged instance.
If both instance kinds are available to reclaim, the
com.rti.dds.publication.DataWriter (p. 557) will reclaim the least recently
used (i.e. disposed, registered, or written) instance.
8.54 DataWriterResourceLimitsQosPolicy Class Reference
8.54
621
DataWriterResourceLimitsQosPolicy
Class Reference
Various settings that configure how a com.rti.dds.publication.DataWriter

Inheritance diagram for DataWriterResourceLimitsQosPolicy::
Public Attributes
int initial concurrent blocking threads
The initial number of threads that are allowed to concurrently block on write
call on the same com.rti.dds.publication.DataWriter ( p. 557).
int max concurrent blocking threads

The maximum number of threads that are allowed to concurrently block on
write call on the same com.rti.dds.publication.DataWriter ( p. 557).
int max remote reader filters

The maximum number of remote DataReaders for which the
com.rti.dds.publication.DataWriter ( p. 557) will perform contentbased filtering.
int max batches

Represents
the
maximum
number
of
batches
com.rti.dds.publication.DataWriter ( p. 557) will manage.
int initial batches

Represents
the
initial
number
of
batches
com.rti.dds.publication.DataWriter ( p. 557) will manage.
DataWriterResourceLimitsInstanceReplacementKind instance replacement

Sets the kinds of instances allowed to be replaced when instance resource
limits are reached.
boolean replace empty instances

Whether or not to replace empty instances during instance replacement.
boolean autoregister instances

Whether or not to automatically register new instances.
622
Class Documentation
int initial virtual writers
The
initial
number
of
virtual
writers
supported
by
supported
by
supported
by
int max virtual writers

The
maximum
number
of
virtual
writers
int max remote readers

The maximum number of remote readers
int max app ack remote readers

The maximum number of application-level acknowledging remote readers supported by a com.rti.dds.publication.DataWriter ( p. 557).
8.54.1
Various settings that configure how a com.rti.dds.publication.DataWriter

DataWriters
must
allocate
internal
structures
to
handle
the
simultaneously
blocking
of
threads
trying
to
call
com.rti.ndds.example.FooDataWriter.write (p. 1021) on the same
com.rti.dds.publication.DataWriter (p. 557), for the storage used to batch
small samples, and for content-based filters specified by DataReaders.
Most of these internal structures start at an initial size and, by default, will be grown as needed by dynamically allocating additional memory.
You may set fixed, maximum sizes for these internal structures
if you want to bound the amount of memory that can be used by a
com.rti.dds.publication.DataWriter (p. 557). By setting the initial size to
the maximum size, you will prevent RTI Connext from dynamically allocating
any memory after the creation of the com.rti.dds.publication.DataWriter
(p. 557).
Entity:
Properties:
RxO (p. 101) = N/A
8.54.2
8.54.2.1
int initial concurrent blocking threads
623
The initial number of threads that are allowed to concurrently block on write
call on the same com.rti.dds.publication.DataWriter (p. 557).
This value only applies if com.rti.dds.infrastructure.HistoryQosPolicy
(p. 1046) has its kind set to com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP ALL HISTORY QOS and com.rti.dds.infrastructure.ReliabilityQosPolicy.max blocking time (p. 1327) is > 0.
[default] 1
[range] [1, 10000], <= max concurrent blocking threads
8.54.2.2
int max concurrent blocking threads
The maximum number of threads that are allowed to concurrently block on

write call on the same com.rti.dds.publication.DataWriter (p. 557).
This value only applies if com.rti.dds.infrastructure.HistoryQosPolicy
(p. 1046) has its kind set to com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP ALL HISTORY QOS and com.rti.dds.infrastructure.ReliabilityQosPolicy.max blocking time (p. 1327) is > 0.
[range] [1, 10000] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), >= initial concurrent blocking threads
8.54.2.3
int max remote reader filters
The maximum number of remote DataReaders for which the

com.rti.dds.publication.DataWriter (p. 557) will perform content-based
filtering.
[default] 32
[range] [0, (2 31)-2] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106).
0: The com.rti.dds.publication.DataWriter (p. 557) will not perform filtering for any com.rti.dds.subscription.DataReader (p. 487).
1 to (2 31)-2: The DataWriter will filter for up to the specified number of
DataReaders. In addition, the Datawriter will store the result of the filtering
per sample per DataReader.
624
Class Documentation
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106): The DataWriter will filter for up to (2 31)-2
DataReaders. However, in this case, the DataWriter will not store the filtering
result per sample per DataReader. Thus, if a sample is resent (such as due to
a loss of reliable communication), the sample will be filtered again.
8.54.2.4
int max batches
Represents
the
maximum
number
of
batches
com.rti.dds.publication.DataWriter (p. 557) will manage.

When batching is enabled, the maximum number of samples that a
com.rti.dds.publication.DataWriter (p. 557) can store is limited by this
value and com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples (p. 1351).
[range] [1,100 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106) >= DDS RtpsReliableWriterProtocol t.heartbeats per max samples if batching is enabled
See also:
com.rti.dds.infrastructure.BatchQosPolicy (p. 412)
8.54.2.5
int initial batches
Represents
the
initial
number
of
batches
com.rti.dds.publication.DataWriter (p. 557) will manage.
[default] 8
See also:
com.rti.dds.infrastructure.BatchQosPolicy (p. 412)
8.54.2.6
instance replacement
Sets the kinds of instances allowed to be replaced when instance resource limits
are reached.
625
When
a
number
of
active
instances
is
greater
than
(p. 557)s
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max instances
(p. 1352), it will try to make room by replacing an existing instance. This field
specifies the kinds of instances allowed to be replaced.
If a replaceable instance is not available, either an out-of-resources exception
will be returned, or the writer may block if the instance reclamation was done
when writing.
[default] com.rti.dds.infrastructure.DataWriterResourceLimitsInstanceReplacementKind.DataWriterResourceLimits
INSTANCE REPLACEMENT
See also:
com.rti.dds.infrastructure.DataWriterResourceLimitsInstanceReplacementKind
(p. 617)
8.54.2.7
boolean replace empty instances
Whether or not to replace empty instances during instance replacement.

When
a
(p. 557)
has
more
active
instances
than
allowed
by
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max instances
(p. 1352), it tries to make room by replacing an existing instance. This
field configures whether empty instances (i.e.
instances with no samples) may be replaced.
If set com.rti.dds.infrastructure.true, then a
com.rti.dds.publication.DataWriter (p. 557) will first try reclaiming empty instances, before trying to replace whatever is specified by
com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy.instance replacement (p. 624).
See also:
com.rti.dds.infrastructure.DataWriterResourceLimitsInstanceReplacementKind
(p. 617)
8.54.2.8
boolean autoregister instances
Whether or not to automatically register new instances.

626
Class Documentation
When set to true, it is possible to write with a non-NIL handle of an instance

that is not registered: the write operation will succeed and the instance will be
registered. Otherwise, that write operation would fail.
See also:
8.54.2.9
int initial virtual writers
The
initial
number
of
virtual
writers
supported
by
[default] 1
[range] [1, 1000000], or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106)
8.54.2.10
int max virtual writers
The
maximum
number
of
virtual
writers
supported
by
Sets the maximum number of unique virtual writers supported by a

com.rti.dds.publication.DataWriter (p. 557), where virtual writers are
added when samples are written with the virtual writer GUID.
This field is specially relevant in the configuration of Persistence Service
DataWriters since these DataWriters will publish samples on behalf of multiple
virtual writers.
8.54.2.11
int max remote readers
The
maximum
number
of
remote
readers
supported
by


8.54.2.12
627
int max app ack remote readers
The maximum number of application-level acknowledging remote readers supported by a com.rti.dds.publication.DataWriter (p. 557).
628
Class Documentation
8.55
DeadlineQosPolicy Class Reference
Inheritance diagram for DeadlineQosPolicy::
Public Attributes
final Duration t period
Duration of the deadline period.
8.55.1
A com.rti.dds.subscription.DataReader (p. 487) expects a new sample updating the value of each instance at least once every period. That is, period
specifies the maximum expected elapsed time between arriving data samples.
indicates
that
A
(p. 557)
the application commits to write a new value (using the
com.rti.dds.publication.DataWriter (p. 557)) for each instance managed by the com.rti.dds.publication.DataWriter (p. 557) at least once
every period.
This QoS can be used during system integration to ensure that applications
have been coded to meet design specifications.
It can also be used during run time to detect when systems are performing
outside of design specifications. Receiving applications can take appropriate
actions to prevent total system failure when data is not received in time. For
topics on which data is not expected to be periodic, period should be set to an
infinite value.
Entity:
(p. 487), com.rti.dds.publication.DataWriter (p. 557)
Status:
com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED DEADLINE MISSED STATUS, com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
8.55 DeadlineQosPolicy Class Reference
629
DEADLINE MISSED STATUS, com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED INCOMPATIBLE QOS STATUS, com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED INCOMPATIBLE QOS STATUS
Properties:
RxO (p. 101) = YES
Changeable (p. 102) = YES (p. 102)
8.55.2
Usage
This policy is useful for cases where a com.rti.dds.topic.Topic (p. 1545) is

expected to have each instance updated periodically. On the publishing side
this setting establishes a contract that the application must meet. On the
subscribing side the setting establishes a minimum requirement for the remote
publishers that are expected to supply the data values.
When RTI Connext matches a com.rti.dds.publication.DataWriter
(p. 557) and a com.rti.dds.subscription.DataReader (p. 487) it
checks whether the settings are compatible (i.e., offered deadline
<= requested deadline); if they are not, the two entities are informed (via the com.rti.dds.infrastructure.Listener (p. 1130) or
com.rti.dds.infrastructure.Condition (p. 464) mechanism) of the incompatibility of the QoS settings and communication will not occur.
Assuming that the reader and writer ends have compatible settings, the fulfilment of this contract is monitored by RTI Connext and the application is informed of any violations by means
of the proper com.rti.dds.infrastructure.Listener (p. 1130) or
com.rti.dds.infrastructure.Condition (p. 464).
8.55.3
Compatibility
The value offered is considered compatible with the value requested if and only
if the inequality offered period <= requested period holds.
8.55.4
Consistency
The setting of the DEADLINE (p. 52) policy must be set consistently with
that of the TIME BASED FILTER (p. 117).
For these two policies to be consistent the settings must be such that deadline
period >= minimum separation.
An attempt to set these policies in an inconsistent manner will result in com.rti.dds.infrastructure.RETCODE INCONSISTENT Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
630
Class Documentation
POLICY
(p. 1359)
in
set qos
(abstract)
(p. 932),
com.rti.dds.infrastructure.Entity (p. 931) will not be created.
or
the
For a com.rti.dds.subscription.DataReader (p. 487), the DEADLINE

(p. 52) policy and com.rti.dds.infrastructure.TimeBasedFilterQosPolicy
may
interact
such
that
even
though
the
(p. 1541)
(p. 557)
is
writing
samples fast enough to fulfill its commitment to its own deadline,
the
(p. 487)
may see violations of its deadline.
This happens because
RTI
Connext
will
drop
any
samples
received
within
the
com.rti.dds.infrastructure.TimeBasedFilterQosPolicy.minimum To
avoid
triggering
the
separation
(p. 1544).
com.rti.dds.subscription.DataReader (p. 487)s deadline, even though
the matched com.rti.dds.publication.DataWriter (p. 557) is meeting its
own deadline, set the two QoS parameters so that:
reader deadline >= reader minimum separation + writer deadline
See com.rti.dds.infrastructure.TimeBasedFilterQosPolicy (p. 1541) for
more information about the interactions between deadlines and time-based filters.
See also:
com.rti.dds.infrastructure.TimeBasedFilterQosPolicy (p. 1541)
8.55.5
8.55.5.1
final Duration t period
Duration of the deadline period.

[range] [1 nanosec, 1 year] or com.rti.dds.infrastructure.Duration t.INFINITE,
>= com.rti.dds.infrastructure.TimeBasedFilterQosPolicy.minimum separation (p. 1544)
8.56 DestinationOrderQosPolicy Class Reference
8.56
631
DestinationOrderQosPolicy Class Reference
com.rti.dds.publication.DataWriter (p. 557) entities for the same instance
of data (i.e., same com.rti.dds.topic.Topic (p. 1545) and key).
Inheritance diagram for DestinationOrderQosPolicy::
Public Attributes
DestinationOrderQosPolicyKind kind
Specifies the desired kind of destination order.
final Duration t source timestamp tolerance

<<eXtension>> (p. 278) Allowed tolerance between source timestamps of
consecutive samples.
8.56.1
com.rti.dds.publication.DataWriter (p. 557) entities for the same instance
of data (i.e., same com.rti.dds.topic.Topic (p. 1545) and key).
Entity:
Status:
com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED INCOMPATIBLE QOS STATUS, com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED INCOMPATIBLE QOS STATUS
Properties:
RxO (p. 101) = YES
632
Class Documentation
8.56.2
Usage
When multiple DataWriters send data for the same topic (p. 359), the order
in which data from different DataWriters are received by the applications of
different DataReaders may be different. So different DataReaders may not
receive the same last value when DataWriters stop sending data.
This QoS policy controls how each subscriber resolves the final value of a data instance that is written by multiple
com.rti.dds.publication.DataWriter (p. 557) entities (which may be
associated with different com.rti.dds.publication.Publisher (p. 1262)
entities) running on different nodes.
The default setting, com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPoli

RECEPTION TIMESTAMP DESTINATIONORDER QOS, indicates that
(assuming the OWNERSHIP STRENGTH (p. 88) policy allows it) the
latest received value for the instance should be the one whose value is kept.
That is, data will be delivered by a com.rti.dds.subscription.DataReader
(p. 487) in the order in which it was received (which may lead to inconsistent
final values).
The setting com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPolicyKind.

SOURCE TIMESTAMP DESTINATIONORDER QOS indicates that (assuming the OWNERSHIP STRENGTH (p. 88) allows it, within each
instance) the source timestamp of the change shall be used to determine the most recent information. That is, data will be delivered by a
com.rti.dds.subscription.DataReader (p. 487) in the order in which it was
sent. If data arrives on the network with a source timestamp that is later than
the source timestamp of the last data delivered, the new data will be dropped.
This by source timestamp ordering therefore works best when system clocks
are relatively synchronized among writing machines.
When using com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPolicyKind.

SOURCE TIMESTAMP DESTINATIONORDER QOS, not all data sent by
multiple com.rti.dds.publication.DataWriter (p. 557) entities may be
delivered to a com.rti.dds.subscription.DataReader (p. 487) and not
all DataReaders will see the same data sent by DataWriters. However, all
DataReaders will see the same final data when DataWriters stop sending
data. This is the only setting that, in the case of concurrently publishing
com.rti.dds.publication.DataWriter (p. 557) entities updating the same
instance of a shared-ownership topic (p. 359), ensures all subscribers will end
up with the same final value for the instance.
This QoS can be used to create systems that have the property of eventual consistency. Thus intermediate states across multiple applications may be inconsistent, but when DataWriters stop sending changes to the same topic (p. 359),
all applications will end up having the same state.
8.56 DestinationOrderQosPolicy Class Reference
8.56.3
633
Compatibility
The value offered is considered compatible with the value requested

if and only if the inequality offered kind >= requested kind evaluates to TRUE. For the purposes of this inequality, the values
of
com.rti.dds.infrastructure.DestinationOrderQosPolicy.kind
are
considered
ordered
such
that
(p. 633)
com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPolicyKind.BY <
RECEPTION TIMESTAMP DESTINATIONORDER QOS
com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPolicyKind.BY SOURCE TIMESTAMP DESTINATIONORDER QOS
8.56.4
8.56.4.1
DestinationOrderQosPolicyKind kind
Specifies the desired kind of destination order.

[default] com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPolicyKind.BY RECEPTION TIMESTAMP DESTINATIONORDER QOS,
8.56.4.2
final Duration t source timestamp tolerance
<<eXtension>> ( p. 278) Allowed tolerance between source timestamps of

consecutive samples.
sets
When
a
(p. 557)
com.rti.dds.infrastructure.DestinationOrderQosPolicyKind (p. 634) to
com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPolicyKind.BY SOURCE TIMESTAMP DESTINATIONORDER QOS, when when writing a
sample, its timestamp must not be less than the timestamp of the previously
written sample. However, if it is less than the timestamp of the previously
written sample but the difference is less than this tolerance, the sample will use
the previously written samples timestamp as its timestamp. Otherwise, if the
difference is greater than this tolerance, the write will fail.
When
a
(p. 487)
sets
com.rti.dds.infrastructure.DestinationOrderQosPolicyKind (p. 634) to
com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPolicyKind.BY SOURCE TIMESTAMP DESTINATIONORDER QOS,
the
com.rti.dds.subscription.DataReader (p. 487) will accept a sample only if
the difference between its source timestamp and the reception timestamp is no
greater than this tolerance. Otherwise, the sample is rejected.
[default] 100 milliseconds for com.rti.dds.publication.DataWriter (p. 557),
30 seconds for com.rti.dds.subscription.DataReader (p. 487)
634
Class Documentation
8.57
DestinationOrderQosPolicyKind
Reference
Class

Inheritance diagram for DestinationOrderQosPolicyKind::

static final DestinationOrderQosPolicyKind BY RECEPTION TIMESTAMP DESTINATIONORDER QOS
[default] Indicates that data is ordered based on the reception time at each
static final DestinationOrderQosPolicyKind

TIMESTAMP DESTINATIONORDER QOS
BY SOURCE -
Indicates that data is ordered based on a time-stamp placed at the source (by
RTI Connext or by the application).
8.57.1

QoS:
com.rti.dds.infrastructure.DestinationOrderQosPolicy (p. 631)
8.57.2
8.57.2.1
final DestinationOrderQosPolicyKind BY RECEPTION TIMESTAMP DESTINATIONORDER QOS

[static]
[default] Indicates that data is ordered based on the reception time at each
Since each subscriber may receive the data at different times there is no guaranteed that the changes will be seen in the same order. Consequently, it is possible
for each subscriber to end up with a different final value for the data.
8.57 DestinationOrderQosPolicyKind Class Reference

8.57.2.2
635
final DestinationOrderQosPolicyKind BY SOURCE TIMESTAMP DESTINATIONORDER QOS

[static]
Indicates that data is ordered based on a time-stamp placed at the source (by
RTI Connext or by the application).
In any case this guarantees a consistent final value for the data in all subscribers.
See also:
Special Instructions if Using Timestamp APIs and BY SOURCE TIMESTAMP Destination Ordering: (p. 1273)
636
Class Documentation
8.58
DiscoveryBuiltinReaderFragmentationResourceLimits t Class Reference
Inherits Struct.

DiscoveryBuiltinReaderFragmentationResourceLimits t ()
DiscoveryBuiltinReaderFragmentationResourceLimits t (boolean
disable fragmentation support, int max fragmented samples, int
initial fragmented samples, int max fragmented samples per remote writer, int max fragments per sample, boolean dynamically allocate fragmented samples)
Public Attributes
boolean dynamically allocate fragmented samples = false
8.58.1
DiscoveryBuiltinReaderFragmentationResourceLimits t (p. 636)
8.58.2
8.58.2.1
DiscoveryBuiltinReaderFragmentationResourceLimits t ()
DiscoveryBuiltinReaderFragmentationResourceLimits t new with no parameter

8.58.2.2
DiscoveryBuiltinReaderFragmentationResourceLimits t
(boolean disable fragmentation support, int
max fragmented samples, int initial fragmented samples,
int max fragmented samples per remote writer,
int max fragments per sample, boolean
dynamically allocate fragmented samples)
DiscoveryBuiltinReaderFragmentationResourceLimits t new with ints

8.58 DiscoveryBuiltinReaderFragmentationResourceLimits t Class

Reference
637
8.58.3
8.58.3.1
DiscoveryBuiltinReaderFragmentationResourceLimits t disable fragmentation support

8.58.3.2
DiscoveryBuiltinReaderFragmentationResourceLimits t max fragmented samples

8.58.3.3
DiscoveryBuiltinReaderFragmentationResourceLimits t initial fragmented samples

8.58.3.4
DiscoveryBuiltinReaderFragmentationResourceLimits t max fragmented samples per remote writer

8.58.3.5
DiscoveryBuiltinReaderFragmentationResourceLimits t max fragments per sample

8.58.3.6
boolean dynamically allocate fragmented samples = false
DiscoveryBuiltinReaderFragmentationResourceLimits t dynamically allocate fragmented samples
638
Class Documentation
8.59
DiscoveryConfigBuiltinPluginKind
Reference
Class

static final int SDP
static final int MASK NONE = 0

static final int MASK ALL = 0xefff

static final int MASK DEFAULT = SDP
8.59.1

See also:
com.rti.dds.infrastructure.DiscoveryConfigBuiltinPluginKindMask
8.59.2
8.59.2.1
final int MASK DEFAULT = SDP [static]
DiscoveryConfigBuiltinPluginKindMask.MASK DEFAULT
8.60 DiscoveryConfigQosPolicy Class Reference
8.60
639
DiscoveryConfigQosPolicy Class Reference

Inheritance diagram for DiscoveryConfigQosPolicy::
Public Attributes
final Duration t participant liveliness lease duration
The liveliness lease duration for the participant.
final Duration t participant liveliness assert period

The period to assert liveliness for the participant.
RemoteParticipantPurgeKind remote participant purge kind

The participants behavior for maintaining knowledge of remote participants
(and their contained entities) with which discovery communication has been
lost.
final Duration t max liveliness loss detection period

The maximum amount of time between when a remote entity stops maintaining its liveliness and when the matched local entity realizes that fact.
int initial participant announcements

The number of initial announcements sent when a participant is first enabled
or when a remote participant is newly discovered.
final Duration t min initial participant announcement period

The minimum period between initial announcements when a participant is
first enabled or when a remote participant is newly discovered.
final Duration t max initial participant announcement period

The maximum period between initial announcements when a participant is
first enabled or when a remote participant is newly discovered.
final BuiltinTopicReaderResourceLimits t participant reader resource limits

Resource limits.
final BuiltinTopicReaderResourceLimits t publication reader resource limits

Resource limits.
640
Class Documentation
final BuiltinTopicReaderResourceLimits t subscription reader resource limits

Resource limits.
final RtpsReliableWriterProtocol t publication writer

RTPS protocol-related configuration settings for a built-in publication
( p. 349) writer.
final WriterDataLifecycleQosPolicy
lifecycle
publication writer data -
Writer data lifecycle settings for a built-in publication ( p. 349) writer.
final RtpsReliableWriterProtocol t subscription writer

RTPS protocol-related configuration settings for a built-in subscription
( p. 353) writer.
final WriterDataLifecycleQosPolicy subscription writer data lifecycle

Writer data lifecycle settings for a built-in subscription ( p. 353) writer.
final RtpsReliableReaderProtocol t publication reader

RTPS protocol-related configuration settings for a built-in publication
( p. 349) reader.
final RtpsReliableReaderProtocol t subscription reader

( p. 353) reader.
int builtin discovery plugins

The kind mask for built-in discovery plugins.
final
RtpsReliableReaderProtocol t
reader
participant message -
RTPS protocol-related configuration settings for a built-in participant message reader.
final RtpsReliableWriterProtocol t participant message writer

RTPS protocol-related configuration settings for a built-in participant message writer.
final PublishModeQosPolicy publication writer publish mode

final PublishModeQosPolicy subscription writer publish mode
final AsynchronousPublisherQosPolicy asynchronous publisher
8.60.1
641

This QoS policy controls the amount of delay in discovering entities in the
system and the amount of discovery traffic in the network.
The amount of network traffic required by the discovery process can vary widely,
based on how your application has chosen to configure the middlewares network
addressing (e.g., unicast vs. multicast, multicast TTL, etc.), the size of the
system, whether all applications are started at the same time or whether start
times are staggered, and other factors. Your application can use this policy
to make tradeoffs between discovery completion time and network bandwidth
utilization. In addition, you can introduce random back-off periods into the
discovery process to decrease the probability of network contention when many
applications start simultaneously.
Entity:
Properties:
RxO (p. 101) = N/A
8.60.2
8.60.2.1
final Duration t participant liveliness lease duration
The liveliness lease duration for the participant.

This is the same as the expiration time of the DomainParticipant as defined in
the RTPS protocol.
If the participant has not refreshed its own liveliness to other participants at
least once within this period, it may be considered as stale by other participants
in the network.
Should be strictly greater than com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.participant liveliness assert period (p. 642).
[range] [1 nanosec,1 year], > participant liveliness assert period
642
Class Documentation
8.60.2.2
final Duration t participant liveliness assert period
The period to assert liveliness for the participant.

The period at which the participant will refresh its liveliness to all the peers.
Should be strictly less than com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.participant liveliness lease duration (p. 641).
[range] [1 nanosec,1 year), < participant liveliness lease duration
8.60.2.3
RemoteParticipantPurgeKind remote participant purge kind
The participants behavior for maintaining knowledge of remote participants

(and their contained entities) with which discovery communication has been
lost.
Most users will not need to change this value from its default,
com.rti.dds.infrastructure.RemoteParticipantPurgeKind.LIVELINESS BASED REMOTE PARTICIPANT PURGE (p. 1342).
However,
com.rti.dds.infrastructure.RemoteParticipantPurgeKind.NO REMOTE PARTICIPANT PURGE (p. 1342) may be a good choice
if the following conditions apply:
1. Discovery communication with a remote participant may be lost while
data communication remains intact. Such will not typically be the case if
discovery takes place over the Simple Discovery Protocol, but may be the
case if the RTI Enterprise Discovery Service is used.
2. Extensive and prolonged lack of discovery communication between participants is not expected to be common, either because participant loss itself
is expected to be rare, or because participants may be lost sporadically
but will typically return again.
3. Maintaining
inter-participant
liveliness
is
problematic,
perhaps because a participant has no writers with the appropriate
com.rti.dds.infrastructure.LivelinessQosPolicyKind (p. 1144).
[default] com.rti.dds.infrastructure.RemoteParticipantPurgeKind.LIVELINESS BASED REMOTE PARTICIPANT PURGE (p. 1342)
8.60.2.4
final Duration t max liveliness loss detection period
The maximum amount of time between when a remote entity stops maintaining
its liveliness and when the matched local entity realizes that fact.
643
Notification of the loss of liveliness of a remote entity may come more quickly
that this duration, depending on the liveliness contract between the local and
remote entities and the capabilities of the discovery mechanism in use. For
example, a com.rti.dds.subscription.DataReader (p. 487) will learn of the
loss of liveliness of a matched com.rti.dds.publication.DataWriter (p. 557)
within the readers offered liveliness lease duration.
Shortening this duration will increase the responsiveness of entities to communication failures. However, it will also increase the CPU usage of the application,
as the liveliness of remote entities will be examined more frequently.
[range] [0, 1 year]
8.60.2.5
int initial participant announcements
The number of initial announcements sent when a participant is first enabled

or when a remote participant is newly discovered.
Also, when a new remote participant appears, the local participant can announce
itself to the peers multiple times controlled by this parameter.
[default] 5
8.60.2.6
final Duration t min initial participant announcement period
The minimum period between initial announcements when a participant is first

enabled or when a remote participant is newly discovered.
A random delay between this and com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.max initial participant announcement period (p. 644) is introduced in between
initial announcements when a new remote participant is discovered.
The setting of com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.min initial participant announcement period (p. 643) must be consistent with
com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.max initial participant announcement period (p. 644). For these two values to be
consistent, they must verify that:
com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.min initial participant announcement period
(p. 643)
<=
com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.max initial participant announcement period (p. 644).
[default] 1 second
644
Class Documentation
[range] [1 nanosec,1 year]
8.60.2.7
final Duration t max initial participant announcement period
The maximum period between initial announcements when a participant is first

enabled or when a remote participant is newly discovered.
A random delay between com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.min initial participant announcement period (p. 643) and this is introduced
in between initial announcements when a new remote participant is discovered.
The setting of com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.max initial participant announcement period (p. 644) must be consistent with
com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.min initial participant announcement period (p. 643). For these two values to be
consistent, they must verify that:
com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.min initial participant announcement period
(p. 643)
<=
com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.max initial participant announcement period (p. 644).
[default] 1 second
[range] [1 nanosec,1 year]
8.60.2.8
final BuiltinTopicReaderResourceLimits t
participant reader resource limits
Resource limits.
Resource limit of the built-in topic (p. 359) participant reader. For details,
see
com.rti.dds.infrastructure.BuiltinTopicReaderResourceLimits t
(p. 426).
8.60.2.9
publication reader resource limits
Resource limits.
Resource
limit
of
the
built-in
topic
(p. 359)
publication
(p. 349)
reader.
For
details,
see
(p. 426).

8.60.2.10
645
subscription reader resource limits
Resource limits.
Resource
limit
of
the
built-in
topic
(p. 359)
subscription
(p. 353)
reader.
For
details,
see
(p. 426).
8.60.2.11
final RtpsReliableWriterProtocol t publication writer
RTPS protocol-related configuration settings for a built-in publication (p. 349)

writer.
For details, refer to the com.rti.dds.publication.DataWriterQos (p. 610)
8.60.2.12
publication writer data lifecycle
Writer data lifecycle settings for a built-in publication (p. 349) writer.
For details, refer to the com.rti.dds.infrastructure.WriterDataLifecycleQosPolicy
(p. 1738). com.rti.dds.infrastructure.WriterDataLifecycleQosPolicy.autodispose unregistered instances
(p. 1739)
will
always
be
forced
to
8.60.2.13
final RtpsReliableWriterProtocol t subscription writer

(p. 353) writer.
8.60.2.14
subscription writer data lifecycle
Writer data lifecycle settings for a built-in subscription (p. 353) writer.
For details, refer to the com.rti.dds.infrastructure.WriterDataLifecycleQosPolicy
(p. 1738). com.rti.dds.infrastructure.WriterDataLifecycleQosPolicy.autodispose unregistered instances
(p. 1739)
will
always
be
forced
to
646
Class Documentation
8.60.2.15
final RtpsReliableReaderProtocol t publication reader
RTPS protocol-related configuration settings for a built-in publication (p. 349)

reader.
For details, refer to the com.rti.dds.subscription.DataReaderQos (p. 536)
8.60.2.16
final RtpsReliableReaderProtocol t subscription reader

(p. 353) reader.
8.60.2.17
int builtin discovery plugins
Initial value:
DiscoveryConfigBuiltinPluginKind.MASK_DEFAULT
The kind mask for built-in discovery plugins.

There are several built-in discovery plugin. This mask enables the different
plugins. Any plugin not enabled will not be created.
[default] com.rti.dds.infrastructure.DiscoveryConfigBuiltinPluginKind.DiscoveryConfigBuiltinPluginKin
8.60.2.18
final RtpsReliableReaderProtocol t
participant message reader
RTPS protocol-related configuration settings for a built-in participant message

reader.
8.60.2.19
final RtpsReliableWriterProtocol t
participant message writer
RTPS protocol-related configuration settings for a built-in participant message

writer.

8.60.2.20
647
final PublishModeQosPolicy publication writer publish mode
Initial value:
new PublishModeQosPolicy()
8.60.2.21
final PublishModeQosPolicy subscription writer publish mode
Initial value:
new PublishModeQosPolicy()
8.60.2.22
final AsynchronousPublisherQosPolicy
asynchronous publisher
Initial value:
new AsynchronousPublisherQosPolicy()
648
Class Documentation
8.61
DiscoveryPluginPromiscuityKind
Reference
Class
<<eXtension>> ( p. 278) Type used to indicate promiscuity mode of the discovery plugin.
Inheritance diagram for DiscoveryPluginPromiscuityKind::
8.61.1
<<eXtension>> ( p. 278) Type used to indicate promiscuity mode of the discovery plugin.
8.62 DiscoveryQosPolicy Class Reference
8.62
649
DiscoveryQosPolicy Class Reference

Inheritance diagram for DiscoveryQosPolicy::
Public Attributes
final StringSeq enabled transports
The transports available for use by the Discovery mechanism.
final StringSeq multicast receive addresses

Specifies the multicast group addresses on which discovery-related metatraffic can be received by the DomainParticipant.
int metatraffic transport priority

The transport priority to use for the Discovery meta-traffic.
final StringSeq initial peers

Determines the initial list of peers that will be contacted by the Discovery
mechanism to send announcements about the presence of this participant.
boolean accept unknown peers

Whether to accept a new participant that is not in the initial peers list.
8.62.1

Entity:
Properties:
RxO (p. 101) = N/A
650
Class Documentation
8.62.2
Usage
This QoS policy identifies where on the network this application can potentially
discover other applications with which to communicate.
The middleware will periodically send network packets to these locations, announcing itself to any remote applications that may be present, and will listen
for announcements from those applications.
See also:
8.62.3
8.62.3.1
The transports available for use by the Discovery mechanism.

Only these transports can be used by the discovery
anism to send meta-traffic via the builtin endpoints
in
(p. 487)
com.rti.dds.publication.DataWriter (p. 557)).
mech(builtand
Also determines the unicast addresses on which the Discovery mechanism will
listen for meta-traffic. These along with the domain id and participant id
determine the unicast locators on which the Discovery mechanism can receive
meta-data.
Alias names for the builtin transports are defined in TRANSPORT BUILTIN (p. 119).
[default] Empty sequence. All the transports available to the DomainParticipant are available for use by the Discovery mechanism.
[range] Sequence of non-null,non-empty strings.
8.62.3.2
final StringSeq multicast receive addresses
Initial value:
new StringSeq()
Specifies the multicast group addresses on which discovery-related meta-traffic

can be received by the DomainParticipant.
8.62 DiscoveryQosPolicy Class Reference
651
The multicast group addresses on which the Discovery mechanism will listen for
meta-traffic.
Each element of this list must be a valid multicast address (IPv4 or IPv6) in
the proper format (see Address Format (p. 59)).
The domain id determines the multicast port on which the Discovery mechanism can receive meta-data.
If
does
not
contain
a
multicast
address,
then
the
string
sequence
com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast receive addresses (p. 650) is cleared and the RTI discovery process will not listen for
discovery messages via multicast.
contains
one
or
more
If
multicast
addresses,
the
addresses
will
be
stored
in
com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast receive addresses (p. 650), starting at element 0. They will be stored in the order
they appear NDDS DISCOVERY PEERS.
Note:
Currently,
RTI Connext will only listen for discovery
traffic
on
the
first
multicast
address
(element
0)
in
com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast receive addresses (p. 650).
[default] See NDDS DISCOVERY PEERS (p. 57)
[range] Sequence of length [0,1], whose elements are multicast addresses. Currently only the first multicast address (if any) is used. The rest are ignored.
See also:
Address Format (p. 59)
8.62.3.3
int metatraffic transport priority
The transport priority to use for the Discovery meta-traffic.

The
discovery
metatraffic
will
be
sent
by
the
built-in
com.rti.dds.publication.DataWriter (p. 557) using this transport priority.
[default] 0
8.62.3.4
final StringSeq initial peers
Determines the initial list of peers that will be contacted by the Discovery
mechanism to send announcements about the presence of this participant.
652
Class Documentation
If there is a remote peer com.rti.dds.domain.DomainParticipant (p. 654)

such as is described in this list, it will become aware of this participant and will
engage in the Discovery protocol to exchange meta-data with this participant.
Each element of this list must be a peer descriptor in the proper format (see
Peer Descriptor Format (p. 58)).
[default] See NDDS DISCOVERY PEERS (p. 57)
[range] Sequence of arbitrary length.
See also:
Peer Descriptor Format (p. 58)
com.rti.dds.domain.DomainParticipant.add peer() (p. 720)
8.62.3.5
boolean accept unknown peers
Whether to accept a new participant that is not in the initial peers list.
If com.rti.dds.infrastructure.false, the participant will only communicate with those in the initial peers list and those added via
com.rti.dds.domain.DomainParticipant.add peer() (p. 720).
If com.rti.dds.infrastructure.true, the participant will also communicate with all
discovered remote participants.
Note: If accept unknown peers is com.rti.dds.infrastructure.false and shared
memory is disabled, applications on the same node will not communicate if
only localhost is specified in the peers list. If shared memory is disabled or
shmem:// is not specified in the peers list, to communicate with other applications on the same node through the loopback interface, you must put the actual
node address or hostname in NDDS DISCOVERY PEERS (p. 57).
8.63 DomainEntity Interface Reference
8.63
653
DomainEntity Interface Reference
<<interface>> ( p. 279) Abstract base class for all DDS entities except for
the com.rti.dds.domain.DomainParticipant (p. 654).
Inheritance diagram for DomainEntity::
8.63.1
<<interface>> ( p. 279) Abstract base class for all DDS entities except for
Its
sole
purpose
is
to
conceptually
express
that
com.rti.dds.domain.DomainParticipant (p. 654) is a special kind of
com.rti.dds.infrastructure.Entity (p. 931) that acts as a container of all
other com.rti.dds.infrastructure.Entity (p. 931) but itself cannot contain
other com.rti.dds.domain.DomainParticipant (p. 654).
654
Class Documentation
8.64
DomainParticipant Interface Reference
<<interface>>
( p. 279)
Container
for
com.rti.dds.infrastructure.DomainEntity (p. 653) objects.
all
Inheritance diagram for DomainParticipant::

void get default flowcontroller property (FlowControllerProperty t prop)
<<eXtension>>
(p. 278)
Copies
the
default
com.rti.dds.publication.FlowControllerProperty t
( p. 968)
values for this domain ( p. 328) participant into the given
com.rti.dds.publication.FlowControllerProperty t ( p. 968) instance.
void set default flowcontroller property

erty t prop)
(FlowControllerProp-
<<eXtension>>
(p. 278)
Set
for this domain ( p. 328) participant.
the
( p. 968)
default
values
void get default topic qos (TopicQos qos)

Copies the default com.rti.dds.topic.TopicQos ( p. 1566) values for this
domain ( p. 328) participant into the given com.rti.dds.topic.TopicQos
( p. 1566) instance.
void set default topic qos (TopicQos qos)

Set the default com.rti.dds.topic.TopicQos ( p. 1566) values for this domain ( p. 328) participant.
void set default topic qos with profile (String library name, String
profile name)
<<eXtension>> (p. 278) Set the default com.rti.dds.topic.TopicQos
( p. 1566) values for this domain ( p. 328) participant based on the input
XML QoS profile.
void get default publisher qos (PublisherQos qos)

Copy the default com.rti.dds.publication.PublisherQos ( p. 1290) values into the provided com.rti.dds.publication.PublisherQos ( p. 1290) instance.
void set default publisher qos (PublisherQos qos)

8.64 DomainParticipant Interface Reference
655
Set the default com.rti.dds.publication.PublisherQos ( p. 1290) values for

this DomainParticipant ( p. 654).
void set default publisher qos with profile (String library name,
String profile name)
<<eXtension>>
(p. 278)
Set
the
default
com.rti.dds.publication.PublisherQos ( p. 1290) values for this DomainParticipant ( p. 654) based on the input XML QoS profile.
void get default datawriter qos (DataWriterQos qos)

<<eXtension>>
(p. 278)
Copy
the
default
com.rti.dds.publication.DataWriterQos ( p. 610) values into the
provided com.rti.dds.publication.DataWriterQos ( p. 610) instance.
void set default datawriter qos (DataWriterQos qos)

<<eXtension>> (p. 278) Set the default DataWriterQos values for this
DomainParticipant ( p. 654).
void set default datawriter qos with profile (String library name,
<<eXtension>>
(p. 278)
Set
the
default
com.rti.dds.publication.DataWriterQos ( p. 610) values for this
domain ( p. 328) participant based on the input XML QoS profile.
void get default datareader qos (DataReaderQos qos)

<<eXtension>>
(p. 278)
Copy
the
default
com.rti.dds.subscription.DataReaderQos ( p. 536) values into the
provided com.rti.dds.subscription.DataReaderQos ( p. 536) instance.
void set default subscriber qos (SubscriberQos qos)

Set the default com.rti.dds.subscription.SubscriberQos ( p. 1505) values
for this Domain{articipant.
void set default subscriber qos with profile (String library name,
<<eXtension>>
(p. 278)
Set
the
default
com.rti.dds.subscription.SubscriberQos ( p. 1505) values for this
DomainParticipant ( p. 654) based on the input XML QoS profile.
void get default subscriber qos (SubscriberQos qos)

Copy the default com.rti.dds.subscription.SubscriberQos ( p. 1505) values into the provided com.rti.dds.subscription.SubscriberQos ( p. 1505)
instance.
void set default datareader qos (DataReaderQos qos)

656
Class Documentation
<<eXtension>>
(p. 278)
Set
the
com.rti.dds.subscription.DataReaderQos ( p. 536) values
domain ( p. 328) participant.
default
for this
void set default datareader qos with profile (String library name,
<<eXtension>>
(p. 278)
Set
the
default
com.rti.dds.subscription.DataReaderQos ( p. 536) values for this
DomainParticipant ( p. 654) based on the input XML QoS profile.
FlowController create flowcontroller (String name,

trollerProperty t prop)
FlowCon-
<<eXtension>> (p. 278) Creates a com.rti.dds.publication.FlowController

( p. 964) with the desired property.
void delete flowcontroller (FlowController fc)

<<eXtension>>
(p. 278)
Deletes
an
existing
Publisher create publisher (PublisherQos qos, PublisherListener

listener, int mask)
Creates
a
( p. 1262)
with
the desired QoS policies and attaches to it the specified
com.rti.dds.publication.PublisherListener ( p. 1289).
Publisher create publisher with profile (String library name, String

profile name, PublisherListener listener, int mask)
<<eXtension>>
(p. 278)
Creates
a
new
( p. 1262)
object
using
the
com.rti.dds.publication.PublisherQos ( p. 1290) associated with the
input XML QoS profile.
void delete publisher (Publisher p)

Deletes an existing com.rti.dds.publication.Publisher ( p. 1262).
Subscriber create subscriber (SubscriberQos qos, SubscriberListener listener, int mask)

Creates
a
( p. 1476)
with the desired QoS policies and attaches to it the specified
com.rti.dds.subscription.SubscriberListener ( p. 1503).
Subscriber create subscriber with profile (String library name,

String profile name, SubscriberListener listener, int mask)
<<eXtension>>
(p. 278)
Creates
( p. 1476)
a
object
using
new
the
657
com.rti.dds.publication.PublisherQos ( p. 1290) associated with the

void delete subscriber (Subscriber s)

Deletes an existing com.rti.dds.subscription.Subscriber ( p. 1476).
DataWriter create datawriter (Topic topic, DataWriterQos qos,

DataWriterListener listener, int mask)
<<eXtension>> (p. 278) Creates a com.rti.dds.publication.DataWriter
( p. 557) that will be attached and belong to the implicit
com.rti.dds.publication.Publisher ( p. 1262).
DataWriter create datawriter with profile (Topic topic, String library name, String profile name, DataWriterListener listener, int
mask)
( p. 557) using a XML QoS profile that will be attached and belong to the
implicit com.rti.dds.publication.Publisher ( p. 1262).
void delete datawriter (DataWriter a datawriter)

<<eXtension>> (p. 278) Deletes a com.rti.dds.publication.DataWriter
( p. 557) that belongs to the implicit com.rti.dds.publication.Publisher
( p. 1262).
DataReader
create datareader
(TopicDescription
topic,
DataReaderQos qos, DataReaderListener listener, int mask)
<<eXtension>> (p. 278) Creates a com.rti.dds.subscription.DataReader
( p. 487) that will be attached and belong to the implicit
DataReader create datareader with profile (TopicDescription

topic, String library name, String profile name, DataReaderListener
listener, int mask)
( p. 487) using a XML QoS profile that will be attached and belong to the
implicit com.rti.dds.subscription.Subscriber ( p. 1476).
void delete datareader (DataReader a datareader)

<<eXtension>> (p. 278) Deletes a com.rti.dds.subscription.DataReader
( p. 487) that belongs to the implicit com.rti.dds.subscription.Subscriber
( p. 1476).
Topic create topic (String topic name, String type name, TopicQos
qos, TopicListener listener, int mask)
658
Class Documentation
Creates a com.rti.dds.topic.Topic ( p. 1545) with the desired QoS policies
and attaches to it the specified com.rti.dds.topic.TopicListener ( p. 1564).
Topic create topic with profile (String topic name, String type name,
String library name, String profile name, TopicListener listener, int
mask)
<<eXtension>> (p. 278) Creates a new com.rti.dds.topic.Topic
( p. 1545) object using the com.rti.dds.publication.PublisherQos
( p. 1290) associated with the input XML QoS profile.
void delete topic (Topic topic)

Deletes a com.rti.dds.topic.Topic ( p. 1545).
ContentFilteredTopic create contentfilteredtopic (String name,

Topic related topic, String filter expression, StringSeq expression parameters)
Creates a com.rti.dds.topic.ContentFilteredTopic ( p. 471), that can be
used to do content-based subscriptions.
ContentFilteredTopic
create contentfilteredtopic with filter
(String name, Topic related topic, String filter expression, StringSeq
expression parameters, String filter name)
<<eXtension>> (p. 278) Creates a com.rti.dds.topic.ContentFilteredTopic
( p. 471) using the specified filter to do content-based subscriptions.
void
delete contentfilteredtopic
contentfilteredtopic)
(ContentFilteredTopic
a-
Deletes a com.rti.dds.topic.ContentFilteredTopic ( p. 471).
MultiTopic create multitopic (String name, String type name, String

subscription expression, StringSeq expression parameters)
[Not supported (optional)] Creates a MultiTopic that can be used to subscribe to multiple topics and combine/filter the received data into a resulting
type.
void delete multitopic (MultiTopic a multitopic)

[Not supported (optional)] Deletes a com.rti.dds.topic.MultiTopic
( p. 1190).
void set qos (DomainParticipantQos qos)

Change the QoS of this DomainParticipant ( p. 654).
<<eXtension>> (p. 278) Change the QoS of this domain ( p. 328) participant using the input XML QoS profile.
659
void get qos (DomainParticipantQos qos)

Get the participant QoS.
String get default library ()

<<eXtension>> (p. 278) Gets the default XML library associated with a
void set default library (String library name)

<<eXtension>> (p. 278) Sets the default XML
library
for
String get default profile ()

<<eXtension>> (p. 278) Gets the default XML profile associated with a
void set default profile (String library name, String profile name)
<<eXtension>> (p. 278) Sets the default XML
profile
for
String get default profile library ()

<<eXtension>> (p. 278) Gets the library where the default XML QoS profile is contained for a com.rti.dds.domain.DomainParticipant ( p. 654).
void set listener (DomainParticipantListener l, int mask)

Sets the participant listener.
DomainParticipantListener get listener ()

Get the participant listener.
void get publishers (PublisherSeq publishers)

<<eXtension>> (p. 278) Allows the application to access all the publishers
the participant has.
void get subscribers (SubscriberSeq subscribers)

<<eXtension>> (p. 278) Allows the application to access all the subscribers the participant has.
Subscriber get builtin subscriber ()

Accesses the built-in com.rti.dds.subscription.Subscriber ( p. 1476).
FlowController lookup flowcontroller (String name)

<<eXtension>> (p. 278) Looks up an existing locally-created
com.rti.dds.publication.FlowController ( p. 964), based on its name.
660
Class Documentation
Topic find topic (String topic name, Duration t timeout)

Finds an existing (or ready to exist) com.rti.dds.topic.Topic ( p. 1545),
based on its name.
TopicDescription lookup topicdescription (String topic name)

Looks up an existing, locally created com.rti.dds.topic.TopicDescription
( p. 1561), based on its name.
void ignore participant (InstanceHandle t handle)

Instructs
RTI
Connext
to
locally
ignore
remote
void ignore topic (InstanceHandle t handle)

Instructs RTI Connext to locally ignore a com.rti.dds.topic.Topic
( p. 1545).
void ignore publication (InstanceHandle t handle)

Instructs RTI Connext to locally ignore a publication ( p. 349).
void ignore subscription (InstanceHandle t handle)

Instructs RTI Connext to locally ignore a subscription ( p. 353).
int get domain id ()

Get the unique domain ( p. 328) identifier.

Manually
asserts
the
liveliness
of
this

Delete all the entities that were created by means of the create operations
on the com.rti.dds.domain.DomainParticipant ( p. 654).
void add peer (String peer desc string)

<<eXtension>> (p. 278) Attempt to contact one or more additional peer
participants.
void remove peer (String peer desc string)

<<eXtension>> (p. 278) Remove one or more peer participants from
the list of peers with which this com.rti.dds.domain.DomainParticipant
( p. 654) will try to communicate.
void get current time (Time t current time)

661
Returns the current value of the time.
void get discovered participants (InstanceHandleSeq participant handles)

Returns list
( p. 654) s.
of
discovered
void get discovered participant data (ParticipantBuiltinTopicData participant data, InstanceHandle t participant handle)
Returns builtin.ParticipantBuiltinTopicData ( p. 1211) for the specified
com.rti.dds.domain.DomainParticipant ( p. 654) .
void get discovered topics (InstanceHandleSeq topic handles)

Returns list of discovered com.rti.dds.topic.Topic ( p. 1545) objects.
void get discovered topic data (TopicBuiltinTopicData topic data,

InstanceHandle t topic handle)
Returns
builtin.TopicBuiltinTopicData
com.rti.dds.topic.Topic ( p. 1545).
for
the
specified
boolean contains entity (InstanceHandle t a handle)

Completes successfully with com.rti.dds.infrastructure.true if the referenced com.rti.dds.infrastructure.Entity ( p. 931) is contained by the
void register durable subscription (EndpointGroup t group, String

topic name)
Registers a Durable Subscription on the specified com.rti.dds.topic.Topic
( p. 1545) on all Persistence Services.
void delete durable subscription (EndpointGroup t group)

Deletes an existing Durable Subscription on all Persistence Services.
void register contentfilter (String filter name, ContentFilter contentfilter)

<<eXtension>> (p. 278) Register a content filter which can be used to
create a com.rti.dds.topic.ContentFilteredTopic ( p. 471).
ContentFilter lookup contentfilter (String filter name)

<<eXtension>> (p. 278) Lookup a content filter previously registered
with
( p. 728).
void unregister contentfilter (String filter name)

662
Class Documentation
<<eXtension>> (p. 278) Unregister a content filter previously registered
with
( p. 728).
Publisher get implicit publisher ()

<<eXtension>>
(p. 278)
Returns
the
implicit
com.rti.dds.publication.Publisher ( p. 1262). If an implicit Publisher
does not already exist, this creates one.
Subscriber get implicit subscriber ()

<<eXtension>>
(p. 278)
Returns
scriber does not already exist, this creates one.
the
implicit
If an implicit Sub-
abstract Publisher lookup publisher by name exp (String publisher name)

<<experimental>> (p. 278) <<eXtension>> (p. 278) Looks up a
com.rti.dds.publication.Publisher ( p. 1262) by its entity name within this
abstract Subscriber lookup subscriber by name exp (String subscriber name)

<<experimental>> (p. 278) <<eXtension>> (p. 278) Retrieves a
com.rti.dds.subscription.Subscriber ( p. 1476) by its entity name within
this com.rti.dds.domain.DomainParticipant ( p. 654).
abstract DataWriter
datawriter full name)
lookup datawriter by name exp
(String

com.rti.dds.publication.DataWriter ( p. 557) by its entity name within
this com.rti.dds.domain.DomainParticipant ( p. 654).
abstract DataReader
datareder full name)
lookup datareader by name exp
(String
<<experimental>> (p. 278) <<eXtension>> (p. 278) Retrieves up a

com.rti.dds.subscription.DataReader ( p. 487) by its entity name in this

static final TopicQos TOPIC QOS DEFAULT = new TopicQos()
Special value for creating a com.rti.dds.topic.Topic ( p. 1545) with default
QoS.
663
static final PublisherQos PUBLISHER QOS DEFAULT = new

PublisherQos()
Special value for creating a com.rti.dds.publication.Publisher ( p. 1262)
with default QoS.
static final SubscriberQos SUBSCRIBER QOS DEFAULT

Special value for creating a com.rti.dds.subscription.Subscriber ( p. 1476)
with default QoS.
static final FlowControllerProperty t FLOW CONTROLLER PROPERTY DEFAULT

<<eXtension>>
(p. 278)
Special
value
for
creating
a
com.rti.dds.publication.FlowController ( p. 964) with default property.
static final String SQLFILTER NAME

<<eXtension>> (p. 278) The name of the built-in SQL filter that can be
static final String STRINGMATCHFILTER NAME

<<eXtension>> (p. 278) The name of the built-in StringMatch filter that
8.64.1
<<interface>>
( p. 279)
Container
for
com.rti.dds.infrastructure.DomainEntity (p. 653) objects.
all
The DomainParticipant (p. 654) object plays several roles:

- It acts as a container for all other com.rti.dds.infrastructure.Entity
(p. 931) objects.
- It acts as factory for the com.rti.dds.publication.Publisher
(p. 1262),
(p. 1476),
com.rti.dds.topic.Topic (p. 1545) and com.rti.dds.topic.MultiTopic
(p. 1190) com.rti.dds.infrastructure.Entity (p. 931) objects.
- It represents the participation of the application on a communication plane
that isolates applications running on the same set of physical computers from
each other. A domain (p. 328) establishes a virtual network linking all applications that share the same domainId and isolating them from applications
running on different domains. In this way, several independent distributed applications can coexist in the same physical network without interfering, or even
being aware of each other.
664
Class Documentation
- It provides administration services in the domain (p. 328), offering

operations that allow the application to ignore locally any information
about a given participant (ignore participant() (p. 714)), publication
(p. 349) (ignore publication() (p. 716)), subscription (p. 353) (ignore subscription() (p. 717)) or topic (p. 359) (ignore topic() (p. 715)).
The
following
operations
may
be
called
even
if
the
is
not
encom.rti.dds.domain.DomainParticipant
(p. 654)
abled.
(Operations NOT in this list will fail with the value
(p. 1361)
if called on a disabled DomainParticipant (p. 654)).
Operations defined at the base-class level: set qos() (p. 705), set qos with profile() (p. 706), get qos() (p. 706), set listener() (p. 709),
get listener() (p. 710), enable() (p. 935);
Factory operations:
create flowcontroller() (p. 681), create topic() (p. 697), create topic with profile() (p. 699), create publisher() (p. 683), create publisher with profile() (p. 684), create subscriber() (p. 686), create subscriber with profile() (p. 687),
delete flowcontroller() (p. 682), delete topic() (p. 700), delete publisher() (p. 685), delete subscriber() (p. 688), set default flowcontroller property() (p. 666), get default flowcontroller property() (p. 665), set default topic qos() (p. 667), set default topic qos with profile() (p. 668), get default topic qos() (p. 667),
set default publisher qos()
(p. 671),
set default publisher qos with profile() (p. 672), get default publisher qos() (p. 670),
set default subscriber qos() (p. 676),
set default subscriber qos with profile() (p. 677), get default subscriber qos() (p. 678),
delete contained entities() (p. 719), set default datareader qos()
(p. 679), set default datareader qos with profile() (p. 680), get default datareader qos() (p. 675), set default datawriter qos()
(p. 673), set default datawriter qos with profile() (p. 674), get default datawriter qos() (p. 673), set default library() (p. 707),
set default profile() (p. 708);
Operations for looking up topics: lookup topicdescription() (p. 713);
Operations that access status: get statuscondition() (p. 936), get status changes() (p. 936).
QoS:
com.rti.dds.domain.DomainParticipantQos (p. 773)
Status:
665
Listener:
com.rti.dds.domain.DomainParticipantListener (p. 771)
See also:
8.64.2
8.64.2.1
void get default flowcontroller property

(FlowControllerProperty t prop)
Copies
the
default
<<eXtension>>
( p. 278)
(p. 968)
values for this domain (p. 328) participant into the given
com.rti.dds.publication.FlowControllerProperty t (p. 968) instance.
The retrieved property will match the set of values specified on the last
successful call to com.rti.dds.domain.DomainParticipant.set default flowcontroller property (p. 666), or else, if the call was never made, the default values listed in com.rti.dds.publication.FlowControllerProperty t
(p. 968).
MT Safety:
UNSAFE. It is not safe to retrieve the default flow controller properties
from a DomainParticipant (p. 654) while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set default flowcontroller property (p. 666)
Parameters:
prop <<in>> ( p. 279) Default property to be retrieved.
NULL.
Cannot be
Exceptions:
See also:
com.rti.dds.domain.DomainParticipant.FLOW CONTROLLER PROPERTY DEFAULT (p. 154)
(p. 681)
666
Class Documentation
8.64.2.2
void set default flowcontroller property

(FlowControllerProperty t prop)
<<eXtension>>
( p. 278)
Set
the
(p. 968)
for this domain (p. 328) participant.
default
values
This
default
value
will
be
used
for
newly
created
(p. 964)
if
com.rti.dds.domain.DomainParticipant.FLOW CONTROLLER PROPERTY DEFAULT (p. 154) is specified as the property parameter
when
(p. 681) is called.
Precondition:
The specified property values must be consistent, or else the operation will
have no effect and fail with com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY (p. 1359)
MT Safety:
UNSAFE. It is not safe to set the default flow controller properties for
a DomainParticipant (p. 654) while another thread may be simultaneously
calling
com.rti.dds.domain.DomainParticipant.set default flowcontroller property
(p. 666)
,
com.rti.dds.domain.DomainParticipant.get default flowcontroller property
(p. 665)
or
calling
(p. 681)
with
com.rti.dds.domain.DomainParticipant.FLOW CONTROLLER PROPERTY DEFAULT (p. 154) as the qos
parameter.
Parameters:
prop <<in>> ( p. 279) Default property to be set.
The special
value
com.rti.dds.domain.DomainParticipant.FLOW CONTROLLER PROPERTY DEFAULT
(p. 154)
may
be passed as property to indicate that the default property
should be reset to the default values the factory would use
if
com.rti.dds.domain.DomainParticipant.set default flowcontroller property (p. 666) had never been called. Cannot be
NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY (p. 1359)
667
See also:
(p. 681)
8.64.2.3
void get default topic qos (TopicQos qos)
Copies the default com.rti.dds.topic.TopicQos (p. 1566) values for this

domain (p. 328) participant into the given com.rti.dds.topic.TopicQos
(p. 1566) instance.
The retrieved qos will match the set of values specified on the last successful call to com.rti.dds.domain.DomainParticipant.set default topic qos
(p. 667), or else, if the call was never made, the default values listed in
com.rti.dds.topic.TopicQos (p. 1566).
MT Safety:
UNSAFE. It is not safe to retrieve the default Topic QoS from a
DomainParticipant (p. 654) while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set default topic qos (p. 667)
Parameters:
qos <<in>> ( p. 279) Default qos to be retrieved. Cannot be NULL.
Exceptions:
See also:
com.rti.dds.domain.DomainParticipant.TOPIC QOS DEFAULT
(p. 152)
8.64.2.4
void set default topic qos (TopicQos qos)
Set the default com.rti.dds.topic.TopicQos (p. 1566) values for this domain
(p. 328) participant.
668
Class Documentation
This default value will be used for newly created com.rti.dds.topic.Topic

if
com.rti.dds.domain.DomainParticipant.TOPIC (p. 1545)
QOS DEFAULT (p. 152) is specified as the qos parameter when
com.rti.dds.domain.DomainParticipant.create topic (p. 697) is called.
Precondition:
The specified QoS policies must be consistent, or else the operation will
MT Safety:
UNSAFE. It is not safe to set the default topic (p. 359) QoS for a DomainParticipant (p. 654) while another thread may be simultaneously
calling com.rti.dds.domain.DomainParticipant.set default topic qos (p. 667), com.rti.dds.domain.DomainParticipant.get default topic qos (p. 667) or calling com.rti.dds.domain.DomainParticipant.create topic (p. 697) with com.rti.dds.domain.DomainParticipant.TOPIC QOS DEFAULT (p. 152) as the qos parameter.
Parameters:
qos <<in>> ( p. 279) Default qos to be set.
The special value
com.rti.dds.domain.DomainParticipant.TOPIC QOS DEFAULT (p. 152) may be passed as qos to indicate that the
default QoS should be reset back to the initial values the factory
would used if com.rti.dds.domain.DomainParticipant.set Cannot be
default topic qos (p. 667) had never been called.
NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
See also:
(p. 152)
8.64.2.5
void set default topic qos with profile (String

library name, String profile name)
<<eXtension>> ( p. 278) Set the default com.rti.dds.topic.TopicQos

669
(p. 1566) values for this domain (p. 328) participant based on the input XML
QoS profile.
This default value will be used for newly created com.rti.dds.topic.Topic
if
com.rti.dds.domain.DomainParticipant.TOPIC (p. 1545)
QOS DEFAULT (p. 152) is specified as the qos parameter when
com.rti.dds.domain.DomainParticipant.create topic (p. 697) is called.
Precondition:
The com.rti.dds.topic.TopicQos (p. 1566) contained in the specified XML QoS profile must be consistent, or else the operation will
MT Safety:
UNSAFE. It is not safe to set the default topic (p. 359) QoS for a DomainParticipant (p. 654) while another thread may be simultaneously
calling com.rti.dds.domain.DomainParticipant.set default topic qos (p. 667), com.rti.dds.domain.DomainParticipant.get default topic qos (p. 667) or calling com.rti.dds.domain.DomainParticipant.create topic (p. 697) with com.rti.dds.domain.DomainParticipant.TOPIC QOS DEFAULT (p. 152) as the qos parameter.
Parameters:
profile. If library name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipant.set default library (p. 707)).
If profile name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipant.set default profile (p. 708)).
If the input profile cannot be found the method
com.rti.dds.infrastructure.RETCODE ERROR (p. 1356).
fails
with
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
See also:
(p. 152)
670
Class Documentation
com.rti.dds.domain.DomainParticipant.create topic with profile
(p. 699)
8.64.2.6
void get default publisher qos (PublisherQos qos)
Copy the default com.rti.dds.publication.PublisherQos (p. 1290) values

into the provided com.rti.dds.publication.PublisherQos (p. 1290) instance.
The retrieved qos will match the set of values specified on the last successful
call to com.rti.dds.domain.DomainParticipant.set default publisher qos (p. 671), or com.rti.dds.domain.DomainParticipant.set default publisher qos with profile (p. 672), or else, if the call was never made, the
default values listed in com.rti.dds.publication.PublisherQos (p. 1290).
If
com.rti.dds.domain.DomainParticipant.PUBLISHER QOS DEFAULT (p. 153) is specified as the qos parameter when
com.rti.dds.domain.DomainParticipant.create topic (p. 697) is called,
the default value of the QoS set in the factory, equivalent to the value
obtained
by
calling
com.rti.dds.domain.DomainParticipant.get (p. 670),
will
be
used
to
create
the
default publisher qos
MT Safety:
UNSAFE. It is not safe to retrieve the default publisher QoS from
a DomainParticipant (p. 654) while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set default publisher qos (p. 671)
Parameters:
qos <<inout>> ( p. 279) Qos to be filled up. Cannot be NULL.
Exceptions:
See also:
com.rti.dds.domain.DomainParticipant.PUBLISHER QOS DEFAULT (p. 153)

8.64.2.7
671
void set default publisher qos (PublisherQos qos)
Set the default com.rti.dds.publication.PublisherQos (p. 1290) values for

this DomainParticipant (p. 654).
This
set
of
default
values
will
be
used
for
a
newly
if
created
(p. 1262)
com.rti.dds.domain.DomainParticipant.create publisher (p. 683) is
called.
Precondition:
MT Safety:
UNSAFE. It is not safe to set the default publisher QoS for a DomainParticipant (p. 654) while another thread may be simultaneously calling
(p. 671),
com.rti.dds.domain.DomainParticipant.get default publisher qos
(p. 670)
or
calling
with com.rti.dds.domain.DomainParticipant.PUBLISHER QOS DEFAULT (p. 153) as the qos parameter.
Parameters:
The special value
com.rti.dds.domain.DomainParticipant.PUBLISHER QOS DEFAULT (p. 153) may be passed as qos to indicate that the
would used if com.rti.dds.domain.DomainParticipant.set default publisher qos (p. 671) had never been called. Cannot be
NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
See also:
672
Class Documentation
8.64.2.8
void set default publisher qos with profile (String

<<eXtension>>
( p. 278)
Set
the
default
com.rti.dds.publication.PublisherQos (p. 1290) values for this DomainParticipant (p. 654) based on the input XML QoS profile.
This
set
of
default
values
will
be
used
for
a
newly
created
(p. 1262)
if
com.rti.dds.domain.DomainParticipant.create publisher (p. 683) is
called.
Precondition:
The com.rti.dds.publication.PublisherQos (p. 1290) contained in the
specified XML QoS profile must be consistent, or else the operation will
MT Safety:
UNSAFE. It is not safe to set the default publisher QoS for a DomainParticipant (p. 654) while another thread may be simultaneously calling
(p. 671),
(p. 670)
or
calling
with com.rti.dds.domain.DomainParticipant.PUBLISHER QOS DEFAULT (p. 153) as the qos parameter.
Parameters:
If the input profile cannot be found, the method
fails
with
673
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
See also:
com.rti.dds.domain.DomainParticipant.create publisher with profile (p. 684)
8.64.2.9
Copy
the
default
<<eXtension>>
( p. 278)
com.rti.dds.publication.DataWriterQos (p. 610) values into the provided com.rti.dds.publication.DataWriterQos (p. 610) instance.
call to com.rti.dds.domain.DomainParticipant.set default datawriter qos (p. 673), or com.rti.dds.domain.DomainParticipant.set default datawriter qos with profile (p. 674), or else, if the call was never made, the
default values listed in com.rti.dds.publication.DataWriterQos (p. 610).
MT Safety:
UNSAFE. It is not safe to retrieve the default DataWriter QoS
from a DomainPartipant while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set default datawriter qos (p. 673).
Parameters:
Exceptions:
8.64.2.10
<<eXtension>> ( p. 278) Set the default DataWriterQos values for this DomainParticipant (p. 654).
674
Class Documentation
This set of default values will be inherited for a newly created

Precondition:
MT Safety:
UNSAFE. It is not safe to set the default DataWriter QoS for a DomainParticipant (p. 654) while another thread may be simultaneously calling
com.rti.dds.domain.DomainParticipant.set default datawriter qos
(p. 673)
or
com.rti.dds.domain.DomainParticipant.get default datawriter qos (p. 673).
Parameters:
The special value
com.rti.dds.publication.Publisher.DATAWRITER QOS DEFAULT (p. 182) may be passed as qos to indicate that the
would used if com.rti.dds.domain.DomainParticipant.set default datawriter qos (p. 673) had never been called. Cannot be
NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.64.2.11
void set default datawriter qos with profile (String

<<eXtension>>
( p. 278)
Set
the
default
com.rti.dds.publication.DataWriterQos (p. 610) values for this domain
(p. 328) participant based on the input XML QoS profile.
Precondition:
The com.rti.dds.publication.DataWriterQos (p. 610) contained in the
675
MT Safety:
UNSAFE. It is not safe to set the default DataWriter QoS for a DomainParticipant (p. 654) while another thread may be simultaneously calling
com.rti.dds.domain.DomainParticipant.set default datawriter or
com.rti.dds.domain.DomainParticipant.get qos
(p. 673)
default datawriter qos (p. 673)
Parameters:
fails
with
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.64.2.12
<<eXtension>>
( p. 278)
Copy
the
default
com.rti.dds.subscription.DataReaderQos (p. 536) values into the provided
com.rti.dds.subscription.DataReaderQos (p. 536) instance.
The retrieved qos will match the set of values specified on the last successful call
to
com.rti.dds.domain.DomainParticipant.set default datareader qos (p. 679), or com.rti.dds.domain.DomainParticipant.set default datareader qos with profile (p. 680), or else, if the call was never made, the
default values listed in com.rti.dds.subscription.DataReaderQos (p. 536).
676
Class Documentation
MT Safety:
UNSAFE. It is not safe to retrieve the default DataReader QoS from
a DomainParticipant (p. 654) while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set default datareader qos (p. 679).
Parameters:
Exceptions:
8.64.2.13
void set default subscriber qos (SubscriberQos qos)
Set the default com.rti.dds.subscription.SubscriberQos (p. 1505) values for

this Domain{articipant.
This set of default values will be used for a newly created
(p. 1476)
if
com.rti.dds.domain.DomainParticipant.SUBSCRIBER QOS DEFAULT (p. 153) is specified as the qos parameter when
com.rti.dds.domain.DomainParticipant.create subscriber
(p. 686)
is called.
Precondition:
MT Safety:
UNSAFE. It is not safe to set the default Subscriber QoS for a DomainParticipant (p. 654) while another thread may be simultaneously calling
com.rti.dds.domain.DomainParticipant.set default subscriber qos
(p. 676),
com.rti.dds.domain.DomainParticipant.get default subscriber qos
(p. 678)
or
calling
with
com.rti.dds.domain.DomainParticipant.SUBSCRIBER QOS DEFAULT (p. 153) as the qos parameter.
Parameters:
The special value
com.rti.dds.domain.DomainParticipant.SUBSCRIBER QOS DEFAULT (p. 153) may be passed as qos to indicate that
677
the default QoS should be reset back to the initial values the factory
would used if com.rti.dds.domain.DomainParticipant.set default subscriber qos (p. 676) had never been called. Cannot be
NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.64.2.14
void set default subscriber qos with profile (String

Set
the
default
<<eXtension>>
( p. 278)
com.rti.dds.subscription.SubscriberQos (p. 1505) values for this DomainParticipant (p. 654) based on the input XML QoS profile.
This set of default values will be used for a newly created
(p. 1476)
if
(p. 686)
is called.
Precondition:
The com.rti.dds.subscription.SubscriberQos (p. 1505) contained in
the specified XML QoS profile must be consistent, or else the operation will
MT Safety:
UNSAFE. It is not safe to set the default Subscriber QoS for a DomainParticipant (p. 654) while another thread may be simultaneously calling
com.rti.dds.domain.DomainParticipant.set default subscriber com.rti.dds.domain.DomainParticipant.get qos
(p. 676),
default subscriber qos
(p. 678)
or
calling
with
com.rti.dds.domain.DomainParticipant.SUBSCRIBER QOS DEFAULT (p. 153) as the qos parameter.
Parameters:
profile. If library name is null RTI Connext will use the deGenerated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
678
Class Documentation
fault library (see com.rti.dds.domain.DomainParticipant.set default library (p. 707)).

fails
with
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
See also:
com.rti.dds.domain.DomainParticipant.SUBSCRIBER QOS DEFAULT (p. 153)
com.rti.dds.domain.DomainParticipant.create subscriber with profile (p. 687)
8.64.2.15
void get default subscriber qos (SubscriberQos qos)
Copy the default com.rti.dds.subscription.SubscriberQos (p. 1505) values into the provided com.rti.dds.subscription.SubscriberQos (p. 1505) instance.
call to com.rti.dds.domain.DomainParticipant.set default subscriber qos (p. 676), or com.rti.dds.domain.DomainParticipant.set default subscriber qos with profile (p. 677), or else, if the call was never made, the
default values listed in com.rti.dds.subscription.SubscriberQos (p. 1505).
If
(p. 686)
is called, the default value of the QoS set in the factory, equivalent to the
value obtained by calling com.rti.dds.domain.DomainParticipant.get default subscriber qos (p. 678),
will be used to create the
679
MT Safety:
UNSAFE. It is not safe to retrieve the default Subscriber QoS from
a DomainParticipant (p. 654) while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set default subscriber qos (p. 676).
Parameters:
Exceptions:
See also:
8.64.2.16
Set
the
default
<<eXtension>>
( p. 278)
com.rti.dds.subscription.DataReaderQos (p. 536) values for this domain (p. 328) participant.
Precondition:
MT Safety:
UNSAFE. It is not safe to set the default DataReader QoS for a DomainParticipant (p. 654) while another thread may be simultaneously calling
com.rti.dds.domain.DomainParticipant.set default datareader qos
(p. 679)
or
com.rti.dds.domain.DomainParticipant.get default datareader qos (p. 675).
Parameters:
The special value
com.rti.dds.subscription.Subscriber.DATAREADER QOS DEFAULT (p. 196) may be passed as qos to indicate that the
680
Class Documentation
would used if com.rti.dds.domain.DomainParticipant.set default datareader qos (p. 679) had never been called. Cannot be
NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.64.2.17
void set default datareader qos with profile (String

<<eXtension>>
( p. 278)
Set
the
default
com.rti.dds.subscription.DataReaderQos (p. 536) values for this DomainParticipant (p. 654) based on the input XML QoS profile.
Precondition:
The com.rti.dds.subscription.DataReaderQos (p. 536) contained in
MT Safety:
UNSAFE. It is not safe to set the default DataReader QoS for a DomainParticipant (p. 654) while another thread may be simultaneously calling
com.rti.dds.domain.DomainParticipant.set default datareader qos
(p. 679)
or
com.rti.dds.domain.DomainParticipant.get default datareader qos (p. 675).
Parameters:

681
fails
with
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.64.2.18
FlowController create flowcontroller (String name,

FlowControllerProperty t prop)
<<eXtension>> ( p. 278) Creates a com.rti.dds.publication.FlowController

(p. 964) with the desired property.
The created com.rti.dds.publication.FlowController (p. 964) is associated with a com.rti.dds.publication.DataWriter (p. 557) via
com.rti.dds.infrastructure.PublishModeQosPolicy.flow controller name (p. 1297).
A single com.rti.dds.publication.FlowController
(p. 964) may service multiple com.rti.dds.publication.DataWriter
instances,
even
if
they
belong
to
a
different
(p. 557)
The property determines how the com.rti.dds.publication.FlowController (p. 964) shapes the
network traffic.
Precondition:
The specified property must be consistent, or the operation will fail and
no com.rti.dds.publication.FlowController (p. 964) will be created.
MT Safety:
UNSAFE.
If
(p. 154)
is
used for property, it is not safe to create the flow controller while another thread may be simultaneously calling
com.rti.dds.domain.DomainParticipant.set default flowcontroller property (p. 666) or trying to lookup that flow
controller with com.rti.dds.domain.DomainParticipant.lookup flowcontroller (p. 712).
Parameters:
name <<in>>
( p. 279)
name
of
the
com.rti.dds.publication.FlowController (p. 964) to create.
A com.rti.dds.publication.DataWriter (p. 557) is associated with
682
Class Documentation
a com.rti.dds.publication.FlowController (p. 964) by name.
Limited to 255 characters.
prop <<in>> ( p. 279) property to be used for creating the new
com.rti.dds.publication.FlowController (p. 964).
The special value com.rti.dds.domain.DomainParticipant.FLOW CONTROLLER PROPERTY DEFAULT (p. 154) can be used
to indicate that the com.rti.dds.publication.FlowController
should
be
created
with
the
default
(p. 964)
(p. 968)
set in the com.rti.dds.domain.DomainParticipant (p. 654).
Cannot be NULL.
Returns:
Newly created flow controller object or NULL on failure.
See also:
com.rti.dds.publication.FlowControllerProperty t (p. 968) for rules
on consistency among property
com.rti.dds.domain.DomainParticipant.get default flowcontroller property (p. 665)
8.64.2.19
void delete flowcontroller (FlowController fc)
Deletes
<<eXtension>>
( p. 278)
an
existing
Precondition:
The com.rti.dds.publication.FlowController (p. 964) must not have
any attached com.rti.dds.publication.DataWriter (p. 557) objects. If
there are any attached com.rti.dds.publication.DataWriter (p. 557)
objects, it will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
The com.rti.dds.publication.FlowController (p. 964) must have been
created by this com.rti.dds.domain.DomainParticipant (p. 654),
or else it will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
Postcondition:
The com.rti.dds.publication.FlowController (p. 964) is deleted if this
method completes successfully.
683
Parameters:
fc <<in>> ( p. 279) The com.rti.dds.publication.FlowController
(p. 964) to be deleted.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.64.2.20
Publisher create publisher (PublisherQos qos,

PublisherListener listener, int mask)
Creates
a
(p. 1262)
with
com.rti.dds.publication.PublisherListener (p. 1289).
Precondition:
The specified QoS policies must be consistent, or the operation will fail and
no com.rti.dds.publication.Publisher (p. 1262) will be created.
MT Safety:
UNSAFE. If com.rti.dds.domain.DomainParticipant.PUBLISHER QOS DEFAULT (p. 153) is used for qos, it is not safe to create
the publisher while another thread may be simultaneously calling
(p. 671).
Parameters:
qos <<in>> ( p. 279) QoS to be used for creating the new
com.rti.dds.publication.Publisher (p. 1262). The special value
com.rti.dds.domain.DomainParticipant.PUBLISHER QOS DEFAULT (p. 153) can be used to indicate that the
com.rti.dds.publication.Publisher (p. 1262) should be created
with the default com.rti.dds.publication.PublisherQos (p. 1290)
Cannot be NULL.
listener <<in>> ( p. 279). Listener to be attached to the newly created
mask <<in>> ( p. 279). Changes of communication status to be invoked
on the listener. See com.rti.dds.infrastructure.StatusMask.
684
Class Documentation
Returns:
newly created publisher object or NULL on failure.
See also:
Specifying QoS on entities (p. 100) for information on setting QoS before
entity creation
com.rti.dds.publication.PublisherQos (p. 1290) for rules on consistency among QoS
com.rti.dds.domain.DomainParticipant.create publisher with profile (p. 684)
(p. 670)
com.rti.dds.publication.Publisher.set listener (p. 1279)
8.64.2.21
Publisher create publisher with profile (String

library name, String profile name, PublisherListener
listener, int mask)
<<eXtension>> ( p. 278) Creates a new com.rti.dds.publication.Publisher

(p. 1262) object using the com.rti.dds.publication.PublisherQos (p. 1290)
associated with the input XML QoS profile.
Precondition:
The com.rti.dds.publication.PublisherQos (p. 1290) in the input
profile must be consistent, or the operation will fail and no
com.rti.dds.publication.Publisher (p. 1262) will be created.
Parameters:
685
Returns:
newly created publisher object or NULL on failure.
See also:
entity creation
(p. 670)
com.rti.dds.publication.Publisher.set listener (p. 1279)
8.64.2.22
void delete publisher (Publisher p)
Deletes an existing com.rti.dds.publication.Publisher (p. 1262).

Precondition:
The com.rti.dds.publication.Publisher (p. 1262) must not have any
attached com.rti.dds.publication.DataWriter (p. 557) objects.
If
there are existing com.rti.dds.publication.DataWriter (p. 557) objects, it will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
com.rti.dds.publication.Publisher (p. 1262) must have been created by
this com.rti.dds.domain.DomainParticipant (p. 654), or else it will fail
with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
Postcondition:
Listener installed on the com.rti.dds.publication.Publisher (p. 1262)
will not be called after this method completes successfully.
Parameters:
p <<in>> ( p. 279) com.rti.dds.publication.Publisher (p. 1262) to be
deleted.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
686
Class Documentation
8.64.2.23
Subscriber create subscriber (SubscriberQos qos,

SubscriberListener listener, int mask)
Creates
a
(p. 1476)
with
com.rti.dds.subscription.SubscriberListener (p. 1503).
Precondition:
no com.rti.dds.subscription.Subscriber (p. 1476) will be created.
MT Safety:
UNSAFE. If com.rti.dds.domain.DomainParticipant.SUBSCRIBER QOS DEFAULT (p. 153) is used for qos, it is not safe to create
the subscriber while another thread may be simultaneously calling
com.rti.dds.domain.DomainParticipant.set default subscriber qos (p. 676).
Parameters:
com.rti.dds.subscription.Subscriber (p. 1476). The special value
com.rti.dds.domain.DomainParticipant.SUBSCRIBER QOS DEFAULT (p. 153) can be used to indicate that the
com.rti.dds.subscription.Subscriber (p. 1476) should be created with the default com.rti.dds.subscription.SubscriberQos
(p. 1505) set in the com.rti.dds.domain.DomainParticipant
(p. 654). Cannot be NULL.
Returns:
newly created subscriber object or NULL on failure.
See also:
entity creation
com.rti.dds.subscription.SubscriberQos (p. 1505) for rules on consistency among QoS
687
com.rti.dds.domain.DomainParticipant.create subscriber with profile (p. 687)

com.rti.dds.subscription.Subscriber.set listener (p. 1496)
8.64.2.24
Subscriber create subscriber with profile (String

library name, String profile name, SubscriberListener
listener, int mask)
<<eXtension>> ( p. 278) Creates a new com.rti.dds.subscription.Subscriber

(p. 1476) object using the com.rti.dds.publication.PublisherQos (p. 1290)
Precondition:
The com.rti.dds.subscription.SubscriberQos (p. 1505) in the input profile must be consistent, or the operation will fail and no
com.rti.dds.subscription.Subscriber (p. 1476) will be created.
Parameters:
Returns:
newly created subscriber object or NULL on failure.
See also:
entity creation
688
Class Documentation
com.rti.dds.subscription.Subscriber.set listener (p. 1496)
8.64.2.25
void delete subscriber (Subscriber s)
Deletes an existing com.rti.dds.subscription.Subscriber (p. 1476).

Precondition:
The com.rti.dds.subscription.Subscriber (p. 1476) must not have
any attached com.rti.dds.subscription.DataReader (p. 487) objects.
If there are existing com.rti.dds.subscription.DataReader (p. 487)
objects, it will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363)
The com.rti.dds.subscription.Subscriber (p. 1476) must have been
created by this com.rti.dds.domain.DomainParticipant (p. 654),
or else it will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
Postcondition:
A Listener installed on the com.rti.dds.subscription.Subscriber
(p. 1476) will not be called after this method completes successfully.
Parameters:
s <<in>> ( p. 279) com.rti.dds.subscription.Subscriber (p. 1476) to
be deleted.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.64.2.26
DataWriter create datawriter (Topic topic,

DataWriterQos qos, DataWriterListener listener, int
mask)
<<eXtension>> ( p. 278) Creates a com.rti.dds.publication.DataWriter

(p. 557) that will be attached and belong to the implicit
689
Precondition:
The given com.rti.dds.topic.Topic (p. 1545) must have been created from
the same DomainParticipant (p. 654) as the implicit Publisher. If it was
created from a different DomainParticipant (p. 654), this method will
fail.
created
usThe
(p. 557)
ing this method will be associated with the implicit Publisher.
This Publisher is automatically created (if it does not exist) using
com.rti.dds.domain.DomainParticipant.PUBLISHER QOS DEFAULT (p. 153) when the following methods are called:
(p. 688),
com.rti.dds.domain.DomainParticipant.create datawriter
com.rti.dds.domain.DomainParticipant.create datawriter with profile (p. 690),
or com.rti.dds.domain.DomainParticipant.get implicit publisher (p. 730).
MT Safety:
UNSAFE. If com.rti.dds.publication.Publisher.DATAWRITER QOS DEFAULT (p. 182) is used for the qos parameter, it is not
safe to create the DataWriter while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set default datawriter qos (p. 673).
Parameters:
topic ( p. 359) <<in>> ( p. 279)
The com.rti.dds.topic.Topic
(p. 1545) that the com.rti.dds.publication.DataWriter (p. 557)
will be associated with. Cannot be NULL.
The special
value
com.rti.dds.publication.Publisher.DATAWRITER QOS DEFAULT
(p. 182)
can
be
used
to
indicate
that
the
(p. 557)
should
be
created
with
the
default
com.rti.dds.publication.DataWriterQos (p. 610) set in the
implicit com.rti.dds.publication.Publisher (p. 1262). The special
value
com.rti.dds.publication.Publisher.DATAWRITER QOS USE TOPIC QOS (p. 183) can be used to indicate
that
the
(p. 557) should be created with the combination of the default
(p. 610)
set
on
the
(p. 1262)
and
the
com.rti.dds.topic.TopicQos
(p. 1566)
of
the
com.rti.dds.topic.Topic (p. 1545). Cannot be NULL.
690
Class Documentation
listener <<in>>
( p. 279)
The
listener
of
the

Returns:
A com.rti.dds.publication.DataWriter (p. 557) of a derived class specific to the data type associated with the com.rti.dds.topic.Topic
(p. 1545) or NULL if an error occurred.
See also:
entity creation
com.rti.dds.publication.Publisher.DATAWRITER QOS DEFAULT (p. 182)
com.rti.dds.publication.Publisher.DATAWRITER QOS USE TOPIC QOS (p. 183)
com.rti.dds.domain.DomainParticipant.create datawriter with profile (p. 690)
com.rti.dds.domain.DomainParticipant.get default datawriter qos (p. 673)
com.rti.dds.domain.DomainParticipant.get implicit publisher
(p. 730)
com.rti.dds.publication.DataWriter.set listener (p. 564)
8.64.2.27
DataWriter create datawriter with profile (Topic

topic, String library name, String profile name,

(p. 557) using a XML QoS profile that will be attached and belong to the implicit
Precondition:
the same DomainParticipant (p. 654) as the implicit Publisher. If it was
created from a different DomainParticipant (p. 654), this method will
return NULL.
691
The
(p. 557)
created
using this method will be associated with the implicit Publisher.
This Publisher is automatically created (if it does not exist) using
com.rti.dds.domain.DomainParticipant.PUBLISHER QOS DEFAULT (p. 153) when the following methods are called:
(p. 688),
com.rti.dds.domain.DomainParticipant.create datawriter
com.rti.dds.domain.DomainParticipant.create datawriter with or com.rti.dds.domain.DomainParticipant.get profile (p. 690),
implicit publisher (p. 730)
Parameters:
topic ( p. 359) <<in>> ( p. 279)
listener <<in>>
( p. 279)
The
listener
of
the

Returns:
See also:
entity creation
com.rti.dds.domain.DomainParticipant.create datawriter (p. 688)
com.rti.dds.domain.DomainParticipant.get default datawriter qos (p. 673)
(p. 730)
692
Class Documentation
8.64.2.28
<<eXtension>> ( p. 278) Deletes a com.rti.dds.publication.DataWriter

(p. 557) that belongs to the implicit com.rti.dds.publication.Publisher
(p. 1262).
The deletion of the com.rti.dds.publication.DataWriter (p. 557) will automatically unregister all instances.
Depending on the settings of the
WRITER DATA LIFECYCLE (p. 140) QosPolicy, the deletion of the
com.rti.dds.publication.DataWriter (p. 557) may also dispose all instances.
8.64.3
Special Instructions if Using Timestamp APIs

and BY SOURCE TIMESTAMP Destination Ordering:
If the DataWriters com.rti.dds.infrastructure.DestinationOrderQosPolicy.kind

(p. 633) is com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPolicyKind.B
SOURCE TIMESTAMP DESTINATIONORDER QOS, calls to delete datawriter() (p. 692) may fail if your application has previously used the with
timestamp APIs (write w timestamp(), register instance w timestamp(), unregister instance w timestamp(), or dispose w timestamp()) with a timestamp
larger (later) than the time at which delete datawriter() (p. 692) is called.
To prevent delete datawriter() (p. 692) from failing in this situation, either:
Change the WRITER DATA LIFECYCLE (p. 140) QosPolicy
so that RTI Connext will not autodispose unregistered instances (set
com.rti.dds.infrastructure.WriterDataLifecycleQosPolicy.autodispose unregistered instances (p. 1739) to com.rti.dds.infrastructure.false.)
or
Explicitly call unregister instance w timestamp() for all instances modified with the w timestamp() APIs before calling delete datawriter()
(p. 692).
Precondition:
If the com.rti.dds.publication.DataWriter (p. 557) does not belong to the implicit com.rti.dds.publication.Publisher (p. 1262),
the operation will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
693
Postcondition:
Listener installed on the com.rti.dds.publication.DataWriter (p. 557)
Parameters:
a datawriter <<in>> ( p. 279) The com.rti.dds.publication.DataWriter
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
(p. 730)
8.64.3.1
DataReader create datareader (TopicDescription topic,

DataReaderQos qos, DataReaderListener listener, int
mask)
<<eXtension>> ( p. 278) Creates a com.rti.dds.subscription.DataReader

(p. 487) that will be attached and belong to the implicit
Precondition:
The given com.rti.dds.topic.TopicDescription (p. 1561) must have
been created from the same DomainParticipant (p. 654) as the implicit
Subscriber. If it was created from a different DomainParticipant (p. 654),
this method will return NULL.
The
(p. 487)
created
using this method will be associated with the implicit Subscriber.
This Subscriber is automatically created (if it does not exist) using
com.rti.dds.domain.DomainParticipant.SUBSCRIBER QOS DEFAULT (p. 153) when the following methods are called:
(p. 693),
com.rti.dds.domain.DomainParticipant.create datareader with profile (p. 695),
or com.rti.dds.domain.DomainParticipant.get implicit subscriber (p. 731).
694
Class Documentation
MT Safety:
UNSAFE. If com.rti.dds.subscription.Subscriber.DATAREADER QOS DEFAULT (p. 196) is used for the qos parameter, it is not safe to
create the datareader while another thread may be simultaneously calling
com.rti.dds.domain.DomainParticipant.set default datareader qos (p. 679).
Parameters:
topic ( p. 359) <<in>> ( p. 279) The com.rti.dds.topic.TopicDescription
(p. 1561) that the com.rti.dds.subscription.DataReader (p. 487)
qos <<in>>
( p. 279)
The
qos
of
the
The special
value com.rti.dds.subscription.Subscriber.DATAREADER QOS DEFAULT (p. 196) can be used to indicate that the
com.rti.dds.subscription.DataReader (p. 487) should be created
with the default com.rti.dds.subscription.DataReaderQos
(p. 536) set in the implicit com.rti.dds.subscription.Subscriber
(p. 1476).
If
(p. 1561) is of type com.rti.dds.topic.Topic (p. 1545) or
com.rti.dds.topic.ContentFilteredTopic (p. 471), the special
value com.rti.dds.subscription.Subscriber.DATAREADER QOS USE TOPIC QOS (p. 197) can be used to indicate
that
the
(p. 536)
set on the implicit com.rti.dds.subscription.Subscriber
(p. 1476) and the com.rti.dds.topic.TopicQos (p. 1566) (in
the
case
of
a
(p. 471),
the
(p. 1566)
of
the
related
(p. 1545)).
if
com.rti.dds.subscription.Subscriber.DATAREADER QOS USE TOPIC QOS (p. 197) is used, topic (p. 359) cannot be a
com.rti.dds.topic.MultiTopic (p. 1190). Cannot be NULL.
listener <<in>>
( p. 279)
The
listener
of
the

Returns:
A com.rti.dds.subscription.DataReader (p. 487) of a derived class
specific to the data-type associated with the com.rti.dds.topic.Topic
695
See also:
entity creation
com.rti.dds.domain.DomainParticipant.create datareader with profile (p. 695)
com.rti.dds.domain.DomainParticipant.get default datareader qos (p. 675)
com.rti.dds.domain.DomainParticipant.get implicit subscriber
(p. 731)
com.rti.dds.subscription.DataReader.set listener (p. 497)
8.64.3.2
DataReader create datareader with profile

(TopicDescription topic, String library name, String
profile name, DataReaderListener listener, int mask)

(p. 487) using a XML QoS profile that will be attached and belong to the
implicit com.rti.dds.subscription.Subscriber (p. 1476).
Precondition:
been created from the same DomainParticipant (p. 654) as the implicit
subscriber. If it was created from a different DomainParticipant (p. 654),
this method will return NULL.
The
(p. 487)
created
using this method will be associated with the implicit Subscriber.
This Subscriber is automatically created (if it does not exist) using
com.rti.dds.domain.DomainParticipant.SUBSCRIBER QOS DEFAULT (p. 153) when the following methods are called:
(p. 693),
com.rti.dds.domain.DomainParticipant.create datareader with profile (p. 695),
or com.rti.dds.domain.DomainParticipant.get implicit subscriber (p. 731)
Parameters:
696
Class Documentation
listener <<in>>
( p. 279)
The
listener
of
the

Returns:
See also:
entity creation
com.rti.dds.domain.DomainParticipant.create datareader (p. 693)
com.rti.dds.domain.DomainParticipant.get default datareader qos (p. 675)
(p. 731)
8.64.3.3
<<eXtension>> ( p. 278) Deletes a com.rti.dds.subscription.DataReader

(p. 487) that belongs to the implicit com.rti.dds.subscription.Subscriber
(p. 1476).
Precondition:
If the com.rti.dds.subscription.DataReader (p. 487) does not belong to the implicit com.rti.dds.subscription.Subscriber (p. 1476),
or if ther are any existing com.rti.dds.subscription.ReadCondition
697
(p. 1313) or com.rti.dds.subscription.QueryCondition (p. 1311) objects that are attached to the com.rti.dds.subscription.DataReader
(p. 487), or if there are outstanding loans on samples (as a result of
a call to read(), take(), or one of the variants thereof), the operation fails with the error com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
Postcondition:
Listener installed on the com.rti.dds.subscription.DataReader (p. 487)
Parameters:
a datareader <<in>> ( p. 279) The com.rti.dds.subscription.DataReader
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
(p. 731)
8.64.3.4
Topic create topic (String topic name, String type name,

TopicQos qos, TopicListener listener, int mask)
Creates a com.rti.dds.topic.Topic (p. 1545) with the desired QoS policies and
attaches to it the specified com.rti.dds.topic.TopicListener (p. 1564).
Precondition:
The application is not allowed to create two com.rti.dds.topic.Topic
(p. 1545) objects with the same topic name attached to the same
com.rti.dds.domain.DomainParticipant (p. 654). If the application attempts this, this method will fail and return a NULL topic (p. 359).
no com.rti.dds.topic.Topic (p. 1545) will be created.
Prior to creating a com.rti.dds.topic.Topic (p. 1545), the type must
have been registered with RTI Connext.
This is done using the
com.rti.ndds.example.FooTypeSupport.register type (p. 1037) operation on a derived class of the com.rti.dds.topic.TypeSupport
(p. 1665) interface.
698
Class Documentation
MT Safety:
UNSAFE. It is not safe to create a topic (p. 359) while another
thread is trying to lookup that topic (p. 359) description with
com.rti.dds.domain.DomainParticipant.lookup topicdescription
(p. 713).
MT Safety:
UNSAFE.
If
com.rti.dds.domain.DomainParticipant.TOPIC QOS DEFAULT (p. 152) is used for qos, it is not safe to create
the topic (p. 359) while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipant.set default topic qos
(p. 667).
Parameters:
topic name <<in>> ( p. 279) Name for the new topic (p. 359), must not
exceed 255 characters. Cannot be NULL.
type name <<in>> ( p. 279) The type to which the new
com.rti.dds.topic.Topic (p. 1545) will be bound.
Cannot be
NULL.
The special value
com.rti.dds.domain.DomainParticipant.TOPIC QOS DEFAULT (p. 152) can be used to indicate that the
com.rti.dds.topic.Topic (p. 1545) should be created with
the default com.rti.dds.topic.TopicQos (p. 1566) set in the
Cannot be
NULL.
Returns:
newly created topic (p. 359), or NULL on failure
See also:
entity creation
com.rti.dds.topic.TopicQos (p. 1566) for rules on consistency among
QoS
(p. 152)
699
com.rti.dds.domain.DomainParticipant.create topic with profile

(p. 699)
com.rti.dds.domain.DomainParticipant.get default topic qos
(p. 667)
com.rti.dds.topic.Topic.set listener (p. 1549)
8.64.3.5
Topic create topic with profile (String topic name, String

type name, String library name, String profile name,
TopicListener listener, int mask)
<<eXtension>> ( p. 278) Creates a new com.rti.dds.topic.Topic (p. 1545)

object using the com.rti.dds.publication.PublisherQos (p. 1290) associated
with the input XML QoS profile.
Precondition:
The
application
is
not
allowed
to
create
two
(p. 1561)
objects
attached
to
the
same
with
the
same
topic name
If the application attempts this, this method will fail and return a NULL topic
(p. 359).
The com.rti.dds.topic.TopicQos (p. 1566) in the input profile must be
consistent, or the operation will fail and no com.rti.dds.topic.Topic
(p. 1545) will be created.
Prior to creating a com.rti.dds.topic.Topic (p. 1545), the type must
have been registered with RTI Connext.
This is done using the
com.rti.ndds.example.FooTypeSupport.register type (p. 1037) operation on a derived class of the com.rti.dds.topic.TypeSupport
(p. 1665) interface.
MT Safety:
UNSAFE. It is not safe to create a topic (p. 359) while another
thread is trying to lookup that topic (p. 359) description with
com.rti.dds.domain.DomainParticipant.lookup topicdescription
(p. 713).
Parameters:
topic name <<in>> ( p. 279) Name for the new topic (p. 359), must not
exceed 255 characters. Cannot be NULL.
type name <<in>> ( p. 279) The type to which the new
com.rti.dds.topic.Topic (p. 1545) will be bound.
Cannot be
NULL.
700
Class Documentation
Returns:
newly created topic (p. 359), or NULL on failure
See also:
entity creation
QoS
com.rti.dds.domain.DomainParticipant.get default topic qos
(p. 667)
8.64.3.6
void delete topic (Topic topic)
Deletes a com.rti.dds.topic.Topic (p. 1545).

Precondition:
If the com.rti.dds.topic.Topic (p. 1545) does not belong to the
applications
(p. 654),
this operation fails with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
Make sure no objects are using the topic (p. 359). More specifically,
there must be no existing com.rti.dds.subscription.DataReader
(p. 487),
(p. 557),
(p. 471),
or
com.rti.dds.topic.MultiTopic (p. 1190) objects belonging to the
same com.rti.dds.domain.DomainParticipant (p. 654) that are using
the com.rti.dds.topic.Topic (p. 1545). If delete topic is called on a
701
com.rti.dds.topic.Topic (p. 1545) with any of these existing objects

attached to it, it will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
Postcondition:
Listener installed on the com.rti.dds.topic.Topic (p. 1545) will not be
called after this method completes successfully.
Parameters:
topic ( p. 359) <<in>> ( p. 279) com.rti.dds.topic.Topic (p. 1545) to
be deleted.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.64.3.7
ContentFilteredTopic create contentfilteredtopic (String

name, Topic related topic, String filter expression,
StringSeq expression parameters)
Creates a com.rti.dds.topic.ContentFilteredTopic (p. 471), that can be

used to do content-based subscriptions.
The com.rti.dds.topic.ContentFilteredTopic (p. 471) only relates to samples published under that com.rti.dds.topic.Topic (p. 1545), filtered according to their content. The filtering is done by means of evaluating a logical
expression that involves the values of some of the data-fields in the sample.
The logical expression derived from the filter expression and expression parameters arguments.
Queries and Filters Syntax (p. 286) describes the syntax of filter expression and expression parameters.
Precondition:
The
application
is
not
allowed
to
create
two
(p. 471)
objects with the same topic name attached to the same
If the application attempts this, this method will fail and returns NULL.
If
related topic
does
not
belong
to
this
com.rti.dds.domain.DomainParticipant (p. 654), this operation
returns NULL.
702
Class Documentation
This function will create a content filter using the builtin (p. 330) SQL filter
which implements a superset of the DDS specification. This filter requires
that all IDL types have been compiled with typecodes. If this precondition
is not met, this operation returns NULL. Do not use rtiddsgens -notypecode
option if you want to use the builtin (p. 330) SQL filter.
Parameters:
name <<in>> ( p. 279) Name for the new content filtered topic (p. 359),
must not exceed 255 characters. Cannot be NULL.
related topic <<in>> ( p. 279) com.rti.dds.topic.Topic (p. 1545) to
be filtered. Cannot be NULL.
filter expression <<in>> ( p. 279) Cannot be NULL
expression parameters <<in>> ( p. 279) Cannot be NULL.An empty
sequence must be used if the filter expression does not contain any
parameters. Length of sequence cannot be greater than 100.
Returns:
newly created com.rti.dds.topic.ContentFilteredTopic (p. 471), or
NULL on failure
8.64.3.8
ContentFilteredTopic create contentfilteredtopic with filter (String name, Topic related topic, String
filter expression, StringSeq expression parameters,
String filter name)
<<eXtension>> ( p. 278) Creates a com.rti.dds.topic.ContentFilteredTopic

(p. 471) using the specified filter to do content-based subscriptions.
Parameters:
name <<in>> ( p. 279) Name for the new content filtered topic (p. 359).
Cannot exceed 255 characters. Cannot be NULL.
related topic <<in>> ( p. 279) com.rti.dds.topic.Topic (p. 1545) to
be filtered. Cannot be NULL.
filter expression <<in>> ( p. 279) Cannot be NULL.
expression parameters <<in>> ( p. 279) Cannot be NULL.. An empty
sequence must be used if the filter expression does not contain any
parameters. Length of the sequence cannot be greater than 100.
filter name <<in>> ( p. 279)
Name
of
content
filter
to
use.
Must
previously
have
been
registered
with
(p. 728) on the same com.rti.dds.domain.DomainParticipant
703
Builtin filter names are com.rti.dds.domain.DomainParticipant.SQLFILTER NAME (p. 155) and com.rti.dds.domain.DomainParticipant.STRINGMATCHFILTER NAME (p. 155)
Returns:
newly created com.rti.dds.topic.ContentFilteredTopic (p. 471), or
NULL on failure
8.64.3.9
void delete contentfilteredtopic (ContentFilteredTopic

a contentfilteredtopic)
Deletes a com.rti.dds.topic.ContentFilteredTopic (p. 471).

Precondition:
The
deletion
of
a
(p. 471)
is
not
allowed
if
there
are
any
existing
com.rti.dds.subscription.DataReader (p. 487) objects that are
using the com.rti.dds.topic.ContentFilteredTopic (p. 471). If the operation is called on a com.rti.dds.topic.ContentFilteredTopic (p. 471)
with existing com.rti.dds.subscription.DataReader (p. 487) objects
attached to it, it will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
The com.rti.dds.topic.ContentFilteredTopic (p. 471) must be created by this com.rti.dds.domain.DomainParticipant (p. 654), or else
this operation will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
Parameters:
a contentfilteredtopic <<in>> ( p. 279)
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
8.64.3.10
MultiTopic create multitopic (String name, String

type name, String subscription expression, StringSeq
expression parameters)
[Not supported (optional)] Creates a MultiTopic that can be used to subscribe to multiple topics and combine/filter the received data into a resulting
type.
704
Class Documentation
The resulting type is specified by the type name argument. The list of topics
and the logic used to combine, filter, and rearrange the information from each
com.rti.dds.topic.Topic (p. 1545) are specified using the subscription expression and expression parameters arguments.
Queries and Filters Syntax (p. 286) describes the syntax of subscription expression and expression parameters.
Precondition:
The
application
is
not
allowed
to
create
two
com.rti.dds.topic.TopicDescription (p. 1561) objects with the same
name attached to the same com.rti.dds.domain.DomainParticipant
(p. 654). If the application attempts this, this method will fail and return
NULL.
Prior to creating a com.rti.dds.topic.MultiTopic (p. 1190), the type
must have been registered with RTI Connext. This is done using
the com.rti.ndds.example.FooTypeSupport.register type (p. 1037)
operation on a derived class of the com.rti.dds.topic.TypeSupport
(p. 1665) interface. Otherwise, this method will return NULL.
Parameters:
name <<in>>
( p. 279)
Name
of
the
newly
create
type name <<in>> ( p. 279) Cannot be NULL.
subscription expression <<in>> ( p. 279) Cannot be NULL.
expression parameters <<in>> ( p. 279) Cannot be NULL.
Returns:
NULL
8.64.3.11
void delete multitopic (MultiTopic a multitopic)
[Not supported (optional)] Deletes a com.rti.dds.topic.MultiTopic

(p. 1190).
Precondition:
The deletion of a com.rti.dds.topic.MultiTopic (p. 1190) is not allowed if there are any existing com.rti.dds.subscription.DataReader
(p. 487) objects that are using the com.rti.dds.topic.MultiTopic
(p. 1190).
If the delete multitopic operation is called on
a
(p. 1190)
with
existing
705
com.rti.dds.subscription.DataReader (p. 487) objects attached

to it, it will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
The com.rti.dds.topic.MultiTopic (p. 1190) must be created by
this com.rti.dds.domain.DomainParticipant (p. 654), or else this
operation will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
Parameters:
a multitopic <<in>> ( p. 279)
Exceptions:
com.rti.dds.infrastructure.RETCODE UNSUPPORTED ( p. 1365)
8.64.3.12
void set qos (DomainParticipantQos qos)
Change the QoS of this DomainParticipant (p. 654).

The com.rti.dds.domain.DomainParticipantQos.user data (p. 775) and
com.rti.dds.domain.DomainParticipantQos.entity factory (p. 775) can
be changed. The other policies are immutable.
Parameters:
qos <<in>> ( p. 279) Set of policies to be applied to
Immutable policies cannot be
changed
after
(p. 654)
is
enabled.
The
special
value
com.rti.dds.domain.DomainParticipantFactory.PARTICIPANT QOS DEFAULT (p. 149) can be used to indicate that
the QoS of the com.rti.dds.domain.DomainParticipant
com.rti.dds.domain.DomainParticipantQos (p. 773) set in
the com.rti.dds.domain.DomainParticipantFactory (p. 742).
Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
com.rti.dds.infrastructure.RETCODE IMMUTABLE POLICY (p. 1358) if immutable policy is changed, or
com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY (p. 1359) if policies are inconsistent
706
Class Documentation
See also:
com.rti.dds.domain.DomainParticipantQos (p. 773) for rules on consistency among QoS
8.64.3.13

profile name)
<<eXtension>> ( p. 278) Change the QoS of this domain (p. 328) participant
using the input XML QoS profile.
The com.rti.dds.domain.DomainParticipantQos.user data (p. 775) and
com.rti.dds.domain.DomainParticipantQos.entity factory (p. 775) can
Parameters:
profile. If library name is null RTI Connext will use the default library (see com.rti.dds.domain.DomainParticipantFactory.set default library (p. 756)).
If profile name is null RTI Connext will use the default profile (see com.rti.dds.domain.DomainParticipantFactory.set default profile (p. 757)).
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
See also:
8.64.3.14
void get qos (DomainParticipantQos qos)
Get the participant QoS.

707
Parameters:
qos <<inout>> ( p. 279) QoS to be filled up. Cannot be NULL.
Exceptions:
See also:
8.64.3.15
<<eXtension>> ( p. 278) Gets the default XML library associated with a

Returns:
The default library or null if the default library was not set.
See also:
com.rti.dds.domain.DomainParticipant.set default library (p. 707)
8.64.3.16
<<eXtension>> ( p. 278) Sets the default XML

library
for
This method specifies the library that will be used as the default the next time
a default library is needed during a call to one of this DomainParticipants
operations.
Any API requiring a library name as a parameter can use null to refer to the
default library.
If the default library is not set, the com.rti.dds.domain.DomainParticipant
(p. 654) inherits the default from the com.rti.dds.domain.DomainParticipantFactory
(p. 742)
(see
com.rti.dds.domain.DomainParticipantFactory.set default library (p. 756)).
Parameters:
library name <<in>> ( p. 279) Library name. If library name is null
any previous default is unset.
708
Class Documentation
Exceptions:
See also:
com.rti.dds.domain.DomainParticipant.get default library
(p. 707)
8.64.3.17
<<eXtension>> ( p. 278) Gets the default XML profile associated with a

Returns:
The default profile or null if the default profile was not set.
See also:
com.rti.dds.domain.DomainParticipant.set default profile (p. 708)
8.64.3.18
void set default profile (String library name, String

profile name)
<<eXtension>> ( p. 278) Sets the default XML

profile
for
This method specifies the profile that will be used as the default the
next time a default DomainParticipant (p. 654) profile is needed during a call to one of this DomainParticipants operations. When calling a
com.rti.dds.domain.DomainParticipant (p. 654) method that requires a
profile name parameter, you can use NULL to refer to the default profile.
(This same information applies to setting a default library.)
If the default profile is not set, the com.rti.dds.domain.DomainParticipant
(p. 654) inherits the default from the com.rti.dds.domain.DomainParticipantFactory
(p. 742)
(see
com.rti.dds.domain.DomainParticipantFactory.set default profile (p. 757)).
This method does not set the default QoS for entities created by the
com.rti.dds.domain.DomainParticipant (p. 654); for this functionality, use
the methods set default <entity> qos with profile (you may pass in NULL after
having called set default profile() (p. 708)).
This
method
does
not
set
created
DomainParticipants;
the
for
default
QoS
for
this
functionality,
newly
use
709
com.rti.dds.domain.DomainParticipantFactory.set default participant qos with profile (p. 752).

Parameters:
library name <<in>> ( p. 279) The library name containing the profile.
profile name <<in>> ( p. 279) The profile name. If profile name is null
Exceptions:
See also:
com.rti.dds.domain.DomainParticipant.get default profile (p. 708)
com.rti.dds.domain.DomainParticipant.get default profile library (p. 709)
8.64.3.19
<<eXtension>> ( p. 278) Gets the library where the default XML QoS profile
is contained for a com.rti.dds.domain.DomainParticipant (p. 654).
The
default
profile
library
is
automatically
set
when
(p. 708)
com.rti.dds.domain.DomainParticipant.set default profile
is called.
This library can be different than the com.rti.dds.domain.DomainParticipant
(p. 654) default library (see com.rti.dds.domain.DomainParticipant.get default library (p. 707)).
Returns:
The default profile library or null if the default profile was not set.
See also:
com.rti.dds.domain.DomainParticipant.set default profile (p. 708)
8.64.3.20
void set listener (DomainParticipantListener l, int mask)
Sets the participant listener.

Parameters:
l <<in>> ( p. 279) Listener to be installed on entity.
710
Class Documentation
mask <<in>> ( p. 279) Changes of communication status to be invoked
MT Safety:
Unsafe. This method is not synchronized with the listener callbacks, so it
is possible to set a new listener on a participant when the old listener is in
a callback.
Exceptions:
See also:
8.64.3.21
DomainParticipantListener get listener ()
Get the participant listener.

Returns:
Existing listener attached to the com.rti.dds.domain.DomainParticipant
(p. 654).
See also:
8.64.3.22
void get publishers (PublisherSeq publishers)
<<eXtension>> ( p. 278) Allows the application to access all the publishers

If the sequence doesnt own its buffer, and its maximum is less than
the total number of publishers, it will be filled up to its maximum, and fail with com.rti.dds.infrastructure.RETCODE OUT OF RESOURCES (p. 1362).
MT Safety:
Safe.
Parameters:
publishers <<inout>> ( p. 279) a PublisherSeq object where the set or
list of publishers will be returned
711
Returns:
One
of
the
Standard
Return
Codes
(p. 108)
or
com.rti.dds.infrastructure.RETCODE OUT OF RESOURCES
(p. 1362)
8.64.3.23
void get subscribers (SubscriberSeq subscribers)
<<eXtension>> ( p. 278) Allows the application to access all the subscribers

If the sequence doesnt own its buffer, and its maximum is less than
the total number of subscribers, it will be filled up to its maximum, and fail with com.rti.dds.infrastructure.RETCODE OUT OF RESOURCES (p. 1362).
MT Safety:
Safe.
Parameters:
subscribers <<inout>> ( p. 279) a SubscriberSeq object where the set
or list of subscribers will be returned
Returns:
One
of
the
Standard
Return
Codes
(p. 108)
or
(p. 1362)
8.64.3.24
Subscriber get builtin subscriber ()
Accesses the built-in com.rti.dds.subscription.Subscriber (p. 1476).

Each com.rti.dds.domain.DomainParticipant (p. 654) contains several
built-in com.rti.dds.topic.Topic (p. 1545) objects as well as corresponding
com.rti.dds.subscription.DataReader (p. 487) objects to access them. All
of these com.rti.dds.subscription.DataReader (p. 487) objects belong to a
single built-in com.rti.dds.subscription.Subscriber (p. 1476).
The
built-in
Topics
are
used
to
communicate
information
about
other
(p. 654),
(p. 487), and com.rti.dds.publication.DataWriter (p. 557) objects.
The built-in subscriber is created when this operation is called for the
first time.
The built-in subscriber is deleted automatically when the
com.rti.dds.domain.DomainParticipant (p. 654) is deleted.
712
Class Documentation
Returns:
The built-in com.rti.dds.subscription.Subscriber (p. 1476) singleton.
See also:
builtin.ParticipantBuiltinTopicData (p. 1211)
8.64.3.25
FlowController lookup flowcontroller (String name)
<<eXtension>> ( p. 278) Looks up an existing locally-created

com.rti.dds.publication.FlowController (p. 964), based on its name.
Looks up a previously created com.rti.dds.publication.FlowController
including
the
built-in
ones.
Once
a
(p. 964),
com.rti.dds.publication.FlowController (p. 964) has been deleted,
subsequent lookups will fail.
MT Safety:
UNSAFE. It is not safe to lookup a flow controller description while another
thread is creating that flow controller.
Parameters:
name <<in>> ( p. 279) Name of com.rti.dds.publication.FlowController
(p. 964) to search for. Limited to 255 characters. Cannot be NULL.
Returns:
The flow controller if it has already been created locally, or NULL otherwise.
8.64.3.26
Topic find topic (String topic name, Duration t timeout)
Finds an existing (or ready to exist) com.rti.dds.topic.Topic (p. 1545), based

on its name.
This call can be used to block for a specified duration to wait for the
com.rti.dds.topic.Topic (p. 1545) to be created.
If the requested com.rti.dds.topic.Topic (p. 1545) already exists, it is returned. Otherwise, find topic() (p. 712) waits until another thread creates
it or else returns when the specified timeout occurs.
713
find topic() (p. 712) is useful when multiple threads are concurrently
creating and looking up topics.
In that case, one thread can
call find topic() (p. 712) and, if another thread has not yet created the topic (p. 359) being looked up, it can wait for some period of time for it to do so.
In almost all other cases, it is more
straightforward to call com.rti.dds.domain.DomainParticipant.lookup topicdescription (p. 713).
The com.rti.dds.domain.DomainParticipant (p. 654) must already be enabled.
obtained
by
Note:
Each
(p. 1545)
com.rti.dds.domain.DomainParticipant.find topic (p. 712) must also be
deleted by means of com.rti.dds.domain.DomainParticipant.delete topic (p. 700). If com.rti.dds.topic.Topic (p. 1545) is obtained multiple
times by means of com.rti.dds.domain.DomainParticipant.find topic (p. 712) or com.rti.dds.domain.DomainParticipant.create topic (p. 697), it must also be deleted that same number of times using
com.rti.dds.domain.DomainParticipant.delete topic (p. 700).
Parameters:
topic name <<in>> ( p. 279) Name of the com.rti.dds.topic.Topic
(p. 1545) to search for. Cannot be NULL.
timeout <<in>>
( p. 279)
The
time
to
wait
if
the
com.rti.dds.topic.Topic (p. 1545) does not exist already. Cannot
be NULL.
Returns:
the topic (p. 359), if it exists, or NULL
8.64.3.27
TopicDescription lookup topicdescription (String

topic name)
Looks up an existing, locally created com.rti.dds.topic.TopicDescription

(p. 1561), based on its name.
com.rti.dds.topic.TopicDescription (p. 1561) is the base class for
(p. 1545),
(p. 1190) and com.rti.dds.topic.ContentFilteredTopic (p. 471).
So
you can narrow the com.rti.dds.topic.TopicDescription (p. 1561) returned from this operation to a com.rti.dds.topic.Topic (p. 1545) or
com.rti.dds.topic.ContentFilteredTopic (p. 471) as appropriate.
Unlike com.rti.dds.domain.DomainParticipant.find topic (p. 712), which
logically returns a new com.rti.dds.topic.Topic (p. 1545) object that must be
714
Class Documentation
independently deleted, this operation returns a reference to the original local

object.
The com.rti.dds.domain.DomainParticipant (p. 654) does not have to be
enabled when you call lookup topicdescription() (p. 713).
The returned topic (p. 359) may be either enabled or disabled.
MT Safety:
UNSAFE. It is not safe to lookup a topic (p. 359) description while another
thread is creating that topic (p. 359).
Parameters:
topic name <<in>>
( p. 279)
Name
of
com.rti.dds.topic.TopicDescription (p. 1561) to search for.
This string must be no more than 255 characters; it cannot be NULL.
Returns:
The topic (p. 359) description, if it has already been created locally, otherwise it returns NULL.
8.64.3.28
void ignore participant (InstanceHandle t handle)
Instructs
RTI
Connext
to
locally
ignore
remote
From the time of this call onwards, RTI Connext will locally behave as if
the remote participant did not exist. This means it will ignore any topic
(p. 359), publication (p. 349), or subscription (p. 353) that originates on that
There is no way to reverse this operation.
This operation can be used in conjunction with the discovery of remote
participants offered by means of the builtin.ParticipantBuiltinTopicData
(p. 1211) to provide access control.
Application
data
can
be
associated
with
a
com.rti.dds.domain.DomainParticipant (p. 654) by means of the USER DATA (p. 132) policy. This application data is propagated as a field in the
built-in topic (p. 359) and can be used by an application to implement its own
access control policy.
The
(p. 654)
to
ignore is identified by the handle argument.
This handle is the
one
that
appears
in
the
715
(p. 1398) retrieved when reading the data-samples available for the
to
the
built-in
(p. 487)
com.rti.dds.domain.DomainParticipant (p. 654) topic (p. 359).
The
built-in com.rti.dds.subscription.DataReader (p. 487) is read with
the same com.rti.ndds.example.FooDataReader.read (p. 981) and
com.rti.ndds.example.FooDataReader.take (p. 983) operations used for
any com.rti.dds.subscription.DataReader (p. 487).
Parameters:
handle <<in>> ( p. 279) com.rti.dds.infrastructure.InstanceHandle t (p. 1055) of the com.rti.dds.domain.DomainParticipant
(p. 654) to be ignored. Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
com.rti.dds.infrastructure.RETCODE OUT OF RESOURCES (p. 1362), com.rti.dds.infrastructure.RETCODE NOT ENABLED (p. 1361)
See also:
builtin.ParticipantBuiltinTopicDataTypeSupport.PARTICIPANT TOPIC NAME (p. 1216)
com.rti.dds.domain.DomainParticipant.get builtin subscriber
(p. 711)
8.64.3.29
void ignore topic (InstanceHandle t handle)
Instructs RTI Connext to locally ignore a com.rti.dds.topic.Topic (p. 1545).

This means it will locally ignore any publication (p. 349), or subscription
(p. 353) to the com.rti.dds.topic.Topic (p. 1545).
This operation can be used to save local resources when the application knows
that it will never publish or subscribe to data under certain topics.
The com.rti.dds.topic.Topic (p. 1545) to ignore is identified by the
handle argument.
This is the handle of a com.rti.dds.topic.Topic
(p. 1545) that appears in the com.rti.dds.subscription.SampleInfo
(p. 1398) retrieved when reading data samples from the builtin
(p. 487)
for
the
716
Class Documentation
Parameters:
handle <<in>> ( p. 279) Handle of the com.rti.dds.topic.Topic
(p. 1545) to be ignored. Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1362)
or
(p. 1361)
See also:
builtin.TopicBuiltinTopicDataTypeSupport.TOPIC TOPIC NAME
(p. 711)
8.64.3.30
void ignore publication (InstanceHandle t handle)
Instructs RTI Connext to locally ignore a publication (p. 349).

A publication (p. 349) is defined by the association of a topic (p. 359)
name, user data, and partition set on the com.rti.dds.publication.Publisher
(p. 1262) (see builtin.PublicationBuiltinTopicData). After this call, any data
written by that publications com.rti.dds.publication.DataWriter (p. 557)
will be ignored.
This operation can be used to ignore local and remote DataWriters.
The publication (p. 349) (DataWriter) to ignore is identified by the handle
argument.
To ignore a remote DataWriter, the handle can be obtained
from
the
(p. 487)
for
the
com.rti.dds.publication (p. 349) topic (p. 359).
To ignore a local DataWriter, the handle can be obtained by calling
com.rti.dds.infrastructure.Entity.get instance handle (p. 937) for
the local DataWriter.
717
Parameters:
handle <<in>>
( p. 279)
Handle
of
the
com.rti.dds.publication.DataWriter (p. 557) to be ignored.
Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1362)
or
(p. 1361)
See also:
builtin.PublicationBuiltinTopicDataTypeSupport.PUBLICATION TOPIC NAME
(p. 711)
8.64.3.31
void ignore subscription (InstanceHandle t handle)
Instructs RTI Connext to locally ignore a subscription (p. 353).

A subscription (p. 353) is defined by the association of a topic (p. 359) name,
user data, and partition set on the com.rti.dds.subscription.Subscriber
(p. 1476)
(see
builtin.SubscriptionBuiltinTopicData).
After
this
call,
any
data
received
related
to
that
subscriptions
com.rti.dds.subscription.DataReader (p. 487) will be ignored.
This operation can be used to ignore local and remote DataReaders.
The subscription (p. 353) to ignore is identified by the handle argument.
To ignore a remote DataReader, the handle can be obtained
from
the
(p. 487)
for
the
com.rti.dds.subscription (p. 353) topic (p. 359).
To ignore a local DataReader, the handle can be obtained by calling
com.rti.dds.infrastructure.Entity.get instance handle (p. 937) for
the local DataReader.
718
Class Documentation
Parameters:
handle <<in>>
( p. 279)
Handle
of
the
com.rti.dds.subscription.DataReader (p. 487) to be ignored.
Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1362)
or
(p. 1361)
See also:
builtin.SubscriptionBuiltinTopicDataTypeSupport.SUBSCRIPTION TOPIC NAME
(p. 711)
8.64.3.32
int get domain id ()
Get the unique domain (p. 328) identifier.

This operation retrieves the domain id used to create the
(p. 654).
The
domain id identifies the DDS domain (p. 328) to which the
com.rti.dds.domain.DomainParticipant (p. 654) belongs.
Each DDS
domain (p. 328) represents a separate data communication plane isolated
from other domains.
Returns:
the unique domainId that was used to create the domain (p. 328)
See also:
8.64.3.33
Manually asserts the liveliness of this com.rti.dds.domain.DomainParticipant

(p. 654).
719
This is used in combination with the com.rti.dds.infrastructure.LivelinessQosPolicy

(p. 1140) to indicate to RTI Connext that the entity remains active.
You need to use this operation if the com.rti.dds.domain.DomainParticipant
(p. 654) conatins com.rti.dds.publication.DataWriter (p. 557) entities with
the com.rti.dds.infrastructure.LivelinessQosPolicy.kind (p. 1143) set to
com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.MANUAL BY PARTICIPANT LIVELINESS QOS and it only affects the liveliness of
those com.rti.dds.publication.DataWriter (p. 557) entities. Otherwise, it
has no effect.
Note: writing data via the com.rti.ndds.example.FooDataWriter.write
or
w timestamp
(p. 1024)
operation
asserts
liveliness
on
the
itself
and
its
(p. 557)
Consequently the
use of assert liveliness() (p. 718) is only needed if the application is not
writing data regularly.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1361)
or
See also:
8.64.3.34
Delete all the entities that were created by means of the create operations on
This operation deletes all contained com.rti.dds.publication.Publisher
(including
an
implicit
Publisher,
if
one
ex(p. 1262)
ists),
(p. 1476)
(including
implicit
subscriber),
(p. 1545),
(p. 471),
and
com.rti.dds.topic.MultiTopic (p. 1190) objects.
Prior to deleting each contained entity, this operation will recursively call the corresponding delete contained entities operation
on each contained entity (if applicable).
This pattern is applied
recursively.
In this manner the operation delete contained entities() (p. 719) on the com.rti.dds.domain.DomainParticipant
(p. 654) will end up deleting all the entities recursively contained
in
the
(p. 654),
720
Class Documentation
that
is
also
the
(p. 557),
as
well
as
(p. 487),
the
(p. 1311)
and
com.rti.dds.subscription.ReadCondition (p. 1313) objects belonging
to the contained com.rti.dds.subscription.DataReader (p. 487).
The operation will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363) if any of the contained entities is
in a state where it cannot be deleted.
If delete contained entities() (p. 719) completes successfully, the application
may delete the com.rti.dds.domain.DomainParticipant (p. 654) knowing
that it has no contained entities.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.64.3.35
void add peer (String peer desc string)
<<eXtension>> ( p. 278) Attempt to contact one or more additional peer

participants.
Add the given peer description to the list of peers with which this
com.rti.dds.domain.DomainParticipant (p. 654) will try to communicate.
This
method
may
be
called
at
any
time
after
this
com.rti.dds.domain.DomainParticipant (p. 654) has been created (before
or after it has been enabled).
If this method is called after com.rti.dds.infrastructure.Entity.enable
(p. 935), an attempt will be made to contact the new peer(s) immediately.
If this method is called before the DomainParticipant (p. 654) is enabled, the peer description will simply be added to the list that was
populated by com.rti.dds.infrastructure.DiscoveryQosPolicy.initial peers (p. 651); the first attempted contact will take place after this
Adding a peer description with this method does not guarantee that any peer(s)
discovered as a result will exactly correspond to those described:
This com.rti.dds.domain.DomainParticipant (p. 654) will attempt to
discover peer participants at the given locations but may not succeed if
no such participants are available. In this case, this method will not wait
for contact attempt(s) to be made and it will not report an error.
721
If remote participants described by the given peer description are discovered, the distributed application is configured with asymmetric peer
lists, and com.rti.dds.infrastructure.DiscoveryQosPolicy.accept unknown peers (p. 652) is set to com.rti.dds.infrastructure.true. Thus,
this com.rti.dds.domain.DomainParticipant (p. 654) may actually
discover more peers than are described in the given peer description.
To be informed of the exact remote participants that are discovered, regardless of which peers this com.rti.dds.domain.DomainParticipant
(p. 654) attempts to discover, use the built-in participant topic (p. 359):
builtin.ParticipantBuiltinTopicDataTypeSupport.PARTICIPANT TOPIC NAME (p. 1216).
To
remove
specific
peer
locators,
you
may
use
com.rti.dds.domain.DomainParticipant.remove peer (p. 722).
If a
peer is removed, the add peer operation will add it back to the list of peers.
To stop communicating with a peer com.rti.dds.domain.DomainParticipant
(p. 654) that has been discovered, use com.rti.dds.domain.DomainParticipant.ignore participant (p. 714).
Adding a peer description with this method has no effect on
the
(p. 651)
that
may
be
subsequently
retrieved
with
com.rti.dds.domain.DomainParticipant.get qos()
(p. 706)
(because
com.rti.dds.infrastructure.DiscoveryQosPolicy (p. 649) is immutable).
Parameters:
peer desc string <<in>> ( p. 279) New peer descriptor to be added.
The format is specified in Peer Descriptor Format (p. 58). Cannot
be NULL.
Exceptions:
See also:
(p. 651)
(p. 711)
722
Class Documentation
8.64.3.36
void remove peer (String peer desc string)
<<eXtension>> ( p. 278) Remove one or more peer participants from the list
of peers with which this com.rti.dds.domain.DomainParticipant (p. 654)
will try to communicate.
This
method
may
be
called
any
time
after
com.rti.dds.domain.DomainParticipant (p. 654) has been enabled
this
Calling this method has the following effects:

If a com.rti.dds.domain.DomainParticipant (p. 654) was already discovered, it will be locally removed along with all its entities.
Any
further
requests
coming
from
a
com.rti.dds.domain.DomainParticipant (p. 654) located on any
of the removed peers will be ignored.
All the locators contained in the peer description will be removed from the
peer list. The local com.rti.dds.domain.DomainParticipant (p. 654)
will stop sending announcement to those locators.
If remote participants located on a peer that was previously removed are discovered, they will be ignored untill the related peer is added back by using
com.rti.dds.domain.DomainParticipant.add peer (p. 720).
Removing a peer description with this method has no effect
on
the
(p. 651)
that
may
be
subsequently
retrieved
with
com.rti.dds.domain.DomainParticipant.get qos()
(p. 706)
(because
com.rti.dds.infrastructure.DiscoveryQosPolicy (p. 649) is immutable).
Parameters:
peer desc string <<in>> ( p. 279) Peer descriptor to be removed. The
format is specified in Peer Descriptor Format (p. 58). Cannot be
NULL.
Exceptions:
See also:
(p. 651)
com.rti.dds.domain.DomainParticipant.add peer (p. 720)

8.64.3.37
723
void get current time (Time t current time)
Returns the current value of the time.

The current value of the time that RTI Connext uses to time-stamp
com.rti.dds.publication.DataWriter (p. 557) and to set the receptiontimestamp for the data updates that it receives.
Parameters:
current time <<inout>> ( p. 279) Current time to be filled up. Cannot
be NULL.
Exceptions:
8.64.3.38
void get discovered participants (InstanceHandleSeq

participant handles)
Returns list of discovered com.rti.dds.domain.DomainParticipant (p. 654)

s.
This operation retrieves the list of com.rti.dds.domain.DomainParticipant
(p. 654) s that have been discovered in the domain (p. 328) and that
the application has not indicated should be ignored by means of the
com.rti.dds.domain.DomainParticipant.ignore participant (p. 714) operation.
Parameters:
participant handles <<inout>>
com.rti.dds.infrastructure.InstanceHandleSeq
(p. 1058) to be filled with handles of the
com.rti.dds.domain.DomainParticipant (p. 654) s
( p. 279)
discovered
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361)
8.64.3.39
or
void get discovered participant data

(ParticipantBuiltinTopicData participant data,
InstanceHandle t participant handle)
Returns builtin.ParticipantBuiltinTopicData (p. 1211) for the specified

com.rti.dds.domain.DomainParticipant (p. 654) .
724
Class Documentation
This
operation
retrieves
information
on
a
com.rti.dds.domain.DomainParticipant (p. 654) that has been discovered
on the network. The participant must be in the same domain (p. 328) as the
participant on which this operation is invoked and must not have been ignored by means of the com.rti.dds.domain.DomainParticipant.ignore participant (p. 714) operation.
The participant handle must correspond to such a DomainParticipant
(p. 654). Otherwise, the operation will fail with PRECONDITION NOT MET.
Use
the
operation
com.rti.dds.domain.DomainParticipant.get discovered participants
(p. 723)
to
find
the
com.rti.dds.domain.DomainParticipant (p. 654) s that are currently
discovered.
Note:
This
operation
does
not
retrieve
the
builtin.ParticipantBuiltinTopicData.property
(p. 1212).
This
information
is
available
through
com.rti.dds.subscription.DataReaderListener.on data available() (p. 520) (if a reader listener is installed on the
builtin.ParticipantBuiltinTopicDataDataReader (p. 1214)).
Parameters:
participant data <<inout>> ( p. 279) builtin.ParticipantBuiltinTopicData
(p. 1211)
to
be
filled
with
the
specified
com.rti.dds.domain.DomainParticipant (p. 654) s data.
participant handle <<in>> ( p. 279) com.rti.dds.infrastructure.InstanceHandle t (p. 1055) of com.rti.dds.domain.DomainParticipant (p. 654).
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1363)
or
(p. 1361)
See also:
com.rti.dds.domain.DomainParticipant.get discovered participants (p. 723)
8.64.3.40
void get discovered topics (InstanceHandleSeq

topic handles)
Returns list of discovered com.rti.dds.topic.Topic (p. 1545) objects.

725
This operation retrieves the list of com.rti.dds.topic.Topic (p. 1545)

s that have been discovered in the domain (p. 328) and that the
application has not indicated should be ignored by means of the
com.rti.dds.domain.DomainParticipant.ignore topic (p. 715) operation.
Parameters:
topic handles <<inout>> ( p. 279) com.rti.dds.infrastructure.InstanceHandleSeq
(p. 1058) to be filled with handles of the discovered
com.rti.dds.topic.Topic (p. 1545) objects
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361)
8.64.3.41
or
void get discovered topic data (TopicBuiltinTopicData

topic data, InstanceHandle t topic handle)
Returns
for
the
specified
This operation retrieves information on a com.rti.dds.topic.Topic (p. 1545)

that has been discovered by the local Participant and must not have been ignored by means of the com.rti.dds.domain.DomainParticipant.ignore topic (p. 715) operation.
OtherThe topic handle must correspond to such a topic (p. 359).
wise, the operation will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
This call is not supported for remote topics. If a remote topic handle is
used, the operation will fail with com.rti.dds.infrastructure.RETCODE UNSUPPORTED (p. 1365).
Use
the
operation
com.rti.dds.domain.DomainParticipant.get discovered topics (p. 724) to find the topics that are currently discovered.
Parameters:
topic data <<inout>> ( p. 279) builtin.TopicBuiltinTopicData to be
filled with the specified com.rti.dds.topic.Topic (p. 1545)s data.
topic handle <<in>> ( p. 279) com.rti.dds.infrastructure.InstanceHandle t (p. 1055) of com.rti.dds.topic.Topic (p. 1545).
726
Class Documentation
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1363)
or
(p. 1361)
See also:
com.rti.dds.domain.DomainParticipant.get discovered topics
(p. 724)
8.64.3.42
boolean contains entity (InstanceHandle t a handle)
Completes successfully with com.rti.dds.infrastructure.true if the referenced com.rti.dds.infrastructure.Entity (p. 931) is contained by the
This operation checks whether or not the given a handle represents
an
(p. 931)
that
was
created
from
the
(p. 654).
The containment applies recursively.
That is, it applies
both
to
entities
(com.rti.dds.topic.TopicDescription
(p. 1561),
(p. 1262),
or
com.rti.dds.subscription.Subscriber (p. 1476)) created directly using
the com.rti.dds.domain.DomainParticipant (p. 654) as well as entities
created using a contained com.rti.dds.publication.Publisher (p. 1262), or
com.rti.dds.subscription.Subscriber (p. 1476) as the factory, and so forth.
The instance handle for an com.rti.dds.infrastructure.Entity (p. 931)
may be obtained from built-in topic (p. 359) data, from various statuses,
or from the operation com.rti.dds.infrastructure.Entity.get instance handle (p. 937).
Parameters:
a handle <<in>> ( p. 279) com.rti.dds.infrastructure.InstanceHandle t (p. 1055) of the com.rti.dds.infrastructure.Entity (p. 931) to be
checked.
Returns:
com.rti.dds.infrastructure.true if com.rti.dds.infrastructure.Entity
(p. 931) is contained by the com.rti.dds.domain.DomainParticipant
(p. 654), or com.rti.dds.infrastructure.false otherwise.

8.64.3.43
727
void register durable subscription (EndpointGroup t

group, String topic name)
Registers a Durable Subscription on the specified com.rti.dds.topic.Topic

(p. 1545) on all Persistence Services.
If
you
need
to
receive
all
samples
published
on
a
com.rti.dds.topic.Topic (p. 1545), including the ones published while a
com.rti.dds.subscription.DataReader (p. 487) is inactive or before it may
be created, create a Durable Subscription using this method.
In this way, the Persistence Service will ensure that all the samples on that
com.rti.dds.topic.Topic (p. 1545) are retained until they are acknowledged
by at least N DataReaders belonging to the Durable Subscription where N is
the quorum count.
If the same Durable Subscription is created on a different
com.rti.dds.topic.Topic (p. 1545), the Persistence Service will implicitly delete the previous Durable Subscription and create a new one on the new
Parameters:
group <<in>> ( p. 279) com.rti.dds.infrastructure.EndpointGroup t (p. 928) The Durable Subscription name and quorum.
topic name <<in>> ( p. 279) The topic (p. 359) name for which the
Durable Subscription is created.
Exceptions:
8.64.3.44
void delete durable subscription (EndpointGroup t

group)
Deletes an existing Durable Subscription on all Persistence Services.

The Persistence Service will delete the Durable Subscription and the quorum of
the existing samples will be considered satisfied.
Parameters:
group <<in>> ( p. 279) com.rti.dds.infrastructure.EndpointGroup t (p. 928) specifying the Durable Subscription name. Quorum is not
required for this operation.
Exceptions:
728
Class Documentation
8.64.3.45
void register contentfilter (String filter name,

ContentFilter contentfilter)
<<eXtension>> ( p. 278) Register a content filter which can be used to create

a com.rti.dds.topic.ContentFilteredTopic (p. 471).
DDS specifies a SQL-like content filter for use by content filtered topics. If this
filter does not meet your filtering requirements, you can register a custom filter.
To use a custom filter, it must be registered in the following places:
In any application that uses the custom filter to create a
com.rti.dds.topic.ContentFilteredTopic (p. 471) and the corresponding com.rti.dds.subscription.DataReader (p. 487).
In each application that writes the data to the applications mentioned
above.
For example, suppose Application A on the subscription (p. 353) side creates a
Topic named X and a ContentFilteredTopic named filteredX (and a corresponding DataReader), using a previously registered content filter, myFilter. With
only that, you will have filtering at the subscription (p. 353) side. If you also
want to perform filtering in any application that publishes Topic X, then you
also need to register the same definition of the ContentFilter myFilter in that
application.
Each filter name can only be used to registered a content filter once with a
Parameters:
filter name <<in>> ( p. 279) Name of the filter. The name must
be unique within the com.rti.dds.domain.DomainParticipant
(p. 654) and must not exceed 255 characters. Cannot be NULL.
contentfilter <<in>> ( p. 279) Content filter to be registered. Cannot
be NULL.
Exceptions:
See also:
com.rti.dds.domain.DomainParticipant.unregister contentfilter
(p. 729)

8.64.3.46
729
ContentFilter lookup contentfilter (String filter name)
<<eXtension>> ( p. 278) Lookup a content filter previously registered with

com.rti.dds.domain.DomainParticipant.register contentfilter (p. 728).
Parameters:
filter name <<in>> ( p. 279) Name of the filter. Cannot be NULL.
Returns:
NULL if the given filter name has not been previously registered
to the com.rti.dds.domain.DomainParticipant (p. 654) with
(p. 728).
Otherwise, return the com.rti.dds.topic.ContentFilter
(p. 467) that has been previosuly registered with the given filter name.
See also:
(p. 728)
8.64.3.47
void unregister contentfilter (String filter name)
<<eXtension>> ( p. 278) Unregister a content filter previously registered with

A filter name can be unregistered only if it has been previously registered to the com.rti.dds.domain.DomainParticipant (p. 654) with
The unregistration of filter is not allowed if there are any existing
com.rti.dds.topic.ContentFilteredTopic (p. 471) objects that are using the filter.
If the operation is called on a filter with existing
com.rti.dds.topic.ContentFilteredTopic (p. 471) objects attached to it,
this operation will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
If there are still existing discovered com.rti.dds.subscription.DataReader
(p. 487) s with the same filter name and the filters compile
method of the filter have previously been called on the discovered
com.rti.dds.subscription.DataReader (p. 487) s, finalize method of the filter will be called on those discovered com.rti.dds.subscription.DataReader
(p. 487) s before the content filter is unregistered.
This means filtering will now be performed on the application that is creating the
730
Class Documentation
Parameters:
filter name <<in>> ( p. 279) Name of the filter. Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
(p. 728)
8.64.3.48
Publisher get implicit publisher ()
Returns
the
implicit
<<eXtension>>
( p. 278)
If an implicit Publisher
There can only be one implicit Publisher per DomainParticipant (p. 654).
The implicit Publisher is created with com.rti.dds.domain.DomainParticipant.PUBLISHER QOS DEFAULT (p. 153) and no Listener.
This
implicit
Publisher
will
be
deleted
automatically
when
the
following
methods
are
called:
com.rti.dds.domain.DomainParticipant.delete contained entities
(p. 719), or com.rti.dds.domain.DomainParticipant.delete publisher
(p. 685) with the implicit publisher as a parameter. Additionally, when a
DomainParticipant (p. 654) is deleted, if there are no attached DataWriters
that belong to the implicit Publisher, the implicit Publisher will be implicitly
deleted.
MT Safety:
UNSAFE.
It
is
not
safe
to
create
an
implicit
Publisher while another thread may be simultaneously calling
(p. 671).
Returns:
The implicit publisher
See also:
731
8.64.3.49
Subscriber get implicit subscriber ()
<<eXtension>>
( p. 278)
Returns
the
implicit
com.rti.dds.subscription.Subscriber (p. 1476). If an implicit Subscriber
There can only be one implicit Subscriber per DomainParticipant (p. 654).
The implicit Subscriber is created with com.rti.dds.domain.DomainParticipant.SUBSCRIBER QOS DEFAULT (p. 153) and no Listener.
This
implicit
Subscriber
will
be
deleted
automatically
when
the
following
methods
are
called:
com.rti.dds.domain.DomainParticipant.delete contained entities
(p. 719), or com.rti.dds.domain.DomainParticipant.delete subscriber
(p. 688) with the subscriber as a parameter. Additionally, when a DomainParticipant (p. 654) is deleted, if there are no attached DataReaders that
belong to the implicit Subscriber, the implicit Subscriber will be implicitly
deleted.
MT Safety:
UNSAFE.
it
is
not
safe
to
create
the
implicit
subscriber while another thread may be simultaneously calling
com.rti.dds.domain.DomainParticipant.set default subscriber qos (p. 676).
Returns:
The implicit subscriber
See also:
8.64.3.50
abstract Publisher lookup publisher by name exp (String

publisher name) [pure virtual]
<<experimental>> ( p. 278) <<eXtension>> ( p. 278) Looks up a

com.rti.dds.publication.Publisher (p. 1262) by its entity name within this
732
Class Documentation
Every com.rti.dds.publication.Publisher (p. 1262) in the system has an entity name which is configured and stored in the GROUP DATA policy. The use
of the GROUP DATA to store the entity name is a temporary situation while
the feature is in experimental state.
This operation retrieves a com.rti.dds.publication.Publisher (p. 1262)
within the com.rti.dds.domain.DomainParticipant (p. 654) given the entitys name. If there are several com.rti.dds.publication.Publisher (p. 1262)
with the same name within the com.rti.dds.domain.DomainParticipant
(p. 654), this function returns the first matching occurrence.
Parameters:
publisher name <<in>>
( p. 279)
Entity
name
of
the
Returns:
The first com.rti.dds.publication.Publisher (p. 1262) found with the
specified name or NULL if it is not found.
See also:
com.rti.dds.domain.DomainParticipant.lookup datawriter by name exp (p. 733)
8.64.3.51
abstract Subscriber lookup subscriber by name exp

(String subscriber name) [pure virtual]
<<experimental>> ( p. 278) <<eXtension>> ( p. 278) Retrieves a

com.rti.dds.subscription.Subscriber (p. 1476) by its entity name within this
Every com.rti.dds.subscription.Subscriber (p. 1476) in the system has an
entity name which is configured and stored in the GROUP DATA policy. The
use of the GROUP DATA to store the entity name is a temporary situation
while the function is in experimental state.
This
operation
retrieves
a
(p. 1476)
within
the
(p. 654)
given
the
entitys
name.
If
there
are
several
com.rti.dds.subscription.Subscriber (p. 1476) with the same name
within the com.rti.dds.domain.DomainParticipant (p. 654), this function
returns the first matching occurrence.
Parameters:
subscriber name <<in>>
( p. 279)
Entity
name
of
the
733
Returns:
The first com.rti.dds.subscription.Subscriber (p. 1476) found with the
See also:
com.rti.dds.domain.DomainParticipant.lookup datareader by name exp (p. 734)
8.64.3.52
abstract DataWriter lookup datawriter by name exp

(String datawriter full name) [pure virtual]

com.rti.dds.publication.DataWriter (p. 557) by its entity name within this
Every com.rti.dds.publication.DataWriter (p. 557) in the system has an
entity name which is configured and stored in the EntityName policy, ENTITY NAME (p. 74).
Every com.rti.dds.publication.Publisher (p. 1262) in the system has an entity name which is configured and stored in the <<eXtension>> ( p. 278)
GROUP DATA policy. This is a temporary situation situation while the function is in experimental state.
This operation retrieves a com.rti.dds.publication.DataWriter (p. 557)
within a com.rti.dds.publication.Publisher (p. 1262) given the specified
name which encodes both to the com.rti.dds.publication.DataWriter
(p. 557) and the com.rti.dds.publication.Publisher (p. 1262) name.
The specified name might be given as a fully-qualified entity name or as a plain
name.
The fully qualified entity name is a concatenation of the
to
which
the
(p. 1262)
com.rti.dds.publication.DataWriter (p. 557) belongs and the entity name
of of the com.rti.dds.publication.DataWriter (p. 557) itself, separated by
a double colon ::. For example: MyPublisherName.MyDataWriterName
The plain name contains the com.rti.dds.publication.DataWriter
(p. 557) name only.
In this situation it is implied that the
com.rti.dds.publication.DataWriter (p. 557) belongs to the implicit com.rti.dds.publication.Publisher (p. 1262) so the use of a
plain name is equivalent to specifying a fully qualified name with the
com.rti.dds.publication.Publisher (p. 1262) name part being implicit.
For example: the plain name MyDataWriterName is equivalent to specifiying
the fully qualified name implicit::MyDataWriterName
734
Class Documentation
The com.rti.dds.publication.DataWriter (p. 557) is only looked up within

the com.rti.dds.publication.Publisher (p. 1262) specified in the fully
qualified name, or within the implicit com.rti.dds.publication.Publisher
(p. 1262) if the name was not fully qualified.
If there are several com.rti.dds.publication.DataWriter (p. 557) with the
same name within the corresponding com.rti.dds.publication.Publisher
(p. 1262) this function returns the first matching occurrence.
Parameters:
datawriter full name <<in>> ( p. 279) Entity name or fully-qualified
entity name of the com.rti.dds.publication.DataWriter (p. 557).
Returns:
The first com.rti.dds.publication.DataWriter (p. 557) found with the
See also:
com.rti.dds.publication.Publisher.lookup datawriter by name exp (p. 1286)
com.rti.dds.domain.DomainParticipant.lookup publisher by name exp (p. 731)
8.64.3.53
abstract DataReader lookup datareader by name exp

(String datareder full name) [pure virtual]
<<experimental>> ( p. 278) <<eXtension>> ( p. 278) Retrieves up a

com.rti.dds.subscription.DataReader (p. 487) by its entity name in this
Every com.rti.dds.subscription.DataReader (p. 487) in the system has an
entity name which is configured and stored in the EntityName policy, ENTITY NAME (p. 74).
Every com.rti.dds.subscription.Subscriber (p. 1476) in the system has an
entity name which is configured and stored in the <<eXtension>> ( p. 278)
GROUP DATA policy. This is a temporary situation situation while the function is in experimental state.
This operation retrieves a com.rti.dds.subscription.DataReader (p. 487)
within a com.rti.dds.subscription.Subscriber (p. 1476) given the specified name which encodes both to the com.rti.dds.subscription.DataReader
(p. 487) and the com.rti.dds.subscription.Subscriber (p. 1476) name.
The specified name might be given as a fully-qualified entity name or as a plain
name.
735
The fully qualified entity name is a concatenation of the

to
which
the
(p. 1476)
com.rti.dds.subscription.DataReader (p. 487) belongs and the entity name
of of the com.rti.dds.subscription.DataReader (p. 487) itself, separated by
a double colon ::. For example: MySubscriberName.MyDataReaderName
The plain name contains the com.rti.dds.subscription.DataReader
(p. 487) name only.
In this situation it is implied that the
com.rti.dds.subscription.DataReader (p. 487) belongs to the implicit com.rti.dds.subscription.Subscriber (p. 1476) so the use of a
plain name is equivalent to specifying a fully qualified name with the
com.rti.dds.subscription.Subscriber (p. 1476) name part being implicit.
For example: the plain name MyDataReaderName is equivalent to specifiying
the fully qualified name implicit::MyDataReaderName
The com.rti.dds.subscription.DataReader (p. 487) is only looked up within
the com.rti.dds.subscription.Subscriber (p. 1476) specified in the fully
qualified name, or within the implicit com.rti.dds.subscription.Subscriber
(p. 1476) if the name was not fully qualified.
If there are several com.rti.dds.subscription.DataReader (p. 487) with the
same name within the corresponding com.rti.dds.subscription.Subscriber
(p. 1476) this function returns the first matching occurrence.
Parameters:
datareader full name <<in>> ( p. 279) Full entity name of the
Returns:
The first com.rti.dds.subscription.DataReader (p. 487) found with the
See also:
com.rti.dds.subscription.Subscriber.lookup datareader by name exp (p. 1500)
com.rti.dds.domain.DomainParticipant.lookup subscriber by name exp (p. 732)
736
Class Documentation
8.65
DomainParticipantAdapter Class Reference

methods)
Inheritance diagram for DomainParticipantAdapter::

void on inconsistent topic (Topic topic, InconsistentTopicStatus
status)
Handle the com.rti.dds.infrastructure.StatusKind.StatusKind.INCONSISTENT TOPIC STATUS status.



status)


become inactive.
8.65 DomainParticipantAdapter Class Reference
737


handle)
Notifies when an instance is replaced in DataWriter queue.
8.65.1

methods)
8.65.2
8.65.2.1
void on inconsistent topic (Topic topic,

InconsistentTopicStatus status)

This callback is called when a remote com.rti.dds.topic.Topic (p. 1545) is
discovered but is inconsistent with the locally created com.rti.dds.topic.Topic
(p. 1545) of the same topic (p. 359) name.
Parameters:
topic ( p. 359) <<out>>
callback
( p. 279)
(p. 1545) that
Locally
triggers
the
created
listener
status <<out>> ( p. 279) Current inconsistent status of locally created

com.rti.dds.topic.Topic (p. 1545)
Implements TopicListener (p. 1565).

738
Class Documentation
8.65.2.2


This
callback
is
called
when
the
deadline
that
the
instance.
Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers
8.65.2.3


Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers

8.65.2.4
739


This
callback
is
called
when
the
liveliness
that
the
this
entities
will
concom.rti.dds.subscription.DataReader
(p. 487)
sider the com.rti.dds.publication.DataWriter (p. 557) as no longer
Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers

8.65.2.5


Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers

740
Class Documentation
8.65.2.6


become inactive.
Parameters:
writer <<out>>
( p. 279)
Locally
created
8.65.2.7

Parameters:
writer <<out>>
( p. 279)
Locally
created
8.65.2.8

Notifies when an instance is replaced in DataWriter queue.

Parameters:
writer <<out>>
( p. 279)
Locally
(p. 557)
that
created
triggers

741
742
Class Documentation
8.66
ence
Class
Refer-
<<singleton>> ( p. 279) <<interface>> ( p. 279) Allows creation and destruction of com.rti.dds.domain.DomainParticipant (p. 654) objects.

abstract DomainParticipant create participant (int domainId, DomainParticipantQos qos, DomainParticipantListener listener, int
mask)
Creates a new com.rti.dds.domain.DomainParticipant ( p. 654) object.
abstract
void
participant)
delete participant
(DomainParticipant
a-
Deletes an existing com.rti.dds.domain.DomainParticipant ( p. 654).
abstract void get default participant qos (DomainParticipantQos

qos)
Initializes the com.rti.dds.domain.DomainParticipantQos ( p. 773) instance with default values.
abstract void set default participant qos (DomainParticipantQos

qos)
Sets the default com.rti.dds.domain.DomainParticipantQos ( p. 773)
values for this domain ( p. 328) participant factory.
abstract void set default participant qos with profile (String library name, String profile name)
<<eXtension>>
(p. 278)
Sets
the
default
com.rti.dds.domain.DomainParticipantQos
( p. 773)
values
for
this domain ( p. 328) participant factory based on the input XML QoS
profile.
abstract DomainParticipant lookup participant (int domainId)

Locates an existing com.rti.dds.domain.DomainParticipant ( p. 654).
abstract void get qos (DomainParticipantFactoryQos qos)

Gets the value for participant factory QoS.
abstract void set qos (DomainParticipantFactoryQos qos)

Sets the value for a participant factory QoS.
8.66 DomainParticipantFactory Class Reference
743
abstract void load profiles ()

<<eXtension>> (p. 278) Loads the XML QoS profiles.
abstract void reload profiles ()

<<eXtension>> (p. 278) Reloads the XML QoS profiles.
abstract void unload profiles ()

<<eXtension>> (p. 278) Unloads the XML QoS profiles.
abstract String get default library ()

com.rti.dds.domain.DomainParticipantFactory ( p. 742).
abstract void set default library (String library name)

<<eXtension>> (p. 278) Sets the default XML library
for
abstract String get default profile ()

abstract void set default profile (String library name, String profile name)
<<eXtension>> (p. 278) Sets the default XML profile
for
abstract String get default profile library ()

<<eXtension>> (p. 278) Gets the library where the default XML profile is contained for a com.rti.dds.domain.DomainParticipantFactory
( p. 742).
abstract void get participant qos from profile (DomainParticipantQos qos, String library name, String profile name)
<<eXtension>> (p. 278) Gets the com.rti.dds.domain.DomainParticipantQos
( p. 773) values associated with the input XML QoS profile.
abstract void get publisher qos from profile (PublisherQos qos,

String library name, String profile name)
<<eXtension>> (p. 278) Gets the com.rti.dds.publication.PublisherQos
abstract void get subscriber qos from profile (SubscriberQos qos,

744
Class Documentation
<<eXtension>> (p. 278) Gets the com.rti.dds.subscription.SubscriberQos
abstract void get datawriter qos from profile (DataWriterQos qos,

<<eXtension>> (p. 278) Gets the com.rti.dds.publication.DataWriterQos
abstract
void
get datawriter qos from profile w topic name
(DataWriterQos qos, String library name, String profile name, String
topic name)
<<eXtension>> (p. 278) Gets the com.rti.dds.publication.DataWriterQos
( p. 610) values associated with the input XML QoS profile while applying
topic ( p. 359) filters to the input topic ( p. 359) name.
abstract void get datareader qos from profile (DataReaderQos

qos, String library name, String profile name)
<<eXtension>> (p. 278) Gets the com.rti.dds.subscription.DataReaderQos
abstract
void
get datareader qos from profile w topic name
(DataReaderQos qos, String library name, String profile name, String
topic name)
<<eXtension>> (p. 278) Gets the com.rti.dds.subscription.DataReaderQos
abstract void get topic qos from profile (TopicQos qos, String library name, String profile name)
<<eXtension>> (p. 278) Gets the com.rti.dds.topic.TopicQos
abstract void get topic qos from profile w topic name (TopicQos
qos, String library name, String profile name, String topic name)
<<eXtension>> (p. 278) Gets the com.rti.dds.topic.TopicQos
abstract void get qos profile libraries (StringSeq library names)

<<eXtension>> (p. 278) Gets the names of all XML QoS profile libraries
associated with the com.rti.dds.domain.DomainParticipantFactory
( p. 742)
abstract void get qos profiles (StringSeq profile names, String library name)
745
<<eXtension>> (p. 278) Gets the names of all XML QoS profiles associated with the input XML QoS profile library.
abstract DomainParticipant create participant with profile (int

domainId, String library name, String profile name, DomainParticipantListener listener, int mask)
<<eXtension>>
(p. 278)
Creates
a
new
com.rti.dds.domain.DomainParticipant ( p. 654) object using the
com.rti.dds.domain.DomainParticipantQos ( p. 773) associated with
the input XML QoS profile.
abstract void unregister thread ()

<<eXtension>> (p. 278) Allows the user to release thread specific resources
kept by the middleware.
abstract DomainParticipant create participant from config exp

(String configuration name, String participant name)
abstract DomainParticipant lookup participant by name exp
(String participant name)
com.rti.dds.domain.DomainParticipant ( p. 654) by its entity name in
the com.rti.dds.domain.DomainParticipantFactory ( p. 742).
abstract void register type support exp

support, String type name)
(TypeSupport
type -
<<experimental>>
(p. 278)
<<eXtension>>
(p. 278)
Registers
a
com.rti.dds.topic.TypeSupport
( p. 1665)
with
the
com.rti.dds.domain.DomainParticipantFactory ( p. 742) to enable
automatic registration if the corresponding type, should it be needed by a

static final DomainParticipantFactory get instance ()
Gets the singleton instance of this class.
static final void finalize instance ()

<<eXtension>> (p. 278) Destroys the singleton instance of this class.

static
final
DEFAULT
PARTICIPANT QOS -
746
Class Documentation
Special value for creating a DomainParticipant ( p. 654) with default QoS.
static DomainParticipantFactory TheParticipantFactory = create singletonI()

Can be used as an alias for the singleton factory returned by the operation com.rti.dds.domain.DomainParticipantFactory.get instance()
( p. 747).
8.66.1
<<singleton>> ( p. 279) <<interface>> ( p. 279) Allows creation and destruction of com.rti.dds.domain.DomainParticipant (p. 654) objects.
The sole purpose of this class is to allow the creation and destruction of
com.rti.dds.domain.DomainParticipant (p. 654) objects. This class itself
is a <<singleton>> ( p. 279), and accessed via the get instance() (p. 747)
method, and destroyed with finalize instance() (p. 747) method.
A single application can participate in multiple domains by instantiating multiple com.rti.dds.domain.DomainParticipant (p. 654) objects.
An application may even instantiate multiple participants in the same domain
(p. 328). Participants in the same domain (p. 328) exchange data in the same
way regardless of whether they are in the same application or different applications or on the same node or different nodes; their location is transparent.
There are two important caveats:
When there are multiple participants on the same node (in the same
application or different applications) in the same domain (p. 328),
the application(s) must make sure that the participants do not try
to bind to the same port numbers. You must disambiguate between
the participants by setting a participant ID for each participant
(com.rti.dds.infrastructure.WireProtocolQosPolicy.participant id (p. 1728)). The port numbers used by a participant are calculated
based on both the participant index and the domain (p. 328) ID, so if
all participants on the same node have different participant indexes, they
can coexist in the same domain (p. 328).
You cannot mix entities from different participants. For example, you
cannot delete a topic (p. 359) on a different participant than you created
it from, and you cannot ask a subscriber to create a reader for a topic
(p. 359) created from a participant different than the subscribers own participant. (Note that it is permissable for an application built on top of
RTI Connext to know about entities from different participants. For example, an application could keep references to a reader from one domain
747
(p. 328) and a writer from another and then bridge the domains by writing
the data received in the reader callback.)
See also:
8.66.2
8.66.2.1
static final DomainParticipantFactory get instance ()

[static]

MT Safety:
On
non-Linux
systems:
UNSAFE
for
multiple
threads
to
simultaneously
make
the
FIRST
call
to
either
com.rti.dds.domain.DomainParticipantFactory.get instance()
(p. 747) or com.rti.dds.domain.DomainParticipantFactory.finalize instance() (p. 747). Subsequent calls are thread safe. (On Linux systems,
these calls are thread safe.)
com.rti.dds.domain.DomainParticipantFactory.TheParticipantFactory
(p. 148) can be used as an alias for the singleton factory returned by this
operation.
Returns:
The
singleton
(p. 742) instance.
See also:
com.rti.dds.domain.DomainParticipantFactory.TheParticipantFactory
(p. 148)
8.66.2.2
static final void finalize instance () [static]
<<eXtension>> ( p. 278) Destroys the singleton instance of this class.

Only necessary to explicitly reclaim resources used by the participant factory
singleton. Note that on many OSs, these resources are automatically reclaimed
by the OS when the program terminates. However, some memory-check tools
still flag these as unreclaimed. So this method provides a way to clean up
memory used by the participant factory.
748
Class Documentation
Precondition:
All participants created from the factory have been deleted.
Postcondition:
All resources belonging to the factory have been reclaimed. Another
call to com.rti.dds.domain.DomainParticipantFactory.get instance
(p. 747) will return a new lifecycle of the singleton.
MT Safety:
On
non-Linux
systems:
UNSAFE
for
multiple
threads
to
simultaneously
make
the
FIRST
call
to
either
com.rti.dds.domain.DomainParticipantFactory.get instance()
(p. 747) or com.rti.dds.domain.DomainParticipantFactory.finalize instance() (p. 747). Subsequent calls are thread safe. (On Linux systems,
these calls are thread safe.)
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.66.2.3
abstract DomainParticipant create participant

(int domainId, DomainParticipantQos qos,
DomainParticipantListener listener, int mask) [pure
virtual]
Creates a new com.rti.dds.domain.DomainParticipant (p. 654) object.

Precondition:
The specified QoS policies must be consistent or the operation will fail and
no com.rti.dds.domain.DomainParticipant (p. 654) will be created.
If you want to create multiple participants on a given host in the same domain (p. 328), make sure each one has a different participant index (set in
the com.rti.dds.infrastructure.WireProtocolQosPolicy (p. 1723)). This
in turn will ensure each participant uses a different port number (since the unicast port numbers are calculated from the participant index and the domain
(p. 328) ID).
Note that if there is a single participant per host in a given domain (p. 328),
the participant index can be left at the default value (-1).
749
Parameters:
domainId <<in>> ( p. 279) ID of the domain (p. 328) that the application intends to join. [range] [>=0], and does not violate guidelines
stated in com.rti.dds.infrastructure.RtpsWellKnownPorts t
(p. 1390).
qos <<in>> ( p. 279) the DomainParticipants QoS. The special value
com.rti.dds.domain.DomainParticipantFactory.PARTICIPANT QOS DEFAULT
(p. 149)
can
be
used
to
indicate
that
the
should
be
created
with
the
default
(p. 654)
com.rti.dds.domain.DomainParticipantQos (p. 773) set in
the com.rti.dds.domain.DomainParticipantFactory (p. 742).
Cannot be NULL.
listener <<in>> ( p. 279) the domain (p. 328) participants listener.
Returns:
domain (p. 328) participant or NULL on failure
See also:
entity creation
com.rti.dds.domain.DomainParticipantFactory.create participant with profile() (p. 764)
com.rti.dds.domain.DomainParticipant.set listener() (p. 709)
8.66.2.4
abstract void delete participant (DomainParticipant

a participant) [pure virtual]
Deletes an existing com.rti.dds.domain.DomainParticipant (p. 654).

Precondition:
All domain (p. 328) entities belonging to the participant must
have already been deleted.
Otherwise it fails with the error
750
Class Documentation
Postcondition:
Listener installed on the com.rti.dds.domain.DomainParticipant
(p. 654) will not be called after this method returns successfully.
Parameters:
a participant <<in>> ( p. 279) com.rti.dds.domain.DomainParticipant
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.66.2.5
abstract void get default participant qos

(DomainParticipantQos qos) [pure virtual]
Initializes the com.rti.dds.domain.DomainParticipantQos (p. 773) instance with default values.

call to com.rti.dds.domain.DomainParticipantFactory.set default participant qos (p. 751), or com.rti.dds.domain.DomainParticipantFactory.set (p. 752),
or
else,
if
default participant qos with profile
the
call
was
never
made,
the
default
values
listed
in
com.rti.dds.domain.DomainParticipantQos (p. 773).
Parameters:
qos <<out>> ( p. 279) the domain (p. 328) participants QoS Cannot be
NULL.
MT Safety:
UNSAFE. It is not safe to retrieve the default QoS value from a domain (p. 328) participant factory while another thread may be simultaneously calling com.rti.dds.domain.DomainParticipantFactory.set default participant qos (p. 751)
751
Exceptions:
See also:
8.66.2.6
abstract void set default participant qos

(DomainParticipantQos qos) [pure virtual]
Sets the default com.rti.dds.domain.DomainParticipantQos (p. 773) values for this domain (p. 328) participant factory.
MT Safety:
Parameters:
qos <<inout>> ( p. 279) Qos to be filled up.
The special value
com.rti.dds.domain.DomainParticipantFactory.PARTICIPANT QOS DEFAULT (p. 149) may be passed as qos to indicate that the
default QoS should be reset back to the initial values the factory would
used if com.rti.dds.domain.DomainParticipantFactory.set default participant qos (p. 751) had never been called. Cannot be
NULL.
Exceptions:
See also:
752
Class Documentation
8.66.2.7
abstract void set default participant qos with profile

(String library name, String profile name) [pure
virtual]
Sets
the
default
<<eXtension>>
( p. 278)
com.rti.dds.domain.DomainParticipantQos (p. 773) values for this
domain (p. 328) participant factory based on the input XML QoS profile.
This
default
value
will
be
used
for
newly
created
(p. 654)
if
com.rti.dds.domain.DomainParticipantFactory.PARTICIPANT QOS DEFAULT (p. 149) is specified as the qos parameter when
com.rti.dds.domain.DomainParticipantFactory.create participant
(p. 748) is called.
Precondition:
The com.rti.dds.domain.DomainParticipantQos (p. 773) contained in
MT Safety:
Parameters:
fails
with
(p. 108),
or
Exceptions:
One of
the
Standard
Return
Codes
753

See also:
8.66.2.8
abstract DomainParticipant lookup participant (int

domainId) [pure virtual]
Locates an existing com.rti.dds.domain.DomainParticipant (p. 654).

If no such com.rti.dds.domain.DomainParticipant (p. 654) exists, the operation will return NULL value.
If multiple com.rti.dds.domain.DomainParticipant (p. 654) entities belonging to that domainId exist, then the operation will return one of them.
It is not specified which one.
Parameters:
domainId <<in>> ( p. 279) ID of the domain (p. 328) participant to
lookup.
Returns:
domain (p. 328) participant if it exists, or NULL
8.66.2.9
abstract void get qos (DomainParticipantFactoryQos qos)

[pure virtual]
Gets the value for participant factory QoS.

Parameters:
Exceptions:
754
Class Documentation
8.66.2.10
abstract void set qos (DomainParticipantFactoryQos qos)

[pure virtual]
Sets the value for a participant factory QoS.

The com.rti.dds.domain.DomainParticipantFactoryQos.entity factory
(p. 769) can be changed. The other policies are immutable.
Note that despite having QoS, the com.rti.dds.domain.DomainParticipantFactory
(p. 742) is not an com.rti.dds.infrastructure.Entity (p. 931).
Parameters:
qos <<in>> ( p. 279) Set of policies to be applied to
(p. 742).
Immutable policies can only be
changed before calling any other RTI Connext methods except
for
com.rti.dds.domain.DomainParticipantFactory.get qos
(p. 753) Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
See also:
com.rti.dds.domain.DomainParticipantFactoryQos (p. 769) for rules
on consistency among QoS
8.66.2.11
abstract void load profiles () [pure virtual]
<<eXtension>> ( p. 278) Loads the XML QoS profiles.

The XML QoS profiles are loaded implicitly after the first
com.rti.dds.domain.DomainParticipant (p. 654) is created or explicitly, after a call to this method.
This has the same effect as com.rti.dds.domain.DomainParticipantFactory.reload profiles() (p. 755).
Exceptions:
755
See also:
com.rti.dds.infrastructure.ProfileQosPolicy (p. 1231)
8.66.2.12
abstract void reload profiles () [pure virtual]
<<eXtension>> ( p. 278) Reloads the XML QoS profiles.

The XML QoS profiles are loaded implicitly after the first
com.rti.dds.domain.DomainParticipant (p. 654) is created or explicitly, after a call to this method.
This has the same effect as com.rti.dds.domain.DomainParticipantFactory.load profiles() (p. 754).
Exceptions:
See also:
8.66.2.13
abstract void unload profiles () [pure virtual]
<<eXtension>> ( p. 278) Unloads the XML QoS profiles.

The resources associated with the XML QoS profiles are freed. Any reference
to the profiles after calling this method will fail with an error.
Exceptions:
See also:
8.66.2.14
abstract String get default library () [pure virtual]

com.rti.dds.domain.DomainParticipantFactory (p. 742).
Returns:
756
Class Documentation
See also:
com.rti.dds.domain.DomainParticipantFactory.set default library (p. 756)
8.66.2.15
abstract void set default library (String library name)

[pure virtual]
<<eXtension>> ( p. 278) Sets the default XML library

for
default library.
See also:
com.rti.dds.domain.DomainParticipantFactory.set default profile
(p. 757) for more information.
Parameters:
Exceptions:
See also:
com.rti.dds.domain.DomainParticipantFactory.get default library (p. 755)
8.66.2.16
abstract String get default profile () [pure virtual]

Returns:
See also:
(p. 757)

8.66.2.17
757
abstract void set default profile (String library name,

String profile name) [pure virtual]
<<eXtension>> ( p. 278) Sets the default XML profile

for
This method specifies the profile that will be used as the default the next
time a default DomainParticipantFactory (p. 742) profile is needed during a call to a DomainParticipantFactory (p. 742) method. When calling a
com.rti.dds.domain.DomainParticipantFactory (p. 742) method that requires a profile name parameter, you can use NULL to refer to the default
profile. (This same information applies to setting a default library.)
This
method
does
not
set
the
default
QoS
for
newly
created
DomainParticipants;
for
this
functionality,
use
com.rti.dds.domain.DomainParticipantFactory.set default participant qos with profile (p. 752) (you may pass in NULL after
having called set default profile() (p. 757)).
Parameters:
Exceptions:
See also:
com.rti.dds.domain.DomainParticipantFactory.get default profile (p. 756)
com.rti.dds.domain.DomainParticipantFactory.get default profile library (p. 757)
8.66.2.18
abstract String get default profile library () [pure

virtual]
<<eXtension>> ( p. 278) Gets the library where the default XML profile is
contained for a com.rti.dds.domain.DomainParticipantFactory (p. 742).
The
default
profile
library
is
automatically
set
when
(p. 757) is called.
This library can be different than the com.rti.dds.domain.DomainParticipantFactory
(p. 742) default library (see com.rti.dds.domain.DomainParticipantFactory.get default library (p. 755)).
758
Class Documentation
Returns:
See also:
(p. 757)
8.66.2.19
abstract void get participant qos from profile

(DomainParticipantQos qos, String library name, String
profile name) [pure virtual]
<<eXtension>> ( p. 278) Gets the com.rti.dds.domain.DomainParticipantQos

(p. 773) values associated with the input XML QoS profile.
Parameters:
qos <<out>> ( p. 279) Qos to be filled up. Cannot be NULL.
fails
with
Exceptions:
8.66.2.20
abstract void get publisher qos from profile

(PublisherQos qos, String library name, String
<<eXtension>> ( p. 278) Gets the com.rti.dds.publication.PublisherQos

Parameters:
759
fails
with
Exceptions:
8.66.2.21
abstract void get subscriber qos from profile

(SubscriberQos qos, String library name, String
<<eXtension>> ( p. 278) Gets the com.rti.dds.subscription.SubscriberQos

Parameters:
fails
Exceptions:
with
760
Class Documentation
8.66.2.22
abstract void get datawriter qos from profile

(DataWriterQos qos, String library name, String
<<eXtension>> ( p. 278) Gets the com.rti.dds.publication.DataWriterQos

Parameters:
fails
with
Exceptions:
8.66.2.23
abstract void get datawriter qos from profile w topic name (DataWriterQos qos, String library name, String
profile name, String topic name) [pure virtual]
<<eXtension>> ( p. 278) Gets the com.rti.dds.publication.DataWriterQos

(p. 610) values associated with the input XML QoS profile while applying topic
(p. 359) filters to the input topic (p. 359) name.
Parameters:
761
topic name <<in>> ( p. 279) Topic name that will be evaluated against
the topic filter attribute in the XML QoS profile. If topic name is
null, RTI Connext will match only QoSs without explicit topic filter
expressions.
fails
with
Exceptions:
8.66.2.24
abstract void get datareader qos from profile

(DataReaderQos qos, String library name, String
<<eXtension>> ( p. 278) Gets the com.rti.dds.subscription.DataReaderQos

Parameters:
fails
with
Exceptions:
8.66.2.25
abstract void get datareader qos from profile w topic name (DataReaderQos qos, String library name, String
profile name, String topic name) [pure virtual]
<<eXtension>> ( p. 278) Gets the com.rti.dds.subscription.DataReaderQos

(p. 536) values associated with the input XML QoS profile while applying topic
(p. 359) filters to the input topic (p. 359) name.
762
Class Documentation
Parameters:
expressions.
fails
with
Exceptions:
8.66.2.26
abstract void get topic qos from profile (TopicQos

qos, String library name, String profile name) [pure
virtual]
<<eXtension>> ( p. 278) Gets the com.rti.dds.topic.TopicQos (p. 1566)

values associated with the input XML QoS profile.
Parameters:
fails
with
763
Exceptions:
8.66.2.27
abstract void get topic qos from profile w topic name

(TopicQos qos, String library name, String profile name,
String topic name) [pure virtual]
<<eXtension>> ( p. 278) Gets the com.rti.dds.topic.TopicQos (p. 1566)

values associated with the input XML QoS profile while applying topic (p. 359)
filters to the input topic (p. 359) name.
Parameters:
expressions.
fails
with
Exceptions:
8.66.2.28
abstract void get qos profile libraries (StringSeq

library names) [pure virtual]
<<eXtension>> ( p. 278) Gets the names of all XML QoS profile libraries associated with the com.rti.dds.domain.DomainParticipantFactory (p. 742)
Parameters:
library names <<out>> ( p. 279) com.rti.dds.infrastructure.StringSeq
(p. 1467) to be filled with names of XML QoS profile libraries. Cannot
be NULL.
764
Class Documentation
8.66.2.29
abstract void get qos profiles (StringSeq profile names,

String library name) [pure virtual]
<<eXtension>> ( p. 278) Gets the names of all XML QoS profiles associated
with the input XML QoS profile library.
Parameters:
profile names <<out>> ( p. 279) com.rti.dds.infrastructure.StringSeq
(p. 1467) to be filled with names of XML QoS profiles. Cannot be
NULL.
8.66.2.30
abstract DomainParticipant create participant with profile (int domainId, String library name, String
profile name, DomainParticipantListener listener, int
mask) [pure virtual]
<<eXtension>> ( p. 278) Creates a new com.rti.dds.domain.DomainParticipant

(p. 654) object using the com.rti.dds.domain.DomainParticipantQos
(p. 773) associated with the input XML QoS profile.
Precondition:
The com.rti.dds.domain.DomainParticipantQos (p. 773) in the input profile must be consistent, or the operation will fail and no
com.rti.dds.domain.DomainParticipant (p. 654) will be created.
If you want to create multiple participants on a given host in the same domain (p. 328), make sure each one has a different participant index (set in
the com.rti.dds.infrastructure.WireProtocolQosPolicy (p. 1723)). This
in turn will ensure each participant uses a different port number (since the unicast port numbers are calculated from the participant index and the domain
(p. 328) ID).
Note that if there is a single participant per host in a given domain (p. 328),
the participant index can be left at the default value (-1).
Parameters:
domainId <<in>> ( p. 279) ID of the domain (p. 328) that the application intends to join. [range] [>=0], and does not violate guidelines
stated in com.rti.dds.infrastructure.RtpsWellKnownPorts t
(p. 1390).
765
listener <<in>> ( p. 279) the DomainParticipants listener.
Returns:
domain (p. 328) participant or NULL on failure
See also:
entity creation
com.rti.dds.domain.DomainParticipantFactory.create participant() (p. 748)
com.rti.dds.domain.DomainParticipant.set listener() (p. 709)
8.66.2.31
abstract void unregister thread () [pure virtual]
<<eXtension>> ( p. 278) Allows the user to release thread specific resources

kept by the middleware.
This function should be called by the user right before exiting a thread where
DDS API were used. In this way the middleware will be able to free all the
resources related to this specific thread. The best approach is to call the function
during the thread deletion after all the DDS related API have have been called.
Exceptions:
766
Class Documentation
8.66.2.32
abstract DomainParticipant create participant from config exp (String configuration name, String
participant name) [pure virtual]
DomainParticipantFactory create participant from config

8.66.2.33
abstract DomainParticipant lookup participant by name exp (String participant name) [pure
virtual]

com.rti.dds.domain.DomainParticipant (p. 654) by its entity name in the
Every com.rti.dds.domain.DomainParticipant (p. 654) in the system has
an entity name which is configured and stored in the EntityName policy, ENTITY NAME (p. 74).
This operation retrieves a com.rti.dds.domain.DomainParticipant
(p. 654) within the com.rti.dds.domain.DomainParticipantFactory
(p. 742)
given
the
entitys
name.
If
there
are
several
com.rti.dds.domain.DomainParticipant (p. 654) with the same name
within the com.rti.dds.domain.DomainParticipantFactory (p. 742) this
function returns the first matching occurrence.
Parameters:
participant name <<in>>
( p. 279)
Entity
name
of
the
Returns:
The first com.rti.dds.domain.DomainParticipant (p. 654) found with
the specified name or NULL if it is not found.
8.66.2.34
abstract void register type support exp (TypeSupport

type support, String type name) [pure virtual]
<<experimental>>
( p. 278)
<<eXtension>>
( p. 278)
Registers
a
(p. 1665)
with
the
com.rti.dds.domain.DomainParticipantFactory (p. 742) to enable
automatic registration if the corresponding type, should it be needed by a
Types refered by the com.rti.dds.topic.Topic (p. 1545) entities within a
com.rti.dds.domain.DomainParticipant (p. 654) must be registered with
767
Type registration in a com.rti.dds.domain.DomainParticipant (p. 654) is

performed by a call to the com.rti.ndds.example.FooTypeSupport.register type (p. 1037) operation. This can be done directly from the application code
or indirectly by the RTI Connext infrastructure (p. 334) as a result of parsing
an XML configuration file that refers to that type.
The
com.rti.dds.domain.DomainParticipantFactory.register type support exp
(p. 766)
operation
provides
the
(p. 742)
with
the
information
it
needs
to
automatically
call
the
(p. 1037)
opcom.rti.ndds.example.FooTypeSupport.register type
eration and register the corresponding type if the type is needed as a result of
parsing an XML configuration file.
Automatic type registration while parsing XML files can also be done by the
RTI Connext infrastructure (p. 334) based on the type description provided in
the XML files. If the com.rti.dds.topic.TypeSupport (p. 1665) has been registered with the com.rti.dds.domain.DomainParticipantFactory (p. 742)
this definition takes precedence over the description of the type given in the
XML file.
The
com.rti.dds.domain.DomainParticipantFactory.register type support exp
(p. 766)
operation
receives
a
com.rti.ndds.example.FooTypeSupport (p. 1036) object as a parameter. This objects class is normally generated using rtiddsgen from a
description of the corresponsing type in IDL, XML, or XSD.
The typical workflow when using this function is as follows: Define the
data-type in IDL (or XML, or XSD) in a file. E.g. Foo.idl Run rtiddsgen in that file to generate the TypeSuppory files, for the desired programming language. E.g. in C++ FooTypeSupport.h FooTypeSupport.cxx
Include the proper header file (e.g. FooTypeSupport.h) in your program
and call com.rti.dds.domain.DomainParticipantFactory.register type support exp (p. 766) passing the function that was generated by rtiddsgen.
E.g. FooTypeSupport.register type Include the TypeSupport source file in your
project such that it is compiled and linked. E.g. FooTypeSupport.cxx
You may refer to the Getting Started Guide for additional details in this
process.
Note that only one register function is allowed per registered type name.
Parameters:
type support <<in>> ( p. 279) com.rti.dds.topic.TypeSupport
(p. 1665) object to be used for registering the type with a
768
Class Documentation
Parameters:
type name <<in>> ( p. 279) Name the type is registered with.
Exceptions:
8.67 DomainParticipantFactoryQos Class Reference
8.67
769
DomainParticipantFactoryQos Class Reference

(p. 742).
Inheritance diagram for DomainParticipantFactoryQos::
Public Attributes
final EntityFactoryQosPolicy entity factory
Entity factory policy, ENTITY FACTORY ( p. 73).
final SystemResourceLimitsQosPolicy resource limits

<<eXtension>> (p. 278) System
RESOURCE LIMITS ( p. 115).
resource
limits,
SYSTEM -
final ProfileQosPolicy profile

<<eXtension>> (p. 278) Qos profile policy, PROFILE ( p. 91).
final LoggingQosPolicy logging

<<eXtension>> (p. 278) Logging qos policy, LOGGING ( p. 84).
8.67.1

(p. 742).
Entity:
See also:
QoS Policies (p. 94) and allowed ranges within each Qos.
8.67.2
8.67.2.1
Entity factory policy, ENTITY FACTORY (p. 73).

770
Class Documentation
8.67.2.2
final SystemResourceLimitsQosPolicy resource limits
System
RESOURCE LIMITS (p. 115).
8.67.2.3
resource
limits,
SYSTEM -
final ProfileQosPolicy profile
<<eXtension>> ( p. 278) Qos profile policy, PROFILE (p. 91).

8.67.2.4
final LoggingQosPolicy logging
<<eXtension>> ( p. 278) Logging qos policy, LOGGING (p. 84).
8.68 DomainParticipantListener Interface Reference
8.68
771
DomainParticipantListener Interface Reference
<<interface>> ( p. 279) Listener for participant status.

Inheritance diagram for DomainParticipantListener::
8.68.1
<<interface>> ( p. 279) Listener for participant status.

Entity:
Status:
This is the interface that can be implemented by an application-provided
class and then registered with the com.rti.dds.domain.DomainParticipant
(p. 654) such that the application can be notified by RTI Connext of relevant
status changes.
The com.rti.dds.domain.DomainParticipantListener (p. 771) interface
extends all other Listener interfaces and has no additional operation beyond
the ones defined by the more general listeners.
The purpose of the com.rti.dds.domain.DomainParticipantListener
(p. 771) is to be the listener of last resort that is notified of all status changes not captured by more specific listeners attached to the
com.rti.dds.infrastructure.DomainEntity (p. 653) objects. When a relevant status change occurs, RTI Connext will first attempt to notify the listener attached to the concerned com.rti.dds.infrastructure.DomainEntity
(p. 653) if one is installed. Otherwise, RTI Connext will notify the Listener
attached to the com.rti.dds.domain.DomainParticipant (p. 654).
Important: Because a com.rti.dds.domain.DomainParticipantListener
(p. 771) may receive callbacks pertaining to many different entities, it is possible for the same listener to receive multiple callbacks simultaneously in different
threads. (Such is not the case for listeners of other types.) It is therefore critical
that users of this listener provide their own protection for any thread-unsafe activities undertaken in a com.rti.dds.domain.DomainParticipantListener
(p. 771) callback.
772
Class Documentation
Note: Due to a thread-safety issue, the destruction of a DomainParticipantListener (p. 771) from an enabled DomainParticipant (p. 654) should
be avoided even if the DomainParticipantListener (p. 771) has been removed from the DomainParticipant (p. 654). (This limitation does not affect
the Java API.)
See also:
com.rti.dds.domain.DomainParticipant.set listener (p. 709)
8.69 DomainParticipantQos Class Reference
8.69
773
DomainParticipantQos Class Reference

(p. 654) entity.
Inheritance diagram for DomainParticipantQos::
Public Attributes

final WireProtocolQosPolicy wire protocol

<<eXtension>> (p. 278) Wire Protocol policy, WIRE PROTOCOL
( p. 134).
final TransportBuiltinQosPolicy transport builtin

<<eXtension>> (p. 278) Transport Builtin policy, TRANSPORT BUILTIN ( p. 119).
final TransportUnicastQosPolicy default unicast

<<eXtension>> (p. 278) Default Unicast Transport policy, TRANSPORT UNICAST ( p. 128).
final DiscoveryQosPolicy discovery

<<eXtension>> (p. 278) Discovery policy, DISCOVERY ( p. 56).
final DomainParticipantResourceLimitsQosPolicy
limits
resource -
<<eXtension>> (p. 278) Domain participant resource limits policy, DOMAIN PARTICIPANT RESOURCE LIMITS ( p. 66).
final EventQosPolicy event

<<eXtension>> (p. 278) Event policy, EVENT ( p. 75).
final ReceiverPoolQosPolicy receiver pool

<<eXtension>> (p. 278) Receiver pool policy, RECEIVER POOL
( p. 104).
774
Class Documentation
final DatabaseQosPolicy database
<<eXtension>> (p. 278) Database policy, DATABASE ( p. 46).
final DiscoveryConfigQosPolicy discovery config

<<eXtension>> (p. 278) Discovery config policy,
CONFIG ( p. 54).
DISCOVERY -

final EntityNameQosPolicy participant name

<<eXtension>> (p. 278) The participant name.
( p. 74)
ENTITY NAME

<<eXtension>> (p. 278) Type support data, TYPESUPPORT ( p. 130).
final TransportMulticastMappingQosPolicy multicast mapping

<<eXtension>> (p. 278) The multicast mapping policy. TRANSPORT MULTICAST MAPPING ( p. 122)
8.69.1

(p. 654) entity.
Certain members must be set in a consistent manner:
Length of com.rti.dds.domain.DomainParticipantQos.user data (p. 775)
.value <= com.rti.dds.domain.DomainParticipantQos.resource limits
(p. 776) .participant user data max length
For
com.rti.dds.domain.DomainParticipantQos.discovery config
(p. 776) .publication writer
high watermark <= com.rti.dds.domain.DomainParticipantQos.resource limits (p. 776) .local writer allocation .max count heartbeats per max samples
<= com.rti.dds.domain.DomainParticipantQos.resource limits (p. 776)
.local writer allocation.max count
For
(p. 776) .suscription writer
high watermark <= com.rti.dds.domain.DomainParticipantQos.resource limits (p. 776) .local reader allocation.max count heartbeats per max samples
775
<= com.rti.dds.domain.DomainParticipantQos.resource limits (p. 776)

.local reader allocation.max count
If any of the above are not true, com.rti.dds.domain.DomainParticipant.set qos (p. 705) and com.rti.dds.domain.DomainParticipant.set qos with profile (p. 706) and com.rti.dds.domain.DomainParticipantFactory.set default participant qos
(p. 751)
will
fail
with
(p. 1359), and com.rti.dds.domain.DomainParticipantFactory.create participant (p. 748) will fail.
Entity:
See also:
QoS Policies (p. 94) and allowed ranges within each Qos.
8.69.2
8.69.2.1
8.69.2.2
8.69.2.3
final WireProtocolQosPolicy wire protocol
<<eXtension>> ( p. 278) Wire Protocol policy, WIRE PROTOCOL

(p. 134).
The wire protocol (RTPS) attributes associated with the participant.
8.69.2.4
final TransportBuiltinQosPolicy transport builtin
<<eXtension>> ( p. 278) Transport Builtin policy,

BUILTIN (p. 119).
TRANSPORT -
776
Class Documentation
8.69.2.5
final TransportUnicastQosPolicy default unicast
<<eXtension>> ( p. 278) Default Unicast Transport policy, TRANSPORT UNICAST (p. 128).
8.69.2.6
final DiscoveryQosPolicy discovery
<<eXtension>> ( p. 278) Discovery policy, DISCOVERY (p. 56).

8.69.2.7
final DomainParticipantResourceLimitsQosPolicy
resource limits
<<eXtension>> ( p. 278) Domain participant resource limits policy, DOMAIN PARTICIPANT RESOURCE LIMITS (p. 66).
8.69.2.8
final EventQosPolicy event
<<eXtension>> ( p. 278) Event policy, EVENT (p. 75).

8.69.2.9
final ReceiverPoolQosPolicy receiver pool
<<eXtension>> ( p. 278) Receiver pool policy,

(p. 104).
8.69.2.10
RECEIVER POOL
final DatabaseQosPolicy database
<<eXtension>> ( p. 278) Database policy, DATABASE (p. 46).

8.69.2.11
final DiscoveryConfigQosPolicy discovery config
<<eXtension>> ( p. 278) Discovery config policy, DISCOVERY CONFIG

(p. 54).
8.69.2.12

8.69.2.13
<<eXtension>> ( p. 278) The participant name. ENTITY NAME (p. 74)


8.69.2.14
777
<<eXtension>> ( p. 278) Type support data, TYPESUPPORT (p. 130).

Optional value that is passed to a type plugins on participant attached function.
8.69.2.15
final TransportMulticastMappingQosPolicy
multicast mapping
<<eXtension>> ( p. 278) The multicast mapping policy. TRANSPORT MULTICAST MAPPING (p. 122)
778
Class Documentation
8.70
DomainParticipantResourceLimitsQosPolicy
Class Reference
Various settings that configure how a com.rti.dds.domain.DomainParticipant

(p. 654) allocates and uses physical memory for internal resources, including
the maximum sizes of various properties.
Inheritance diagram for DomainParticipantResourceLimitsQosPolicy::
Public Attributes
final AllocationSettings t local writer allocation
Allocation settings applied to local DataWriters.
final AllocationSettings t local reader allocation

Allocation settings applied to local DataReaders.
final AllocationSettings t local publisher allocation

Allocation settings applied to local Publisher.
final AllocationSettings t local subscriber allocation

Allocation settings applied to local Subscriber.
final AllocationSettings t local topic allocation

Allocation settings applied to local Topic.
final AllocationSettings t remote writer allocation

Allocation settings applied to remote DataWriters.
final AllocationSettings t remote reader allocation

Allocation settings applied to remote DataReaders.
final AllocationSettings t remote participant allocation

Allocation settings applied to remote DomainParticipants.
final
AllocationSettings t
allocation
matching writer reader pair -
Allocation settings applied to matching local writer and remote/local reader

pairs.
8.70 DomainParticipantResourceLimitsQosPolicy Class Reference779

final
AllocationSettings t
allocation
matching reader writer pair -
Allocation settings applied to matching local reader and remote/local writer

pairs.
final AllocationSettings t ignored entity allocation

Allocation settings applied to ignored entities.
final AllocationSettings t content filtered topic allocation

Allocation settings applied to content filtered topic ( p. 359).
final AllocationSettings t content filter allocation

Allocation settings applied to content filter.
final AllocationSettings t read condition allocation

Allocation settings applied to read condition pool.
final AllocationSettings t query condition allocation

Allocation settings applied to query condition pool.
final AllocationSettings t
allocation
outstanding asynchronous sample -
Allocation settings applied to the maximum number of samples (from

all com.rti.dds.publication.DataWriter ( p. 557)) waiting to be asynchronously written.
final AllocationSettings t flow controller allocation

Allocation settings applied to flow controllers.
int local writer hash buckets

Hash Buckets settings applied to local DataWriters.
int local reader hash buckets

Number of hash buckets for local DataReaders.
int local publisher hash buckets

Number of hash buckets for local Publisher.
int local subscriber hash buckets

Number of hash buckets for local Subscriber.
int local topic hash buckets

Number of hash buckets for local Topic.
780
Class Documentation
int remote writer hash buckets

Number of hash buckets for remote DataWriters.
int remote reader hash buckets

Number of hash buckets for remote DataReaders.
int remote participant hash buckets

Number of hash buckets for remote DomainParticipants.
int matching writer reader pair hash buckets

Number of hash buckets for matching local writer and remote/local reader
pairs.
int matching reader writer pair hash buckets

Number of hash buckets for matching local reader and remote/local writer
pairs.
int ignored entity hash buckets

Number of hash buckets for ignored entities.
int content filtered topic hash buckets

Number of hash buckets for content filtered topics.
int content filter hash buckets

Number of hash buckets for content filters.
int flow controller hash buckets

Number of hash buckets for flow controllers.
int max gather destinations

Maximum number of destinations per RTI Connext send.
int participant user data max length

Maximum length of user data in com.rti.dds.domain.DomainParticipantQos
( p. 773) and builtin.ParticipantBuiltinTopicData.
int topic data max length

Maximum
length
of
topic
( p. 359)
data
in
( p. 1566),
builtin.TopicBuiltinTopicData, builtin.PublicationBuiltinTopicData and
builtin.SubscriptionBuiltinTopicData.

int publisher group data max length
Maximum length of group data in com.rti.dds.publication.PublisherQos
( p. 1290) and builtin.PublicationBuiltinTopicData.
int subscriber group data max length

Maximum length of group data in com.rti.dds.subscription.SubscriberQos
( p. 1505) and builtin.SubscriptionBuiltinTopicData.
int writer user data max length

Maximum length of user data in com.rti.dds.publication.DataWriterQos
( p. 610) and builtin.PublicationBuiltinTopicData.
int reader user data max length

Maximum length of user data in com.rti.dds.subscription.DataReaderQos
( p. 536) and builtin.SubscriptionBuiltinTopicData.
int max partitions

Maximum number of partition name strings allowable
com.rti.dds.infrastructure.PartitionQosPolicy ( p. 1217).
in
int max partition cumulative characters

Maximum number of combined characters allowable in all partition names
in a com.rti.dds.infrastructure.PartitionQosPolicy ( p. 1217).
int type code max serialized length

Maximum size of serialized string for type code.
int
int
int
int
int
type object max serialized length = 3072

serialized type object dynamic allocation threshold = 3072
type object max deserialized length = -1
deserialized type object dynamic allocation threshold = 4096
contentfilter property max length
This field is the maximum length of all data related to a Content-filtered
topic ( p. 359).
int channel seq max length

Maximum
number
of
channels
that
can
be
specified
com.rti.dds.infrastructure.MultiChannelQosPolicy
( p. 1187)
MultiChannel DataWriters.
in
for
int channel filter expression max length

Maximum length of a channel com.rti.dds.infrastructure.ChannelSettings t.filter expression ( p. 455) in a MultiChannel DataWriter.
782
Class Documentation
int participant property list max length
Maximum
number
of
properties
associated
with
the
int participant property string max length

Maximum string length of the properties associated
with
the
with
int writer property list max length

Maximum
number
of
properties
associated
int writer property string max length

Maximum string length of the properties
associated
with
int reader property list max length

Maximum
number
of
properties
associated
with
int reader property string max length

associated
with
int max endpoint groups

Maximum number of com.rti.dds.infrastructure.EndpointGroup t
( p. 928) allowable in a com.rti.dds.infrastructure.AvailabilityQosPolicy
( p. 402).
int max endpoint group cumulative characters

Maximum number of combined role name characters allowable
all
com.rti.dds.infrastructure.EndpointGroup t
( p. 928)
in
com.rti.dds.infrastructure.AvailabilityQosPolicy ( p. 402).
8.70.1
in
a
Various settings that configure how a com.rti.dds.domain.DomainParticipant

(p. 654) allocates and uses physical memory for internal resources, including
the maximum sizes of various properties.
This QoS policy sets maximum size limits on variable-length parameters used
by the participant and its contained Entities. It also controls the initial and

maximum sizes of data structures used by the participant to store information about locally-created and remotely-discovered entities (such as DataWriters/DataReaders), as well as parameters used by the internal database to size
the hash tables it uses.
By default, a com.rti.dds.domain.DomainParticipant (p. 654) is allowed to dynamically allocate memory as needed as users create local Entities such as com.rti.dds.publication.DataWriter (p. 557) and
com.rti.dds.subscription.DataReader (p. 487) objects or as the participant
discovers new applications. By setting fixed values for the maximum parameters in this QoS policy, you can bound the memory that can be allocated by
a com.rti.dds.domain.DomainParticipant (p. 654). In addition, by setting
the initial values to the maximum values, you can prevent DomainParticipants
from allocating memory after the initialization period.
The
maximum
sizes
of
different
variable-length
parameters
such as the number of partitions that can be stored in the
com.rti.dds.infrastructure.PartitionQosPolicy (p. 1217), the maximum
length of data store in the com.rti.dds.infrastructure.UserDataQosPolicy
(p. 1694) and com.rti.dds.infrastructure.GroupDataQosPolicy (p. 1039),
and many others can be changed from their defaults using this QoS policy.
However, it is important that all DomainParticipants that need to communicate
with each other use the same set of maximum values. Otherwise, when these parameters are propagated from one com.rti.dds.domain.DomainParticipant
(p. 654) to another, a com.rti.dds.domain.DomainParticipant (p. 654)
with a smaller maximum length may reject the parameter, resulting in an error.
An important parameter in this QoS policy that is often changed by users is
com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.type code max serialized length (p. 792).
Entity:
Properties:
RxO (p. 101) = N/A
8.70.2
8.70.2.1
final AllocationSettings t local writer allocation
Allocation settings applied to local DataWriters.

784
Class Documentation
[default]
initial count
=
16;
max count
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106); incremental count = -1
[range] See allowed ranges in struct com.rti.dds.infrastructure.AllocationSettings t (p. 395)

8.70.2.2
final AllocationSettings t local reader allocation
Allocation settings applied to local DataReaders.

[default]
initial count
=
16;
max count

8.70.2.3
final AllocationSettings t local publisher allocation
Allocation settings applied to local Publisher.

[default]
initial count
=
4;
max count

8.70.2.4
final AllocationSettings t local subscriber allocation
Allocation settings applied to local Subscriber.

[default]
initial count
=
4;
max count

8.70.2.5
final AllocationSettings t local topic allocation
Allocation settings applied to local Topic.

[default]
initial count
=
16;
max count

8.70.2.6
final AllocationSettings t remote writer allocation
Allocation settings applied to remote DataWriters.

Remote DataWriters include all DataWriters, both local and remote.
=
64;
max count
[default]
initial count

8.70.2.7
final AllocationSettings t remote reader allocation
Allocation settings applied to remote DataReaders.

Remote DataReaders include all DataReaders, both local and remote.
=
64;
max count
[default]
initial count

8.70.2.8
final AllocationSettings t remote participant allocation
Allocation settings applied to remote DomainParticipants.

Remote DomainParticipants include all DomainParticipants, both local and remote.
[default]
initial count
=
16;
max count

8.70.2.9
final AllocationSettings t matching writer reader pair allocation
Allocation settings applied to matching local writer and remote/local reader

pairs.
786
Class Documentation
[default]
initial count
=
32;
max count
8.70.2.10
final AllocationSettings t matching reader writer pair allocation
Allocation settings applied to matching local reader and remote/local writer

pairs.
=
32;
max count
[default]
initial count
8.70.2.11
final AllocationSettings t ignored entity allocation
Allocation settings applied to ignored entities.

[default]
initial count
=
8;
max count
8.70.2.12
final AllocationSettings t content filtered topic allocation
Allocation settings applied to content filtered topic (p. 359).

[default]
initial count
=
4;
max count
8.70.2.13
final AllocationSettings t content filter allocation
Allocation settings applied to content filter.


[default]
initial count
=
4;
max count
8.70.2.14
final AllocationSettings t read condition allocation
Allocation settings applied to read condition pool.

=
4;
max count
[default]
initial count
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), incremental count = -1
8.70.2.15
final AllocationSettings t query condition allocation
Allocation settings applied to query condition pool.

[default]
initial count
=
4;
max count
8.70.2.16
final AllocationSettings t outstanding asynchronous sample allocation
Allocation settings applied to the maximum number of samples (from all

com.rti.dds.publication.DataWriter (p. 557)) waiting to be asynchronously
written.
[default]
initial count
=
64;
max count
8.70.2.17
final AllocationSettings t flow controller allocation
Allocation settings applied to flow controllers.

788
Class Documentation
[default]
initial count
=
4;
max count
8.70.2.18
int local writer hash buckets
Hash Buckets settings applied to local DataWriters.

[default] 4
[range] [1, 10000]
8.70.2.19
int local reader hash buckets
Number of hash buckets for local DataReaders.

[default] 4
[range] [1, 10000]
8.70.2.20
int local publisher hash buckets
Number of hash buckets for local Publisher.

[default] 1
[range] [1, 10000]
8.70.2.21
int local subscriber hash buckets
Number of hash buckets for local Subscriber.

[default] 1
[range] [1, 10000]
8.70.2.22
int local topic hash buckets
Number of hash buckets for local Topic.

[default] 4
[range] [1, 10000]

8.70.2.23
int remote writer hash buckets
Number of hash buckets for remote DataWriters.

Remote DataWriters include all DataWriters, both local and remote.
[default] 16
[range] [1, 10000]
8.70.2.24
int remote reader hash buckets
Number of hash buckets for remote DataReaders.

Remote DataReaders include all DataReaders, both local and remote.
[default] 16
[range] [1, 10000]
8.70.2.25
int remote participant hash buckets
Number of hash buckets for remote DomainParticipants.

Remote DomainParticipants include all DomainParticipants, both local and remote.
[default] 4
[range] [1, 10000]
8.70.2.26
int matching writer reader pair hash buckets
Number of hash buckets for matching local writer and remote/local reader pairs.
[default] 32
[range] [1, 10000]
8.70.2.27
int matching reader writer pair hash buckets
Number of hash buckets for matching local reader and remote/local writer pairs.
[default] 32
[range] [1, 10000]
790
Class Documentation
8.70.2.28
int ignored entity hash buckets
Number of hash buckets for ignored entities.

[default] 1
[range] [1, 10000]
8.70.2.29
int content filtered topic hash buckets
Number of hash buckets for content filtered topics.

[default] 1
[range] [1, 10000]
8.70.2.30
int content filter hash buckets
Number of hash buckets for content filters.

[default] 1
[range] [1, 10000]
8.70.2.31
int flow controller hash buckets
Number of hash buckets for flow controllers.

[default] 1
[range] [1, 10000]
8.70.2.32
int max gather destinations
Maximum number of destinations per RTI Connext send.

When RTI Connext sends out a message, it has the capability to send to multiple
destinations to be more efficient. The maximum number of destinations per RTI
Connext send is specified by max gather destinations.
[default] 8
8.70.2.33
int participant user data max length
Maximum length of user data in com.rti.dds.domain.DomainParticipantQos

(p. 773) and builtin.ParticipantBuiltinTopicData.

[default] 256
[range] [0,0x7fffffff]
8.70.2.34
int topic data max length
Maximum length of topic (p. 359) data in com.rti.dds.topic.TopicQos

(p. 1566), builtin.TopicBuiltinTopicData, builtin.PublicationBuiltinTopicData
and builtin.SubscriptionBuiltinTopicData.
[default] 256
8.70.2.35
int publisher group data max length
Maximum length of group data in com.rti.dds.publication.PublisherQos

(p. 1290) and builtin.PublicationBuiltinTopicData.
[default] 256
8.70.2.36
int subscriber group data max length
Maximum length of group data in com.rti.dds.subscription.SubscriberQos

(p. 1505) and builtin.SubscriptionBuiltinTopicData.
[default] 256
8.70.2.37
int writer user data max length
Maximum length of user data in com.rti.dds.publication.DataWriterQos

(p. 610) and builtin.PublicationBuiltinTopicData.
[default] 256
8.70.2.38
int reader user data max length
Maximum length of user data in com.rti.dds.subscription.DataReaderQos

(p. 536) and builtin.SubscriptionBuiltinTopicData.
[default] 256
792
Class Documentation
8.70.2.39
int max partitions
Maximum number of partition name strings allowable

com.rti.dds.infrastructure.PartitionQosPolicy (p. 1217).
in
This setting is made on a per DomainParticipant basis; it cannot be set individually on a per Publisher/Subscriber basis. However, the limit is enforced and
applies per Publisher/Subscriber.
This value cannot exceed 64.
[default] 64
[range] [0,64]
8.70.2.40
int max partition cumulative characters
Maximum number of combined characters allowable in all partition names in a

com.rti.dds.infrastructure.PartitionQosPolicy (p. 1217).
The maximum number of combined characters should account for a terminating
NULL (\0) character for each partition name string.
This setting is made on a per DomainParticipant basis; it cannot be set individually on a per Publisher/Subscriber basis. However, the limit is enforced and
applies per Publisher/Subscriber.
This value cannot exceed 256.
[default] 256
[range] [0,256]
8.70.2.41
int type code max serialized length
Maximum size of serialized string for type code.

This parameter limits the size of the type code that a
com.rti.dds.domain.DomainParticipant (p. 654) is able to store and
propagate for user data types. Type codes can be used by external applications
to understand user data types without having the data type predefined in
compiled form. However, since type codes contain all of the information of a
data structure, including the strings that define the names of the members of
a structure, complex data structures can result in type codes larger than the
default maximum of 2048 bytes. So it is common for users to set this parameter
to a larger value. However, as with all parameters in this QoS policy defining

maximum sizes for variable-length elements, all DomainParticipants in the
same domain (p. 328) should use the same value for this parameter.
[default] 2048
[range] [0,0xffff]
8.70.2.42
int type object max serialized length = 3072
8.70.2.43
int serialized type object dynamic allocation threshold =

3072
8.70.2.44
int type object max deserialized length = -1
8.70.2.45
int deserialized type object dynamic allocation threshold

= 4096
8.70.2.46
int contentfilter property max length
This field is the maximum length of all data related to a Content-filtered topic
(p. 359).
This is the sum of the length of the content filter name, the length of the
related topic (p. 359) name, the length of the filter expression, the length of
the filter parameters, and the length of the filter name. The maximum number
of combined characters should account for a terminating NULL (\0) character
for each string.
[default] 256
[range] [0,0xffff]
8.70.2.47
int channel seq max length
Maximum
number
of
channels
that
can
be
specified
in
com.rti.dds.infrastructure.MultiChannelQosPolicy (p. 1187) for MultiChannel DataWriters.
[default] 32
[range] [0,0xffff]
8.70.2.48
int channel filter expression max length
Maximum length of a channel com.rti.dds.infrastructure.ChannelSettings t.filter expression (p. 455) in a MultiChannel DataWriter.
The length should account for a terminating NULL (\0) character.
794
Class Documentation
[default] 256
[range] [0,0xffff]
8.70.2.49
int participant property list max length
Maximum
number
of
properties
associated
with
the
[default] 32
[range] [0,0xffff]
8.70.2.50
int participant property string max length
Maximum string length of the properties associated

with
the
The string length is defined as the cumulative length in bytes, including the
null terminating characters, of all the pair (name,value) associated with the
com.rti.dds.domain.DomainParticipant (p. 654) properties.
[default] 1024
[range] [0,0xffff]
8.70.2.51
int writer property list max length
Maximum
number
of
properties
associated
with
[range] [0,0xffff]
[default] 32
8.70.2.52
int writer property string max length

associated
with
null terminating characters, of all the pair (name,value) associated with the
com.rti.dds.publication.DataWriter (p. 557) properties.
[default] 1024
[range] [0,0xffff]

8.70.2.53
int reader property list max length
Maximum
number
of
properties
associated
with
[default] 32
[range] [0,0xffff]
8.70.2.54
int reader property string max length

associated
with
null terminating characters, of all the pair (name,value) associated with a
com.rti.dds.subscription.DataReader (p. 487) properties.
[default] 1024
[range] [0,0xffff]
8.70.2.55
int max endpoint groups
Maximum number of com.rti.dds.infrastructure.EndpointGroup t

(p. 928) allowable in a com.rti.dds.infrastructure.AvailabilityQosPolicy
(p. 402).
[default] 32
[range] [0,65535]
8.70.2.56
int max endpoint group cumulative characters
Maximum number of combined role name characters allowable

all
com.rti.dds.infrastructure.EndpointGroup t
(p. 928)
in
com.rti.dds.infrastructure.AvailabilityQosPolicy (p. 402).
in
a
The maximum number of combined characters should account for a terminating

NULL character for each role name string.
[default] 1024
[range] [0,65535]
796
Class Documentation
8.71
DoubleSeq Class Reference

double >.
Inheritance diagram for DoubleSeq::

DoubleSeq ()
Constructs an empty sequence of doubles with an initial maximum of zero.
DoubleSeq (int initialMaximum)

Constructs an empty sequence of doubles with the given initial maximum.
DoubleSeq (double[ ] doubles)

Constructs a new sequence containing the given doubles.
final boolean addAllDouble (double[ ] elements, int offset, int length)

final boolean addAllDouble (double[ ] elements)

final void addDouble (double element)
final void addDouble (int index, double element)

final double getDouble (int index)

Returns the double at the given index.
final double setDouble (int index, double element)

Set the new double at the given index and return the old double.
final void setDouble (int dstIndex, double[ ] elements, int srcIndex, int
length)
final double[ ] toArrayDouble (double[ ] array)

8.71 DoubleSeq Class Reference
797

sequence.
final Object get (int index)

A wrapper for getDouble(int) ( p. 798) that returns a java.lang.Double.
final Object set (int index, Object element)

A wrapper for setDouble() ( p. 799).
final void add (int index, Object element)

A wrapper for addDouble(int, int).
8.71.1

double >.
Instantiates:
See also:
double
8.71.2
8.71.2.1
DoubleSeq ()
Constructs an empty sequence of doubles with an initial maximum of zero.

8.71.2.2
DoubleSeq (int initialMaximum)
Constructs an empty sequence of doubles with the given initial maximum.

8.71.2.3
DoubleSeq (double[ ] doubles)
Constructs a new sequence containing the given doubles.

798
Class Documentation
Parameters:
doubles the initial contents of this sequence
Exceptions:
8.71.3
8.71.3.1
final boolean addAllDouble (double[ ] elements, int offset,

int length)
Exceptions:
8.71.3.2
final boolean addAllDouble (double[ ] elements)
Exceptions:
8.71.3.3
final void addDouble (double element)

8.71.3.4
final void addDouble (int index, double element)
8.71.3.5
final double getDouble (int index)
Returns the double at the given index.

Exceptions:

8.71.3.6
799
final double setDouble (int index, double element)
Set the new double at the given index and return the old double.
Exceptions:
8.71.3.7
final void setDouble (int dstIndex, double[ ] elements, int


Parameters:
Exceptions:
8.71.3.8
final double [ ] toArrayDouble (double[ ] array)

Parameters:
into instead.
Returns:
800
Class Documentation
8.71.3.9
elements.
first created.
Returns:
See also:
8.71.3.10
final Object get (int index) [virtual]
A wrapper for getDouble(int) (p. 798) that returns a java.lang.Double.

See also:
8.71.3.11
final Object set (int index, Object element) [virtual]
A wrapper for setDouble() (p. 799).

Exceptions:
ClassCastException if the element is not of type Double.
See also:

8.71.3.12
final void add (int index, Object element) [virtual]
A wrapper for addDouble(int, int).

Exceptions:
ClassCastException if the element is not of type Double.
See also:
801
802
Class Documentation
8.72
DurabilityQosPolicy Class Reference

network later.
Inheritance diagram for DurabilityQosPolicy::
Public Attributes
DurabilityQosPolicyKind kind
The kind of durability.
boolean direct communication

<<eXtension>> (p. 278) Indicates whether or not a TRANSIENT
or PERSISTENT com.rti.dds.subscription.DataReader ( p. 487)
should receive samples directly from a TRANSIENT or PERSISTENT
com.rti.dds.publication.DataWriter ( p. 557)
8.72.1

network later.
Entity:
Status:
com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED INCOMPATIBLE QOS STATUS, com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED
Properties:
RxO (p. 101) = YES
8.72 DurabilityQosPolicy Class Reference
803
See also:
DURABILITY SERVICE (p. 69)
8.72.2
Usage
It is possible for a com.rti.dds.publication.DataWriter (p. 557) to start

publishing data before all (or any) com.rti.dds.subscription.DataReader
(p. 487) entities have joined the network.
Moreover, a com.rti.dds.subscription.DataReader (p. 487) that joins the
network after some data has been written could potentially be interested in
accessing the most current values of the data, as well as potentially some history.
This
policy
makes
it
possible
for
com.rti.dds.subscription.DataReader (p. 487) to
published samples.
a
late-joining
obtain previously
By helping to ensure that DataReaders get all data that was sent by DataWriters, regardless of when it was sent, using this QoS policy can increase system
tolerance to failure conditions.
Note that although related, this does not strictly control what data RTI
Connext will maintain internally. That is, RTI Connext may choose to
maintain some data for its own purposes (e.g., flow control) and yet not make it
available to late-joining readers if the DURABILITY (p. 68) policy is set to
com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.VOLATILE DURABILITY QOS.
8.72.2.1
Transient and Persistent Durability
For the purpose of implementing the DURABILITY QoS kind TRANSIENT or PERSISTENT, RTI Connext behaves as if for each Topic
that has com.rti.dds.infrastructure.DurabilityQosPolicy.kind (p. 805) of
com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.TRANSIENT DURABILITY QOS or com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.PERSISTENT
DURABILITY QOS
there
is
a
corresponding
builtin
(p. 487)
and
com.rti.dds.publication.DataWriter (p. 557) configured with the same
DURABILITY kind. In other words, it is as if somewhere in the system,
independent of the original com.rti.dds.publication.DataWriter (p. 557),
there is a built-in durable com.rti.dds.subscription.DataReader (p. 487)
subscribing to that Topic and a built-in durable DataWriter re-publishing it
as needed for the new subscribers that join the system. This functionality is
provided by the RTI Persistence Service.
The Persistence Service can configure itself based on the QoS of
your applications com.rti.dds.publication.DataWriter (p. 557) and
804
Class Documentation
com.rti.dds.subscription.DataReader (p. 487) entities. For each transient or persistent com.rti.dds.topic.Topic (p. 1545), the built-in fictitious
Persistence Service com.rti.dds.subscription.DataReader (p. 487) and
com.rti.dds.publication.DataWriter (p. 557) have their QoS configured
from the QoS of your applications com.rti.dds.publication.DataWriter
(p. 557) and com.rti.dds.subscription.DataReader (p. 487) entities that
communicate on that com.rti.dds.topic.Topic (p. 1545).
For a given com.rti.dds.topic.Topic (p. 1545),
the usual request/offered
semantics
apply
to
the
matching
between
any
in
the
domain
(p. 557)
(p. 328) that writes the com.rti.dds.topic.Topic (p. 1545) and the
built-in
transient/persistent
(p. 487) for that com.rti.dds.topic.Topic (p. 1545); similarly for the
built-in
transient/persistent
(p. 557)
for
a
(p. 1545)
and
any
(p. 487)
for
the
(p. 1545).
As
a
consequence,
a
com.rti.dds.publication.DataWriter (p. 557) that has an incompatible QoS will not send its data to the RTI Persistence Service, and a
com.rti.dds.subscription.DataReader (p. 487) that has an incompatible
QoS will not get data from it.
Incompatibilities between local com.rti.dds.subscription.DataReader
(p. 487) and com.rti.dds.publication.DataWriter (p. 557) entities and
the corresponding fictitious built-in transient/persistent entities cause
the
com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED INCOMPATIBLE QOS STATUS and com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED INCOMPATIBLE QOS STATUS
to
change
and
the
corresponding
Listener
(p. 1130)
invocations
and/or
signaling
of
com.rti.dds.infrastructure.Condition (p. 464) objects as they would
with your applications own entities.
The value of com.rti.dds.infrastructure.DurabilityServiceQosPolicy.service cleanup delay (p. 811) controls when RTI Persistence Service is able to remove
all information regarding a data instances.
Information on a data instance is maintained until the following conditions are
met:
1. The instance has been explicitly disposed (instance state = NOT ALIVE DISPOSED),
and
2. While in the NOT ALIVE DISPOSED state, the system detects that there
are no more live com.rti.dds.publication.DataWriter (p. 557) entities writing the instance. That is, all existing writers either unregister the instance (call
unregister) or lose their liveliness,
8.72 DurabilityQosPolicy Class Reference
805
and
3. A time interval longer that com.rti.dds.infrastructure.DurabilityServiceQosPolicy.service cleanup delay (p. 811) has elapsed since the moment RTI Connext detected
that the previous two conditions were met.
The utility of com.rti.dds.infrastructure.DurabilityServiceQosPolicy.service cleanup delay (p. 811) is apparent in the situation where an application disposes an instance and it crashes before it has a chance to complete additional
tasks related to the disposition. Upon restart, the application may ask for initial
data to regain its state and the delay introduced by the service cleanup delay
will allow the restarted application to receive the information on the disposed
instance and complete the interrupted tasks.
8.72.3
Compatibility
The value offered is considered compatible with the value requested if and only if the inequality offered kind >= requested
kind evaluates to TRUE. For the purposes of this inequality, the
values of DURABILITY kind are considered ordered such that
com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.VOLATILE DURABILITY QOS < com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.TRANSIENT LOCAL DURABILITY QOS < com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.TRAN
DURABILITY QOS < com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.PERSISTENT
DURABILITY QOS.
8.72.4
8.72.4.1
DurabilityQosPolicyKind kind
The kind of durability.

[default] com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.VOLATILE DURABILITY QOS
8.72.4.2
boolean direct communication
<<eXtension>> ( p. 278) Indicates whether or not a TRANSIENT

or
PERSISTENT
(p. 487)
should receive samples directly from a TRANSIENT or PERSISTENT
When direct communication is set to com.rti.dds.infrastructure.true, a
TRANSIENT or PERSISTENT com.rti.dds.subscription.DataReader
(p. 487)
will
receive
samples
from
both
the
original
806
Class Documentation
com.rti.dds.publication.DataWriter (p. 557) configured with TRANSIENT

or PERSISTENT durability and the com.rti.dds.publication.DataWriter
(p. 557) created by the persistence service. This peer-to-peer communication
pattern provides low latency between end-points.
If
the
same
sample
is
received
from
the
original
com.rti.dds.publication.DataWriter (p. 557) and the persistence service, the middleware will discard the duplicate.
When direct communication is set to com.rti.dds.infrastructure.false, a TRANSIENT or PERSISTENT com.rti.dds.subscription.DataReader (p. 487)
will only receive samples from the com.rti.dds.publication.DataWriter
(p. 557) created by the persistence service. This brokered communication pattern provides a way to guarantee eventual consistency.
8.73 DurabilityQosPolicyKind Class Reference
8.73
807
DurabilityQosPolicyKind Class Reference
Inheritance diagram for DurabilityQosPolicyKind::

static
final
DurabilityQosPolicyKind
DURABILITY QOS
VOLATILE -
[default] RTI Connext does not need to keep any samples of data instances
on behalf of any com.rti.dds.subscription.DataReader ( p. 487) that is
unknown by the com.rti.dds.publication.DataWriter ( p. 557) at the time
the instance is written.
static final DurabilityQosPolicyKind TRANSIENT LOCAL DURABILITY QOS

RTI Connext will attempt to keep some samples so that they can be delivered to any potential late-joining com.rti.dds.subscription.DataReader
( p. 487).
static
final
DURABILITY QOS
TRANSIENT -
RTI Connext will attempt to keep some samples so that they can be delivered to any potential late-joining com.rti.dds.subscription.DataReader
( p. 487).
static
final
DURABILITY QOS
PERSISTENT -
Data is kept on permanent storage, so that they can outlive a system session.
8.73.1
QoS:
com.rti.dds.infrastructure.DurabilityQosPolicy (p. 802)
808
Class Documentation
8.73.2
8.73.2.1
final DurabilityQosPolicyKind VOLATILE DURABILITY QOS [static]
[default] RTI Connext does not need to keep any samples of data instances
on behalf of any com.rti.dds.subscription.DataReader (p. 487) that is unknown by the com.rti.dds.publication.DataWriter (p. 557) at the time the
instance is written.
In other words, RTI Connext will only attempt to provide the data to existing
subscribers.
This option does not require RTI Persistence Service.
8.73.2.2
final DurabilityQosPolicyKind TRANSIENT LOCAL DURABILITY QOS [static]
RTI Connext will attempt to keep some samples so that they can be delivered to
any potential late-joining com.rti.dds.subscription.DataReader (p. 487).
Which particular samples are kept depends on other QoS such
and
as
com.rti.dds.infrastructure.HistoryQosPolicy
(p. 1046)
(p. 1348).
RTI Connext is only required to keep the data in memory of the
com.rti.dds.publication.DataWriter (p. 557) that wrote the data.
Data is not required to survive the com.rti.dds.publication.DataWriter
(p. 557).
For this setting to be effective,
you must also set the
com.rti.dds.infrastructure.ReliabilityQosPolicy.kind
(p. 1327)
to
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.RELIABLE RELIABILITY QOS.
This option does not require RTI Persistence Service.
8.73.2.3
final DurabilityQosPolicyKind TRANSIENT DURABILITY QOS [static]
RTI Connext will attempt to keep some samples so that they can be delivered to
any potential late-joining com.rti.dds.subscription.DataReader (p. 487).
Which particular samples are kept depends on other QoS such
as
(p. 1046)
and
com.rti.dds.infrastructure.ResourceLimitsQosPolicy (p. 1348).
RTI
Connext is only required to keep the data in memory and not in permanent
storage.
8.73 DurabilityQosPolicyKind Class Reference
809
Data is not tied to the lifecycle of the com.rti.dds.publication.DataWriter

(p. 557).
Data will survive the com.rti.dds.publication.DataWriter (p. 557).
This option requires RTI Persistence Service.
8.73.2.4
final DurabilityQosPolicyKind PERSISTENT DURABILITY QOS [static]
Data is kept on permanent storage, so that they can outlive a system session.
This option requires RTI Persistence Service.
810
Class Documentation
8.74
DurabilityServiceQosPolicy Class Reference
Various
settings
to
configure
the
external
RTI
com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.PERSISTENT DURABILITY QOS or com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.TR
DURABILITY QOS.
Inheritance diagram for DurabilityServiceQosPolicy::
Public Attributes
final Duration t service cleanup delay
[Not supported (optional)] Controls when the service is able to remove
all information regarding a data instances.
HistoryQosPolicyKind history kind

The kind of history to apply in recouping durable data.
int history depth

Part of history QoS policy to apply when feeding a late joiner.
int max samples

Part of resource limits QoS policy to apply when feeding a late joiner.
int max instances

int max samples per instance

8.74.1
Various
settings
to
configure
the
external
RTI
com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.PERSISTENT DURABILITY QOS or com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.TR
DURABILITY QOS.
8.74 DurabilityServiceQosPolicy Class Reference
811
Entity:
(p. 557)
Properties:
RxO (p. 101) = NO
See also:
DURABILITY (p. 68)
HISTORY (p. 79)
RESOURCE LIMITS (p. 106)
8.74.2
Usage
When a DataWriters com.rti.dds.infrastructure.DurabilityQosPolicy.kind

(p. 805) is com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.PERSISTENT DURABILITY QOS or com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.TRANSIENT
DURABILITY QOS,
an
external
service,
the
RTI
Persistence Service, is used to store and possibly forward the data
to
sent
by
the
(p. 557)
com.rti.dds.subscription.DataReader (p. 487) objects that are created
after the data was initially sent.
This QoS policy is used to configure certain parameters of the Persistence Service
when it operates on the behalf of the com.rti.dds.publication.DataWriter
(p. 557), such as how much data to store. For example, it configures the HISTORY (p. 79) and the RESOURCE LIMITS (p. 106) used by the fictitious
DataReader and DataWriter used by the Persistence Service. Note, however,
that the Persistence Service itself may be configured to ignore these values and
instead use values from its own configuration file.
8.74.3
8.74.3.1
final Duration t service cleanup delay
Initial value:
new Duration_t(
Duration_t.DURATION_INFINITE_SEC, Duration_t.DURATION_INFINITE_NSEC)
[Not supported (optional)] Controls when the service is able to remove all
information regarding a data instances.
[default] 0
812
Class Documentation
8.74.3.2
HistoryQosPolicyKind history kind
The kind of history to apply in recouping durable data.

[default] com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP LAST HISTORY QOS
8.74.3.3
int history depth
Part of history QoS policy to apply when feeding a late joiner.

[default] 1
8.74.3.4
int max samples
8.74.3.5
int max instances
8.74.3.6
8.75 Duration t Class Reference
8.75
Duration t Class Reference

Inherits Struct, and Externalizable.

Duration t (Duration t duration)
Copy constructor.
Duration
boolean is
boolean is
boolean is
Duration
Duration
t (int sec, int nanosec)

zero ()
infinite ()
auto ()
t add (Duration t other)
t subtract (Duration t other)

static Duration t from nanos (long nanos)
Public Attributes
int sec
seconds
int nanosec
nanoseconds

static final int DURATION ZERO SEC
A zero-length second period of time.
static final int DURATION ZERO NSEC

A zero-length nano-second period of time.
static final int DURATION INFINITE SEC

An infinite second period of time.
813
814
Class Documentation
static final int DURATION INFINITE NSEC
An infinite nano-second period of time.
static final int DURATION AUTO SEC

An auto second period of time.
static final int DURATION AUTO NSEC

An auto nano-second period of time.
8.75.1

Represents a time interval.
8.75.2
8.75.2.1
Duration t (Duration t duration)
Copy constructor.
Parameters:
duration The duration instance to copy. It must not be null.
8.75.2.2
Duration t (int sec, int nanosec)
Parameters:
sec must be >=0
nanosec must be >=0
Exceptions:
RETCODE BAD PARAMETER ( p. 1355) if either value is negative
8.75.3
8.75.3.1
static Duration t from nanos (long nanos) [static]
Creates a new duration object from a duration expressed in nanoseconds

8.75 Duration t Class Reference

8.75.3.2
815
boolean is zero ()
Returns:
com.rti.dds.infrastructure.true if the given duration is of zero length.
8.75.3.3
boolean is infinite ()
Returns:
com.rti.dds.infrastructure.true if the given duration is of infinite length.
8.75.3.4
boolean is auto ()
Returns:
com.rti.dds.infrastructure.true if the given duration has auto value.
8.75.3.5
Duration t add (Duration t other)
Calculates a duration as the result of adding other and this.

Special case: d.add(Duration t.DURATION INFINITE).is infinite() (p. 815)
8.75.3.6
Duration t subtract (Duration t other)
Calculates a duration as the result of substracting other to this.

Special cases:
d.substract(Duration t.DURATION INFINITE).is zero()
(p. 815) Duration t.DURATION INFINITE.substract(d).is infinite() (p. 815)
Duration t.DURATION INFINITE.substract(Duration t.DURATION INFINITE).is infinite() (p. 815) d1.substract(d2).is zero() (p. 815) if d2
is greater or equal than d1
8.75.4
8.75.4.1
final int DURATION ZERO SEC [static]
A zero-length second period of time.

8.75.4.2
final int DURATION ZERO NSEC [static]
A zero-length nano-second period of time.

816
Class Documentation
8.75.4.3
final int DURATION INFINITE SEC [static]
An infinite second period of time.

8.75.4.4
final int DURATION INFINITE NSEC [static]
An infinite nano-second period of time.

8.75.4.5
final int DURATION AUTO SEC [static]
An auto second period of time.

8.75.4.6
final int DURATION AUTO NSEC [static]
An auto nano-second period of time.

8.75.4.7
int sec
seconds
8.75.4.8
int nanosec
nanoseconds
8.76 DynamicData Class Reference
8.76
817
DynamicData Class Reference
reflectively.
Inheritance diagram for DynamicData::

void delete ()
Finalize and deallocate this com.rti.dds.dynamicdata.DynamicData
( p. 817) sample.
boolean equals (Object o)

Indicate
whether
the
contents
com.rti.dds.dynamicdata.DynamicData ( p. 817)
same as those of this one.
of
sample
another
are the

Deeply copy from the given object to this object.
void clear all members ()

Clear the contents of all data members of this object, including key members.
void clear nonkey members ()

Clear the contents of all data members of this object, not including key members.
void clear member (String member name, int member id)

Clear the contents of a single data member of this object.
void print (File fp, int indent)

Output a textual representation of this object and its contents to the given
file.
void get info (DynamicDataInfo info out)

Fill
in
the
given
descriptor
with
information
about
void bind type (TypeCode type)

this
818
Class Documentation
If this com.rti.dds.dynamicdata.DynamicData ( p. 817) object is not
yet associated with a data type, set that type now to the given
com.rti.dds.typecode.TypeCode ( p. 1611).
void unbind type ()

Dissociate this com.rti.dds.dynamicdata.DynamicData ( p. 817) object
from any particular data type.
void bind complex member (DynamicData value out, String member name, int member id)
Use
another
( p. 817) object to provide access to a complex field of this
com.rti.dds.dynamicdata.DynamicData ( p. 817) object.
void unbind complex member (DynamicData value)

Tear
down
the
association
created
by
a
com.rti.dds.dynamicdata.DynamicData.bind complex member
( p. 835) operation, committing any changes to the outer object since then.
TypeCode get type ()

Get the data type, of which this com.rti.dds.dynamicdata.DynamicData
( p. 817) represents an instance.
TCKind get type kind ()

Get the kind of this objects data type.
int get member count ()

Get the number of members in this sample.
boolean member exists (String member name, int member id)

Indicates whether a member of a particular name/ID exists in this data sample.
boolean member exists in type (String member name, int member id)
Indicates whether a member of a particular name/ID exists in this data samples type.
void get member info (DynamicDataMemberInfo info, String member name, int member id)
Fill in the given descriptor with information about the identified member of
this com.rti.dds.dynamicdata.DynamicData ( p. 817) sample.
void get member info by index (DynamicDataMemberInfo info,

int index)
819
Fill in the given descriptor with information about the identified member of
this com.rti.dds.dynamicdata.DynamicData ( p. 817) sample.
TypeCode get member type (String member name, int member id)
Get the type of the given member of this sample.
boolean is member key (String member name, int member id)

Indicates whether a given member forms part of the key of this samples data
type.
int get int (String member name, int member id)

Get the value of the given field, which is of type com.rti.dds.infrastructure.int
or another type implicitly convertible to it (byte, char, short,
com.rti.dds.infrastructure.short, or com.rti.dds.util.Enum ( p. 944)).
int get int array (int[ ] array, String member name, int member id)
Get a copy of the given array member.
void get int seq (IntSeq seq, String member name, int member id)
Get a copy of the given sequence member.
short get short (String member name, int member id)

Get the value of the given field, which is of type short or another type implicitly convertible to it (byte or char).
int get short array (short[ ] array, String member name, int member id)
void get short seq (ShortSeq seq, String member name, int member id)
float get float (String member name, int member id)

Get the value of the given field, which is of type float.
int get float array (float[ ] array, String member name, int member id)
void get float seq (FloatSeq seq, String member name, int member id)
double get double (String member name, int member id)

820
Class Documentation
Get the value of the given field, which is of type double or another type
implicitly convertible to it (float).
int get double array (double[ ] array, String member name, int member id)
void get double seq (DoubleSeq seq, String member name, int member id)
boolean get boolean (String member name, int member id)

Get the value of the given field, which is of type boolean.
int get boolean array (boolean[ ] array, String member name, int member id)
void get boolean seq (BooleanSeq seq, String member name, int member id)
char get char (String member name, int member id)

Get the value of the given field, which is of type char.
int get char array (char[ ] array, String member name, int member id)
void get char seq (CharSeq seq, String member name, int member id)
byte get byte (String member name, int member id)

Get the value of the given field, which is of type byte.
int get byte array (byte[ ] array, String member name, int member id)
void get byte seq (ByteSeq seq, String member name, int member id)
long get long (String member name, int member id)

821
Get the value of the given field, which is of type long or another type implicitly convertible to it (byte, char, short, com.rti.dds.infrastructure.short,
com.rti.dds.infrastructure.int,
com.rti.dds.infrastructure.long,
or
com.rti.dds.util.Enum ( p. 944)).
int get long array (long[ ] array, String member name, int member id)
void get long seq (LongSeq seq, String member name, int member id)
String get string (String member name, int member id)

Get
the
value
of
the
given
com.rti.dds.infrastructure.String.
field,
which
is
of
type
void get complex member (DynamicData value out, String member name, int member id)
Get a copy of the value of the given field, which is of some composed type.
void set int (String member name, int member id, int value)
Set the value of the given field, which is of type com.rti.dds.infrastructure.int.
void set int array (String member name, int member id, int[ ] array)
Set the contents of the given array member.
void set int seq (String member name, int member id, IntSeq value)
Set the contents of the given sequence member.
void set short (String member name, int member id, short value)
Set the value of the given field, which is of type short.
void set short array (String member name, int member id, short[ ] array)
void set short seq (String member name, int member id, ShortSeq
value)
void set float (String member name, int member id, float value)
Set the value of the given field, which is of type float.
822
Class Documentation
void set float array (String member name, int member id, float[ ] array)
void set float seq (String member name, int member id, FloatSeq
value)
void set double (String member name, int member id, double value)
Set the value of the given field, which is of type double.
void set double array (String member name, int member id, double[ ]
array)
void set double seq (String member name, int member id, DoubleSeq
value)
void set boolean (String member name, int member id, boolean value)
Set the value of the given field, which is of type boolean.
void set boolean array (String member name, int member id, boolean[ ]
array)
void set boolean seq

BooleanSeq value)
(String
member name,
int
member id,
void set char (String member name, int member id, char value)
Set the value of the given field, which is of type char.
void set char array (String member name, int member id, char[ ] array)
void set char seq (String member name, int member id, CharSeq
value)
void set byte (String member name, int member id, byte value)
Set the value of the given field, which is of type byte.
823
void set byte array (String member name, int member id, byte[ ] array)
void set byte seq (String member name, int member id, ByteSeq
value)
void set long (String member name, int member id, long value)
Set the value of the given field, which is of type long.
void set long array (String member name, int member id, long[ ] array)
void set long seq (String member name, int member id, LongSeq
value)
void set string (String member name, int member id, String value)
Set the value of the given field of type com.rti.dds.infrastructure.String.
void set complex member (String member name, int member id, DynamicData value)
Copy the state of the given com.rti.dds.dynamicdata.DynamicData
( p. 817) object into a member of this object.
DynamicData (TypeCode type, DynamicDataProperty t property)

The constructor
( p. 817) objects.
for
new

static final int MEMBER ID UNSPECIFIED
A sentinel value that indicates that no member ID is needed in order to
perform some operation.
static final DynamicDataProperty t PROPERTY DEFAULT

Sentinel
constant
indicating
default
values
com.rti.dds.dynamicdata.DynamicDataProperty t ( p. 890).
for
824
Class Documentation
8.76.1
reflectively.
Objects of type com.rti.dds.dynamicdata.DynamicData (p. 817)
represent corresponding objects of the type identified by their
Because the definition of
com.rti.dds.typecode.TypeCode (p. 1611).
these types may not have existed at compile time on the system on which the
application is running, you will interact with the data using an API of reflective
getters and setters.
For example, if you had access to your data types at compile time, you could
do this:
theValue = theObject.theField;
Instead, you will do something like this:

theValue = get(theObject, "theField");
objects
(p. 817)
can
represent
any
complex
data
type,
including
those
of
type
kinds
com.rti.dds.typecode.TCKind.TK ARRAY
(p. 1528),
(p. 1528),
(p. 1528),
(p. 1528),
(p. 1529),
and
com.rti.dds.typecode.TCKind.TK SPARSE (p. 1529).
They cannot
represent objects of basic types (e.g. integers and strings). Since those type
definitions always exist on every system, you can examine their objects directly.
8.76.2
Member Names and IDs
The members of a data type can be identified in one of two ways: by their name
or by their numeric ID. The former is often more transparent to human users;
the latter is typically faster.
You define the name and ID of a type member when you add that member
to that type. When you define a sparse type, you will typically choose both
explicitly. If you define your type in IDL or XML, the name will be the field
name that appears in the type definition; the ID will be the one-based index of
the field in declaration order. For example, in the following IDL structure, the
ID of theLong is 2.
struct MyType {
825
short theShort;
long theLong;
};
For unions (com.rti.dds.typecode.TCKind.TK UNION (p. 1528)), the ID

of a member is the discriminator value corresponding to that member.
8.76.3
Arrays and Sequences
The members of array and sequence types, unlike those of structure and
union types, dont have names or explicit member IDs. However, they may
nevertheless be accessed by ID: the ID is one more than the index. (The first
element has ID 1, the second 2, etc.)
Multi-dimensional arrays are effectively flattened by this pattern. For example,
for an array theArray[4][5], accessing ID 7 is equivalent to index 6, or the second
element of the second group of 5.
To determine the length of a collection-typed member of a structure or union,
you have two choices:
1. Get the length along with the data: call the appropriate array accessor
(see Getters and Setters (p. 826)) and check the resulting length.
2. Get
the
length
without
getting
the
data
itself:
call
com.rti.dds.dynamicdata.DynamicData.get member info
(p. 840)
and
check
the
resulting
com.rti.dds.dynamicdata.DynamicDataMemberInfo.element count (p. 889).
8.76.4
Available Functionality
The Dynamic Data API is large when measured by the number of methods it
contains. But each method falls into one of a very small number of categories.
You will find it easier to navigate this documentation if you understand these
categories.
8.76.4.1
Lifecycle and Utility Methods
Managing the lifecycle of com.rti.dds.dynamicdata.DynamicData (p. 817)

objects is simple. You have two choices:
1. Usually, you will go through a com.rti.dds.dynamicdata.DynamicDataTypeSupport
(p. 901) factory object, which will ensure that the type and property
information for the new com.rti.dds.dynamicdata.DynamicData
(p. 817) object corresponds to a registered type in your system.
826
Class Documentation
2. In certain advanced cases, such as when youre navigating a nested structure, you will want to have a com.rti.dds.dynamicdata.DynamicData
(p. 817) object that is not bound up front to any particular type, or you
will want to initialize the object in a custom way. In that case, you can
call the constructor directly.
com.rti.dds.dynamicdata.DynamicDataTypeSupport
(p. 901)
(p. 817)
com.rti.dds.dynamicdata.DynamicDataTypeSupport.create
com.rti.dds.dynamicdata.DynamicData.DynamicData.Dynamic
data
(p. 905)
Table 8.1: Lifecycle
You can also copy com.rti.dds.dynamicdata.DynamicData (p. 817) objects:
com.rti.dds.dynamicdata.DynamicData.copy
You can test them for equality:
com.rti.dds.dynamicdata.DynamicData.DynamicData.equals
And you can print their contents:
com.rti.dds.dynamicdata.DynamicData.print (p. 833)
com.rti.dds.dynamicdata.DynamicDataTypeSupport.print data
(p. 905)
8.76.4.2
Getters and Setters
Most methods get or set the value of some field. These methods are named
according to the type of the field they access.
The names of integer types vary across languages. The programming API for
each language reflects that programming language. However, if your chosen language does not use the same names as the language that you used to define your
types (e.g., IDL), or if you need to interoperate among programming languages,
you will need to understand these differences. They are explained the following
table.
When working with a com.rti.dds.dynamicdata.DynamicData (p. 817)
object representing an array or sequence, calling one of the get

Type
16-bit
integer
32-bit
integer
64-bit
integer
827
IDL
short
C, C++
DDS Short
C#
short
Java
short
long
DDS Long
int
int
long long
DDS LongLong
long
long
Table 8.2: Integer Type Names Across Languages

methods below for an index that is out of bounds will result in
com.rti.dds.infrastructure.RETCODE NO DATA (p. 1360).
Calling
set for an index that is past the end of a sequence will cause that sequence to
automatically lengthen (filling with default contents).
In addition to getting or setting a field, you can clear its value; that is, set it
to a default zero value.
com.rti.dds.dynamicdata.DynamicData.clear member (p. 832)
com.rti.dds.dynamicdata.DynamicData.clear all members
(p. 831)
com.rti.dds.dynamicdata.DynamicData.clear nonkey members
(p. 832)
8.76.4.3
Query and Iteration
Not all components of your application will have static knowledge of all of the
fields of your type. Sometimes, you will want to query meta-data about the
fields that appear in a given data sample.
com.rti.dds.dynamicdata.DynamicData.get type (p. 838)
com.rti.dds.dynamicdata.DynamicData.get type kind (p. 838)
com.rti.dds.dynamicdata.DynamicData.get member type
(p. 842)
com.rti.dds.dynamicdata.DynamicData.get member count
(p. 838)
com.rti.dds.dynamicdata.DynamicData.get member info by index (p. 841)
com.rti.dds.dynamicdata.DynamicData.member exists (p. 839)
828
Class Documentation
com.rti.dds.dynamicdata.DynamicData.member exists in type
(p. 840)
com.rti.dds.dynamicdata.DynamicData.is member key (p. 843)
8.76.4.4
Type/Object Association
Sometimes, you may want to change the association between a data object and its type.
This is not something you can do with a typical object, but with com.rti.dds.dynamicdata.DynamicData (p. 817)
objects, it is a powerful capability.
It allows you to, for example,
examine nested structures without copying them by using a bound
com.rti.dds.dynamicdata.DynamicData (p. 817) object as a view into an
enclosing com.rti.dds.dynamicdata.DynamicData (p. 817) object.
com.rti.dds.dynamicdata.DynamicData.bind type (p. 834)
com.rti.dds.dynamicdata.DynamicData.unbind type (p. 835)
(p. 835)
com.rti.dds.dynamicdata.DynamicData.unbind complex member (p. 837)
8.76.4.5
Keys
Keys can be specified in dynamically defined types just as they can in types defined in generated code. However, there are some minor restrictions when sparse
value types are involved (see com.rti.dds.typecode.TCKind.TK SPARSE
(p. 1529)).
If a type has a member that is of a sparse value type, that member cannot
be a key for the enclosing type.
Sparse value types themselves may have at most a single key field. That
field may itself be of any type.
8.76.5
Performance
Due to the way in which com.rti.dds.dynamicdata.DynamicData (p. 817)

objects manage their internal state, it is typically more efficient, when setting
the field values of a com.rti.dds.dynamicdata.DynamicData (p. 817) for
the first time, to do so in the declared order of those fields.
For example, suppose a type definition like the following:
829
struct MyType {
float my_float;
sequence<octet> my_bytes;
short my_short;
};
The richness of the type system makes it difficult to fully characterize the performance differences between all access patterns. Nevertheless, the following are
generally true:
It will be most performant to set the value of my float, then my bytes,
and finally my short.
The order of modification has a greater impact for types of
kind com.rti.dds.typecode.TCKind.TK STRUCT (p. 1528) and
com.rti.dds.typecode.TCKind.TK VALUE (p. 1529) than it does for
types of kind com.rti.dds.typecode.TCKind.TK SPARSE (p. 1529).
Modifications to variable-sized types (i.e. those containing strings, sequences, unions, or optional members) are more expensive than modifications to fixed-size types.
MT Safety:
UNSAFE. In general, using a single com.rti.dds.dynamicdata.DynamicData
(p. 817) object concurrently from multiple threads is unsafe.
8.76.6
8.76.6.1
DynamicData (TypeCode type, DynamicDataProperty t

property)
The constructor for new com.rti.dds.dynamicdata.DynamicData (p. 817)

objects.
The type parameter may be null.
In that case,
this
com.rti.dds.dynamicdata.DynamicData (p. 817) must be bound
with
com.rti.dds.dynamicdata.DynamicData.bind type
(p. 834)
or
(p. 835) before it can be used.
If the com.rti.dds.typecode.TypeCode (p. 1611) is not null, the newly constructed com.rti.dds.dynamicdata.DynamicData (p. 817) object will retain
a reference to it. It is not safe to delete the com.rti.dds.typecode.TypeCode
(p. 1611) until all samples that use it have themselves been deleted. You have
two options:
830
Class Documentation
Keep a reference to the com.rti.dds.typecode.TypeCode
object
yourself,
and
delete
it
with
(p. 1611)
com.rti.dds.typecode.TypeCodeFactory.delete tc (p. 1660) after youve deleted all of the objects that use it.
Do not keep a reference to the com.rti.dds.typecode.TypeCode
(p. 1611). The garbage collector will delete it when its eligible for collection.
In most cases, it is not necessary to call this constructor explicitly. Instead,

use com.rti.dds.dynamicdata.DynamicDataTypeSupport.create data
(p. 905), and the com.rti.dds.typecode.TypeCode (p. 1611) and properties
will be specified for you. Using the factory method also ensures that the
memory management contract documented above is followed correctly, because
the com.rti.dds.dynamicdata.DynamicDataTypeSupport (p. 901) object
maintains the com.rti.dds.typecode.TypeCode (p. 1611) used by the samples it creates.
Parameters:
type <<in>> ( p. 279) The type of which the new object will represent
an object.
property <<in>> ( p. 279) Properties that configure the
havior of the new object.
Most users can simply
com.rti.dds.dynamicdata.DYNAMIC DATA PROPERTY DEFAULT.
beuse
See also:
com.rti.dds.dynamicdata.DynamicDataTypeSupport.create data
(p. 905)
8.76.7
8.76.7.1
void delete ()
Finalize and deallocate this com.rti.dds.dynamicdata.DynamicData

(p. 817) sample.
MT Safety:
UNSAFE.
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.DynamicData

8.76.7.2
831
boolean equals (Object o)
Indicate
whether
the
contents
of
another
com.rti.dds.dynamicdata.DynamicData (p. 817) sample are the same
as those of this one.
This operation compares the data and type of existing members. The types of
non-instantiated members may differ in sparse types.
MT Safety:
UNSAFE.
See also:
http://java.sun.com/javase/6/docs/api/java/lang/Object.html#equals(java.lang.Object)
com.rti.dds.typecode.TCKind.TK SPARSE (p. 1529)
8.76.7.3
Deeply copy from the given object to this object.

MT Safety:
UNSAFE.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
com.rti.dds.infrastructure.RETCODE OUT OF RESOURCES (p. 1362)
or

8.76.7.4
void clear all members ()
Clear the contents of all data members of this object, including key members.
MT Safety:
UNSAFE.
Exceptions:
832
Class Documentation
See also:
(p. 832)
8.76.7.5
void clear nonkey members ()
Clear the contents of all data members of this object, not including key members.
This method is only applicable to sparse value types.
MT Safety:
UNSAFE.
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.clear all members (p. 831)
8.76.7.6
void clear member (String member name, int member id)
Clear the contents of a single data member of this object.

This method is only applicable to sparse value types.
MT Safety:
UNSAFE.
Parameters:
member name <<in>> ( p. 279) The name of the member or null to
look up the member by its ID.
member id <<in>> ( p. 279) The ID of the member or
com.rti.dds.dynamicdata.DynamicData.MEMBER ID UNSPECIFIED (p. 880) to look up by name. See Member
Names and IDs (p. 824).
Exceptions:
833
See also:
(p. 832)
8.76.7.7
void print (File fp, int indent)
Output a textual representation of this object and its contents to the given file.
This method is equivalent to com.rti.dds.dynamicdata.DynamicDataTypeSupport.print data (p. 905).
Warning: This operation may not display any data for members at the end
of a data structure that have not been explicitly set before the data sample is
serialized. This will not be a problem on a received data sample, which should
always correctly display all members.
MT Safety:
UNSAFE.
Parameters:
fp <<in>> ( p. 279) The file to which the object should be printed.
indent <<in>> ( p. 279) The output of this method will be prettyprinted. This argument indicates the amount of initial indentation
of the output.
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicDataTypeSupport.print data
(p. 905)
8.76.7.8
void get info (DynamicDataInfo info out)
Fill
in
the
given
descriptor
with
information
com.rti.dds.dynamicdata.DynamicData (p. 817).
about
MT Safety:
UNSAFE.
this
834
Class Documentation
Parameters:
info out <<out>> ( p. 279) The descriptor object whose contents will be
overwritten by this operation.
8.76.7.9
void bind type (TypeCode type)
If this com.rti.dds.dynamicdata.DynamicData (p. 817) object is not

yet associated with a data type, set that type now to the given
This
advanced
operation
allows
you
to
reuse
a
single
com.rti.dds.dynamicdata.DynamicData (p. 817) object with multiple
data types.
DynamicData myData = new DynamicData(null, myProperties);
TypeCode myType = ...;
myData.bind_type(myType);
try {
// Do something...
} finally {
myData.unbind_type();
}
myData.delete();
Note that the com.rti.dds.dynamicdata.DynamicData (p. 817) object will

retain a reference to the com.rti.dds.typecode.TypeCode (p. 1611) object
you provide. It is not safe to delete the com.rti.dds.typecode.TypeCode
(p. 1611) until after it is unbound. You have two options:
(p. 1611)
object
yourself,
and
delete
it
with
com.rti.dds.typecode.TypeCodeFactory.delete tc (p. 1660) after youve finished using it.
MT Safety:
UNSAFE.
Parameters:
type <<in>> ( p. 279)
The type to associate with
com.rti.dds.dynamicdata.DynamicData (p. 817) object.
this
835
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.unbind type (p. 835)
8.76.7.10
void unbind type ()
Dissociate this com.rti.dds.dynamicdata.DynamicData (p. 817) object

from any particular data type.
This step is necessary before the object can be associated with a new data type.
This operation clears all members as a side effect.
MT Safety:
UNSAFE.
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.bind type (p. 834)
8.76.7.11
void bind complex member (DynamicData value out,

String member name, int member id)
Use
another
(p. 817) object to provide access to a complex field of this
com.rti.dds.dynamicdata.DynamicData (p. 817) object.
For example, consider the following data types:
struct MyFieldType {
float theFloat;
};
struct MyOuterType {
MyFieldType complexMember;
};
836
Class Documentation
Suppose you have an instance of MyOuterType, and you would like to examine
the contents of its member complexMember. To do this, you must bind another com.rti.dds.dynamicdata.DynamicData (p. 817) object to that member. This operation will bind the type code of the member to the provided
com.rti.dds.dynamicdata.DynamicData (p. 817) object and perform additional initialization.
The following example demonstrates the usage pattern. Note that error handling
has been omitted for brevity.
DynamicData outer = ...;
DynamicData toBeBound = new DynamicData(null, myProperties);
outer.bind_complex_member(
toBeBound,
"complexMember",
DynamicData.MEMBER_ID_UNSPECIFIED);
try {
float theFloatValue = toBeBound.get_float(
"theFloat"
DynamicData.MEMBER_ID_UNSPECIFIED);
} finally {
outer.unbind_complex_member(toBeBound);
}
toBeBound.delete();
This operation is only permitted when the object toBeBound (named as in

the example above) is not currently associated with any type, including already being bound to another member. You can see in the example that
this object is created directly with the constructer and is not provided with
a com.rti.dds.typecode.TypeCode (p. 1611).
Only a single member of a given com.rti.dds.dynamicdata.DynamicData
(p. 817) object may be bound at one time however, members of members
may be recursively bound to any depth. Furthermore, while the outer object
has a bound member, it may only be modified through that bound member.
That is, after calling this member, all set operations on the outer object
will be disabled until com.rti.dds.dynamicdata.DynamicData.unbind complex member (p. 837) has been called. Furthermore, any bound member
must be unbound before a sample can be written or deleted.
This method is logically related to com.rti.dds.dynamicdata.DynamicData.get complex member (p. 860) in that both allow you to examine the
state of nested objects. They are different in an important way: this
method provides a view into an outer object, such that any change
made to the inner object will be reflected in the outer.
But the
com.rti.dds.dynamicdata.DynamicData.get complex member (p. 860)
operation copies the state of the nested object; changes to it will not be
reflected in the source object.
Note that you can bind to a member of a sequence at an index that is past the
current length of that sequence. In that case, this method behaves like a set
837
method: it automatically lengthens the sequence (filling in default elements) to

allow the bind to take place. See Getters and Setters (p. 826).
MT Safety:
UNSAFE.
Parameters:
value out <<out>> ( p. 279) The object that you wish to bind to the
field.
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.unbind complex member
(p. 837)
com.rti.dds.dynamicdata.DynamicData.get complex member
(p. 860)
8.76.7.12
void unbind complex member (DynamicData value)
Tear
down
the
association
created
by
(p. 835) operation, committing any changes to the outer object since then.
Some changes to the outer object will not be observable until after you have
performed this operation.
If you have called com.rti.dds.dynamicdata.DynamicData.bind complex member (p. 835) on a data sample, you must unbind before writing
or deleting the sample.
MT Safety:
UNSAFE.
838
Class Documentation
Parameters:
value <<in>> ( p. 279) The same object you passed to
com.rti.dds.dynamicdata.DynamicData.bind complex member (p. 835). This argument is used for error checking purposes.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
(p. 835)
8.76.7.13
TypeCode get type ()
Get the data type, of which this com.rti.dds.dynamicdata.DynamicData

(p. 817) represents an instance.
MT Safety:
UNSAFE.
8.76.7.14
TCKind get type kind ()
Get the kind of this objects data type.

This is a convenience method.
Its equivalent to calling
(p. 838)
followed
com.rti.dds.dynamicdata.DynamicData.get type
by com.rti.dds.typecode.TypeCode.kind (p. 1616).
MT Safety:
UNSAFE.
8.76.7.15
int get member count ()
Get the number of members in this sample.

For objects of type kind com.rti.dds.typecode.TCKind.TK ARRAY
(p. 1528) or com.rti.dds.typecode.TCKind.TK SEQUENCE (p. 1528),
this method returns the number of elements in the collection.
839
For objects of type kind com.rti.dds.typecode.TCKind.TK STRUCT

(p. 1528) or com.rti.dds.typecode.TCKind.TK VALUE (p. 1529), it returns the number of fields in the sample, which will always be the same as
the number of fields in the type.
For objects of type kind com.rti.dds.typecode.TCKind.TK SPARSE
(p. 1529), it returns the number of fields in the sample, which may be less than
or equal to the number of fields in the type.
MT Safety:
UNSAFE.
See also:
8.76.7.16
boolean member exists (String member name, int

member id)
Indicates whether a member of a particular name/ID exists in this data sample.

Only one of the name and/or ID need by specified.
For objects of type kinds other than com.rti.dds.typecode.TCKind.TK SPARSE (p. 1529), the result of this method will always be the same as
that of com.rti.dds.dynamicdata.DynamicData.member exists in type
(p. 840).
MT Safety:
UNSAFE.
Parameters:
See also:
com.rti.dds.dynamicdata.DynamicData.member exists in type
(p. 840)
com.rti.dds.dynamicdata.DynamicData.MEMBER ID UNSPECIFIED (p. 880)
840
Class Documentation
8.76.7.17
boolean member exists in type (String member name,

int member id)
Indicates whether a member of a particular name/ID exists in this data samples

type.
Only one of the name and/or ID need by specified.
For objects of type kinds other than com.rti.dds.typecode.TCKind.TK SPARSE (p. 1529), the result of this method will always be the same as that
of com.rti.dds.dynamicdata.DynamicData.member exists (p. 839).
MT Safety:
UNSAFE.
Parameters:
See also:
com.rti.dds.dynamicdata.DynamicData.member exists (p. 839)
8.76.7.18
void get member info (DynamicDataMemberInfo info,

Fill in the given descriptor with information about the identified member of this
com.rti.dds.dynamicdata.DynamicData (p. 817) sample.
This operation is valid for objects of com.rti.dds.typecode.TCKind
(p. 1525)
(p. 1528),
(p. 1528),
(p. 1528),
(p. 1529),
and
MT Safety:
UNSAFE.
841
Parameters:
info <<out>> ( p. 279) The descriptor object whose contents will be overwritten by this operations.
member name <<in>> ( p. 279) The name of the member for which to
get the info or null to look up the member by its ID. Only one of the
name and the ID may be unspecified.
member id <<in>> ( p. 279) The ID of the member for which to get the
info, or com.rti.dds.dynamicdata.DynamicData.MEMBER ID UNSPECIFIED (p. 880) to look up by name. See Member
Exceptions:
See also:
8.76.7.19
void get member info by index

(DynamicDataMemberInfo info, int index)
Fill in the given descriptor with information about the identified member of this
(p. 1525)
(p. 1528),
(p. 1528),
(p. 1528),
(p. 1529),
and
MT Safety:
UNSAFE.
Parameters:
info <<out>> ( p. 279) The descriptor object whose contents will be overwritten by this operations.
index <<in>> ( p. 279) The zero-based of the member for which to get
the info.
842
Class Documentation
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.get member count
(p. 838)
8.76.7.20
TypeCode get member type (String member name, int

member id)
Get the type of the given member of this sample.

The member can be looked up either by name or by ID.
(p. 1528),
(p. 1525)
(p. 1528),
(p. 1528),
(p. 1529),
and
For type
kinds
(p. 1528)
and
com.rti.dds.typecode.TCKind.TK SEQUENCE (p. 1528), the index
into the collection is taken to be one less than the ID, if specified. If this index
is valid, this operation will return the content type of this collection.
MT Safety:
UNSAFE.
Parameters:
Exceptions:
843
See also:
8.76.7.21
boolean is member key (String member name, int

member id)
Indicates whether a given member forms part of the key of this samples data
type.
This operation is only valid
com.rti.dds.typecode.TCKind.TK
for samples of types

STRUCT
VALUE
(p. 1529),
SPARSE (p. 1529).
of kind
(p. 1528),
or
Note to users of sparse types: A key member may only have a single representation and is required to exist in every sample.
MT Safety:
UNSAFE.
Parameters:
Exceptions:
8.76.7.22
int get int (String member name, int member id)
Get the value of the given field, which is of type com.rti.dds.infrastructure.int

or another type implicitly convertible to it (byte, char, short,
com.rti.dds.infrastructure.short, or com.rti.dds.util.Enum (p. 944)).
The member may be specified by name or by ID.
MT Safety:
UNSAFE.
844
Class Documentation
Parameters:
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.set int
8.76.7.23
int get int array (int[ ] array, String member name, int
member id)

This
method
will
perform
an
automatic
com.rti.dds.infrastructure.IntSeq (p. 1064).
conversion
from
If the destination array is insufficiently long to store the data, this operation
will fail without copying anything.
MT Safety:
UNSAFE.
Parameters:
array <<out>> ( p. 279) An already-allocated array, into which the elements will be copied.
Exceptions:
845
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.set int array
com.rti.dds.dynamicdata.DynamicData.DynamicData.get int seq
8.76.7.24
void get int seq (IntSeq seq, String member name, int
member id)

The provided sequence will be automatically resized as necessary.
This method will perform an automatic conversion from an array of
com.rti.dds.infrastructure.int.
MT Safety:
UNSAFE.
Parameters:
seq <<out>> ( p. 279) A sequence, into which the elements will be copied.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.set int seq
com.rti.dds.dynamicdata.DynamicData.DynamicData.get int array
8.76.7.25
short get short (String member name, int member id)
Get the value of the given field, which is of type short or another type implicitly
convertible to it (byte or char).
846
Class Documentation
MT Safety:
UNSAFE.
Parameters:
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.set short (p. 863)
8.76.7.26
int get short array (short[ ] array, String member name,

int member id)

This
method
will
perform
an
automatic
com.rti.dds.infrastructure.ShortSeq (p. 1442).
conversion
from
MT Safety:
UNSAFE.
Parameters:
847
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.set short array (p. 864)
com.rti.dds.dynamicdata.DynamicData.get short seq (p. 847)
8.76.7.27
void get short seq (ShortSeq seq, String member name,

int member id)

This method will perform an automatic conversion from an array of short.
MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
See also:
com.rti.dds.dynamicdata.DynamicData.set short seq (p. 865)
com.rti.dds.dynamicdata.DynamicData.get short array (p. 846)
8.76.7.28
float get float (String member name, int member id)
Get the value of the given field, which is of type float.

or
848
Class Documentation
MT Safety:
UNSAFE.
Parameters:
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.set float (p. 865)
8.76.7.29
int get float array (float[ ] array, String member name,

int member id)

This
method
will
perform
an
automatic
com.rti.dds.infrastructure.FloatSeq (p. 958).
conversion
from
MT Safety:
UNSAFE.
Parameters:
849
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.set float array (p. 866)
com.rti.dds.dynamicdata.DynamicData.get float seq (p. 849)
8.76.7.30
void get float seq (FloatSeq seq, String member name,

int member id)

This method will perform an automatic conversion from an array of float.
MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.set float seq (p. 867)
com.rti.dds.dynamicdata.DynamicData.get float array (p. 848)
8.76.7.31
double get double (String member name, int member id)
Get the value of the given field, which is of type double or another type implicitly
convertible to it (float).
850
Class Documentation

MT Safety:
UNSAFE.
Parameters:
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.set double (p. 868)
8.76.7.32
int get double array (double[ ] array, String

member name, int member id)

This
method
will
perform
an
automatic
com.rti.dds.infrastructure.DoubleSeq (p. 796).
conversion
from
MT Safety:
UNSAFE.
Parameters:
851
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.set double array (p. 868)
com.rti.dds.dynamicdata.DynamicData.get double seq (p. 851)
8.76.7.33
void get double seq (DoubleSeq seq, String


This method will perform an automatic conversion from an array of double.
MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.set double seq (p. 869)
com.rti.dds.dynamicdata.DynamicData.get double array (p. 850)
8.76.7.34
boolean get boolean (String member name, int

member id)
Get the value of the given field, which is of type boolean.

852
Class Documentation

MT Safety:
UNSAFE.
Parameters:
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.set boolean (p. 870)
8.76.7.35
int get boolean array (boolean[ ] array, String


This
method
will
perform
an
automatic
com.rti.dds.infrastructure.BooleanSeq (p. 417).
conversion
from
MT Safety:
UNSAFE.
Parameters:
853
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.set boolean array (p. 870)
com.rti.dds.dynamicdata.DynamicData.get boolean seq (p. 853)
8.76.7.36
void get boolean seq (BooleanSeq seq, String


This method will perform an automatic conversion from an array of boolean.
MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.set boolean seq (p. 871)
com.rti.dds.dynamicdata.DynamicData.get boolean array (p. 852)
8.76.7.37
char get char (String member name, int member id)
Get the value of the given field, which is of type char.

854
Class Documentation
MT Safety:
UNSAFE.
Parameters:
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.set char (p. 872)
8.76.7.38
int get char array (char[ ] array, String member name,

int member id)

This
method
will
perform
an
automatic
com.rti.dds.infrastructure.CharSeq (p. 458).
conversion
from
MT Safety:
UNSAFE.
Parameters:
855
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.set char array (p. 872)
com.rti.dds.dynamicdata.DynamicData.get char seq (p. 855)
8.76.7.39
void get char seq (CharSeq seq, String member name,

int member id)

This method will perform an automatic conversion from an array of char.
MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
See also:
com.rti.dds.dynamicdata.DynamicData.set char seq (p. 873)
com.rti.dds.dynamicdata.DynamicData.get char array (p. 854)
8.76.7.40
byte get byte (String member name, int member id)
Get the value of the given field, which is of type byte.

or
856
Class Documentation
MT Safety:
UNSAFE.
Parameters:
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.set byte
8.76.7.41
int get byte array (byte[ ] array, String member name,

int member id)

This
method
will
perform
an
automatic
com.rti.dds.infrastructure.ByteSeq (p. 441).
conversion
from
MT Safety:
UNSAFE.
Parameters:
857
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.set byte array
com.rti.dds.dynamicdata.DynamicData.DynamicData.get byte seq
8.76.7.42
void get byte seq (ByteSeq seq, String member name,

int member id)

This method will perform an automatic conversion from an array of byte.
MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.set byte seq
com.rti.dds.dynamicdata.DynamicData.DynamicData.get byte array
8.76.7.43
long get long (String member name, int member id)
Get the value of the given field, which is of type long or another type implicitly convertible to it (byte, char, short, com.rti.dds.infrastructure.short,
858
Class Documentation
com.rti.dds.infrastructure.int,
com.rti.dds.util.Enum (p. 944)).
or

MT Safety:
UNSAFE.
Parameters:
Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.set long
8.76.7.44
int get long array (long[ ] array, String member name,

int member id)

This
method
will
perform
an
automatic
com.rti.dds.infrastructure.LongSeq (p. 1181).
conversion
from
MT Safety:
UNSAFE.
Parameters:
859

Exceptions:
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.set long array
com.rti.dds.dynamicdata.DynamicData.DynamicData.get long seq
8.76.7.45
void get long seq (LongSeq seq, String member name,

int member id)

This method will perform an automatic conversion from an array of long.
MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.set long seq
com.rti.dds.dynamicdata.DynamicData.DynamicData.get long array
or
860
Class Documentation
8.76.7.46
String get string (String member name, int member id)
Get
the
value
of
the
com.rti.dds.infrastructure.String.
given
field,
which
is
of
type

MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.set string (p. 878)
8.76.7.47
void get complex member (DynamicData value out,

Get a copy of the value of the given field, which is of some composed type.
The member may be of type kind com.rti.dds.typecode.TCKind.TK ARRAY
(p. 1528),
com.rti.dds.typecode.TCKind.TK com.rti.dds.typecode.TCKind.TK SEQUENCE
(p. 1528),
STRUCT
(p. 1528),
(p. 1529), com.rti.dds.typecode.TCKind.TK UNION (p. 1528), or
It may be
specified by name or by ID.
This method is logically related to com.rti.dds.dynamicdata.DynamicData.bind complex member (p. 835) in that both allow you to examine the state of
nested objects. They are different in an important way: this method provides
a copy of the data; changes to it will not be reflected in the source object.
861
MT Safety:
UNSAFE.
Parameters:
value out <<out>> ( p. 279) The com.rti.dds.dynamicdata.DynamicData
(p. 817) sample whose contents will be overwritten by this operation.
This object must not be a bound member of another
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.set complex member
(p. 879)
(p. 835)
8.76.7.48
void set int (String member name, int member id, int
value)
Set the value of the given field, which is of type com.rti.dds.infrastructure.int.

MT Safety:
UNSAFE.
Parameters:
862
Class Documentation
value <<in>> ( p. 279) The value to which to set the member.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.get int
8.76.7.49
void set int array (String member name, int member id,
int[ ] array)

This
method
will
perform
an
automatic
com.rti.dds.infrastructure.IntSeq (p. 1064).
conversion
to
MT Safety:
UNSAFE.
Parameters:
array <<in>> ( p. 279) The elements to copy.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.get int array
com.rti.dds.dynamicdata.DynamicData.DynamicData.set int seq

8.76.7.50
863
void set int seq (String member name, int member id,
IntSeq value)

This method will perform an automatic conversion to an array of
com.rti.dds.infrastructure.int.
MT Safety:
UNSAFE.
Parameters:
value <<out>> ( p. 279) A sequence, from which the elements will be
copied.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.get int seq
com.rti.dds.dynamicdata.DynamicData.DynamicData.set int array
8.76.7.51
void set short (String member name, int member id,

short value)
Set the value of the given field, which is of type short.

MT Safety:
UNSAFE.
Parameters:
864
Class Documentation
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.get short (p. 845)
8.76.7.52
void set short array (String member name, int

member id, short[ ] array)

This
method
will
perform
an
automatic
com.rti.dds.infrastructure.ShortSeq (p. 1442).
conversion
to
MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
865
See also:
com.rti.dds.dynamicdata.DynamicData.get short array (p. 846)
com.rti.dds.dynamicdata.DynamicData.set short seq (p. 865)
8.76.7.53
void set short seq (String member name, int member id,
ShortSeq value)

This method will perform an automatic conversion to an array of short.
MT Safety:
UNSAFE.
Parameters:
copied.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
See also:
com.rti.dds.dynamicdata.DynamicData.get short seq (p. 847)
com.rti.dds.dynamicdata.DynamicData.set short array (p. 864)
8.76.7.54
void set float (String member name, int member id,

float value)
Set the value of the given field, which is of type float.

MT Safety:
UNSAFE.
or
866
Class Documentation
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.get float (p. 847)
8.76.7.55
void set float array (String member name, int

member id, float[ ] array)

This
method
will
perform
an
automatic
com.rti.dds.infrastructure.FloatSeq (p. 958).
conversion
to
MT Safety:
UNSAFE.
Parameters:
867
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.get float array (p. 848)
com.rti.dds.dynamicdata.DynamicData.set float seq (p. 867)
8.76.7.56
void set float seq (String member name, int member id,
FloatSeq value)

This method will perform an automatic conversion to an array of float.
MT Safety:
UNSAFE.
Parameters:
copied.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
See also:
com.rti.dds.dynamicdata.DynamicData.get float seq (p. 849)
com.rti.dds.dynamicdata.DynamicData.set float array (p. 866)
or
868
Class Documentation
8.76.7.57
void set double (String member name, int member id,

double value)
Set the value of the given field, which is of type double.

MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.get double (p. 849)
8.76.7.58
void set double array (String member name, int

member id, double[ ] array)

This
method
will
perform
an
automatic
com.rti.dds.infrastructure.DoubleSeq (p. 796).
conversion
to
MT Safety:
UNSAFE.
Parameters:
869

Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.get double array (p. 850)
com.rti.dds.dynamicdata.DynamicData.set double seq (p. 869)
8.76.7.59
void set double seq (String member name, int

member id, DoubleSeq value)

This method will perform an automatic conversion to an array of double.
MT Safety:
UNSAFE.
Parameters:
copied.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
870
Class Documentation
See also:
com.rti.dds.dynamicdata.DynamicData.get double seq (p. 851)
com.rti.dds.dynamicdata.DynamicData.set double array (p. 868)
8.76.7.60
void set boolean (String member name, int member id,

boolean value)
Set the value of the given field, which is of type boolean.

MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.get boolean (p. 851)
8.76.7.61
void set boolean array (String member name, int

member id, boolean[ ] array)

This
method
will
perform
an
automatic
com.rti.dds.infrastructure.BooleanSeq (p. 417).
conversion
to
871
MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.get boolean array (p. 852)
com.rti.dds.dynamicdata.DynamicData.set boolean seq (p. 871)
8.76.7.62
void set boolean seq (String member name, int

member id, BooleanSeq value)

This method will perform an automatic conversion to an array of boolean.
MT Safety:
UNSAFE.
Parameters:
copied.
872
Class Documentation
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.get boolean seq (p. 853)
com.rti.dds.dynamicdata.DynamicData.set boolean array (p. 870)
8.76.7.63
void set char (String member name, int member id,

char value)
Set the value of the given field, which is of type char.

MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.get char (p. 853)
8.76.7.64
void set char array (String member name, int

member id, char[ ] array)


This
method
will
perform
an
automatic
com.rti.dds.infrastructure.CharSeq (p. 458).
873
conversion
to
MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.get char array (p. 854)
com.rti.dds.dynamicdata.DynamicData.set char seq (p. 873)
8.76.7.65
void set char seq (String member name, int member id,
CharSeq value)

This method will perform an automatic conversion to an array of char.
MT Safety:
UNSAFE.
Parameters:
874
Class Documentation
copied.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.get char seq (p. 855)
com.rti.dds.dynamicdata.DynamicData.set char array (p. 872)
8.76.7.66
void set byte (String member name, int member id,

byte value)
Set the value of the given field, which is of type byte.

MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.get byte

8.76.7.67
875
void set byte array (String member name, int

member id, byte[ ] array)

This
method
will
perform
an
automatic
com.rti.dds.infrastructure.ByteSeq (p. 441).
conversion
to
MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.get byte array
com.rti.dds.dynamicdata.DynamicData.DynamicData.set byte seq
8.76.7.68
void set byte seq (String member name, int member id,
ByteSeq value)

This method will perform an automatic conversion to an array of byte.
MT Safety:
UNSAFE.
876
Class Documentation
Parameters:
copied.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.get byte seq
com.rti.dds.dynamicdata.DynamicData.DynamicData.set byte array
8.76.7.69
void set long (String member name, int member id, long
value)
Set the value of the given field, which is of type long.

MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
877
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.get long
8.76.7.70
void set long array (String member name, int

member id, long[ ] array)

This
method
will
perform
an
automatic
com.rti.dds.infrastructure.LongSeq (p. 1181).
conversion
to
MT Safety:
UNSAFE.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.get long array
com.rti.dds.dynamicdata.DynamicData.DynamicData.set long seq
8.76.7.71
void set long seq (String member name, int member id,
LongSeq value)

This method will perform an automatic conversion to an array of long.
878
Class Documentation
MT Safety:
UNSAFE.
Parameters:
copied.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.DynamicData.get long seq
com.rti.dds.dynamicdata.DynamicData.DynamicData.set long array
8.76.7.72
void set string (String member name, int member id,

String value)
Set the value of the given field of type com.rti.dds.infrastructure.String.

MT Safety:
UNSAFE.
Parameters:
879
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.get string (p. 860)
8.76.7.73
void set complex member (String member name, int

member id, DynamicData value)
Copy the state of the given com.rti.dds.dynamicdata.DynamicData

(p. 817) object into a member of this object.
The member may be of type kind com.rti.dds.typecode.TCKind.TK ARRAY
(p. 1528),
com.rti.dds.typecode.TCKind.TK com.rti.dds.typecode.TCKind.TK SEQUENCE
(p. 1528),
STRUCT
(p. 1528),
(p. 1529), com.rti.dds.typecode.TCKind.TK UNION (p. 1528), or
It may be
specified by name or by ID.
Example: Copying Data
This method can be used with com.rti.dds.dynamicdata.DynamicData.bind complex member
(p. 835)
to
copy
from
one
com.rti.dds.dynamicdata.DynamicData (p. 817) object to another
efficiently. Suppose the following data structure:
struct Bar {
short theShort;
};
struct Foo {
Bar theBar;
};
Support we have two instances of Foo: foo dst and foo src. We want to
replace the contents of foo dst.theBar with the contents of foo src.theBar.
Error handling has been omitted for the sake of brevity.
DynamicData foo_dst = ...;
DynamicData foo_src = ...;
DynamicData bar = new DynamicData(null, myProperties);
// Point to the source of the copy:
foo_src.bind_complex_member(
"theBar",
880
Class Documentation
DynamicData.MEMBER_ID_UNSPECIFIED,
bar);
try {
// Just one copy:
foo_dst.set_complex_member(
"theBar",
DynamicData.MEMBER_ID_UNSPECIFIED,
bar);
} finally {
// Tear down:
foo_src.unbind_complex_member(bar);
}
bar.delete();
MT Safety:
UNSAFE.
Parameters:
value <<in>> ( p. 279) The source com.rti.dds.dynamicdata.DynamicData
(p. 817) object whose contents will be copied.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
See also:
com.rti.dds.dynamicdata.DynamicData.get complex member
(p. 860)
(p. 835)
8.76.8
8.76.8.1
final int MEMBER ID UNSPECIFIED [static]
A sentinel value that indicates that no member ID is needed in order to perform

some operation.
881
Most commonly, this constant will be used in get operations to indicate that
a lookup should be performed based on a name, not on an ID.
882
Class Documentation
Get
Set
com.rti.dds.dynamicdata.DynamicData.DynamicData.get
com.rti.dds.dynamicdata.DynamicData.DynamicData.set
int
int
com.rti.dds.dynamicdata.DynamicData.get
com.rti.dds.dynamicdata.DynamicData.set
short
short
(p. 845)
(p. 863)
long
long
float
float
(p. 847)
(p. 865)
double
double
(p. 849)
(p. 868)
boolean
boolean
(p. 851)
(p. 870)
byte
byte
char
char
(p. 853)
(p. 872)
string
string
(p. 860)
(p. 878)
Table 8.3: Basic Types
Get
Set
complex member
complex member
(p. 860)
(p. 879)
Table 8.4: Structures, Arrays, and Other Complex Types
Get
883
Set
int array
int array
short array
short array
(p. 846)
(p. 864)
long array
long array
float array
float array
(p. 848)
(p. 866)
double array
double array
(p. 850)
(p. 868)
boolean array
boolean
(p. 852)
(p. 870)
byte array
byte array
char array
char array
(p. 854)
(p. 872)
Table 8.5: Arrays of Basic Types
884
Class Documentation
Get
Set
int seq
int seq
short seq
short seq
(p. 847)
(p. 865)
long seq
long seq
float seq
float seq
(p. 849)
(p. 867)
double seq
double seq
(p. 851)
(p. 869)
boolean seq
boolean seq
(p. 853)
(p. 871)
byte seq
byte seq
char seq
char seq
(p. 855)
(p. 873)
Table 8.6: Sequences of Basic Types
8.77 DynamicDataInfo Class Reference
8.77
885
DynamicDataInfo Class Reference

Inherits Struct.

DynamicDataInfo ()
DynamicDataInfo (int member count, int stored size, boolean is optimized storage)
Public Attributes
int member count
The
number
of
data
members
in
com.rti.dds.dynamicdata.DynamicData ( p. 817) sample.
this
int stored size

The number of bytes currently used to store the data
com.rti.dds.dynamicdata.DynamicData ( p. 817) sample.
8.77.1
of
this

See also:
8.77.2
8.77.2.1
int member count
The number of data members in this com.rti.dds.dynamicdata.DynamicData

(p. 817) sample.
886
Class Documentation
8.77.2.2
int stored size
The number of bytes currently used to store the

data
of
this
8.78 DynamicDataMemberInfo Class Reference
8.78
887
DynamicDataMemberInfo Class Reference
Inherits Struct.

DynamicDataMemberInfo ()
DynamicDataMemberInfo (int member id, String member name,

boolean member exists, TCKind member kind, int representation count, int element count, TCKind element kind)
Public Attributes
int member id
An integer that uniquely identifies the data member within
com.rti.dds.dynamicdata.DynamicData ( p. 817) samples type.
this
String member name

The string name of the data member.
boolean member exists

Indicates whether the corresponding member of the data type actually exists
in this sample.
TCKind member kind

The kind of type of this data member (e.g. integer, structure, etc.).
int element count

The number of elements within this data member.
TCKind element kind

The kind of type of the elements within this data member.
888
Class Documentation
8.78.1
See also:
8.78.2
8.78.2.1
int member id
An integer that uniquely identifies the data member within

com.rti.dds.dynamicdata.DynamicData (p. 817) samples type.
this
For sparse data types, this value will be assigned by the type designer. For
types defined in IDL, it will be assigned automatically by the middleware based
on the members declaration order within the type.
See also:
com.rti.dds.typecode.TCKind (p. 1525)
8.78.2.2
String member name
The string name of the data member.

This name will be unique among members of the same type. However, a single
named member may have multiple type representations.
See also:
com.rti.dds.dynamicdata.DynamicDataMemberInfo.representation count
8.78.2.3
boolean member exists
Indicates whether the corresponding member of the data type actually exists in
this sample.
For
non-sparse
data
types,
this
value
will
always
be
See also:
com.rti.dds.typecode.TCKind (p. 1525)
8.78 DynamicDataMemberInfo Class Reference

8.78.2.4
889
TCKind member kind
The kind of type of this data member (e.g. integer, structure, etc.).
This is a convenience field; it is equivalent to looking up the member in the com.rti.dds.typecode.TypeCode (p. 1611) and getting the
com.rti.dds.typecode.TCKind (p. 1525) from there.
8.78.2.5
int element count
The number of elements within this data member.

This information is only valid for members of array or sequence types. Members
of other types will always report zero (0) here.
8.78.2.6
TCKind element kind
The kind of type of the elements within this data member.

This information is only valid for members of array or sequence types. Members
of other types will always report com.rti.dds.typecode.TCKind.TK NULL
(p. 1527) here.
890
Class Documentation
8.79
DynamicDataProperty t Class Reference
A
collection
of
attributes
used
to
com.rti.dds.dynamicdata.DynamicData (p. 817) objects.
configure

DynamicDataProperty t ()
The constructor.
DynamicDataProperty t (int buffer initial size, int buffer max size, int buffer max size increment)
The constructor.
Public Attributes
int buffer initial size = 0
The
initial
amount
of
memory
used
by
com.rti.dds.dynamicdata.DynamicData ( p. 817) object, in bytes.
this
int buffer max size = 65536

The
maximum
amount
of
in bytes.
8.79.1
memory
that
( p. 817) object may
this
use,
A
collection
of
attributes
used
to
8.79.2
8.79.2.1
DynamicDataProperty t ()
configure
The constructor.
8.79.2.2
DynamicDataProperty t (int buffer initial size, int

buffer max size, int buffer max size increment)
The constructor.
8.79 DynamicDataProperty t Class Reference
8.79.3
8.79.3.1
int buffer initial size = 0
The
initial
amount
of
memory
used
by
com.rti.dds.dynamicdata.DynamicData (p. 817) object, in bytes.
891
this
See also:
com.rti.dds.dynamicdata.DynamicDataProperty t.buffer max size (p. 891)
8.79.3.2
int buffer max size = 65536
The
maximum
amount
of
memory
that
this
com.rti.dds.dynamicdata.DynamicData (p. 817) object may use, in
bytes.
It will grow to this size from the initial size as needed.
See also:
com.rti.dds.dynamicdata.DynamicDataProperty t.buffer initial size (p. 891)
892
Class Documentation
8.80
DynamicDataReader Class Reference
Reads (subscribes to) objects of type com.rti.dds.dynamicdata.DynamicData

(p. 817).
Inheritance diagram for DynamicDataReader::

void read (DynamicDataSeq received data, SampleInfoSeq info seq,
int max samples, int sample states, int view states, int instance states)
Access
a
collection
of
data
samples
8.80.1
from
the
Reads (subscribes to) objects of type com.rti.dds.dynamicdata.DynamicData

(p. 817).
Instantiates
com.rti.dds.dynamicdata.DynamicData (p. 817) > .
<
See also:
com.rti.dds.dynamicdata.DynamicData (p. 817)
8.80.2
8.80.2.1
void read (DynamicDataSeq received data, SampleInfoSeq

Access
a
collection
of
data
samples
from
the
This
operation
offers
the
same
functionality
and
API
as
com.rti.ndds.example.FooDataReader.take (p. 983) except that the
samples returned remain in the com.rti.dds.subscription.DataReader
(p. 487) such that they can be retrieved again by means of a read or take
operation.
8.80 DynamicDataReader Class Reference
893
Please refer to the documentation of com.rti.ndds.example.FooDataReader.take()

(p. 983) for details on the number of samples returned within the received data
and info seq as well as the order in which the samples appear in these sequences.
The act of reading a sample changes its sample state to
com.rti.dds.subscription.SampleStateKind.SampleStateKind.READ SAMPLE STATE. If the sample belongs to the most recent generation
of the instance, it will also set the view state of the instance to be
com.rti.dds.subscription.ViewStateKind.ViewStateKind.NOT NEW VIEW STATE. It will not affect the instance state of the instance.
Important: If the samples returned by this method are loaned from RTI
Connext (see com.rti.ndds.example.FooDataReader.take (p. 983) for more
information on memory loaning), it is important that their contents not be
changed. Because the memory in which the data is stored belongs to the middleware, any modifications made to the data will be seen the next time the same
samples are read or taken; the samples will no longer reflect the state that was
received from the network.
Parameters:
received data <<inout>>
( p. 279)
User
data
type-specific
object
where the received data samples will be returned.
Must
be a valid non-NULL FooSeq.
The method will fail with
(p. 1355) if it is NULL.
info seq <<inout>> ( p. 279) A com.rti.dds.subscription.SampleInfoSeq
(p. 1409)
object
where
the
received
sample
info
will
be
returned.
Must
be
a
valid
non-NULL
com.rti.dds.subscription.SampleInfoSeq (p. 1409). The method
will fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) if it is NULL.
max samples <<in>>
( p. 279)
The
maximum
number of samples to be returned.
If the special value
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106) is provided, as many samples will be returned
as are available, up to the limits described in the documentation for
com.rti.ndds.example.FooDataReader.take() (p. 983).
sample states <<in>> ( p. 279) Data samples matching one of these
sample states are returned.
view states <<in>> ( p. 279) Data samples matching one of these
view state are returned.
instance states <<in>> ( p. 279) Data samples matching ones of these
instance state are returned.
894
Class Documentation
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1363),
(p. 1360)
com.rti.dds.infrastructure.RETCODE NO DATA
(p. 1361).
See also:
(p. 990),
(p. 983),
8.81 DynamicDataSeq Class Reference
8.81
895
DynamicDataSeq Class Reference
An ordered collection of com.rti.dds.dynamicdata.DynamicData (p. 817)

elements.
Inheritance diagram for DynamicDataSeq::

DynamicDataSeq ()
Construct a new empty com.rti.dds.dynamicdata.DynamicDataSeq
( p. 895).
DynamicDataSeq (int initialMaximum)

( p. 895).
DynamicDataSeq (Collection elements)

Construct a new com.rti.dds.dynamicdata.DynamicDataSeq ( p. 895)
containing the same elements as the given collection.
8.81.1
An ordered collection of com.rti.dds.dynamicdata.DynamicData (p. 817)

elements.
See also:
http://java.sun.com/javase/6/docs/api/java/util/List.html
8.81.2
8.81.2.1
DynamicDataSeq ()

(p. 895).
896
Class Documentation
8.81.2.2
DynamicDataSeq (int initialMaximum)

(p. 895).
The new sequence will have the given maximum. (The maximum of the sequence
is equivalent to what, in an ArrayList, is called the capacity.)
See also:
http://java.sun.com/javase/6/docs/api/java/util/ArrayList.html
8.81.2.3
DynamicDataSeq (Collection elements)
Construct a new com.rti.dds.dynamicdata.DynamicDataSeq (p. 895) containing the same elements as the given collection.
See also:
http://java.sun.com/javase/6/docs/api/java/util/Collection.html
8.82 DynamicDataTypeProperty t Class Reference
8.82
897
DynamicDataTypeProperty t Class Reference
A
collection
of
attributes
used
to
configure

DynamicDataTypeProperty t ()
The constructor.
DynamicDataTypeProperty t (DynamicDataProperty t data,

DynamicDataTypeSerializationProperty t serialization)
The constructor.
Public Attributes
final DynamicDataProperty t data
These
properties
will
be
provided
to
every
new
com.rti.dds.dynamicdata.DynamicData ( p. 817) sample created from
the com.rti.dds.dynamicdata.DynamicDataTypeSupport ( p. 901).
final DynamicDataTypeSerializationProperty t serialization

Properties that govern how the data of this type will be serialized on the
network.
8.82.1
A
collection
of
attributes
used
to
8.82.2
8.82.2.1
DynamicDataTypeProperty t ()
configure
The constructor.
898
Class Documentation
8.82.2.2
DynamicDataTypeProperty t (DynamicDataProperty t
data, DynamicDataTypeSerializationProperty t
serialization)
The constructor.
8.82.3
8.82.3.1
final DynamicDataProperty t data
Initial value:
new DynamicDataProperty_t()
These
properties
will
be
provided
to
every
new
com.rti.dds.dynamicdata.DynamicData (p. 817) sample created from
the com.rti.dds.dynamicdata.DynamicDataTypeSupport (p. 901).
8.82.3.2
final DynamicDataTypeSerializationProperty t
serialization
Initial value:
new DynamicDataTypeSerializationProperty_t()
Properties that govern how the data of this type will be serialized on the network.
8.83 DynamicDataTypeSerializationProperty t Class Reference 899
8.83
DynamicDataTypeSerializationProperty t
Class Reference
network.

DynamicDataTypeSerializationProperty t ()
The constructor.
DynamicDataTypeSerializationProperty t (boolean
compatible alignment, int max size serialized)
use 42e -
The constructor.
Public Attributes
boolean use 42e compatible alignment = false
Use RTI Connext 4.2e-compatible alignment for large primitive types.
int max size serialized = 0xffffffff

The maximum number of bytes that objects of a given type could consume
when serialized on the network.
8.83.1
network.
8.83.2
8.83.2.1
DynamicDataTypeSerializationProperty t ()
The constructor.
8.83.2.2
DynamicDataTypeSerializationProperty t (boolean
use 42e compatible alignment, int max size serialized)
The constructor.
900
Class Documentation
8.83.3
8.83.3.1
boolean use 42e compatible alignment = false
Use RTI Connext 4.2e-compatible alignment for large primitive types.

In RTI Connext 4.2e, the default alignment for large primitive types long,
double,
and
com.rti.dds.infrastructure.LongDouble was not RTPS-compliant.
This
compatibility mode allows applications targeting post-4.2e versions of RTI
Connext to interoperate with 4.2e-based applications, regardless of the data
types they use.
If this flag is not set, all data will be serialized in an RTPS-compliant manner,
which for the types listed above, will not be interoperable with RTI Connext
4.2e.
8.83.3.2
int max size serialized = 0xffffffff
The maximum number of bytes that objects of a given type could consume when
serialized on the network.
This value is used to set the sizes of certain internal middleware buffers.
The effective value of the maximum serialized size will be the
value of this field or the size automatically inferred from the types
com.rti.dds.typecode.TypeCode (p. 1611), whichever is smaller.
8.84 DynamicDataTypeSupport Class Reference
8.84
901
DynamicDataTypeSupport Class Reference
A factory for registering a dynamically defined type

and
creating
Inheritance diagram for DynamicDataTypeSupport::

final void register type (DomainParticipant participant, String type name)
Associate the com.rti.dds.typecode.TypeCode ( p. 1611) with the given
com.rti.dds.domain.DomainParticipant ( p. 654) under the given logical
name.
final void unregister type (DomainParticipant participant, String

type name)
Remove
the
definition
of
this
type
from
the
final String get type name ()

Get the default name of this type.
final TypeCode get data type ()

Get the com.rti.dds.typecode.TypeCode ( p. 1611) wrapped by this
com.rti.dds.dynamicdata.DynamicDataTypeSupport ( p. 901).
Object create data ()

Create a new com.rti.dds.dynamicdata.DynamicData ( p. 817) sample initialized with the com.rti.dds.typecode.TypeCode ( p. 1611) and
properties of this com.rti.dds.dynamicdata.DynamicDataTypeSupport
( p. 901).
void destroy data (Object data)

Finalize and deallocate the com.rti.dds.dynamicdata.DynamicData
( p. 817) sample.
void print data (DynamicData data)

Print a string representation of the given sample to the given file.
void copy data (DynamicData dst, DynamicData src)

902
Class Documentation
Deeply copy the given data samples.
void delete ()
Delete a com.rti.dds.dynamicdata.DynamicDataTypeSupport ( p. 901)
object.
DynamicDataTypeSupport (TypeCode type, DynamicDataTypeProperty t props)

Construct a new com.rti.dds.dynamicdata.DynamicDataTypeSupport
( p. 901) object.

static final DynamicDataTypeProperty t TYPE PROPERTY DEFAULT
Sentinel
constant
indicating
default
values
com.rti.dds.dynamicdata.DynamicDataTypeProperty t ( p. 897).
for
Static Protected Attributes

static final RuntimeException DYNAMICDATA TYPE NOT SUPPORTED = new RETCODE ERROR(not a top-level type)
8.84.1
A factory for registering a dynamically defined type

and
creating
A com.rti.dds.dynamicdata.DynamicDataTypeSupport (p. 901) has

three roles:
1. It associates a com.rti.dds.typecode.TypeCode (p. 1611) with

policies for managing objects of that type.
See the constructor,
com.rti.dds.dynamicdata.DynamicDataTypeSupport.DynamicDataTypeSupport.DynamicDataTyp
2. It
registers
its
type
under
logical
names
with
a
(p. 654).
See
com.rti.dds.dynamicdata.DynamicDataTypeSupport.register type (p. 904).
3. It creates com.rti.dds.dynamicdata.DynamicData (p. 817) samples
pre-initialized with the type and properties of the type support itself. See
903
com.rti.dds.dynamicdata.DynamicDataTypeSupport.create data (p. 905).
8.84.2
8.84.2.1
DynamicDataTypeSupport (TypeCode type,

DynamicDataTypeProperty t props)
Construct a new com.rti.dds.dynamicdata.DynamicDataTypeSupport

(p. 901) object.
This step is usually followed by type registration.
The new object created by this constructor retains a reference to the
com.rti.dds.typecode.TypeCode (p. 1611) that is passed in. It is not
safe to delete the com.rti.dds.typecode.TypeCode (p. 1611) until the
com.rti.dds.dynamicdata.DynamicDataTypeSupport (p. 901) itself is
deleted. You have two options:
(p. 1611)
object
yourself,
and
delete
it
with
com.rti.dds.typecode.TypeCodeFactory.delete after
youve
deleted
the
tc
(p. 1660)
com.rti.dds.dynamicdata.DynamicDataTypeSupport (p. 901).
Parameters:
type The com.rti.dds.typecode.TypeCode (p. 1611) that describes the
members of this type.
props Policies that describe how to manage the memory and
other properties of the data samples created by this factory. In most cases, the default values will be appropriate; see
com.rti.dds.dynamicdata.DynamicDataTypeSupport.TYPE PROPERTY DEFAULT (p. 179).
See also:
com.rti.dds.dynamicdata.DynamicDataTypeSupport.register type (p. 904)
904
Class Documentation
8.84.3
8.84.3.1
final void register type (DomainParticipant participant,

String type name)
Associate the com.rti.dds.typecode.TypeCode (p. 1611) with the given

com.rti.dds.domain.DomainParticipant (p. 654) under the given logical
name.
Once a type has been registered, it can be referenced by name when creating a
topic (p. 359). Statically and dynamically defined types behave the same way
in this respect.
See also:
com.rti.ndds.example.FooTypeSupport.register type (p. 1037)
com.rti.dds.dynamicdata.DynamicDataTypeSupport.unregister type (p. 904)
8.84.3.2
final void unregister type (DomainParticipant participant,

String type name)
Remove
the
definition
of
this
type
from
the
This operation is optional; all types are automatically unregistered when a

com.rti.dds.domain.DomainParticipant (p. 654) is deleted. Most application will not need to manually unregister types.
A type cannot be unregistered while it is still in use; that is, while any
com.rti.dds.topic.Topic (p. 1545) is still referring to it.
See also:
com.rti.ndds.example.FooTypeSupport.unregister type
com.rti.dds.dynamicdata.DynamicDataTypeSupport.register type (p. 904)
8.84.3.3
final String get type name ()
Get the default name of this type.

The com.rti.dds.typecode.TypeCode (p. 1611) that is wrapped by this
com.rti.dds.dynamicdata.DynamicDataTypeSupport (p. 901) includes a
name; this operation returns that name.
905
This operation is useful when registering a type, because in most cases it is not
necessary for the physical and logical names of the type to be different.
myTypeSupport.register_type(myParticipant, myTypeSupport.get_type_name());
See also:
com.rti.ndds.example.FooTypeSupport.get type name (p. 1036)
8.84.3.4
final TypeCode get data type ()
Get the com.rti.dds.typecode.TypeCode (p. 1611) wrapped by this

com.rti.dds.dynamicdata.DynamicDataTypeSupport (p. 901).
8.84.3.5
Object create data ()
Create a new com.rti.dds.dynamicdata.DynamicData (p. 817) sample initialized with the com.rti.dds.typecode.TypeCode (p. 1611) and properties
of this com.rti.dds.dynamicdata.DynamicDataTypeSupport (p. 901).
See also:
com.rti.ndds.example.FooTypeSupport.create data
com.rti.dds.dynamicdata.DynamicData.DynamicData.DynamicData
com.rti.dds.dynamicdata.DynamicDataTypeProperty t.data
(p. 898)
8.84.3.6
void destroy data (Object data)
Finalize and deallocate

(p. 817) sample.
the
See also:
com.rti.ndds.example.FooTypeSupport.delete data
com.rti.dds.dynamicdata.DynamicDataTypeSupport.create data
(p. 905)
8.84.3.7
void print data (DynamicData data)
Print a string representation of the given sample to the given file.

This method is equivalent to com.rti.dds.dynamicdata.DynamicData.print
(p. 833).
906
Class Documentation
See also:
com.rti.dds.dynamicdata.DynamicData.print (p. 833)
8.84.3.8
void copy data (DynamicData dst, DynamicData src)
Deeply copy the given data samples.

8.84.3.9
void delete ()
Delete a com.rti.dds.dynamicdata.DynamicDataTypeSupport (p. 901)

object.
A
com.rti.dds.dynamicdata.DynamicDataTypeSupport
(p. 901) cannot be deleted while it is still in use.
For each
com.rti.dds.domain.DomainParticipant (p. 654) with which the
com.rti.dds.dynamicdata.DynamicDataTypeSupport (p. 901) is registered, either the type must be unregistered or the participant must be
deleted.
Calling this method is optional. If you do not call it, the garbage collector will
perform the deletion when it is able.
See also:
com.rti.dds.dynamicdata.DynamicDataTypeSupport.unregister type (p. 904)

com.rti.dds.dynamicdata.DynamicDataTypeSupport.DynamicDataTypeSupport.DynamicDataType
8.84.4
8.84.4.1
final RuntimeException DYNAMICDATA TYPE NOT SUPPORTED = new RETCODE ERROR(not a

top-level type) [static, protected]
Cached exception to be thrown in the event that we cant create native type
support.
8.85 DynamicDataWriter Class Reference
8.85
907
DynamicDataWriter Class Reference

(p. 817).
Inheritance diagram for DynamicDataWriter::

InstanceHandle t
data)
register instance
(DynamicData
instance -
Informs RTI Connext that the application will be modifying a particular instance.
InstanceHandle t register instance untyped (Object instance data)

InstanceHandle t register instance w timestamp (DynamicData

instance data, Time t source timestamp)
Performs the same functions as register instance except that the application
provides the value for the source timestamp.
void unregister instance (DynamicData instance data, InstanceHandle t handle)

Reverses the action of com.rti.ndds.example.FooDataWriter.register instance ( p. 1014).
void unregister instance untyped (Object instance data, InstanceHandle t handle)

void unregister instance w timestamp (DynamicData instance data, InstanceHandle t handle, Time t source timestamp)
Performs the same function as com.rti.ndds.example.FooDataWriter.unregister instance ( p. 1016) except that it also provides the value for the source timestamp.
void write (DynamicData instance data, InstanceHandle t handle)

Modifies the value of a data instance.
908
Class Documentation
void write untyped (Object instance data, InstanceHandle t handle)
void write w timestamp (DynamicData instance data, InstanceHandle t handle, Time t source timestamp)
Performs the same function as com.rti.ndds.example.FooDataWriter.write
( p. 1021) except that it also provides the value for the source timestamp.
void dispose (DynamicData instance data, InstanceHandle t instance handle)

Requests the middleware to delete the data.
void dispose w timestamp (DynamicData instance data, InstanceHandle t instance handle, Time t source timestamp)
Performs the same functions as dispose except that the application provides the value for the source timestamp that is made
available to com.rti.dds.subscription.DataReader ( p. 487) objects by means of the source timestamp attribute inside the
void dispose w timestamp untyped (Object instance data, InstanceHandle t instance handle, Time t source timestamp)
void get key value (DynamicData key holder, InstanceHandle t

handle)
Retrieve the instance key that corresponds to an instance handle.
InstanceHandle t lookup instance (DynamicData key holder)

Retrieve the instance handle that corresponds to an instance key holder.
8.85.1

(p. 817).
Instantiates
<
See also:
8.85.2
8.85.2.1
InstanceHandle t register instance (DynamicData

instance data)
909
This operation is only useful for keyed data types. Using it for non-keyed
types causes no effect and returns com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL. The operation takes as a parameter an instance (of which only the key value is examined) and returns a handle that can
be used in successive write() (p. 916) or dispose() (p. 921) operations.
The operation gives RTI Connext an opportunity to pre-configure itself to improve performance.
The use of this operation by an application is optional even for keyed types. If
an instance has not been pre-registered, the application can use the special value
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL as
the com.rti.dds.infrastructure.InstanceHandle t (p. 1055) paramater to
the write or dispose operation and RTI Connext will auto-register the instance.
For best performance,
the operation should be invoked prior
to
calling
any
operation
that
modifies
the
instance,
such
as
com.rti.ndds.example.FooDataWriter.write
(p. 1021),
(p. 1024),
com.rti.ndds.example.FooDataWriter.dispose
(p. 1027)
and
and the handle used in conjunction with the data for those calls.
When this operation is used, RTI Connext will automatically supply the value
of the source timestamp that is used.
This operation may fail and return com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL if com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max instances (p. 1352) limit has been exceeded.
The operation is idempotent. If it is called for an already registered instance,
it just returns the already allocated handle. This may be used to lookup and
retrieve the handle allocated to a given instance.
This operation can only be called after com.rti.dds.publication.DataWriter
(p. 557) has been enabled. Otherwise, com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL will be returned.
Parameters:
instance data <<in>> ( p. 279) The instance that should be registered.
Of this instance, only the fields that represent the key are examined
by the function. Cannot be NULL..
910
Class Documentation
Returns:
For keyed data type, a handle that can be used in the calls
that
take
a
com.rti.dds.infrastructure.InstanceHandle t (p. 1055), such as write, dispose, unregister instance, or return
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL on failure. If the instance data is of a data type that has no keys,
this function always return com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL.
See also:
(p. 1016),
com.rti.ndds.example.FooDataWriter.get key value
(p. 1031), RELATIONSHIP BETWEEN REGISTRATION,
LIVELINESS and OWNERSHIP (p. 1202)
8.85.2.2
InstanceHandle t register instance untyped (Object

instance data)

Statically
type-safe
code
should
use
the
appropriate
(p. 1014)
com.rti.ndds.example.FooDataWriter.register instance
See also:
com.rti.dds.publication.DataWriter.unregister instance untyped
(p. 576)
Implements DataWriter (p. 575).
8.85.2.3
InstanceHandle t register instance w timestamp

(DynamicData instance data, Time t source timestamp)
The provided source timestamp potentially affects the relative order in which
readers observe events from multiple writers. Refer to DESTINATION ORDER (p. 53) QoS policy for details.
911
Parameters:
by the function. Cannot be NULL.
operation (used in a register , unregister , dispose, or write, with either the automatically supplied timestamp or the application provided
timestamp). This timestamp may potentially affect the order in which
readers observe events from multiple writers. Cannot be NULL.
Returns:
For keyed data type, return a handle that can be used in the
calls that take a com.rti.dds.infrastructure.InstanceHandle t (p. 1055), such as write, dispose, unregister instance, or return
See also:
(p. 1016),
(p. 1031)
8.85.2.4
void unregister instance (DynamicData instance data,

Reverses the action of com.rti.ndds.example.FooDataWriter.register instance (p. 1014).

This operation is useful only for keyed data types. Using it for non-keyed types
causes no effect and reports no error. The operation takes as a parameter an
instance (of which only the key value is examined) and a handle.
This operation should only be called on an instance that is currently registered.
This includes instances that have been autoGenerated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
912
Class Documentation
registered by calling operations such as write or dispose as described

in
com.rti.ndds.example.FooDataWriter.register instance (p. 1014).
Otherwise, this operation may fail with
This only need be called just once per instance, regardless of how many times
register instance was called for that instance.
This
operation
informs
RTI
Connext
that
the
com.rti.dds.publication.DataWriter (p. 557) is no longer going to provide
any information about the instance. This operation also indicates that RTI
Connext can locally remove all information regarding that instance. The
application should not attempt to use the handle previously allocated to that
instance after calling com.rti.ndds.example.FooDataWriter.unregister instance() (p. 1016).
The special value com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL can be used for the parameter handle. This indicates that the
identity of the instance should be automatically deduced from the instance data (by means of the key).
If handle is any value other than com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL, then it must correspond to an instance that
has been registered. If there is no correspondence, the operation will fail with
RTI Connext will not detect the error when the handle is any value other
than com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL, corresponds to an instance that has been registered, but does not correspond to the instance deduced from the instance data (by means of the key).
RTI Connext will treat as if the unregister instance() (p. 911) operation is
for the instance as indicated by the handle.
If
after
a
(p. 1016),
the
application
wants
to
modify
(com.rti.ndds.example.FooDataWriter.write
(p. 1021)
or
(p. 1027))
an
instance, it has to register it again, or else use the special handle value
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL.
This operation does not indicate that the instance is deleted (that is the
purpose of com.rti.ndds.example.FooDataWriter.dispose (p. 1027)). The
operation
(p. 1016) just indicates that the com.rti.dds.publication.DataWriter
(p. 557)
no
longer
has
anything
to
say
about
the
instance.
(p. 487)
entities that are reading the instance may receive a sample with
913
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE NO WRITERS INSTANCE STATE for the instance, unless there are other
com.rti.dds.publication.DataWriter (p. 557) objects writing that same
instance.
This operation can affect the ownership of the data instance (see OWNERSHIP (p. 87)). If the com.rti.dds.publication.DataWriter (p. 557) was the
exclusive owner of the instance, then calling unregister instance() (p. 911)
will relinquish that ownership.
If com.rti.dds.infrastructure.ReliabilityQosPolicy.kind (p. 1327) is set to
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.RELIABLE RELIABILITY QOS and the unregistration would overflow the resource
limits of this writer or of a reader, this operation may block for up to
com.rti.dds.infrastructure.ReliabilityQosPolicy.max blocking time
(p. 1327); if this writer is still unable to unregister after that period, this
method will fail with com.rti.dds.infrastructure.RETCODE TIMEOUT
(p. 1364).
Parameters:
instance data <<in>> ( p. 279) The instance that should be unregistered. If com.rti.ndds.example.Foo (p. 977) has a key and
instance handle
is
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL, only the fields that represent
the key are examined by the function. Otherwise, instance data is not used. If instance data is used, it must represent
an instance that has been registerd.
Otherwise, this method
may fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) .
If com.rti.ndds.example.Foo
(p. 977) has a key, instance data can be NULL only if handle is
not
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle this method will fail with
t.HANDLE NIL. Otherwise,
(p. 1355).
handle <<in>> ( p. 279) represents the instance to be unregistered.
If com.rti.ndds.example.Foo (p. 977) has a key and handle
is
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL, handle is not used and instance is deduced
If com.rti.ndds.example.Foo (p. 977)
from instance data.
has no key, handle is not used. If handle is used, it must
represent an instance that has been registered. Otherwise, this
method may fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER
(p. 1355).
This
method
will
fail
with
com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) if handle is NULL. If
com.rti.ndds.example.Foo (p. 977) has a key, handle cannot
914
Class Documentation
be
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL if instance data is NULL. Otherwise, this method
will report the error com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355).
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364)
(p. 1361)
See also:
RELATIONSHIP BETWEEN REGISTRATION, LIVELINESS
and OWNERSHIP (p. 1202)
8.85.2.5
void unregister instance untyped (Object instance data,


Statically
type-safe
code
should
use
the
appropriate
(p. 1016)
See also:
com.rti.dds.publication.DataWriter.register instance untyped
(p. 575)
(p. 1016)


8.85.2.6
915
void unregister instance w timestamp (DynamicData

source timestamp)
Performs the same function as com.rti.ndds.example.FooDataWriter.unregister instance (p. 1016) except that it also provides the value for the source timestamp.
The constraints on the values of the handle parameter and
the corresponding error behavior are the same specified for the
(p. 1016)
operation.
This
operation
may
block
and
may
time
(com.rti.dds.infrastructure.RETCODE TIMEOUT (p. 1364))
the same circumtances described for the unregister instance operation.
out
under
Parameters:
instance handle
is
may fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355). If com.rti.ndds.example.Foo (p. 977)
has a key, instance data can be NULL only if handle is
not
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL. Otherwise,
this method will fail with
(p. 1355).
is
from instance data.
(p. 1355).
This
method
will
fail
with
916
Class Documentation
be
will fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355).
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364)
(p. 1361).
See also:
(p. 1016)
8.85.2.7
void write (DynamicData instance data, InstanceHandle t

handle)

When this operation is used, RTI Connext will automatically
supply the value of the source timestamp that is made available
to
(p. 487)
objects by means of the source timestamp attribute inside the
(p. 1398).
(Refer
to
com.rti.dds.subscription.SampleInfo (p. 1398) and DESTINATION ORDER (p. 53) QoS policy for details).
As
a
side
effect,
this
operation
asserts
liveliness
on
the
(p. 557)
itself,
the
(p. 1262)
and
the
Note that the special value com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL can be used for the parameter handle. This
917
indicates the identity of the instance should be automatically deduced from the
instance data (by means of the key).
than com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL, corresponds to an instance that has been registered, but does not correspond to the instance deduced from the instance data (by means of the
key). RTI Connext will treat as if the write() (p. 916) operation is for the
instance as indicated by the handle.
This operation may block if the RELIABILITY (p. 105) kind is set to
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.RELIABLE RELIABILITY QOS and the modification would cause data to be lost or else
cause one of the limits specified in the RESOURCE LIMITS (p. 106) to be
exceeded.
Specifically,
this operation may block in the following situations (note that the list may not be exhaustive), even if its
com.rti.dds.infrastructure.HistoryQosPolicyKind
(p. 1050)
is
com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP LAST HISTORY QOS:
If
(com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples (p. 1351) < com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max instances (p. 1352) com.rti.dds.infrastructure.HistoryQosPolicy.depth
(p. 1049)), then in the situation where the max samples resource limit
is exhausted, RTI Connext is allowed to discard samples of some other
instance, as long as at least one sample remains for such an instance. If
it is still not possible to make space available to store the modification,
the writer is allowed to block.
If
(com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples (p. 1351) < com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max instances (p. 1352)), then the com.rti.dds.publication.DataWriter
(p. 557)
may
block
regardless
of
the
com.rti.dds.infrastructure.HistoryQosPolicy.depth (p. 1049).
If
(com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.min send window size (p. 1383) < com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples (p. 1351)), then it is possible for the send window size limit to
be reached before RTI Connext is allowed to discard samples, in which
case the com.rti.dds.publication.DataWriter (p. 557) will block.
This
operation
may
also
block
when
using
918
Class Documentation
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.BEST EFFORT RELIABILITY QOS and com.rti.dds.infrastructure.PublishModeQosPolicyKind.PublishMode

PUBLISH MODE QOS. In this case, the com.rti.dds.publication.DataWriter
(p. 557) will queue samples until they are sent by the asynchronous publishing
thread. The number of samples that can be stored is determined by the
com.rti.dds.infrastructure.HistoryQosPolicy (p. 1046).
If the asynchronous thread does not send samples fast enough (e.g., when using a slow
com.rti.dds.publication.FlowController (p. 964)), the queue may fill up.
In that case, subsequent write calls will block.
If this operation does block for any of the above reasons, the RELIABILITY (p. 105) max blocking time configures the maximum time the write operation may block (waiting for space to become available). If max blocking time
elapses before the com.rti.dds.publication.DataWriter (p. 557) is able to
store the modification without exceeding the limits, the operation will time out
(com.rti.dds.infrastructure.RETCODE TIMEOUT (p. 1364)).
If there are no instance resources left, this operation may fail with
(p. 1362).
Calling com.rti.ndds.example.FooDataWriter.unregister instance (p. 1016) may help freeing up some resources.
This operation will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363) if the timestamp is less than the
timestamp used in the last writer operation (register , unregister , dispose, or
write, with either the automatically supplied timestamp or the applicationprovided timestamp).
Parameters:
instance data <<in>> ( p. 279) The data to write.
This method will fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) if instance data is NULL.
Parameters:
handle <<in>> ( p. 279) Either the handle returned by a previous call to com.rti.ndds.example.FooDataWriter.register instance
(p. 1014),
or
else
the
special
value
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL. If com.rti.ndds.example.Foo (p. 977) has a
key and handle is not com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL,
handle
must
represent
a registered instance of type com.rti.ndds.example.Foo
(p. 977).
Otherwise,
this
method
may
fail
with
This method will fail with
919

(p. 1355) if handle is NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
com.rti.dds.infrastructure.RETCODE TIMEOUT (p. 1364),
com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363), com.rti.dds.infrastructure.RETCODE (p. 1362),
or
OUT OF RESOURCES
(p. 1361).
See also:
DESTINATION ORDER (p. 53)
8.85.2.8
void write untyped (Object instance data,


Statically
type-safe
code
should
use
the
appropriate
com.rti.ndds.example.FooDataWriter.write (p. 1021) method instead of
this one. See that method for detailed documentation.
See also:
com.rti.dds.publication.DataWriter.write w timestamp untyped
(p. 577)
8.85.2.9
void write w timestamp (DynamicData instance data,


(p. 1021) except that it also provides the value for the source timestamp.
920
Class Documentation
Explicitly
provides
the
timestamp
that
will
be
available
obto
the
(p. 487)
jects by means of the source timestamp attribute inside the
(Refer
to
(p. 1398).
com.rti.dds.subscription.SampleInfo (p. 1398) and DESTINATION ORDER (p. 53) QoS policy for details)
com.rti.ndds.example.FooDataWriter.write (p. 1021) operation.
This
operation
may
block
and
(com.rti.dds.infrastructure.RETCODE TIMEOUT
(p. 1364))
under
the
same
circumtances
time
out
described
for
(p. 1362).
Calling com.rti.ndds.example.FooDataWriter.unregister instance (p. 1016) may help free up some resources.
This operation may fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) under the same circumstances described for
the write operation.
Parameters:
instance data <<in>> ( p. 279) The data to write. This method
will fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) if instance data is NULL.
(p. 1014),
or
else
the
special
value
handle
must
represent
Otherwise,
this
method
may
fail
with
(p. 977).
source timestamp <<in>>

( p. 279)
When
using
com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPolicyKind.BY
SOURCE TIMESTAMP DESTINATIONORDER QOS the timestamp value must be greater than or equal to the timestamp value
used in the last writer operation (register , unregister , dispose, or
921
write, with either the automatically supplied timestamp or the

application-provided timestamp) However, if it is less than the
timestamp of the previous operation but the difference is less than the
com.rti.dds.infrastructure.DestinationOrderQosPolicy.source timestamp tolerance (p. 633), the timestamp of the previous operation will be used as the source timestamp of
this sample.
Otherwise, if the difference is greater than
com.rti.dds.infrastructure.DestinationOrderQosPolicy.source timestamp tolerance (p. 633),
the function will return
(p. 1355).
Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364),
(p. 1362),
or
(p. 1361).
See also:
8.85.2.10
void dispose (DynamicData instance data,

InstanceHandle t instance handle)

has no effect and reports no error.
The actual deletion is postponed until there is no more use for that data in the
whole system.
Applications are made aware of the deletion by means of operations on the
com.rti.dds.subscription.DataReader (p. 487) objects that already knew
that instance. com.rti.dds.subscription.DataReader (p. 487) objects that
didnt know the instance will never see it.
This operation does not modify the value of the instance. The instance data
parameter is passed just for the purposes of identifying the instance.
922
Class Documentation

to
(p. 487)
(p. 1016)
operation.
The special value com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL can be used for the parameter instance handle. This indicates the identity of the instance should be automatically deduced from the
key). RTI Connext will treat as if the dispose() (p. 921) operation is for the
This
operation
may
block
and
time
(p. 1364))
under
the
same
circumtances
described
com.rti.ndds.example.FooDataWriter.write() (p. 1021).
out
for
(p. 1362).
Parameters:
instance data <<in>> ( p. 279) The data to dispose.
If
com.rti.ndds.example.Foo (p. 977) has a key and instance handle
is
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL, only the fields that represent the key are
examined by the function.
Otherwise, instance data is not
used.
If com.rti.ndds.example.Foo (p. 977) has a key,
instance data can be NULL only if instance handle is
not
923

(p. 1355).
instance handle <<in>> ( p. 279) Either the handle returned by a
previous call to com.rti.ndds.example.FooDataWriter.register instance
(p. 1014),
or
else
the
special
value
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL. If com.rti.ndds.example.Foo (p. 977) has a key
and instance handle is com.rti.dds.infrastructure.InstanceHandle instance handle
is
not
t.InstanceHandle t.HANDLE NIL,
used and instance is deduced from instance data.
If
com.rti.ndds.example.Foo (p. 977) has no key, instance handle is not used. If handle is used, it must represent a registered
instance of type com.rti.ndds.example.Foo (p. 977). Otherwise,
this method fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355).
(p. 1355) if handle is NULL. If com.rti.ndds.example.Foo
(p. 977)
has
a
key,
instance handle
cannot
be
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364),
(p. 1362)
or
(p. 1361).
See also:
(p. 1029)
8.85.2.11
void dispose w timestamp (DynamicData instance data,

InstanceHandle t instance handle, Time t
source timestamp)
Performs the same functions

tion provides the value for
as dispose except that the applicathe source timestamp that is made
924
Class Documentation
available
to
(p. 487)
jects by means of the source timestamp attribute inside
obthe

com.rti.ndds.example.FooDataWriter.dispose (p. 1027) operation.
This
operation
may
block
and
under
the
same
circumtances
(p. 1364))
time
out
described
for
(p. 1362).
Parameters:
If
is
used.
not
(p. 1355).
(p. 1014),
or
else
the
special
value
and instance handle is com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL,
instance handle
is
not
If
com.rti.ndds.example.Foo (p. 977) has no key, instance handle
is not used. If handle is used, it must represent a registered instance
of type com.rti.ndds.example.Foo (p. 977).
Otherwise, this
method may fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) This method will fail with
(p. 977)
has
a
key,
instance handle
cannot
be
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
925
t.HANDLE NIL if instance data is NULL. Otherwise, this method

operation (used in a register , unregister , dispose, or write, with either the automatically supplied timestamp or the application provided timestamp). This timestamp may potentially affect the order in
which readers observe events from multiple writers. This timestamp
will be available to the com.rti.dds.subscription.DataReader
(p. 487) objects by means of the source timestamp attribute inside
the com.rti.dds.subscription.SampleInfo (p. 1398). Cannot be
NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364),
(p. 1362)
or
(p. 1361).
See also:
8.85.2.12
void dispose w timestamp untyped (Object

source timestamp)
Statically
type-safe
code
should
use
the
appropriate
See also:
com.rti.dds.publication.DataWriter.dispose untyped (p. 578)
(p. 1029)
926
Class Documentation
8.85.2.13
void get key value (DynamicData key holder,


Useful for keyed data types.
The operation will only fill the fields that form the key inside the key holder
instance. If com.rti.ndds.example.Foo (p. 977) has no key, this method has
no effect and exit with no error.
For
keyed
data
types,
this
operation
may
fail
with
com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355)
if the handle does not correspond to an existing data-object known to the
Parameters:
key holder <<inout>> ( p. 279) a user data type specific
key holder, whose key fields are filled by this operation.
If com.rti.ndds.example.Foo (p. 977) has no key,
this method has no effect.
(p. 1355) if key holder is NULL.
handle <<in>> ( p. 279) the instance whose key is to be
retrieved.
If com.rti.ndds.example.Foo (p. 977) has a
key, handle must represent a registered instance of type
com.rti.ndds.example.Foo (p. 977).
will fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355). If com.rti.ndds.example.Foo (p. 977)
has a key and handle is com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL,
this
method
will
fail
with
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361).
or
See also:

8.85.2.14
927
InstanceHandle t lookup instance (DynamicData

key holder)

This operation takes as a parameter an instance and returns a handle that can be
used in subsequent operations that accept an instance handle as an argument.
The instance parameter is only used for the purpose of examining the fields
that define the key. This operation does not register the instance in question. If
the instance has not been previously registered, or if for any other reason RTI
Connext is unable to provide an instance handle, RTI Connext will return the
special value HANDLE NIL.
Parameters:
key holder <<in>> ( p. 279) a user data type specific key holder.
Returns:
the instance handle associated with this instance.
If
com.rti.ndds.example.Foo (p. 977) has no key, this method has no effect
and returns com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL
928
Class Documentation
8.86
EndpointGroup t Class Reference
Specifies a group of endpoints that can be collectively identified by a name and

satisfied by a quorum.
Inherits Struct.

EndpointGroup t ()
Constructor.
EndpointGroup t (EndpointGroup t src)

Copy constructor.
EndpointGroup t (String role name, int quorum count)

Construct an EndpointGroup t ( p. 928) with the given parameters.
Public Attributes
String role name = null
Defines the role name of the endpoint group.
int quorum count = 0

Defines the minimum number of members that satisfies the endpoint group.
8.86.1
Specifies a group of endpoints that can be collectively identified by a name and

satisfied by a quorum.
8.86.2
8.86.2.1
EndpointGroup t ()
Constructor.
8.86.2.2
EndpointGroup t (EndpointGroup t src)
Copy constructor.
8.86 EndpointGroup t Class Reference

8.86.2.3
929
EndpointGroup t (String role name, int quorum count)
Construct an EndpointGroup t (p. 928) with the given parameters.
8.86.3
8.86.3.1
String role name = null
Defines the role name of the endpoint group.

If used in the com.rti.dds.infrastructure.AvailabilityQosPolicy (p. 402)
on a com.rti.dds.publication.DataWriter (p. 557), it specifies the name that
identifies a Durable Subcription.
8.86.3.2
int quorum count = 0
Defines the minimum number of members that satisfies the endpoint group.
If used in the com.rti.dds.infrastructure.AvailabilityQosPolicy (p. 402)
on a com.rti.dds.publication.DataWriter (p. 557), it specifies the number
of DataReaders that must acknowledge a sample before the sample is considered
to be acknowledged by the Durable Subscription.
930
Class Documentation
8.87
EndpointGroupSeq Class Reference
A sequence of com.rti.dds.infrastructure.EndpointGroup t (p. 928).

8.87.1
A sequence of com.rti.dds.infrastructure.EndpointGroup t (p. 928).

In the context of Collaborative DataWriters, it can be used by a
com.rti.dds.subscription.DataReader (p. 487) to define a group of remote
DataWriters that the com.rti.dds.subscription.DataReader (p. 487) will
wait to discover before skipping missing samples.
In the context of Durable Subscriptions, it can be used to create a set of Durable
Subscriptions identified by a name and a quorum count.
Instantiates:
See also:
com.rti.dds.infrastructure.EndpointGroup t (p. 928)
8.88 Entity Interface Reference
8.88
931
Entity Interface Reference
<<interface>> ( p. 279) Abstract base class for all the DDS objects that support QoS policies, a listener, and a status condition.
Inheritance diagram for Entity::

void enable ()
Enables the com.rti.dds.infrastructure.Entity ( p. 931).
StatusCondition get statuscondition ()

Allows access to the com.rti.dds.infrastructure.StatusCondition
( p. 1448) associated with the com.rti.dds.infrastructure.Entity ( p. 931).
int get status changes ()

Retrieves
the
list
of
communication
statuses
com.rti.dds.infrastructure.Entity ( p. 931) that are triggered.
in
the
InstanceHandle t get instance handle ()

Allows access to the com.rti.dds.infrastructure.InstanceHandle t
( p. 1055) associated with the com.rti.dds.infrastructure.Entity ( p. 931).
8.88.1
<<interface>> ( p. 279) Abstract base class for all the DDS objects that support QoS policies, a listener, and a status condition.
All
operations
except
for
set qos(),
get qos(),
set listener(),
get listener()
and
enable()
(p. 935),
may
return
the
value
com.rti.dds.infrastructure.RETCODE NOT ENABLED (p. 1361).
QoS:
Status:
Listener:
932
Class Documentation
8.88.2
Abstract operations
Each derived entity provides the following operations specific to its role in RTI
Connext.
8.88.2.1
set qos (abstract)
This
operation
sets
the
QoS
policies
of
the
This
operation
must
be
provided
by
each
of
the
derived
(p. 931)
classes
(com.rti.dds.domain.DomainParticipant
(p. 654),
com.rti.dds.topic.Topic (p. 1545), com.rti.dds.publication.Publisher
(p. 1262),
(p. 557),
(p. 1476),
and
com.rti.dds.subscription.DataReader (p. 487)) so that the policies
that are meaningful to each com.rti.dds.infrastructure.Entity (p. 931) can
be set.
Precondition:
Certain policies are immutable (see QoS Policies (p. 94)): they can
only be set at com.rti.dds.infrastructure.Entity (p. 931) creation time
or before the entity is enabled. If set qos() is invoked after the
com.rti.dds.infrastructure.Entity (p. 931) is enabled and it attempts
to change the value of an immutable policy, the operation will fail
and return com.rti.dds.infrastructure.RETCODE IMMUTABLE POLICY (p. 1358).
Certain values of QoS policies can be incompatible with the settings
of the other policies. The set qos() operation will also fail if it
specifies a set of values that, once combined with the existing values,
would result in an inconsistent set of policies. In this case, the operation will fail and return com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY (p. 1359).
If the application supplies a non-default value for a QoS policy that
is not supported by the implementation of the service, the set qos operation will fail and return com.rti.dds.infrastructure.RETCODE UNSUPPORTED (p. 1365).
Postcondition:
The existing set of policies is only changed if the set qos()
operation succeeds.
This is indicated by a return code of
com.rti.dds.infrastructure.RETCODE OK. In all other cases, none of the
policies are modified.
933
Each
derived
(p. 931)
class
(p. 654),
(p. 1262),
(p. 557),
(p. 1476),
(p. 487))
has
a
corresponding
special
value
of
the
QoS
(com.rti.dds.domain.DomainParticipantFactory.PARTICIPANT QOS DEFAULT (p. 149), com.rti.dds.domain.DomainParticipant.PUBLISHER QOS DEFAULT (p. 153), com.rti.dds.domain.DomainParticipant.SUBSCRIBER QOS DEFAULT (p. 153), com.rti.dds.domain.DomainParticipant.TOPIC QOS DEFAULT (p. 152), com.rti.dds.publication.Publisher.DATAWRITER QOS DEFAULT (p. 182), com.rti.dds.subscription.Subscriber.DATAREADER QOS DEFAULT (p. 196)).
This special value may be used as a
parameter to the set qos operation to indicate that the QoS of the
com.rti.dds.infrastructure.Entity (p. 931) should be changed to match
the current default QoS set in the com.rti.dds.infrastructure.Entity
(p. 931)s factory. The operation set qos cannot modify the immutable QoS,
so a successful return of the operation indicates that the mutable QoS for
the Entity (p. 931) has been modified to match the current default for the
com.rti.dds.infrastructure.Entity (p. 931)s factory.
The set of policies specified in the qos parameter are applied on top of the
existing QoS, replacing the values of any policies previously set.
Possible error codes returned in addition to Standard Return Codes
com.rti.dds.infrastructure.RETCODE IMMUTABLE (p. 108) :
POLICY
(p. 1358),
or
com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY (p. 1359).
8.88.2.2
get qos (abstract)
This operation allows access to the existing set of QoS policies for the
This operation must be
provided by each of the derived com.rti.dds.infrastructure.Entity
(p. 931)
classes
(p. 654),
(p. 1262),
(p. 557),
(p. 1476),
and
com.rti.dds.subscription.DataReader (p. 487)), so that the policies
that are meaningful to each com.rti.dds.infrastructure.Entity (p. 931) can
be retrieved.
Possible error codes are Standard Return Codes (p. 108).
934
Class Documentation
8.88.2.3
set listener (abstract)
This operation installs a com.rti.dds.infrastructure.Listener (p. 1130) on

the com.rti.dds.infrastructure.Entity (p. 931). The listener will only be
invoked on the changes of communication status indicated by the specified mask.
This
operation
must
be
provided
by
each
of
the
declasses
rived
(p. 931)
(p. 654),
(p. 1262),
(p. 557),
and
(p. 1476),
com.rti.dds.subscription.DataReader (p. 487)), so that the listener is of the
concrete type suitable to the particular com.rti.dds.infrastructure.Entity
(p. 931).
It is permitted to use null as the value of the listener. The null listener behaves as
if the mask is com.rti.dds.infrastructure.StatusKind.STATUS MASK NONE (p. 114).
Postcondition:
Only
one
listener
can
be
attached
to
each
If a listener was already set, the operation set listener() will replace it with the new one.
Consequently, if the value null is passed for the listener parameter to the
set listener operation, any existing listener will be removed.
8.88.2.4
get listener (abstract)
This
operation
allows
access
to
the
(p. 1130)
attached
existing
to
the
This
operation
must
be
provided
by
each
of
the
derived
(p. 931)
classes
(p. 654),
(p. 1262),
(p. 557),
(p. 1476),
and
com.rti.dds.subscription.DataReader (p. 487)) so that the listener is of the
concrete type suitable to the particular com.rti.dds.infrastructure.Entity
(p. 931).
If no listener is installed on the com.rti.dds.infrastructure.Entity (p. 931),
this operation will return null.
8.88.3
8.88.3.1
void enable ()
935
Enables the com.rti.dds.infrastructure.Entity (p. 931).

This operation enables the Entity (p. 931). Entity (p. 931) objects can be
created either enabled or disabled. This is controlled by the value of the ENTITY FACTORY (p. 73) QoS policy on the corresponding factory for the
By default, ENTITY FACTORY (p. 73) is set so that it is not necessary to
explicitly call com.rti.dds.infrastructure.Entity.enable (p. 935) on newly
created entities.
The com.rti.dds.infrastructure.Entity.enable (p. 935) operation is idempotent. Calling enable on an already enabled Entity (p. 931) returns OK and has
no effect.
If a com.rti.dds.infrastructure.Entity (p. 931) has not yet been enabled, the
following kinds of operations may be invoked on it:
set or get the QoS policies (including default QoS policies) and listener
com.rti.dds.infrastructure.Entity.get statuscondition (p. 936)
factory operations
com.rti.dds.infrastructure.Entity.get status changes (p. 936) and
other get status operations (although the status of a disabled entity never
changes)
lookup operations
Other operations may explicitly state that they may be called
on disabled entities;
those that do not will return the error
com.rti.dds.infrastructure.RETCODE NOT ENABLED (p. 1361).
It is legal to delete an com.rti.dds.infrastructure.Entity (p. 931) that has
not been enabled by calling the proper operation on its factory.
Entities created from a factory that is disabled are created disabled, regardless
of the setting of the com.rti.dds.infrastructure.EntityFactoryQosPolicy
(p. 938).
Calling enable on an Entity (p. 931) whose factory is not enabled will fail
and return com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
If
com.rti.dds.infrastructure.EntityFactoryQosPolicy.autoenable created entities (p. 939) is TRUE, the enable operation on a factory will
automatically enable all entities created from that factory.
936
Class Documentation
Listeners associated with an entity are not called until the entity is enabled.
Conditions associated with a disabled entity are inactive, that is, they have a
trigger value == FALSE.
Exceptions:
One of the Standard Return Codes (p. 108), Standard Return Codes (p. 108) or com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
8.88.3.2
StatusCondition get statuscondition ()
Allows access to the com.rti.dds.infrastructure.StatusCondition (p. 1448)

associated with the com.rti.dds.infrastructure.Entity (p. 931).
The
returned
condition
can
then
be
so
(p. 1709)
plication can wait for specific status changes
added
to
that
the
that affect
a
apthe
Returns:
the status condition associated with this entity.
8.88.3.3
int get status changes ()
Retrieves
the
list
of
communication
statuses
com.rti.dds.infrastructure.Entity (p. 931) that are triggered.
in
the
That is, the list of statuses whose value has changed since the last time the
application read the status using the get status() method.
When the entity is first created or if the entity is not enabled, all communication
statuses are in the untriggered state so the list returned by the get status changes operation will be empty.
The list of statuses returned by the get status changes operation refers to the
status that are triggered on the Entity (p. 931) itself and does not include
statuses that apply to contained entities.
Returns:
list of communication statuses in the com.rti.dds.infrastructure.Entity
(p. 931) that are triggered.
937
See also:
8.88.3.4
InstanceHandle t get instance handle ()
Allows access to the com.rti.dds.infrastructure.InstanceHandle t

(p. 1055) associated with the com.rti.dds.infrastructure.Entity (p. 931).
This operation returns the com.rti.dds.infrastructure.InstanceHandle t
(p. 1055) that represents the com.rti.dds.infrastructure.Entity (p. 931).
Returns:
the instance handle associated with this entity.
938
Class Documentation
8.89
EntityFactoryQosPolicy Class Reference

(p. 931) types.
Inheritance diagram for EntityFactoryQosPolicy::
Public Attributes
boolean autoenable created entities
Specifies whether the entity acting as a factory automatically enables the
instances it creates.
8.89.1

(p. 931) types.
Entity:
(p. 742),
(p. 654),
(p. 1262),
com.rti.dds.subscription.Subscriber (p. 1476)
Properties:
RxO (p. 101) = NO
8.89.2
Usage
This policy controls the behavior of the com.rti.dds.infrastructure.Entity

(p. 931) as a factory for other entities. It controls whether or not child entities
are created in the enabled state.
RTI Connext uses a factory design pattern for creating DDS Entities. That is,
a parent entity must be used to create child entities. DomainParticipants create
Topics, Publishers and Subscribers. Publishers create DataWriters. Subscribers
create DataReaders.
8.89 EntityFactoryQosPolicy Class Reference
939
By default, a child object is enabled upon creation (initialized and may be

actively used). With this QoS policy, a child object can be created in a disabled
state. A disabled entity is only partially initialized and cannot be used until
the entity is enabled. Note: an entity can only be enabled ; it cannot be disabled
after it has been enabled.
This QoS policy is useful to synchronize the initialization of DDS Entities.
For example, when a com.rti.dds.subscription.DataReader
(p. 487) is created in an enabled state, its existence is immediately propagated for discovery and the com.rti.dds.subscription.DataReader (p. 487)
objects listener called as soon as data is received.
The initialization process for an application may extend beyond the creation of the
com.rti.dds.subscription.DataReader (p. 487), and thus, it may not be desireable for the com.rti.dds.subscription.DataReader (p. 487) to start to
receive or process any data until the initialization process is complete. So by
creating readers in a disabled state, your application can make sure that no
data is received until the rest of the application initialization is complete, and
at that time, enable the them.
Note: if an entity is disabled, then all of the child entities it creates will be
disabled too, regardless of the setting of this QoS policy. However, enabling a
disabled entity will enable all of its children if this QoS policy is set to automatically enable children entities.
This policy is mutable. A change in the policy affects only the entities created
after the change, not any previously created entities.
8.89.3
8.89.3.1
boolean autoenable created entities
Specifies whether the entity acting as a factory automatically enables the instances it creates.
The
setting
of
autoenable created entities
to
com.rti.dds.infrastructure.true
indicates
that
the
factory
create <entity >
operation(s)
will
automatically
invoke
the
com.rti.dds.infrastructure.Entity.enable (p. 935) operation each time
a new com.rti.dds.infrastructure.Entity (p. 931) is created. Therefore,
the com.rti.dds.infrastructure.Entity (p. 931) returned by create <entity > will already be enabled. A setting of com.rti.dds.infrastructure.false
indicates that the com.rti.dds.infrastructure.Entity (p. 931) will
not be automatically enabled.
Your application will need to call
com.rti.dds.infrastructure.Entity.enable (p. 935) itself.
The
default
setting
of
autoenable created entities
=
com.rti.dds.infrastructure.true means that, by default, it is not necessary
940
Class Documentation
to explicitly call com.rti.dds.infrastructure.Entity.enable (p. 935) on

newly created entities.
8.90 EntityHowTo.MyEntityListener Class Reference
8.90
EntityHowTo.MyEntityListener Class Reference
Inheritance diagram for EntityHowTo.MyEntityListener::
8.90.1
941
942
Class Documentation
8.91
EntityNameQosPolicy Class Reference
Assigns
a
name
and
a
role
name
to
a
(p. 654),
(p. 557)
or
These names will be
debug your system.
Inheritance diagram for EntityNameQosPolicy::
Public Attributes
String name
The name of the entity.
String role name

The entity role name.
8.91.1
Assigns
a
name
and
a
role
name
to
a
(p. 654),
(p. 557)
or
These names will be
debug your system.
Entity:
(p. 654),
(p. 487),
Properties:
RxO (p. 101) = NO;
8.91.2
Usage
The name and role name can only be 255 characters in length.
8.91 EntityNameQosPolicy Class Reference
8.91.3
8.91.3.1
String name
943
The name of the entity.

[default] [ENTITY] for com.rti.dds.domain.DomainParticipant
(p. 654).
null for com.rti.dds.subscription.DataReader (p. 487) and
[range] Null terminated string with length not exceeding 255. It can be null.
8.91.3.2
String role name
The entity role name.

With Durable Subscriptions this name is used to specify to which Durable Subscription the com.rti.dds.subscription.DataReader (p. 487) belongs.
With Collaborative DataWriters this name is used to specify to which endpoint
group the com.rti.dds.publication.DataWriter (p. 557) belongs.
[range] Null terminated string with length not exceeding 255. It can be null.
[default] null
944
Class Documentation
8.92
Enum Class Reference

Inheritance diagram for Enum::

final int ordinal ()
The integral value of this enumerated constant.

final String name ()
The name of this enum constant, as declared in the enum declaration.
final String toString ()

The string value of this enum constant.
Protected Member Functions

Enum (String name, int ordinal)
The constructor.
8.92.1

This class is not part of the DDS specification per se. It has been introduced to facilitate the implementation of the numerous enumerated
types in the specification and is based on the Java enumeration JSR. See
<http://www.jcp.org/aboutJava/communityprocess/jsr/tiger/enum.html>.
8.92.2
8.92.2.1
Enum (String name, int ordinal) [protected]
The constructor.
8.92 Enum Class Reference
945
Parameters:
ordinal The value of the ordinal field of the new enumerated constant.
name The value of the name field of the new enumerated constant.
See also:
com.rti.dds.util.Enum.ordinal (p. 945)
com.rti.dds.util.Enum.name (p. 946)
8.92.3
8.92.3.1
final int ordinal ()
The integral value of this enumerated constant.

For example, in an IDL definition like this:
enum Foo {
BAR = 2
};
...the value of Foo.BAR.ordinal() will be 2. If the assignment (<code>=

2</code>) is omitted, the ordinal value will be 0.
8.92.3.2
This is the implementation of the Copyable interface. While this implementation is not strictly a copy it can have the same effect. In order to use
it properly, assign the result of the operation to the member that is the
target of the copy. So, for example: myEnumField = myEnumField.copy from(anotherInstanceOfEnum); Since Enum (p. 944)s are immutable there cannot be a true copy made but this method will return a reference to the same
enumerate as anotherInstanceOfEnum.
Returns:
returns src
See also:
946
Class Documentation
8.92.3.3
final String name ()
The name of this enum constant, as declared in the enum declaration.

Most programmers should use the com.rti.dds.util.Enum.toString (p. 946)
method rather than accessing this field.
8.92.3.4
final String toString ()
The string value of this enum constant.

See also:
com.rti.dds.util.Enum.name (p. 946)
Returns:
the name of this enum constant
8.93 EnumMember Class Reference
8.93
947
EnumMember Class Reference

Inherits Serializable.

EnumMember (String name, int ordinal)
Public Attributes
String name
The name of the enumeration member.
int ordinal
The value associated the the enumeration member.
8.93.1

See also:
com.rti.dds.typecode.TypeCodeFactory.create enum tc (p. 1656)
8.93.2
8.93.2.1
EnumMember (String name, int ordinal)
Constructs an EnumMember (p. 947) object initialized with the given values.
8.93.3
8.93.3.1
String name
The name of the enumeration member.

Cannot be null.
948
Class Documentation
8.93.3.2
int ordinal
The value associated the the enumeration member.
8.94 EventQosPolicy Class Reference
8.94
949
EventQosPolicy Class Reference
Settings for event.

Inheritance diagram for EventQosPolicy::
Public Attributes
Event thread QoS.
int initial count

The initial number of events.
int max count

The maximum number of events.
8.94.1
Settings for event.

In a com.rti.dds.domain.DomainParticipant (p. 654), a thread is dedicated to handle all timed events, including checking for timeouts and deadlines and executing internal and user-defined timeout or exception handling
routines/callbacks.
This QoS policy allows you to configure thread properties such as priority level and stack size. You can also configure the maximum number of events that can be posted to the event thread. By default, a
com.rti.dds.domain.DomainParticipant (p. 654) will dynamically allocate
memory as needed for events posted to the event thread. However, by setting a
maximum value or setting the initial and maximum value to be the same, you
can either bound the amount of memory allocated for the event thread or prevent a com.rti.dds.domain.DomainParticipant (p. 654) from dynamically
allocating memory for the event thread after initialization.
Entity:
950
Class Documentation
Properties:
RxO (p. 101) = N/A
8.94.2
8.94.2.1
Event thread QoS.

There is only one event thread.
Priority:
For Windows: -2
For LynxOS: 13
For INTEGRITY: 80
For VxWorks: 110
Stack Size:
For LynxOS: 4161024
Mask:
[default] mask = com.rti.dds.infrastructure.ThreadSettingsKind.THREAD SETTINGS FLOATING POINT
(p. 1535)
|
com.rti.dds.infrastructure.ThreadSettingsKind.THREAD SETTINGS STDIO (p. 1535)
8.94 EventQosPolicy Class Reference

8.94.2.2
951
int initial count
The initial number of events.

[default] 256
[range] [1, 1 million], <= max count
8.94.2.3
int max count
The maximum number of events.

The maximum number of events. If the limit is reached, no new event can be
added.
[range] [1, 1 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), >= initial count
952
Class Documentation
8.95
ExclusiveAreaQosPolicy Class Reference

Inheritance diagram for ExclusiveAreaQosPolicy::
Public Attributes
boolean use shared exclusive area
Whether the com.rti.dds.infrastructure.Entity ( p. 931) is protected by its
own exclusive area or the shared exclusive area.
8.95.1

An exclusive area is an abstraction of a multi-thread-safe region. Each entity
is protected by one and only one exclusive area, although a single exclusive area
may be shared by multiple entities.
Conceptually, an exclusive area is a mutex or monitor with additional deadlock protection features. If a com.rti.dds.infrastructure.Entity (p. 931)
has entered its exclusive area to perform a protected operation, no other
com.rti.dds.infrastructure.Entity (p. 931) sharing the same exclusive area
may enter it until the first com.rti.dds.infrastructure.Entity (p. 931) exits
the exclusive area.
Entity:
(p. 1262),
Properties:
RxO (p. 101) = N/A
See also:
8.95 ExclusiveAreaQosPolicy Class Reference
8.95.2
953
Usage
Exclusive Areas (EAs) allow RTI Connext to be multi-threaded while

preventing deadlock in multi-threaded applications.
EAs prevent a
com.rti.dds.domain.DomainParticipant (p. 654) objects internal threads
from deadlocking with each other when executing internal code as well as when
executing the code of user-registered listener callbacks.
Within an EA, all calls to the code protected by the EA are single
threaded.
Each
(p. 1262)
and
(p. 654),
com.rti.dds.subscription.Subscriber (p. 1476) entity represents a separate EA. Thus all DataWriters of the same Publisher and all DataReaders
of the same Subscriber share the EA of its parent. Note: this means that
operations on the DataWriters of the same Publisher and on the DataReaders
of the same Subscriber will be serialized, even when invoked from multiple
concurrent application threads.
Within an EA, there are limitations on how code protected by a different EA
can be accessed. For example, when received data is being processed by user
code in the DataReader Listener (p. 1130), within a Subscriber EA, the user
code may call the com.rti.ndds.example.FooDataWriter.write (p. 1021)
operation of a DataWriter that is protected by the EA of its Publisher, so
you can send data in the function called to process received data. However,
you cannot create entities or call functions that are protected by the EA of
the com.rti.dds.domain.DomainParticipant (p. 654). See Chapter 4 in the
Users Manual for complete documentation on Exclusive Areas.
With this QoS policy, you can force a com.rti.dds.publication.Publisher
(p. 1262) or com.rti.dds.subscription.Subscriber (p. 1476) to share the same
EA as its com.rti.dds.domain.DomainParticipant (p. 654). Using this capability, the restriction of not being able to create entities in a DataReader
Listeners on data available() callback is lifted. However, the tradeoff is that
the application has reduced concurrency through the Entities that share an EA.
Note that the restrictions on calling methods in a different EA only exist for user
code that is called in registered DDS Listeners by internal DomainParticipant
threads. User code may call all RTI Connext functions for any DDS Entities
from their own threads at any time.
8.95.3
8.95.3.1
boolean use shared exclusive area
Whether the com.rti.dds.infrastructure.Entity (p. 931) is protected by its

own exclusive area or the shared exclusive area.
954
Class Documentation
All writers belonging to the same com.rti.dds.publication.Publisher

(p. 1262) are protected by the same exclusive area as the
com.rti.dds.publication.Publisher (p. 1262) itself.
The same is true
of all readers belonging to the same com.rti.dds.subscription.Subscriber
(p. 1476). Typically, the publishers and subscribers themselves do not share
their exclusive areas with each other; each has its own. This configuration
maximizes the concurrency of the system because independent readers and
writers do not need to take the same mutexes in order to operate. However,
it places some restrictions on the operations that may be invoked from
within listener callbacks because of the possibility of a deadlock. See the
com.rti.dds.infrastructure.Listener (p. 1130) documentation for more
details.
If this field is set to com.rti.dds.infrastructure.false, the default more concurrent
behavior will be used. In the event that this behavior is insufficiently flexible
for your application, you may set this value to com.rti.dds.infrastructure.true.
In that case, the com.rti.dds.subscription.Subscriber (p. 1476) or
com.rti.dds.publication.Publisher (p. 1262) in question, and all of the readers or writers (as appropriate) created from it, will share a global exclusive area.
This global exclusive area is shared by all entities whose value for this QoS field
is com.rti.dds.infrastructure.true. By sharing the same exclusive area across
a larger number of entities, the concurrency of the system will be decreased;
however, some of the callback restrictions will be relaxed.
8.96 ExpressionProperty Class Reference
8.96
ExpressionProperty Class Reference
Inherits Struct.
Public Attributes
boolean key only filter = false
boolean writer side filter optimization = false
8.96.1
8.96.2
8.96.2.1
boolean key only filter = false
8.96.2.2
boolean writer side filter optimization = false
955
956
Class Documentation
8.97
ExtensibilityKind Class Reference

Inheritance diagram for ExtensibilityKind::

static final ExtensibilityKind FINAL EXTENSIBILITY
static final ExtensibilityKind EXTENSIBLE EXTENSIBILITY

static final ExtensibilityKind MUTABLE EXTENSIBILITY

8.97.1
8.98 FilterSampleInfo Class Reference
8.98
957
FilterSampleInfo Class Reference
Inherits Struct.
Public Attributes
SampleIdentity t related sample identity = new SampleIdentity t()
int priority = PRIORITY UNDEFINED
8.98.1
8.98.2
8.98.2.1
SampleIdentity t related sample identity = new

SampleIdentity t()
8.98.2.2
int priority = PRIORITY UNDEFINED
958
Class Documentation
8.99
FloatSeq Class Reference

float >.
Inheritance diagram for FloatSeq::

FloatSeq ()
Constructs an empty sequence of floats with an initial maximum of zero.
FloatSeq (int initialMaximum)

Constructs an empty sequence of floats with the given initial maximum.
FloatSeq (float[ ] floats)

Constructs a new sequence containing the given floats.
boolean addAllFloat (float[ ] elements, int offset, int length)

boolean addAllFloat (float[ ] elements)

void addFloat (float element)
void addFloat (int index, float element)

float getFloat (int index)

Returns the float at the given index.
float setFloat (int index, float element)

Set the new float at the given index and return the old float.
void setFloat (int dstIndex, float[ ] elements, int srcIndex, int length)
float[ ] toArrayFloat (float[ ] array)

8.99 FloatSeq Class Reference
959
int getMaximum ()
sequence.

A wrapper for getFloat(int) ( p. 960) that returns a java.lang.Float.

A wrapper for setFloat() ( p. 961).

A wrapper for addFloat(int, int).
8.99.1

float >.
Instantiates:
See also:
float
8.99.2
8.99.2.1
FloatSeq ()
Constructs an empty sequence of floats with an initial maximum of zero.

8.99.2.2
FloatSeq (int initialMaximum)
Constructs an empty sequence of floats with the given initial maximum.

8.99.2.3
FloatSeq (float[ ] floats)
Constructs a new sequence containing the given floats.

960
Class Documentation
Parameters:
floats the initial contents of this sequence
Exceptions:
8.99.3
8.99.3.1
boolean addAllFloat (float[ ] elements, int offset, int

length)
Exceptions:
8.99.3.2
boolean addAllFloat (float[ ] elements)
Exceptions:
8.99.3.3
void addFloat (float element)

8.99.3.4
void addFloat (int index, float element)
8.99.3.5
float getFloat (int index)
Returns the float at the given index.

Exceptions:

8.99.3.6
961
float setFloat (int index, float element)
Set the new float at the given index and return the old float.
Exceptions:
8.99.3.7
void setFloat (int dstIndex, float[ ] elements, int srcIndex,

int length)

Parameters:
Exceptions:
8.99.3.8
float [ ] toArrayFloat (float[ ] array)

Parameters:
into instead.
Returns:
962
Class Documentation
8.99.3.9
int getMaximum ()
elements.
first created.
Returns:
See also:
8.99.3.10
A wrapper for getFloat(int) (p. 960) that returns a java.lang.Float.

See also:
8.99.3.11
A wrapper for setFloat() (p. 961).

Exceptions:
ClassCastException if the element is not of type Float.
See also:

8.99.3.12
A wrapper for addFloat(int, int).

Exceptions:
ClassCastException if the element is not of type Float.
See also:
963
964
Class Documentation
8.100
FlowController Interface Reference
<<interface>> ( p. 279) A flow controller is the object responsible for

com.rti.dds.publication.DataWriter (p. 557) instances are allowed to write
data.

String get name ()
Returns the
( p. 964).
name
of
the
DomainParticipant get participant ()

Returns the com.rti.dds.domain.DomainParticipant ( p. 654) to which
the com.rti.dds.publication.FlowController ( p. 964) belongs.
void set property (FlowControllerProperty t prop)

Sets the com.rti.dds.publication.FlowController ( p. 964) property.
void get property (FlowControllerProperty t prop)

Gets the com.rti.dds.publication.FlowController ( p. 964) property.
void trigger flow ()

Provides an external trigger to the com.rti.dds.publication.FlowController
( p. 964).

static final String DEFAULT FLOW CONTROLLER NAME
[default] Special value of com.rti.dds.infrastructure.PublishModeQosPolicy.flow controller name ( p. 1297) that refers to the built-in default flow controller.
static
final
NAME
String
FIXED RATE FLOW CONTROLLER -
Special value of com.rti.dds.infrastructure.PublishModeQosPolicy.flow controller name ( p. 1297) that refers to the built-in fixed-rate flow
controller.
static final
NAME
String
ON DEMAND FLOW CONTROLLER -
8.100 FlowController Interface Reference
965
Special value of com.rti.dds.infrastructure.PublishModeQosPolicy.flow controller name ( p. 1297) that refers to the built-in on-demand flow
controller.
8.100.1
<<interface>> ( p. 279) A flow controller is the object responsible for

com.rti.dds.publication.DataWriter (p. 557) instances are allowed to write
data.
QoS:
com.rti.dds.publication.FlowControllerProperty t (p. 968)
8.100.2
8.100.2.1
String get name ()
Returns the name of the com.rti.dds.publication.FlowController (p. 964).

Returns:
The name of the com.rti.dds.publication.FlowController (p. 964).
8.100.2.2
Returns the com.rti.dds.domain.DomainParticipant (p. 654) to which the

com.rti.dds.publication.FlowController (p. 964) belongs.
Returns:
The com.rti.dds.domain.DomainParticipant (p. 654) to which the
com.rti.dds.publication.FlowController (p. 964) belongs.
8.100.2.3
void set property (FlowControllerProperty t prop)
Sets the com.rti.dds.publication.FlowController (p. 964) property.

This
operation
modifies
the
property
of
the
966
Class Documentation
Once a com.rti.dds.publication.FlowController (p. 964) has been instantiated, only the com.rti.dds.publication.FlowControllerProperty t.token bucket
(p. 969)
can
be
changed.
The
com.rti.dds.publication.FlowControllerProperty t.scheduling policy
(p. 969) is immutable.
A new com.rti.dds.publication.FlowControllerTokenBucketProperty t.period (p. 975) only takes effect at the next scheduled token distribution time
(as determined by its previous value).
Parameters:
prop <<in>> ( p. 279) The new com.rti.dds.publication.FlowControllerProperty t (p. 968). Property must be consistent. Immutable fields cannot
be changed after com.rti.dds.publication.FlowController
(p. 964)
has
been
created.
The
special
value
(p. 154)
can be used to indicate that the property of the
(p. 964)
should
be
changed
to
match
the
current
default
(p. 968)
Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
See also:
com.rti.dds.publication.FlowControllerProperty t (p. 968) for rules
on consistency among property values.
8.100.2.4
void get property (FlowControllerProperty t prop)
Gets the com.rti.dds.publication.FlowController (p. 964) property.

Parameters:
prop <<in>> ( p. 279) com.rti.dds.publication.FlowController
8.100 FlowController Interface Reference
967
Exceptions:
8.100.2.5
void trigger flow ()
Provides an external trigger to the com.rti.dds.publication.FlowController

(p. 964).
Typically,
a
(p. 964)
uses an internal trigger to periodically replenish its tokens.
The
period by which this trigger is called is determined by the
com.rti.dds.publication.FlowControllerTokenBucketProperty t.period (p. 975) property setting.
This function provides an additional,
external trigger to the
This trigger adds
com.rti.dds.publication.FlowControllerTokenBucketProperty t.tokens added per period (p. 974) tokens each time it is called (subject to
the other property settings of the com.rti.dds.publication.FlowController
(p. 964)).
An on-demand com.rti.dds.publication.FlowController (p. 964) can
be created with a com.rti.dds.infrastructure.Duration t.INFINITE as
com.rti.dds.publication.FlowControllerTokenBucketProperty t.period (p. 975), in which case the only trigger source is external (i.e.
the com.rti.dds.publication.FlowController (p. 964) is solely triggered by
the user on demand).
com.rti.dds.publication.FlowController.trigger flow (p. 967) can be
called on both strict on-demand com.rti.dds.publication.FlowController
(p. 964) and hybrid com.rti.dds.publication.FlowController (p. 964) (internally and externally triggered).
Exceptions:
968
Class Documentation
8.101
FlowControllerProperty t
ence
Class
Determines
the
flow
control
characteristics
Referof
the
of
the
Inherits Struct.
Public Attributes
FlowControllerSchedulingPolicy scheduling policy
Scheduling policy.
FlowControllerTokenBucketProperty t token bucket

Settings for the token bucket.
8.101.1
Determines
the
flow
control
characteristics
The flow control characteristics shape the network traffic by determining how often and in what order associated asynchronous
com.rti.dds.publication.DataWriter (p. 557) instances are serviced
and how much data they are allowed to send.
Note
that
these
settings
apply
directly
to
the
com.rti.dds.publication.FlowController (p. 964), and do not depend
on the number of com.rti.dds.publication.DataWriter (p. 557) instances the com.rti.dds.publication.FlowController (p. 964) is servicing.
For instance, the specified flow rate does not double simply because two
com.rti.dds.publication.DataWriter (p. 557) instances are waiting to
write.
Entity:
com.rti.dds.publication.FlowController (p. 964)
Properties:
RxO (p. 101) = N/A
Changeable (p. 102) = NO (p. 102) for com.rti.dds.publication.FlowControllerProperty t.scheduling policy
(p. 969),
YES
(p. 102)
for
8.101 FlowControllerProperty t Class Reference
969
com.rti.dds.publication.FlowControllerProperty (p. 969).

However,
the
special
value
t.token bucket
of
com.rti.dds.infrastructure.Duration t.INFINITE
as
com.rti.dds.publication.FlowControllerTokenBucketProperty t.period
(p. 975)
is
strictly
used
to
create
an
on-demand
The token period
cannot toggle from an infinite to finite value (or vice versa). It can, however,
change from one finite value to another.
8.101.2
8.101.2.1
FlowControllerSchedulingPolicy scheduling policy
Scheduling policy.
Determines
the
scheduling
policy
for
servicing
the
com.rti.dds.publication.DataWriter (p. 557) instances associated with
the com.rti.dds.publication.FlowController (p. 964).
[default]
idref FlowControllerSchedulingPolicy EDF FLOW CONTROLLER SCHED POLICY
8.101.2.2
FlowControllerTokenBucketProperty t token bucket
Settings for the token bucket.
970
Class Documentation
8.102
FlowControllerSchedulingPolicy
Reference
Class

Inheritance diagram for FlowControllerSchedulingPolicy::

static
final
CONTROLLER SCHED POLICY
RR FLOW -
Indicates to flow control in a round-robin fashion.
static
final
CONTROLLER SCHED POLICY
EDF FLOW -
Indicates to flow control in an earliest-deadline-first fashion.
8.102.1

Samples written by an asynchronous com.rti.dds.publication.DataWriter
(p. 557)
are
not
sent
in
the
context
of
the
com.rti.ndds.example.FooDataWriter.write (p. 1021) call.
Instead,
the middleware puts the samples in a queue for future processing. The
com.rti.dds.publication.FlowController (p. 964) associated with each
asynchronous DataWriter (p. 557) instance determines when the samples are
actually sent.
Each com.rti.dds.publication.FlowController (p. 964) maintains a separate
FIFO queue for each unique destination (remote application). Samples written
by asynchronous com.rti.dds.publication.DataWriter (p. 557) instances associated with the flow controller, are placed in the queues that correspond to
the intended destinations of the sample.
When tokens become available, a flow controller must decide which queue(s)
to grant tokens first. This is determined by the flow controllers scheduling
policy. Once a queue has been granted tokens, it is serviced by the asynchronous
publishing thread. The queued up samples will be coalesced and sent to the
corresponding destination. The number of samples sent depends on the data
size and the number of tokens granted.
8.102 FlowControllerSchedulingPolicy Class Reference
971
QoS:
com.rti.dds.publication.FlowControllerProperty t (p. 968)
8.102.2
8.102.2.1
final FlowControllerSchedulingPolicy
RR FLOW CONTROLLER SCHED POLICY [static]
Indicates to flow control in a round-robin fashion.

Whenever tokens become available, the flow controller distributes the tokens
uniformly across all of its (non-empty) destination queues. No destinations are
prioritized. Instead, all destinations are treated equally and are serviced in a
round-robin fashion.
8.102.2.2
final FlowControllerSchedulingPolicy
EDF FLOW CONTROLLER SCHED POLICY
[static]
Indicates to flow control in an earliest-deadline-first fashion.

A samples deadline is determined by the time it was written plus the latency
budget of the DataWriter (p. 557) at the time of the write call (as specified in
the com.rti.dds.infrastructure.LatencyBudgetQosPolicy (p. 1124)). The
relative priority of a flow controllers destination queue is determined by the
earliest deadline across all samples it contains.
When tokens become available, the com.rti.dds.publication.FlowController
(p. 964) distributes tokens to the destination queues in order of their deadline
priority. In other words, the queue containing the sample with the earliest
deadline is serviced first. The number of tokens granted equals the number of
tokens required to send the first sample in the queue. Note that the priority
of a queue may change as samples are sent (i.e. removed from the queue).
If a sample must be sent to multiple destinations or two samples have an
equal deadline value, the corresponding destination queues are serviced in a
round-robin fashion.
Hence, under the default com.rti.dds.infrastructure.LatencyBudgetQosPolicy.duration
(p. 1125)
setting,
an
EDF FLOW CONTROLLER SCHED POLICY
com.rti.dds.publication.FlowController (p. 964) preserves the order
in which the user calls com.rti.ndds.example.FooDataWriter.write
(p. 1021) across the DataWriters associated with the flow controller.
Since
the
(p. 1124)
is
mutable,
a
sample
written
second
may
contain an earlier deadline than the sample written first if the
972
Class Documentation
com.rti.dds.infrastructure.LatencyBudgetQosPolicy.duration (p. 1125)

value is sufficiently decreased in between writing the two samples. In that
case, if the first sample is not yet written (still in queue waiting for its turn),
it inherits the priority corresponding to the (earlier) deadline from the second
sample.
In other words, the priority of a destination queue is always determined by
the earliest deadline among all samples contained in the queue. This priority inheritance approach is required in order to both honor the updated
and adhere to the com.rti.dds.publication.DataWriter (p. 557) in-order
data delivery guarantee.
[default] for com.rti.dds.publication.DataWriter (p. 557)
8.103 FlowControllerTokenBucketProperty t Class Reference
8.103
973
FlowControllerTokenBucketProperty t
Class Reference
com.rti.dds.publication.FlowController (p. 964) uses the popular token

Inherits Struct.
Public Attributes
int max tokens
Maximum number of tokens than can accumulate in the token bucket.
int tokens added per period

The number of tokens added to the token bucket per specified period.
int tokens leaked per period

The number of tokens removed from the token bucket per specified period.
Duration t period
Period for adding tokens to and removing tokens from the bucket.
int bytes per token

Maximum number of bytes allowed to send for each token available.
8.103.1
com.rti.dds.publication.FlowController (p. 964) uses the popular token

Asynchronously published samples are queued up and transmitted based on the
token bucket flow control scheme. The token bucket contains tokens, each of
which represents a number of bytes. Samples can be sent only when there are
sufficient tokens in the bucket. As samples are sent, tokens are consumed. The
number of tokens consumed is proportional to the size of the data being sent.
Tokens are replenished on a periodic basis.
The rate at which tokens become available and other token bucket properties
determine the network traffic flow.
974
Class Documentation
Note that if the same sample must be sent to multiple destinations, separate
tokens are required for each destination. Only when multiple samples are destined to the same destination will they be co-alesced and sent using the same
token(s). In other words, each token can only contribute to a single network
packet.
Entity:
Properties:
RxO (p. 101) = N/A
Changeable (p. 102) = YES (p. 102).
However,
the special
value
of
com.rti.dds.infrastructure.Duration t.INFINITE
as
com.rti.dds.publication.FlowControllerTokenBucketProperty t.period
(p. 975)
is
strictly
used
to
create
an
on-demand
The token period
cannot toggle from an infinite to finite value (or vice versa). It can, however,
change from one finite value to another.
8.103.2
8.103.2.1
int max tokens
Maximum number of tokens than can accumulate in the token bucket.

The number of tokens in the bucket will never exceed this value. Any
excess tokens are discarded.
This property value, combined with
com.rti.dds.publication.FlowControllerTokenBucketProperty t.bytes per token (p. 976), determines the maximum allowable data
burst.
Use com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106) to allow accumulation of an unlimited amount of tokens
(and therefore potentially an unlimited burst size).
8.103.2.2
int tokens added per period
The number of tokens added to the token bucket per specified period.
com.rti.dds.publication.FlowController (p. 964) transmits data only when
tokens are available. Tokens are periodically replenished. This field determines
8.103 FlowControllerTokenBucketProperty t Class Reference
975
the number of tokens added to the token bucket with each periodic replenishment.
Available
tokens
are
distributed
to
associated
com.rti.dds.publication.DataWriter (p. 557) instances based on the
(p. 969).
Use com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106) to add the maximum number of tokens allowed
by
com.rti.dds.publication.FlowControllerTokenBucketProperty t.max tokens (p. 974).
8.103.2.3
int tokens leaked per period
The number of tokens removed from the token bucket per specified period.
tokens are available. When tokens are replenished and there are sufficient tokens
to send all samples in the queue, this property determines whether any or all of
the leftover tokens remain in the bucket.
Use com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106) to remove all excess tokens from the token bucket once
all samples have been sent. In other words, no token accumulation is allowed.
When new samples are written after tokens were purged, the earliest point in
time at which they can be sent is at the next periodic replenishment.
[default] 0
8.103.2.4
Duration t period
Period for adding tokens to and removing tokens from the bucket.
tokens are available. This field determines the period by which tokens are added
or removed from the token bucket.
The special value com.rti.dds.infrastructure.Duration t.INFINITE can be
used to create an on-demand com.rti.dds.publication.FlowController
(p. 964),
for
which
tokens
are
no
longer
replenished
periodically.
Instead,
tokens must be added explicitly by
calling
com.rti.dds.publication.FlowController.trigger flow
(p. 967).
This
external
trigger
adds
com.rti.dds.publication.FlowControllerTokenBucketProperty t.tokens added per period (p. 974) tokens each time it is called (subject to
976
Class Documentation
the other property settings).

[default] 1 second
[range] [0,1 year] or com.rti.dds.infrastructure.Duration t.INFINITE
8.103.2.5
int bytes per token
Maximum number of bytes allowed to send for each token available.

tokens are available. This field determines the number of bytes that can actually
be transmitted based on the number of tokens.
Tokens
are
always
consumed
in
whole
by
each
com.rti.dds.publication.DataWriter (p. 557). That is, in cases where
com.rti.dds.publication.FlowControllerTokenBucketProperty t.bytes per token (p. 976) is greater than the sample size, multiple
samples may be sent to the same destination using a single token (regardless of
(p. 969)).
Where fragmentation is required,
the fragment size will be
com.rti.dds.publication.FlowControllerTokenBucketProperty t.bytes per token (p. 976) or the minimum largest message size across
all transports installed with the com.rti.dds.publication.DataWriter
(p. 557), whichever is less.
Use com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106) to indicate that an unlimited number of bytes can
be transmitted per token. In other words, a single token allows the recipient com.rti.dds.publication.DataWriter (p. 557) to transmit all its queued
samples to a single destination. A separate token is required to send to each
additional destination.
8.104 Foo Class Reference
8.104
977
Foo Class Reference

Inheritance diagram for Foo::

8.104.1

Foo (p. 977) represents a user-defined data-type that is intended to be distributed using DDS.
The type Foo (p. 977) is usually defined using IDL syntax and
placed in a .idl file that is then processed using rtiddsgen
(p. 298).
The rtiddsgen (p. 298) utility generates the helper classes
com.rti.dds.infrastructure.com.rti.dds.util.Sequence as well as the necessary
code for DDS to manipulate the type (serialize it so that it can be sent over
the network) as well as the implied com.rti.ndds.example.FooDataReader
(p. 979) and com.rti.ndds.example.FooDataWriter (p. 1012) types that
allow the application to send and receive data of this type.
See also:
com.rti.dds.infrastructure.com.rti.dds.util.Sequence,
com.rti.ndds.example.FooDataWriter
(p. 1012),
com.rti.ndds.example.FooDataReader
(p. 979),
com.rti.ndds.example.FooTypeSupport (p. 1036), rtiddsgen (p. 298)
8.104.2
8.104.2.1
This is the implementation of the Copyable interface. This method will perform a deep copy of src. This method could be placed into FooTypeSupport
(p. 1036).
rather than here by using the -noCopyable option to rtiddsgen.
978
Class Documentation
Parameters:
src The Object which contains the data to be copied.
Returns:
Returns this
Exceptions:
See also:
8.105 FooDataReader Class Reference
8.105
979
FooDataReader Class Reference
<<interface>> ( p. 279) <<generic>> ( p. 279) User data type-specific data

reader.
Inheritance diagram for FooDataReader::

void read (FooSeq received data, SampleInfoSeq info seq, int max samples, int sample states, int view states, int instance states)
Access
a
collection
of
data
samples
from
the
void take (FooSeq received data, SampleInfoSeq info seq, int max samples, int sample states, int view states, int instance states)
Access
a
collection
of
data-samples
from
the
void read w condition (FooSeq received data, SampleInfoSeq info seq, int max samples, ReadCondition condition)
Accesses
via
( p. 981) the samples that match the criteria specified in the
void take w condition (FooSeq received data, SampleInfoSeq info seq, int max samples, ReadCondition condition)
Analogous
to
( p. 990)
except
it
accesses
samples
via
the
com.rti.ndds.example.FooDataReader.take ( p. 983) operation.
void read next sample (Foo received data, SampleInfo sample info)
value
from
the
void take next sample (Foo received data, SampleInfo sample info)
value
from
the
void read instance (FooSeq received data, SampleInfoSeq info seq,

int max samples, InstanceHandle t a handle, int sample states, int
980
Class Documentation
Access
a
collection
of
data
samples
from
the
void take instance (FooSeq received data, SampleInfoSeq info seq,

int max samples, InstanceHandle t a handle, int sample states, int
Access
a
collection
of
data
samples
from
the
void read next instance (FooSeq received data, SampleInfoSeq

info seq, int max samples, InstanceHandle t previous handle, int sample states, int view states, int instance states)
Access
a
collection
of
data
samples
from
the
void take next instance (FooSeq received data, SampleInfoSeq

info seq, int max samples, InstanceHandle t previous handle, int sample states, int view states, int instance states)
Access
a
collection
of
data
samples
from
the
void read next instance w condition (FooSeq received data, SampleInfoSeq info seq, int max samples, InstanceHandle t previous handle, ReadCondition condition)
Accesses
via
com.rti.ndds.example.FooDataReader.read next instance ( p. 999) the samples that match the criteria specified in the
void take next instance w condition (FooSeq received data, SampleInfoSeq info seq, int max samples, InstanceHandle t previous handle, ReadCondition condition)
Accesses
via
com.rti.ndds.example.FooDataReader.take next instance ( p. 1002) the samples that match the criteria specified in
the com.rti.dds.subscription.ReadCondition ( p. 1313).
void return loan (FooSeq received data, SampleInfoSeq info seq)

void get key value (Foo key holder, InstanceHandle t handle)

InstanceHandle t lookup instance (Foo key holder)

981
Retrieves the instance handle that corresponds to an instance key holder.
8.105.1
<<interface>> ( p. 279) <<generic>> ( p. 279) User data type-specific data

reader.
Defines the user data type specific reader interface generated for each application
class.
The concrete user data type reader automatically generated by the implementation is an incarnation of this class.
See also:
com.rti.ndds.example.Foo (p. 977)
rtiddsgen (p. 298)
8.105.2
8.105.2.1
void read (FooSeq received data, SampleInfoSeq info seq,

int max samples, int sample states, int view states, int
instance states)
Access
a
collection
of
data
samples
from
the
This
operation
offers
the
same
functionality
and
API
as
com.rti.ndds.example.FooDataReader.take (p. 983) except that the
samples returned remain in the com.rti.dds.subscription.DataReader
(p. 487) such that they can be retrieved again by means of a read or take
operation.
Please refer to the documentation of com.rti.ndds.example.FooDataReader.take()
(p. 983) for details on the number of samples returned within the received data
and info seq as well as the order in which the samples appear in these sequences.
The act of reading a sample changes its sample state to
com.rti.dds.subscription.SampleStateKind.SampleStateKind.READ SAMPLE STATE. If the sample belongs to the most recent generation
of the instance, it will also set the view state of the instance to be
Important: If the samples returned by this method are loaned from RTI
982
Class Documentation
Connext (see com.rti.ndds.example.FooDataReader.take (p. 983) for more

information on memory loaning), it is important that their contents not be
changed. Because the memory in which the data is stored belongs to the middleware, any modifications made to the data will be seen the next time the same
samples are read or taken; the samples will no longer reflect the state that was
received from the network.
Parameters:
( p. 279)
User
data
type-specific
com.rti.dds.infrastructure.com.rti.dds.util.Sequence object where
the received data samples will be returned. Must be a valid
non-NULL FooSeq (p. 1034).
(p. 1409)
object
where
the
received
sample
info
will
be
returned.
Must
be
a
valid
non-NULL
max samples <<in>>
( p. 279)
The
maximum
instance states <<in>> ( p. 279) Data samples matching ones of these
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
com.rti.dds.infrastructure.RETCODE (p. 1363),
PRECONDITION NOT MET
(p. 1360)
(p. 1361).
See also:
983
(p. 990),
(p. 983),
8.105.2.2
void take (FooSeq received data, SampleInfoSeq info seq,

int max samples, int sample states, int view states, int
instance states)
Access
a
collection
of
data-samples
from
the
The operation will return the list of samples received by the

(p. 487)
since
the
last
operation
(p. 983)
that
match
the
specified
com.rti.dds.subscription.SampleStateMask,
com.rti.dds.subscription.ViewStateMask and com.rti.dds.subscription.InstanceStateMask.
This operation may fail with com.rti.dds.infrastructure.RETCODE ERROR (p. 1356) if com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max outstanding reads (p. 548) limit has been exceeded.
The actual number of samples returned depends on the information that has been received by the middleware as well as
the
(p. 1046),
(p. 1348),
(p. 542) and the characteristics of the data-type that is associated with the
com.rti.dds.subscription.DataReader (p. 487):
In the case where the com.rti.dds.infrastructure.HistoryQosPolicy.kind
(p. 1048) is com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP LAST HISTORY QOS,
the
call
will
return
at
most
com.rti.dds.infrastructure.HistoryQosPolicy.depth
(p. 1049)
samples per instance.
The maximum number of samples returned is limited by
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples (p. 1351), and by com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max samples per read (p. 548).
For
multiple
instances,
the
number
of
samples
returned
is
additionally
limited
by
the
product
(com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples per instance (p. 1352) com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max instances (p. 1352))
984
Class Documentation
If com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max infos (p. 547) is limited, the number of samples returned may also be
limited if insufficient com.rti.dds.subscription.SampleInfo (p. 1398)
resources are available.
If the read or take succeeds and the number of samples returned has been
limited (by means of a maximum limit, as listed above, or insufficient
com.rti.dds.subscription.SampleInfo (p. 1398) resources), the call will complete successfully and provide those samples the reader is able to return. The
user may need to make additional calls, or return outstanding loaned buffers in
the case of insuffificient resources, in order to access remaining samples.
Note that in the case where the com.rti.dds.topic.Topic (p. 1545) associated
with the com.rti.dds.subscription.DataReader (p. 487) is bound to a datatype that has no key definition, then there will be at most one instance in the
com.rti.dds.subscription.DataReader (p. 487). So the per-sample limits
will apply.
The act of taking a sample removes it from RTI Connext so it cannot
be read or taken again. If the sample belongs to the most recent generation of the instance, it will also set the view state of the samples instance to com.rti.dds.subscription.ViewStateKind.ViewStateKind.NOT NEW VIEW STATE. It will not affect the instance state of the samples instance.
After com.rti.ndds.example.FooDataReader.take (p. 983) completes,
received data and info seq will be of the same length and contain the received data.
If the sequences are empty (maximum size equals 0) when the
com.rti.ndds.example.FooDataReader.take (p. 983) is called, the
samples returned in the received data and the corresponding info seq are loaned to the application from buffers provided by the
The application can
use them as desired and has guaranteed exclusive access to them.
Once the application completes its use of the samples it must return the
loan to the com.rti.dds.subscription.DataReader (p. 487) by calling the
com.rti.ndds.example.FooDataReader.return loan (p. 1008) operation.
Important:
When you loan data from the middleware, you must
not keep any pointers to any part of the data samples or the
com.rti.dds.subscription.SampleInfo (p. 1398) objects after the call to
com.rti.ndds.example.FooDataReader.return loan (p. 1008). Returning
the loan places the objects back into a pool, allowing the middleware to overwrite them with new data.
Note: While you must call com.rti.ndds.example.FooDataReader.return loan (p. 1008) at some point, you do not have to do so before
the
next
(p. 983)
985
call.
However, failure to return the loan will eventually deplete the com.rti.dds.subscription.DataReader (p. 487) of the
buffers it needs to receive new samples and eventually samples will
start to be lost.
The total number of buffers available to the
com.rti.dds.subscription.DataReader (p. 487) is specified by the
and
(p. 1348)
the com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy
(p. 542).
If the sequences are not empty (maximum size not equal to 0 and length not
equal to 0) when com.rti.ndds.example.FooDataReader.take (p. 983) is
called, samples are copied to received data and info seq. The application will not
need to call com.rti.ndds.example.FooDataReader.return loan (p. 1008).
The order of the samples returned to the caller depends on the
com.rti.dds.infrastructure.PresentationQosPolicy (p. 1221).
If com.rti.dds.infrastructure.PresentationQosPolicy.access scope
(p. 1225) is com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPolicyAccessSco
PRESENTATION QOS, the returned collection is a list where samples
belonging to the same data instance are consecutive.
PRESENTATION QOS and com.rti.dds.infrastructure.PresentationQosPolicy.ordered access (p. 1225) is set to com.rti.dds.infrastructure.false, then returned
collection is a list where samples belonging to the same data instance are
consecutive.
PRESENTATION QOS and com.rti.dds.infrastructure.PresentationQosPolicy.ordered access (p. 1225) is set to com.rti.dds.infrastructure.true, then the returned
collection is a list were the relative order of samples is preserved also
accross different instances. Note that samples belonging to the same
instance may or may not be consecutive. This is because to preserve
order it may be necessary to mix samples from different instances.
PRESENTATION QOS and com.rti.dds.infrastructure.PresentationQosPolicy.ordered access (p. 1225) is set to com.rti.dds.infrastructure.false, then returned
collection is a list where samples belonging to the same data instance are
consecutive. [Not supported (optional)]
986
Class Documentation
PRESENTATION QOS and com.rti.dds.infrastructure.PresentationQosPolicy.ordered access (p. 1225) is set to com.rti.dds.infrastructure.true, then the returned
collection contains at most one sample. The difference in this case is due
to the fact that is required that the application is able to read samples
belonging to different com.rti.dds.subscription.DataReader (p. 487)
objects in a specific order. [Not supported (optional)]
In any case, the relative order between the samples of one instance is consistent
with the DESTINATION ORDER (p. 53) policy:
If
(p. 633) is com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPolicyK
RECEPTION TIMESTAMP DESTINATIONORDER QOS,
samples
belonging to the same instances will appear in the relative order in which
there were received (FIFO, earlier samples ahead of the later samples).
If
(p. 633) is com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPolicyK
SOURCE TIMESTAMP DESTINATIONORDER QOS, samples belonging to the same instances will appear in the relative order implied by the
source timestamp (FIFO, smaller values of source timestamp ahead of
the larger values).
If
the
(p. 487)
has
no
samples that meet the constraints, the method will fail with
In addition to the collection of samples, the read and take operations also use
a collection of com.rti.dds.subscription.SampleInfo (p. 1398) structures.
8.105.3
SEQUENCES USAGE IN TAKE AND READ
The initial (input) properties of the received data and info seq collections
will determine the precise behavior of the read or take operation. For the purposes of this description, the collections are modeled as having these properties:
the current-length (len, see com.rti.dds.infrastructure.com.rti.dds.util.Sequence.Sequence.size())
the maximum length (max len, see com.rti.dds.infrastructure.com.rti.dds.util.Sequence.Sequence.ge

The initial values of the len and max len properties for the received data and
info seq collections govern the behavior of the read and take operations as
specified by the following rules:
987
1. The values of len and max len properties for the two collections must be identical.
Otherwise read/take will fail with
2. On successful output, the values of len and max len will be the same for
both collections.
3. If the initial max len==0, then the received data and info seq
collections will be filled with elements that are loaned by the
com.rti.dds.subscription.DataReader (p. 487). On output, len will
be set to the number of values returned, and max len will be set to
a value verifying max len >= len. The use of this variant allows for
zero-copy access to the data and the application will need to return
the loan to the com.rti.dds.publication.DataWriter (p. 557) using
4. If the initial max len>0 then the read or take operation will fail
with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363). This avoids the potential hard-to-detect memory
leaks caused by an application forgetting to return the loan.
5. If initial max len>0 then the read or take operation will copy
the received data values and com.rti.dds.subscription.SampleInfo
(p. 1398) values into the elements already inside the collections. On output, len will be set to the number of values copied and max len will
remain unchanged. The use of this variant forces a copy but the application can control where the copy is placed and the application will not
need to return the loan. The number of samples copied depends on the
relative values of max len and max samples:
If max samples == LENGTH UNLIMITED, then at most max len
values will be copied. The use of this variant lets the application
limit the number of samples returned to what the sequence can accommodate.
If max samples <= max len, then at most max samples values will be
copied. The use of this variant lets the application limit the number of
samples returned to fewer that what the sequence can accommodate.
If max samples > max len, then the read or take operation will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363). This avoids the potential confusion where the application expects to be able to access
up to max samples, but that number can never be returned, even if
they are available in the com.rti.dds.subscription.DataReader
(p. 487), because the output sequence cannot accommodate them.
988
Class Documentation
As described above,
upon completion,
the received data and
collections
may
contain
elements
loaned
from
the
info seq
com.rti.dds.subscription.DataReader (p. 487). If this is the case, the application will need to use com.rti.ndds.example.FooDataReader.return loan (p. 1008) to return the loan once it is no longer using the received data
in the collection. When com.rti.ndds.example.FooDataReader.return loan (p. 1008) completes, the collection will have max len=0.
The application can determine whether it is necessary to return the loan or
not based on how the state of the collections when the read/take operation was called However, in many cases it may be simpler to always call
com.rti.ndds.example.FooDataReader.return loan (p. 1008), as this
operation is harmless (i.e., it leaves all elements unchanged) if the collection
does not have a loan.
On output, the collection of com.rti.ndds.example.Foo (p. 977) values
and the collection of com.rti.dds.subscription.SampleInfo (p. 1398) structures are of the same length and are in a one-to-one correspondence. Each
com.rti.dds.subscription.SampleInfo (p. 1398) provides information, such
as the source timestamp, the sample state, view state, and instance state, etc.,
about the corresponding sample.
Some elements in the returned collection may not have valid data. If the
instance state in the com.rti.dds.subscription.SampleInfo (p. 1398) is
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE DISPOSED INSTANCE STATE or com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT
ALIVE NO WRITERS INSTANCE STATE,
then
the
last
sample for that instance in the collection (that is, the one whose
com.rti.dds.subscription.SampleInfo (p. 1398) has sample rank==0)
does not contain valid data.
Samples that contain no data do not count towards the limits imposed by the com.rti.dds.infrastructure.ResourceLimitsQosPolicy
(p. 1348).
The act of reading/taking a sample sets its sample state
to
com.rti.dds.subscription.SampleStateKind.SampleStateKind.READ SAMPLE STATE.
If the sample belongs to the most recent generation of the
instance,
it will also set the view state of the instance to
This
operation
must
be
provided
on
the
specialized
that is generated for the particular application data-type
If
is being read (com.rti.ndds.example.Foo (p. 977)).
(p. 487)
has
no
ples
that
meet
the
constraints,
the
operations
fails
class
that
the
samwith
989
For an example (p. 375) on how take can be used, please refer to the receive
example (p. 254).
Parameters:
( p. 279)
User
data
type-specific
Parameters:
(p. 1409)
object
where
the
received
sample
info
will
be
returned.
Must
be
a
valid
non-NULL
max samples <<in>>
( p. 279)
The
maximum
as are available, up to the limits described above.
instance states <<in>> ( p. 279) Data samples matching one of these
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1363),
(p. 1360)
(p. 1361).
See also:
com.rti.ndds.example.FooDataReader.read w condition (p. 990),
990
Class Documentation
8.105.3.1
void read w condition (FooSeq received data,

ReadCondition condition)
Accesses
via
(p. 981) the samples that match the criteria specified in the
This
operation
is
especially
useful
in
combination
with
com.rti.dds.subscription.QueryCondition (p. 1311) to filter data samples
based on the content.
The specified com.rti.dds.subscription.ReadCondition (p. 1313) must be
attached to the com.rti.dds.subscription.DataReader (p. 487); otherwise the operation will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
In case the com.rti.dds.subscription.ReadCondition (p. 1313) is a plain
com.rti.dds.subscription.ReadCondition (p. 1313) and not the specialized com.rti.dds.subscription.QueryCondition (p. 1311), the operation is
equivalent to calling com.rti.ndds.example.FooDataReader.read (p. 981)
and passing as sample states, view states and instance states the value of
the corresponding attributes in the read condition. Using this operation, the
application can avoid repeating the same parameters specified when creating
the com.rti.dds.subscription.ReadCondition (p. 1313).
The
samples
are
accessed
with
the
same
com.rti.ndds.example.FooDataReader.read (p. 981).
semantics
as
If
the
(p. 487)
has
no
samples that meet the constraints, the operation will fail with
Parameters:
( p. 279)
user
data
type-specific
info seq <<inout>> ( p. 279) a com.rti.dds.subscription.SampleInfoSeq
(p. 1409)
object
where
the
received
sample
info
will
be
returned.
Must
be
a
valid
non-NULL
991

max samples <<in>>
( p. 279)
The
maximum
condition <<in>> ( p. 279) the com.rti.dds.subscription.ReadCondition
(p. 1313) to select samples of interest. Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1363),
(p. 1360)
(p. 1361).
See also:
(p. 983),
8.105.3.2
void take w condition (FooSeq received data,

Analogous
to
except
it
accesses
samples
via
the
w condition
com.rti.ndds.example.FooDataReader.take (p. 983) operation.
This operation is analogous to com.rti.ndds.example.FooDataReader.read w condition (p. 990) except that it accesses samples via the
com.rti.ndds.example.FooDataReader.take (p. 983) operation.
The specified com.rti.dds.subscription.ReadCondition (p. 1313) must be
attached to the com.rti.dds.subscription.DataReader (p. 487); otherwise the operation will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
992
Class Documentation
The
samples
are
accessed
with
the
same
com.rti.ndds.example.FooDataReader.take (p. 983).
semantics
as
This
operation
is
especially
useful
in
combination
with
com.rti.dds.subscription.QueryCondition (p. 1311) to filter data samples
based on the content.
If
the
(p. 487)
has
no
Parameters:
( p. 279)
user
data
type-specific
(p. 1409)
object
where
the
received
sample
info
will
be
returned.
Must
be
a
valid
non-NULL
max samples <<in>>
( p. 279)
The
maximum
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1363),
(p. 1360)
(p. 1361).
See also:
(p. 990),
993

8.105.3.3
void read next sample (Foo received data, SampleInfo

sample info)
Copies
the
next
value
from
the
This operation copies the next not-previously-accessed data value from

This operation
also copies the corresponding com.rti.dds.subscription.SampleInfo
(p. 1398).
The implied order among the samples stored in the
com.rti.dds.subscription.DataReader (p. 487) is the same as for the
com.rti.ndds.example.FooDataReader.read (p. 981) operation.
The
com.rti.ndds.example.FooDataReader.read next sample
(p. 993)
operation
is
semantically
equivalent
to
the
com.rti.ndds.example.FooDataReader.read (p. 981) operation, where
the input data sequences has max len=1, the sample states=NOT READ, the
view states=ANY VIEW STATE, and the instance states=ANY INSTANCE STATE.
The com.rti.ndds.example.FooDataReader.read next sample (p. 993)
operation provides a simplified API to read samples, avoiding the need for
the application to manage sequences and specify states.
If there is no unread data in the com.rti.dds.subscription.DataReader
(p. 487), the operation will fail with com.rti.dds.infrastructure.RETCODE NO DATA (p. 1360) and nothing is copied.
Parameters:
( p. 279)
user
data
type-specific
com.rti.ndds.example.Foo (p. 977) object where the next received data sample will be returned. The received data must have
been fully allocated. Otherwise, this operation may fail. Must
be a valid non-NULL Foo (p. 977). The method will fail with
sample info <<inout>> ( p. 279) a com.rti.dds.subscription.SampleInfo
(p. 1398) object where the next received sample info
will
be
returned.
Must
be
a
valid
non-NULL
The method
994
Class Documentation
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1360)
(p. 1361).
See also:
8.105.3.4
void take next sample (Foo received data, SampleInfo

sample info)
Copies
the
next not-previously-accessed data
value
from
the
This operation copies the next not-previously-accessed data value from

the com.rti.dds.subscription.DataReader (p. 487) and removes it
from the com.rti.dds.subscription.DataReader (p. 487) so that it is
no longer accessible.
This operation also copies the corresponding
com.rti.dds.subscription.SampleInfo (p. 1398). This operation is analogous to the com.rti.ndds.example.FooDataReader.read next sample
(p. 993) except for the fact that the sample is removed from the
The
com.rti.ndds.example.FooDataReader.take next sample
(p. 994)
operation
is
semantically
equivalent
to
the
com.rti.ndds.example.FooDataReader.take (p. 983) operation, where
the input data sequences has max len=1, the sample states=NOT READ, the
view states=ANY VIEW STATE, and the instance states=ANY INSTANCE STATE.
The com.rti.ndds.example.FooDataReader.read next sample (p. 993)
operation provides a simplified API to take samples, avoiding the need for
the application to manage sequences and specify states.
If there is no unread data in the com.rti.dds.subscription.DataReader
(p. 487), the operation will fail with com.rti.dds.infrastructure.RETCODE NO DATA (p. 1360) and nothing is copied.
Parameters:
( p. 279)
user
data
type-specific
com.rti.ndds.example.Foo (p. 977) object where the next received data sample will be returned. The received data must have
been fully allocated. Otherwise, this operation may fail. Must
be a valid non-NULL Foo (p. 977). The method will fail with
995

sample info <<inout>> ( p. 279) a com.rti.dds.subscription.SampleInfo
(p. 1398) object where the next received sample info
will
be
returned.
Must
be
a
valid
non-NULL
The method
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1360)
(p. 1361).
See also:
8.105.3.5
void read instance (FooSeq received data, SampleInfoSeq

info seq, int max samples, InstanceHandle t a handle,
int sample states, int view states, int instance states)
Access
a
collection
of
data
samples
from
the
This operation accesses a collection of data values from the

com.rti.dds.subscription.DataReader (p. 487). The behavior is identical to com.rti.ndds.example.FooDataReader.read (p. 981), except that
all samples returned belong to the single specified instance whose handle is
a handle.
Upon successful completion,
the data collection will contain
samples all belonging to the same instance.
The corresponding
(p. 1398)
verifies
com.rti.dds.subscription.SampleInfo.instance handle (p. 1404) ==
a handle.
The
com.rti.ndds.example.FooDataReader.read instance
(p. 995)
operation
is
semantically
equivalent
to
the
com.rti.ndds.example.FooDataReader.read (p. 981) operation,
except in building the collection, the com.rti.dds.subscription.DataReader
(p. 487) will check that the sample belongs to the specified instance and
otherwise it will not place the sample in the returned collection.
The behavior of the com.rti.ndds.example.FooDataReader.read instance
(p. 995)
operation
follows
the
same
rules
as
the
996
Class Documentation
com.rti.ndds.example.FooDataReader.read (p. 981) operation regarding

the pre-conditions and post-conditions for the received data and sample info. Similar to the com.rti.ndds.example.FooDataReader.read (p. 981),
the com.rti.ndds.example.FooDataReader.read instance (p. 995) operation may loan elements to the output collections, which must then be
returned by means of com.rti.ndds.example.FooDataReader.return loan
(p. 1008).
Similar to the com.rti.ndds.example.FooDataReader.read (p. 981), this
operation must be provided on the specialized class that is generated for the
particular application data-type that is being taken.
has
no
If
the
(p. 487)
This operation may fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) if the com.rti.dds.infrastructure.InstanceHandle t (p. 1055) a handle does not correspond to an existing data-object known to
Parameters:
( p. 279)
user
data
type-specific
(p. 1409)
object
where
the
received
sample
info
will
be
returned.
Must
be
a
valid
non-NULL
max samples <<in>>
( p. 279)
The
maximum
a handle <<in>> ( p. 279)
The
specified
instance
to
return
samples
for.
Must
be
a
valid
non-NULL
com.rti.dds.infrastructure.InstanceHandle t (p. 1055).
The
method will fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) if it is NULL The method
will
fail
with
com.rti.dds.infrastructure.RETCODE Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
997
BAD PARAMETER (p. 1355) if the handle does

correspond to an existing data-object known to
not
the
sample states <<in>> ( p. 279) data samples matching ones of these

sample states are returned
view states <<in>> ( p. 279) data samples matching ones of these
view state are returned
instance states <<in>> ( p. 279) data samples matching ones of these
instance state are returned
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1363),
(p. 1360)
(p. 1361).
See also:
8.105.3.6
void take instance (FooSeq received data, SampleInfoSeq

info seq, int max samples, InstanceHandle t a handle,
int sample states, int view states, int instance states)
Access
a
collection
of
data
samples
from
the

com.rti.dds.subscription.DataReader (p. 487). The behavior is identical to com.rti.ndds.example.FooDataReader.take (p. 983), except for
that all samples returned belong to the single specified instance whose handle
is a handle.
The semantics are the same for the com.rti.ndds.example.FooDataReader.take
operation,
except
in
building
the
collection,
the
(p. 983)
com.rti.dds.subscription.DataReader (p. 487) will check that the sample
belongs to the specified instance, and otherwise it will not place the sample in
the returned collection.
The behavior of the com.rti.ndds.example.FooDataReader.take instance
(p. 997)
operation
follows
the
same
rules
as
the
998
Class Documentation

the pre-conditions and post-conditions for the received data and sample info.
Similar to the com.rti.ndds.example.FooDataReader.read (p. 981), the
com.rti.ndds.example.FooDataReader.take instance (p. 997) operation
may loan elements to the output collections, which must then be returned by
means of com.rti.ndds.example.FooDataReader.return loan (p. 1008).
If
the
(p. 487)
no samples that meet the constraints, the method fails
has
with
This operation may fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) if the com.rti.dds.infrastructure.InstanceHandle t (p. 1055) a handle does not correspond to an existing data-object known to
Parameters:
( p. 279)
user
data
type-specific
(p. 1409)
object
where
the
received
sample
info
will
be
returned.
Must
be
a
valid
non-NULL
max samples <<in>>
( p. 279)
The
maximum
a handle <<in>> ( p. 279)
The
specified
instance
to
return
samples
for.
Must
be
a
valid
non-NULL
The
method will fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) if it is NULL. The method
will
fail
with
com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) if the handle does not
999
correspond to an existing data-object known

to
the

Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1363),
(p. 1360)
(p. 1361).
See also:
8.105.3.7
void read next instance (FooSeq received data,

InstanceHandle t previous handle, int sample states, int
Access
a
collection
of
data
samples
from
the

com.rti.dds.subscription.DataReader (p. 487) where all the samples belong to a single instance.
The behavior is similar to
(p. 995),
excom.rti.ndds.example.FooDataReader.read instance
cept that the actual instance is not directly specified. Rather, the samples
will all belong to the next instance with instance handle greater than the
specified previous handle that has available samples.
This operation implies the existence of a total order greater-than relationship between the instance handles. The specifics of this relationship are not
all important and are implementation specific. The important thing is that,
according to the middleware, all instances are ordered relative to each other.
This ordering is between the instance handles; It should not depend on the
1000
Class Documentation
state of the instance (e.g. whether it has data or not) and must be defined even
for instance handles that do not correspond to instances currently managed by
the com.rti.dds.subscription.DataReader (p. 487). For the purposes of the
ordering, it should be as if each instance handle was represented as unique
integer.
The behavior of com.rti.ndds.example.FooDataReader.read next instance (p. 999) is as if the com.rti.dds.subscription.DataReader
(p. 487) invoked com.rti.ndds.example.FooDataReader.read instance
(p. 995), passing the smallest instance handle among all the ones that: (a)
are greater than previous handle, and (b) have available samples (i.e. samples
that meet the constraints imposed by the specified states).
The special value com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL is guaranteed to be less than any valid instance handle.
So the use of the parameter value previous handle ==
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL
will return the samples for the instance which has the smallest instance handle
among all the instances that contain available samples.
The
operation
com.rti.ndds.example.FooDataReader.read next instance (p. 999) is intended to be used in an application-driven iteration, where the application starts by passing previous handle ==
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL, examines the samples returned, and then uses the instance handle
returned
in
the
(p. 1398) as the value of the previous handle argument to
the
next
call
to
(p. 999).
The
iteration
continues
until
(p. 999)
fails with the value com.rti.dds.infrastructure.RETCODE NO DATA
(p. 1360).
Note that it is possible to call the com.rti.ndds.example.FooDataReader.read next instance (p. 999) operation with a previous handle that
does not correspond to an instance currently managed by the
This is because as
stated earlier the greater-than relationship is defined even for handles not managed by the com.rti.dds.subscription.DataReader
(p. 487). One practical situation where this may occur is when an application is iterating though all the instances, takes all the samples of a
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE NO WRITERS INSTANCE STATE instance, returns the loan (at which point
the instance information may be removed, and thus the handle becomes
invalid), and tries to read the next instance.
The behavior
next instance
of the
(p. 999)
com.rti.ndds.example.FooDataReader.read operation follows the same rules as the
1001

the com.rti.ndds.example.FooDataReader.read instance (p. 995) operation may loan elements to the output collections, which must then be
(p. 1008).
has
no
If
the
(p. 487)
Parameters:
( p. 279)
user
data
type-specific
(p. 1409)
object
where
the
received
sample
info
will
be
returned.
Must
be
a
valid
non-NULL
max samples <<in>>
( p. 279)
The
maximum
previous handle <<in>> ( p. 279)
The
next
smallest
instance with a value greater than this value that has available samples will be returned.
Must be a valid non-NULL
The
method will fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) if it is NULL.
1002
Class Documentation

Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
com.rti.dds.infrastructure.RETCODE (p. 1363)
(p. 1360)
(p. 1361).
See also:
8.105.3.8
void take next instance (FooSeq received data,

InstanceHandle t previous handle, int sample states, int
Access
a
collection
of
data
samples
from
the

com.rti.dds.subscription.DataReader (p. 487) and removes them from
This
operation
has
the
same
behavior
as
(p. 999),
except
that
the
samples
are
taken
from
the
com.rti.dds.subscription.DataReader (p. 487) such that they are no
longer accessible via subsequent read or take operations.
Similar to the operation com.rti.ndds.example.FooDataReader.read next instance
(p. 999),
it
is
possible
to
call
com.rti.ndds.example.FooDataReader.take next instance
(p. 1002)
with a previous handle that does not correspond to an instance currently
managed by the com.rti.dds.subscription.DataReader (p. 487).
The behavior of the com.rti.ndds.example.FooDataReader.take next instance (p. 1002) operation follows the same rules as the
1003
the com.rti.ndds.example.FooDataReader.take next instance (p. 1002)

operation may loan elements to the output collections, which must then be
(p. 1008).
If
the
(p. 487)
has
no
Parameters:
( p. 279)
user
data
type-specific
object
where
the
received
sample
info
(p. 1409)
will
be
returned.
Must
be
a
valid
non-NULL
max samples <<in>>
( p. 279)
The
maximum
The
next
smallest
The
1004
Class Documentation
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1363),
(p. 1360)
(p. 1361).
See also:
8.105.3.9
void read next instance w condition (FooSeq

InstanceHandle t previous handle, ReadCondition
condition)
Accesses
via
com.rti.ndds.example.FooDataReader.read next instance (p. 999) the samples that match the criteria specified in the
com.rti.dds.subscription.DataReader (p. 487). The behavior is identical
to
(p. 999), except that all returned samples satisfy the specified condition. In
other words, on success, all returned samples belong to the same instance, and
the instance is the instance with smallest instance handle among the ones
that verify: (a) instance handle >= previous handle, and (b) have samples
for which the specified com.rti.dds.subscription.ReadCondition (p. 1313)
evaluates to TRUE.
(p. 999),
it
is
possible
to
call
com.rti.ndds.example.FooDataReader.read next instance w condition (p. 1004) with a previous handle that does not correspond to an
instance currently managed by the com.rti.dds.subscription.DataReader
(p. 487).
The behavior of the com.rti.ndds.example.FooDataReader.read next instance w condition (p. 1004) operation follows the same rules as the
the pre-conditions and post-conditions for the received data and sample info.
Similar to the com.rti.ndds.example.FooDataReader.read
(p. 981),
the
com.rti.ndds.example.FooDataReader.read next Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
1005
instance w condition (p. 1004) operation may loan elements to

the output collections, which must then be returned by means of
has
no
If
the
(p. 487)
Parameters:
( p. 279)
user
data
type-specific
(p. 1409)
object
where
the
received
sample
info
will
be
returned.
Must
be
a
valid
non-NULL
max samples <<in>>
( p. 279)
The
maximum
The
next
smallest
The
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1363)
1006
Class Documentation
(p. 1360)
(p. 1361).
See also:
8.105.3.10
void take next instance w condition (FooSeq

received data, SampleInfoSeq info seq, int
max samples, InstanceHandle t previous handle,
Accesses
via
com.rti.ndds.example.FooDataReader.take next instance (p. 1002) the samples that match the criteria specified in the
com.rti.dds.subscription.DataReader (p. 487) and removes them from
The
operation
has
the
same
behavior
as
com.rti.ndds.example.FooDataReader.read next instance w condition (p. 1004), except that the samples are taken from the
com.rti.dds.subscription.DataReader (p. 487) such that they are no
longer accessible via subsequent read or take operations.
(p. 999),
it
is
possible
to
call
com.rti.ndds.example.FooDataReader.take next instance w condition (p. 1006) with a previous handle that does not correspond to an
instance currently managed by the com.rti.dds.subscription.DataReader
(p. 487).
The behavior of the com.rti.ndds.example.FooDataReader.take next instance w condition (p. 1006) operation follows the same rules as the
com.rti.ndds.example.FooDataReader.read (p. 981) operation regarding the pre-conditions and post-conditions for the received data and
sample info.
Similar to com.rti.ndds.example.FooDataReader.read
(p. 981),
the
com.rti.ndds.example.FooDataReader.take next instance w condition (p. 1006) operation may loan elements to
the output collections, which must then be returned by means of
1007
has
no
If
the
(p. 487)
Parameters:
( p. 279)
user
data
type-specific
(p. 1409)
object
where
the
received
sample
info
will
be
returned.
Must
be
a
valid
non-NULL
max samples <<in>>
( p. 279)
The
maximum
The
next
smallest
The
Exceptions:
One of
the
Standard
Return
com.rti.dds.infrastructure.RETCODE
(p. 1361).
Codes
(p. 108),
(p. 1363),
or
NO DATA
(p. 1360),
NOT ENABLED
1008
Class Documentation
See also:
8.105.3.11
void return loan (FooSeq received data, SampleInfoSeq

info seq)

This operation indicates to the com.rti.dds.subscription.DataReader
(p. 487) that the application is done accessing the collection of received data and info seq obtained by some earlier invocation of read or take on the
The received data and info seq must belong to a single related pair;
that is, they should correspond to a pair returned from a single call to read
or take. The received data and info seq must also have been obtained
from the same com.rti.dds.subscription.DataReader (p. 487) to which they
are returned. If either of these conditions is not met, the operation will
fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
The
operation
com.rti.ndds.example.FooDataReader.return loan
(p. 1008) allows implementations of the read and take operations to loan
buffers from the com.rti.dds.subscription.DataReader (p. 487) to the
application and in this manner provide zerocopy access to the data. During
the loan, the com.rti.dds.subscription.DataReader (p. 487) will guarantee
that the data and sample-information are not modified.
It is not necessary for an application to return the loans immediately after the
read or take calls. However, as these buffers correspond to internal resources
inside the com.rti.dds.subscription.DataReader (p. 487), the application
should not retain them indefinitely.
The use of com.rti.ndds.example.FooDataReader.return loan (p. 1008)
is only necessary if the read or take calls loaned buffers to the application.
This only occurs if the received data and info Seq collections had max len=0
at the time read or take was called.
If
the
collections
had
a
loan,
upon
completion
of
com.rti.ndds.example.FooDataReader.return loan (p. 1008), the collections will have max len=0.
Similar to read, this operation must be provided on the specialized class that is
1009
generated for the particular application data-type that is being taken.

Parameters:
received data <<in>>
( p. 279)
user
data
type-specific
com.rti.dds.infrastructure.com.rti.dds.util.Sequence object where the
received data samples was obtained from earlier invocation of read or
take on the com.rti.dds.subscription.DataReader (p. 487). Must
be a valid non-NULL FooSeq (p. 1034). The method will fail with
Parameters:
info seq <<in>> ( p. 279) a com.rti.dds.subscription.SampleInfoSeq
(p. 1409) object where the received sample info was obtained from earlier invocation of read or take on the
Must be a
valid
non-NULL
com.rti.dds.subscription.SampleInfoSeq
(p. 1409).
The
method
will
fail
with
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1363)
or
(p. 1361).
8.105.3.12
void get key value (Foo key holder, InstanceHandle t

handle)

instance.
For
keyed
data
types,
this
operation
may
fail
with
Parameters:
key holder <<inout>>
( p. 279)
user
data
type
specific
1010
Class Documentation

handle <<in>> ( p. 279) the instance whose key is to be retrieved.
If com.rti.ndds.example.Foo (p. 977) has a key, handle must
represent an existing instance of type com.rti.ndds.example.Foo
(p. 977) known to the com.rti.dds.subscription.DataReader
(p. 487).
Otherwise,
this
method
will
fail
with
(p. 1355).
key and handle is com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL, this method will fail with
(p. 1355). If com.rti.ndds.example.Foo (p. 977) has a key and
handle represents an instance of another type or an instance of type
com.rti.ndds.example.Foo (p. 977) that has been unregistered, this
method will fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355). If com.rti.ndds.example.Foo
(p. 977) has no key, this method has no effect. This method
will fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) if handle is NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361).
or
See also:
8.105.3.13
Retrieves the instance handle that corresponds to an instance key holder.

This operation takes as a parameter an instance and returns a handle that can
be used in subsequent operations that accept an instance handle as an argument.
The instance parameter is only used for the purpose of examining the fields that
define the key. This operation does not register the instance in question. If the
instance has not been previously registered, or if for any other reason the Service
is unable to provide an instance handle, the Service will return the special value
HANDLE NIL.
1011
Parameters:
Returns:
If
1012
Class Documentation
8.106
FooDataWriter Class Reference
<<interface>> ( p. 279) <<generic>> ( p. 279) User data type specific data

writer.
Inheritance diagram for FooDataWriter::

InstanceHandle t register instance (Foo instance data)
InstanceHandle t register instance w timestamp (Foo instance data, Time t source timestamp)
InstanceHandle t register instance w params (Foo instance data,

WriteParams t params)
Performs the same function as com.rti.ndds.example.FooDataWriter.register instance ( p. 1014) and com.rti.ndds.example.FooDataWriter.register instance w timestamp ( p. 1015) except that it also provides the values
contained in params.
void unregister instance (Foo instance data, InstanceHandle t handle)

Reverses the action of com.rti.ndds.example.FooDataWriter.register instance ( p. 1014).
void unregister instance w timestamp (Foo instance data,

stanceHandle t handle, Time t source timestamp)
In-
Performs the same function as com.rti.ndds.example.FooDataWriter.unregister instance ( p. 1016) except that it also provides the value for the source timestamp.
void
unregister instance w params
(Foo
instance data,
Performs the same function as com.rti.ndds.example.FooDataWriter.unregister instance ( p. 1016) and com.rti.ndds.example.FooDataWriter.FooDataWriter.unregister instance w timestamp except that it also provides the values contained in
params.
8.106 FooDataWriter Class Reference
1013
void write (Foo instance data, InstanceHandle t handle)

void write w timestamp (Foo instance data, InstanceHandle t handle, Time t source timestamp)
void write w params (Foo instance data, WriteParams t params)

( p. 1021)
and
com.rti.ndds.example.FooDataWriter.write w timestamp ( p. 1024) except that it also provides the values contained
in params.
void dispose (Foo instance data, InstanceHandle t instance handle)

void dispose w timestamp (Foo instance data, InstanceHandle t instance handle, Time t source timestamp)
available to com.rti.dds.subscription.DataReader ( p. 487) objects by means of the source timestamp attribute inside the
void dispose w params

params)
(Foo
instance data,
WriteParams t
Performs the same function as com.rti.ndds.example.FooDataWriter.dispose

( p. 1027)
and
com.rti.ndds.example.FooDataWriter.dispose w timestamp ( p. 1029) except that it also provides the values contained in
params.
void get key value (Foo key holder, InstanceHandle t handle)


8.106.1
<<interface>> ( p. 279) <<generic>> ( p. 279) User data type specific data

writer.
1014
Class Documentation
Defines the user data type specific writer interface generated for each application
class.
The concrete user data type writer automatically generated by the implementation is an incarnation of this class.
See also:
com.rti.ndds.example.Foo (p. 977)
rtiddsgen (p. 298)
8.106.2
8.106.2.1
InstanceHandle t register instance (Foo instance data)
This operation is only useful for keyed data types. Using it for non-keyed
types causes no effect and returns com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL. The operation takes as a parameter an instance (of which only the key value is examined) and returns a handle that can
be used in successive write() (p. 1021) or dispose() (p. 1027) operations.
The operation gives RTI Connext an opportunity to pre-configure itself to improve performance.
The use of this operation by an application is optional even for keyed types. If
an instance has not been pre-registered, the application can use the special value
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL as
the com.rti.dds.infrastructure.InstanceHandle t (p. 1055) paramater to
the write or dispose operation and RTI Connext will auto-register the instance.
For best performance,
the operation should be invoked prior
to
calling
any
operation
that
modifies
the
instance,
such
as
(p. 1021),
(p. 1024),
(p. 1027)
and
and the handle used in conjunction with the data for those calls.
1015
The operation is idempotent. If it is called for an already registered instance,

it just returns the already allocated handle. This may be used to lookup and
retrieve the handle allocated to a given instance.
Parameters:
by the function. Cannot be NULL..
Returns:
For keyed data type, a handle that can be used in the calls
that
take
a
com.rti.dds.infrastructure.InstanceHandle t (p. 1055), such as write, dispose, unregister instance, or return
See also:
(p. 1016),
(p. 1031), RELATIONSHIP BETWEEN REGISTRATION,
LIVELINESS and OWNERSHIP (p. 1202)
8.106.2.2
InstanceHandle t register instance w timestamp (Foo

1016
Class Documentation
Parameters:
by the function. Cannot be NULL.
Returns:
For keyed data type, return a handle that can be used in the
calls that take a com.rti.dds.infrastructure.InstanceHandle t (p. 1055), such as write, dispose, unregister instance, or return
See also:
(p. 1016),
(p. 1031)
8.106.2.3
InstanceHandle t register instance w params (Foo

instance data, WriteParams t params)
Performs the same function as com.rti.ndds.example.FooDataWriter.register instance (p. 1014) and com.rti.ndds.example.FooDataWriter.register instance w timestamp (p. 1015) except that it also provides the values
contained in params.
See also:
com.rti.ndds.example.FooDataWriter.write w params (p. 1026)
8.106.2.4
void unregister instance (Foo instance data,

Reverses the action of com.rti.ndds.example.FooDataWriter.register instance (p. 1014).

1017
causes no effect and reports no error. The operation takes as a parameter an
instance (of which only the key value is examined) and a handle.
This operation should only be called on an instance that is currently registered.
This includes instances that have been autoregistered by calling operations such as write or dispose as described
in
com.rti.ndds.example.FooDataWriter.register instance (p. 1014).
Otherwise, this operation may fail with
This only need be called just once per instance, regardless of how many times
register instance was called for that instance.
This
operation
informs
RTI
Connext
that
the
com.rti.dds.publication.DataWriter (p. 557) is no longer going to provide
any information about the instance. This operation also indicates that RTI
Connext can locally remove all information regarding that instance. The
application should not attempt to use the handle previously allocated to that
instance after calling com.rti.ndds.example.FooDataWriter.unregister instance() (p. 1016).
The special value com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL can be used for the parameter handle. This indicates that the
identity of the instance should be automatically deduced from the instance data (by means of the key).
than com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL, corresponds to an instance that has been registered, but does not correspond to the instance deduced from the instance data (by means of the key).
RTI Connext will treat as if the unregister instance() (p. 1016) operation is
for the instance as indicated by the handle.
If
after
a
(p. 1016),
the
application
wants
to
modify
(com.rti.ndds.example.FooDataWriter.write
(p. 1021)
or
(p. 1027))
an
instance, it has to register it again, or else use the special handle value
This operation does not indicate that the instance is deleted (that is the
1018
Class Documentation
purpose of com.rti.ndds.example.FooDataWriter.dispose (p. 1027)). The

operation
(p. 1016) just indicates that the com.rti.dds.publication.DataWriter
no
longer
has
anything
to
say
about
the
in(p. 557)
stance.
(p. 487)
entities that are reading the instance may receive a sample with
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE NO WRITERS INSTANCE STATE for the instance, unless there are other
com.rti.dds.publication.DataWriter (p. 557) objects writing that same
instance.
This operation can affect the ownership of the data instance (see OWNERSHIP (p. 87)). If the com.rti.dds.publication.DataWriter (p. 557) was the
exclusive owner of the instance, then calling unregister instance() (p. 1016)
will relinquish that ownership.
If com.rti.dds.infrastructure.ReliabilityQosPolicy.kind (p. 1327) is set to
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.RELIABLE RELIABILITY QOS and the unregistration would overflow the resource
limits of this writer or of a reader, this operation may block for up to
com.rti.dds.infrastructure.ReliabilityQosPolicy.max blocking time
(p. 1327); if this writer is still unable to unregister after that period, this
method will fail with com.rti.dds.infrastructure.RETCODE TIMEOUT
(p. 1364).
Parameters:
instance handle
is
may fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) .
If com.rti.ndds.example.Foo
(p. 977) has a key, instance data can be NULL only if handle is
not
(p. 1355).
is
from instance data.
1019

(p. 1355).
This
method
will
fail
with
be
will report the error com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355).
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364)
(p. 1361)
See also:
8.106.2.5
void unregister instance w timestamp (Foo instance data,

Performs the same function as com.rti.ndds.example.FooDataWriter.unregister instance (p. 1016) except that it also provides the value for the source timestamp.
(p. 1016)
operation.
This
operation
may
block
and
may
time
(com.rti.dds.infrastructure.RETCODE TIMEOUT (p. 1364))
the same circumtances described for the unregister instance operation.
out
under
1020
Class Documentation
Parameters:
instance handle
is
may fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355). If com.rti.ndds.example.Foo (p. 977)
has a key, instance data can be NULL only if handle is
not
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle this method will fail with
t.HANDLE NIL. Otherwise,
(p. 1355).
is
from instance data.
(p. 1355).
This
method
will
fail
with
be
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364)
(p. 1361).
1021
See also:
(p. 1016)
8.106.2.6
void unregister instance w params (Foo instance data,

Performs the same function as com.rti.ndds.example.FooDataWriter.unregister instance (p. 1016) and com.rti.ndds.example.FooDataWriter.FooDataWriter.unregister instance w timestamp except that it also provides the values contained in
params.
See also:
com.rti.ndds.example.FooDataWriter.dispose w params (p. 1031)
8.106.2.7
void write (Foo instance data, InstanceHandle t handle)

to
(p. 487)
(p. 1398).
(Refer
to
com.rti.dds.subscription.SampleInfo (p. 1398) and DESTINATION ORDER (p. 53) QoS policy for details).
As
a
side
effect,
this
operation
asserts
liveliness
on
the
(p. 557)
itself,
the
(p. 1262)
and
the
Note that the special value com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL can be used for the parameter handle. This
indicates the identity of the instance should be automatically deduced from the
1022
Class Documentation
key). RTI Connext will treat as if the write() (p. 1021) operation is for the
This operation may block if the RELIABILITY (p. 105) kind is set to
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.RELIABLE RELIABILITY QOS and the modification would cause data to be lost or else
cause one of the limits specified in the RESOURCE LIMITS (p. 106) to be
exceeded.
Specifically,
this operation may block in the following situations (note that the list may not be exhaustive), even if its
com.rti.dds.infrastructure.HistoryQosPolicyKind
(p. 1050)
is
com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP LAST HISTORY QOS:
If
(com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples (p. 1351) < com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max instances (p. 1352) com.rti.dds.infrastructure.HistoryQosPolicy.depth
(p. 1049)), then in the situation where the max samples resource limit
is exhausted, RTI Connext is allowed to discard samples of some other
instance, as long as at least one sample remains for such an instance. If
it is still not possible to make space available to store the modification,
the writer is allowed to block.
If
(com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples (p. 1351) < com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max instances (p. 1352)), then the com.rti.dds.publication.DataWriter
(p. 557)
may
block
regardless
of
the
com.rti.dds.infrastructure.HistoryQosPolicy.depth (p. 1049).
If
(com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.min send window size (p. 1383) < com.rti.dds.infrastructure.ResourceLimitsQosPolicy
samples (p. 1351)), then it is possible for the send window size limit to
be reached before RTI Connext is allowed to discard samples, in which
case the com.rti.dds.publication.DataWriter (p. 557) will block.
This
operation
may
also
block
when
using
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.BEST EFFORT RELIABILITY QOS and com.rti.dds.infrastructure.PublishModeQosPolicyKind.PublishMode
PUBLISH MODE QOS. In this case, the com.rti.dds.publication.DataWriter
(p. 557) will queue samples until they are sent by the asynchronous publishing
thread. The number of samples that can be stored is determined by the
If the asynchronous thread does not send samples fast enough (e.g., when using a slow
1023
com.rti.dds.publication.FlowController (p. 964)), the queue may fill up.

In that case, subsequent write calls will block.
If this operation does block for any of the above reasons, the RELIABILITY (p. 105) max blocking time configures the maximum time the write operation may block (waiting for space to become available). If max blocking time
elapses before the com.rti.dds.publication.DataWriter (p. 557) is able to
store the modification without exceeding the limits, the operation will time out
(com.rti.dds.infrastructure.RETCODE TIMEOUT (p. 1364)).
Calling com.rti.ndds.example.FooDataWriter.unregister (p. 1362).
instance (p. 1016) may help freeing up some resources.
This operation will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363) if the timestamp is less than the
timestamp used in the last writer operation (register , unregister , dispose, or
write, with either the automatically supplied timestamp or the applicationprovided timestamp).
Parameters:
instance data <<in>> ( p. 279) The data to write.
This method will fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) if instance data is NULL.
Parameters:
(p. 1014),
or
else
the
special
value
key and handle is not com.rti.dds.infrastructure.InstanceHandle handle
must
represent
t.InstanceHandle t.HANDLE NIL,
(p. 977).
Otherwise,
this
method
may
fail
with
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364),
1024
Class Documentation
com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363), com.rti.dds.infrastructure.RETCODE OUT OF RESOURCES
(p. 1362),
or
(p. 1361).
See also:
8.106.2.8
void write w timestamp (Foo instance data,


Explicitly
provides
the
timestamp
that
will
be
available
obto
the
(p. 487)
jects by means of the source timestamp attribute inside the
(p. 1398).
(Refer
to
com.rti.dds.subscription.SampleInfo (p. 1398) and DESTINATION ORDER (p. 53) QoS policy for details)
This
operation
may
block
and
(p. 1364))
under
the
same
circumtances
time
out
described
for
(p. 1362).
Calling com.rti.ndds.example.FooDataWriter.unregister instance (p. 1016) may help free up some resources.
Parameters:
1025
(p. 1014),
or
else
the
special
value
handle
must
represent
Otherwise,
this
method
may
fail
with
(p. 977).
com.rti.dds.infrastructure.RETCODE BAD This method will fail with
PARAMETER (p. 1355).
source timestamp <<in>>
( p. 279)
When
using
com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPolicyKind.BY SOURCE TIMESTAMP DESTINATIONORDER QOS the timestamp value must be greater than or equal to the timestamp value
used in the last writer operation (register , unregister , dispose, or
write, with either the automatically supplied timestamp or the
application-provided timestamp) However, if it is less than the
timestamp of the previous operation but the difference is less than the
com.rti.dds.infrastructure.DestinationOrderQosPolicy.source timestamp tolerance (p. 633), the timestamp of the previous operation will be used as the source timestamp of
this sample.
Otherwise, if the difference is greater than
com.rti.dds.infrastructure.DestinationOrderQosPolicy.source timestamp tolerance (p. 633),
the function will return
(p. 1355).
Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364),
(p. 1362),
or
(p. 1361).
See also:
1026
8.106.2.9
Class Documentation
void write w params (Foo instance data, WriteParams t
params)

(p. 1021) and com.rti.ndds.example.FooDataWriter.write w timestamp
(p. 1024) except that it also provides the values contained in params.
Allows provision of the sample identity, instance handle, source timestamp,
publication priority, and cookie contained in params.
The sample identity identifies the sample being written. The identity consist of
a pair (virtual GUID, virtual sequence number).
The cookie is a sequence of bytes tagging the data being written, and is used
by the callback com.rti.dds.publication.DataWriterListener.on application acknowledgment.
This
operation
may
block
and
under
the
same
circumtances
(p. 1364))
time
out
described
for
(p. 1362).
Calling com.rti.ndds.example.FooDataWriter.unregister instance w params (p. 1021) may help free up some resources.
Parameters:
params <<in>> ( p. 279)
The
handle
is
either
returned
by
a
previous
call
to
com.rti.ndds.example.FooDataWriter.register instance (p. 1014), or else
the special value com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL. If com.rti.ndds.example.Foo (p. 977) has a key and
handle is not com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL, handle must represent a registered instance of type
com.rti.ndds.example.Foo (p. 977). Otherwise, this method may fail with
1027

This method will fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) if handle is NULL.
The source timestamp value must be greater than or equal to the timestamp value used in the last writer operation (used in a register , unregister , dispose, or write, with either the automatically supplied timestamp or
the application provided timestamp). This timestamp may potentially affect the order in which readers observe events from multiple writers. This
timestamp will be available to the com.rti.dds.subscription.DataReader
(p. 487) objects by means of the source timestamp attribute inside the
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364),
(p. 1362)
or
(p. 1361).
See also:
8.106.2.10
void dispose (Foo instance data, InstanceHandle t

instance handle)

has no effect and reports no error.
The actual deletion is postponed until there is no more use for that data in the
whole system.
Applications are made aware of the deletion by means of operations on the
com.rti.dds.subscription.DataReader (p. 487) objects that already knew
that instance. com.rti.dds.subscription.DataReader (p. 487) objects that
didnt know the instance will never see it.
This operation does not modify the value of the instance. The instance data
parameter is passed just for the purposes of identifying the instance.
When this
supply the
operation
value of
is used, RTI Connext will

the source timestamp that is
automatically
made avail-
1028
Class Documentation
able
to
(p. 487)
jects by means of the source timestamp attribute inside
obthe

(p. 1016)
operation.
The special value com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL can be used for the parameter instance handle. This indicates the identity of the instance should be automatically deduced from the
key). RTI Connext will treat as if the dispose() (p. 1027) operation is for the
This
operation
may
block
and
time
(p. 1364))
under
the
same
circumtances
described
com.rti.ndds.example.FooDataWriter.write() (p. 1021).
out
for
(p. 1362).
Parameters:
If
is
used.
not
(p. 1355).
1029

(p. 1014),
or
else
the
special
value
instance handle
is
not
If
com.rti.ndds.example.Foo (p. 977) has no key, instance handle is not used. If handle is used, it must represent a registered
instance of type com.rti.ndds.example.Foo (p. 977). Otherwise,
this method fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355).
(p. 977)
has
a
key,
instance handle
cannot
be
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364),
(p. 1362)
or
(p. 1361).
See also:
(p. 1029)
8.106.2.11
void dispose w timestamp (Foo instance data,

source timestamp)
available
to
(p. 487)
1030
Class Documentation

com.rti.ndds.example.FooDataWriter.dispose (p. 1027) operation.
This
operation
may
block
and
(p. 1364))
under
the
same
circumtances
time
out
described
for
(p. 1362).
Parameters:
If
is
used.
not
(p. 1355).
(p. 1014),
or
else
the
special
value
instance handle
is
not
If
com.rti.ndds.example.Foo (p. 977) has no key, instance handle
is not used. If handle is used, it must represent a registered instance
of type com.rti.ndds.example.Foo (p. 977).
Otherwise, this
method may fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355) This method will fail with
(p. 977)
has
a
key,
instance handle
cannot
be
1031

operation (used in a register , unregister , dispose, or write, with either the automatically supplied timestamp or the application provided timestamp). This timestamp may potentially affect the order in
which readers observe events from multiple writers. This timestamp
will be available to the com.rti.dds.subscription.DataReader
(p. 487) objects by means of the source timestamp attribute inside
the com.rti.dds.subscription.SampleInfo (p. 1398). Cannot be
NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364),
(p. 1362)
or
(p. 1361).
See also:
8.106.2.12
void dispose w params (Foo instance data,

Performs the same function as com.rti.ndds.example.FooDataWriter.dispose

and
com.rti.ndds.example.FooDataWriter.dispose w (p. 1027)
timestamp (p. 1029) except that it also provides the values contained in
params.
See also:
8.106.2.13
void get key value (Foo key holder, InstanceHandle t

handle)

instance. If com.rti.ndds.example.Foo (p. 977) has no key, this method has
no effect and exit with no error.
1032
Class Documentation
For
keyed
data
types,
this
operation
may
fail
with
Parameters:
key holder <<inout>> ( p. 279) a user data type specific
handle <<in>> ( p. 279) the instance whose key is to be
retrieved.
key, handle must represent a registered instance of type
com.rti.ndds.example.Foo (p. 977).
will fail with com.rti.dds.infrastructure.RETCODE BAD PARAMETER (p. 1355). If com.rti.ndds.example.Foo (p. 977)
has a key and handle is com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL,
this
method
will
fail
with
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361).
or
See also:
8.106.2.14

This operation takes as a parameter an instance and returns a handle that can be
used in subsequent operations that accept an instance handle as an argument.
The instance parameter is only used for the purpose of examining the fields
that define the key. This operation does not register the instance in question. If
1033
the instance has not been previously registered, or if for any other reason RTI
Connext is unable to provide an instance handle, RTI Connext will return the
special value HANDLE NIL.
Parameters:
Returns:
If
1034
Class Documentation
8.107
FooSeq Class Reference
<<interface>> ( p. 279) <<generic>> ( p. 279) A type-safe, ordered collection of elements. The type of these elements is referred to in this documentation
as com.rti.ndds.example.Foo (p. 977).
Inheritance diagram for FooSeq::

Package Attributes
Sequence loanedInfoSequence = null
8.107.1
For users who define data types in OMG IDL, this type corresponds to the IDL
express sequence<Foo (p. 977)>.
For any user-data type Foo (p. 977) that an application defines for the purpose
of data-distribution with RTI Connext, a FooSeq (p. 1034) is generated. We
refer to an IDL sequence<Foo (p. 977)> as FooSeq (p. 1034).
A sequence is a type-safe List that makes a distinction between its allocated
size and its logical size (much like the ArrayList class). The Collection.size()
method returns the logical size.
A new sequence is created for elements of a particular Class, which does not
change throughout the lifetime of a sequence instance.
To add an element to a sequence, use the add() (p. 391) method inherited
from the standard interface java.util.List; this will implicitly increase the
sequences size. Or, to pre-allocate space for several elements at once, use
An attempt to add an element to a sequence that is not of the correct element
type will result in a ClassCastException. (Note that null is considered to belong
to any type.)
8.107 FooSeq Class Reference
1035
See also:
(p. 1012),
(p. 979),
8.107.2
8.107.2.1
Parameters:
Returns:
this
Exceptions:
See also:
8.107.3
8.107.3.1
Sequence loanedInfoSequence = null [package]
1036
Class Documentation
8.108
FooTypeSupport Class Reference
<<interface>> ( p. 279) <<generic>> ( p. 279) User data type specific interface.

Inherits TypeSupportImpl.

Object copy data (Object destination, Object source)

Get the default name for this type.

type name)
Allows an application to communicate to RTI Connext the existence of a
data type.
8.108.1
<<interface>> ( p. 279) <<generic>> ( p. 279) User data type specific interface.

Defines the user data type specific interface generated for each application class.
The concrete user data type automatically generated by the implementation is
an incarnation of this class.
See also:
rtiddsgen (p. 298)
8.108.2
8.108.2.1
Get the default name for this type.

Can be used for calling com.rti.ndds.example.FooTypeSupport.register type (p. 1037) or creating com.rti.dds.topic.Topic (p. 1545)
8.108 FooTypeSupport Class Reference
1037
Returns:
default name for this type
See also:
com.rti.ndds.example.FooTypeSupport.register type (p. 1037)
8.108.2.2

Allows an application to communicate to RTI Connext the existence of a data

type.
The generated implementation of the operation embeds all the knowledge that
has to be communicated to the middleware in order to make it able to manage
the contents of data of that type. This includes in particular the key definition
that will allow RTI Connext to distinguish different instances of the same type.
The same com.rti.dds.topic.TypeSupport (p. 1665) can be registered multiple times with a com.rti.dds.domain.DomainParticipant (p. 654) using
the same or different values for the type name. If register type is called multiple times on the same com.rti.dds.topic.TypeSupport (p. 1665) with the
same com.rti.dds.domain.DomainParticipant (p. 654) and type name, the
second (and subsequent) registrations are ignored by the operation fails with
Precondition:
Cannot use the same type name to register two different
with
the
same
(p. 1665)
com.rti.dds.domain.DomainParticipant (p. 654),
or else the
operation will fail and com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363) will be returned.
Parameters:
(p. 654) to register the data type Foo (p. 977) with. Cannot be
NULL.
type name <<in>> ( p. 279) the type name under with the data type
Foo (p. 977) is registered with the participant; this type name is
used when creating a new com.rti.dds.topic.Topic (p. 1545). (See
The name may not be NULL or longer than 255 characters.
1038
Class Documentation
Exceptions:
One of
the
Standard
Return
Codes
(p. 1363)
(p. 108),
or
MT Safety:
See also:
8.108.2.3
Object copy data (Object destination, Object source)
This is a concrete implementation of this method inherited from the base class.
This method will perform a deep copy of source into destination.
Parameters:
source The Object which contains the data to be copied.
destination The object where data will be copied to.
Returns:
Returns destination.
Exceptions:
NullPointerException If destination or source is null.
ClassCastException If either destination or this is not a Foo (p. 977)
type.
8.109 GroupDataQosPolicy Class Reference
8.109
1039
GroupDataQosPolicy Class Reference

Inheritance diagram for GroupDataQosPolicy::
Public Attributes
final ByteSeq value
8.109.1

Entity:
(p. 1262),
Properties:
RxO (p. 101) = NO
See also:
(p. 711)
8.109.2
Usage
The
additional
information
is
attached
to
a
or
(p. 1262)
This extra data
is not used by RTI Connext itself.
When a remote application discovers the com.rti.dds.publication.Publisher (p. 1262) or
com.rti.dds.subscription.Subscriber (p. 1476), it can access that information and use it for its own purposes.
1040
Class Documentation
Use
cases
for
this
QoS
policy,
as
well
as
the
and
(p. 1559)
com.rti.dds.infrastructure.UserDataQosPolicy (p. 1694), are often
application-to-application identification, authentication, authorization, and
encryption purposes. For example, applications can use Group or User Data to
send security certificates to each other for RSA-type security.
In combination with com.rti.dds.subscription.DataReaderListener
com.rti.dds.publication.DataWriterListener (p. 586) and
(p. 518),
operations such as com.rti.dds.domain.DomainParticipant.ignore publication (p. 716) and com.rti.dds.domain.DomainParticipant.ignore subscription (p. 717), this QoS policy can help an application to
define and enforce its own security policies.
For example, an application can implement matching policies similar to those of the
com.rti.dds.infrastructure.PartitionQosPolicy (p. 1217), except the
decision can be made based on an application-defined policy.
The use of this QoS is not limited to security; it offers a simple, yet flexible
extensibility mechanism.
Important: RTI Connext stores the data placed in this policy in pre-allocated
pools. It is therefore necessary to configure RTI Connext with the maximum size
of the data that will be stored in policies of this type. This size is configured with
com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.publisher group data max length (p. 791) and com.rti.dds.infrastructure.DomainParticipantResourceLi
group data max length (p. 791).
8.109.3
8.109.3.1
final ByteSeq value
[default] Empty (zero-sized)
[range] Octet sequence of length [0,max length]
8.110 GuardCondition Class Reference
8.110
1041
GuardCondition Class Reference
<<interface>> ( p. 279) A specific com.rti.dds.infrastructure.Condition

(p. 464) whose trigger value is completely under the control of the application.
Inherits AbstractNativeObject, and NativeCondition.

GuardCondition ()
No argument constructor.
void set trigger value (boolean value)

Set the guard condition trigger value.

void delete ()
Destructor.
8.110.1

(p. 464) whose trigger value is completely under the control of the application.
The
(p. 1041)
provides a way for an application to manually wake up a
com.rti.dds.infrastructure.WaitSet (p. 1709).
This is accomplished by attaching the com.rti.dds.infrastructure.GuardCondition
(p. 1041)
to
the
(p. 1709)
and
then
setting
the
trigger value
by
means
of
the
com.rti.dds.infrastructure.GuardCondition.set trigger value (p. 1042)
operation.
Important:
The
(p. 1041)
allocates
native
resources.
When
com.rti.dds.infrastructure.GuardCondition (p. 1041) is no longer being
used, user should call com.rti.dds.infrastructure.GuardCondition.delete
(p. 1042) explicitly to properly cleanup all native resources.
See also:
1042
Class Documentation
8.110.2
8.110.2.1
GuardCondition ()
No argument constructor.
Construct
a
new
guard
com.rti.dds.infrastructure.false.
condition
with
trigger
value
Exceptions:
com.rti.dds.infrastructure.RETCODE OUT OF RESOURCES ( p. 1362)
if a new com.rti.dds.infrastructure.GuardCondition (p. 1041)
could not be allocated.
Important:
The
(p. 1041)
allocates
native
resources.
When
com.rti.dds.infrastructure.GuardCondition (p. 1041) is no longer being
used, user should call com.rti.dds.infrastructure.GuardCondition.delete
(p. 1042) explicitly to properly cleanup all native resources.
8.110.3
8.110.3.1
void set trigger value (boolean value)
Set the guard condition trigger value.

Parameters:
value <<in>> ( p. 279) the new trigger value.
8.110.3.2

Returns:
the trigger value.
Implements Condition (p. 464).
8.110.3.3
void delete ()
Destructor.
8.110 GuardCondition Class Reference
1043
Releases the resources associated with this object.

Calling this method multiple times on the same object is safe; subsequent deletions will have no effect.
1044
Class Documentation
8.111
GUID t Class Reference

Inherits Struct.

GUID t (GUID t guid)
Copy constructor.
GUID t (byte[ ] value)

Constructor.
Public Attributes
byte[ ] value = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}
A 16 byte array containing the GUID value.

static final GUID t GUID UNKNOWN
Unknown GUID.
static final GUID t GUID AUTO

Indicates that RTI Connext should choose an appropriate virtual GUID.
8.111.1

Represents a 128 bit GUID.
8.111.2
8.111.2.1
GUID t (GUID t guid)
Copy constructor.
8.111 GUID t Class Reference
1045
Parameters:
guid The GUID instance to copy. It must not be null.
8.111.2.2
GUID t (byte[ ] value)
Constructor.
Parameters:
value GUID value as a 16 byte array. It must not be null.
8.111.3
8.111.3.1
final GUID t GUID UNKNOWN [static]
Unknown GUID.
8.111.3.2
final GUID t GUID AUTO [static]
Initial value:
new GUID_t(new byte[]{0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0})
Indicates that RTI Connext should choose an appropriate virtual GUID.

If this special value is assigned to com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.virtual guid (p. 593) or com.rti.dds.infrastructure.DataReaderProtocolQosPolicy.virtual guid (p. 522), RTI Connext will assign the virtual GUID automatically based
on the RTPS or physical GUID.
8.111.3.3
byte [ ] value = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}
A 16 byte array containing the GUID value.
1046
Class Documentation
8.112
HistoryQosPolicy Class Reference
Inheritance diagram for HistoryQosPolicy::
Public Attributes
HistoryQosPolicyKind kind
Specifies the kind of history to be kept.
int depth
Specifies the number of samples to be kept, when the kind is
com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP LAST HISTORY QOS.
RefilterQosPolicyKind refilter
<<eXtension>> (p. 278) Specifies how a writer should handle previously
written samples to a new reader.
8.112.1
This QoS policy specifies how much data must to stored by RTI
Connext for a com.rti.dds.publication.DataWriter (p. 557) or
It controls whether
RTI Connext should deliver only the most recent value, attempt to deliver all
intermediate values, or do something in between.
On the publishing side, this QoS policy controls the samples that should be
maintained by the com.rti.dds.publication.DataWriter (p. 557) on behalf
of existing com.rti.dds.subscription.DataReader (p. 487) entities. The behavior with regards to a com.rti.dds.subscription.DataReader (p. 487) entities discovered after a sample is written is controlled by the DURABILITY
(p. 68) policy.
On the subscribing side, this QoS policy controls the samples that should be
maintained until the application takes them from RTI Connext.
8.112 HistoryQosPolicy Class Reference
1047
Entity:
Properties:
RxO (p. 101) = NO
See also:
com.rti.dds.infrastructure.ReliabilityQosPolicy (p. 1324)
com.rti.dds.infrastructure.HistoryQosPolicy (p. 1046)
8.112.2
Usage
This policy controls the behavior of RTI Connext when the

value of an instance changes before it is finally communicated to
When a com.rti.dds.publication.DataWriter (p. 557) sends data,
or a com.rti.dds.subscription.DataReader (p. 487) receives data,
the data sent or received is stored in a cache whose contents are
controlled by this QoS policy.
This QoS policy interacts with
com.rti.dds.infrastructure.ReliabilityQosPolicy (p. 1324) by controlling whether RTI Connext guarantees that all of the sent data is received
(com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP ALL HISTORY QOS)
or
if
only
the
last
N
data
values
sent
are
guaranteed
to
be
received
(com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP ALL HISTORY QOS)this is a reduced level of reliability.
The amount of data that is sent to new DataReaders who have configured
their com.rti.dds.infrastructure.DurabilityQosPolicy (p. 802) to receive
previously published data is also controlled by the History QoS policy.
Note that the History QoS policy does not control the physical sizes of the send
and receive queues. The memory allocation for the queues is controlled by the
If kind is com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP LAST HISTORY QOS (the default), then RTI Connext will only attempt
to keep the latest values of the instance and discard the older ones. In this
case, the value of depth regulates the maximum number of values (up to and
including the most current one) RTI Connext will maintain and deliver. After
N values have been sent or received, any new data will overwrite the oldest
data in the queue. Thus the queue acts like a circular buffer of length N .
1048
Class Documentation
The default (and most common setting) for depth is 1, indicating that only the
most recent value should be delivered.
If kind is com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP ALL HISTORY QOS, then RTI Connext will attempt to maintain and deliver
all the values of the instance to existing subscribers. The resources that RTI
Connext can use to keep this history are limited by the settings of the RESOURCE LIMITS (p. 106). If the limit is reached, then the behavior of RTI
Connext will depend on the RELIABILITY (p. 105). If the Reliability kind is
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.BEST EFFORT RELIABILITY QOS, then the old values will be discarded.
If Reliability kind is RELIABLE, then RTI Connext will block the
com.rti.dds.publication.DataWriter (p. 557) until it can deliver the
necessary old values to all subscribers.
If refilter is com.rti.dds.infrastructure.RefilterQosPolicyKind.NONE REFILTER QOS (p. 1322), then samples written before a DataReader is
matched to a DataWriter are not refiltered by the DataWriter.
If refilter is com.rti.dds.infrastructure.RefilterQosPolicyKind.ALL REFILTER QOS (p. 1323), then all samples written before a DataReader is
matched to a DataWriter are refiltered by the DataWriter when the DataReader
is matched.
If refilter is com.rti.dds.infrastructure.RefilterQosPolicyKind.ON DEMAND REFILTER QOS (p. 1323), then a DataWriter will only refilter
samples that a DataReader requests.
8.112.3
Consistency
This QoS policys depth must be consistent with the RESOURCE LIMITS
(p. 106) max samples per instance. For these two QoS to be consistent, they
must verify that depth <= max samples per instance.
See also:
com.rti.dds.infrastructure.ResourceLimitsQosPolicy (p. 1348)
8.112.4
8.112.4.1
HistoryQosPolicyKind kind
Specifies the kind of history to be kept.

[default] com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP LAST HISTORY QOS
8.112 HistoryQosPolicy Class Reference

8.112.4.2
1049
int depth
Specifies the number of samples to be kept, when the kind is

com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP LAST HISTORY QOS.
If a value other than 1 (the default) is specified, it should be consistent with
the settings of the RESOURCE LIMITS (p. 106) policy. That is:
depth <= com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples per instance (p. 1352)
When the kind is com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP ALL HISTORY QOS, the depth has no effect. Its implied value is infinity
(in practice limited by the settings of the RESOURCE LIMITS (p. 106)
policy).
[default] 1
[range] [1,100 million], <= com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples per instance (p. 1352)
8.112.4.3
RefilterQosPolicyKind refilter
<<eXtension>> ( p. 278) Specifies how a writer should handle previously

written samples to a new reader.
[default] com.rti.dds.infrastructure.RefilterQosPolicyKind.NONE REFILTER QOS (p. 1322)
1050
Class Documentation
8.113
HistoryQosPolicyKind Class Reference
Kinds of history.
Inheritance diagram for HistoryQosPolicyKind::

static
QOS
final
HistoryQosPolicyKind
KEEP LAST HISTORY -
[default] Keep the last depth samples.
static final HistoryQosPolicyKind KEEP ALL HISTORY QOS

Keep all the samples.
8.113.1
Kinds of history.
QoS:
8.113.2
8.113.2.1
final HistoryQosPolicyKind KEEP LAST HISTORY QOS [static]
[default] Keep the last depth samples.

On the publishing side, RTI Connext will only attempt to keep the most recent
depth samples of each instance of data (identified by its key) managed by the
On the subscribing side, the com.rti.dds.subscription.DataReader (p. 487)
will only attempt to keep the most recent depth samples received for each
instance (identified by its key) until the application takes them via the
com.rti.dds.subscription.DataReader (p. 487) s take() operation.
8.113 HistoryQosPolicyKind Class Reference

8.113.2.2
1051
final HistoryQosPolicyKind KEEP ALL HISTORY QOS

[static]
Keep all the samples.

On the publishing side, RTI Connext will attempt to keep all samples (representing each value written) of each instance of data (identified by its key) managed by the com.rti.dds.publication.DataWriter (p. 557) until they can be
delivered to all subscribers.
On the subscribing side, RTI Connext will attempt to keep all samples of each instance of data (identified by its key) managed by the
com.rti.dds.subscription.DataReader (p. 487). These samples are kept until the application takes them from RTI Connext via the take() operation.
1052
Class Documentation
8.114
InconsistentTopicStatus Class Reference

Inherits Status.
Public Attributes
int total count
Total cumulative count of the Topics discovered whose name matches
the com.rti.dds.topic.Topic ( p. 1545) to which this status is attached
and whose type is inconsistent with that of that com.rti.dds.topic.Topic
( p. 1545).
int total count change

The incremental number of inconsistent topics discovered since the last time
this status was read.
8.114.1

Entity:
Listener:
com.rti.dds.topic.TopicListener (p. 1564)
A remote com.rti.dds.topic.Topic (p. 1545) will be inconsistent with the locally created com.rti.dds.topic.Topic (p. 1545) if the type name of the two
topics are different.
8.114.2
8.114.2.1
int total count
Total cumulative count of the Topics discovered whose name matches the
com.rti.dds.topic.Topic (p. 1545) to which this status is attached and whose
type is inconsistent with that of that com.rti.dds.topic.Topic (p. 1545).
8.114 InconsistentTopicStatus Class Reference

8.114.2.2
1053
The incremental number of inconsistent topics discovered since the last time
this status was read.
1054
Class Documentation
8.115
InetAddressSeq Class Reference


InetAddressSeq ()
Construct a new empty sequence.
InetAddressSeq (int initial maximum)

Construct a new empty sequence with the given maximum.
InetAddressSeq (Collection addresses)

Construct a new sequence containing all of the given addresses.
8.115.1

Instantiates:
See also:
com.rti.dds.infrastructure.java.net.InetAddress
8.115.2
8.115.2.1
InetAddressSeq ()
Construct a new empty sequence.

8.115.2.2
InetAddressSeq (int initial maximum)
Construct a new empty sequence with the given maximum.

8.115.2.3
InetAddressSeq (Collection addresses)
Construct a new sequence containing all of the given addresses.

8.116 InstanceHandle t Class Reference
8.116
1055
InstanceHandle t Class Reference

Inheritance diagram for InstanceHandle t::

InstanceHandle t ()
InstanceHandle t (InstanceHandle t src)
boolean is nil ()
Compare this handle to com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL.

boolean equals (Object other)

Compares this instance handle with another handle for equality.

static final InstanceHandle t HANDLE NIL
The NIL instance handle.
8.116.1

Handle to identiy different instances of the same com.rti.dds.topic.Topic
(p. 1545) of a certain type.
See also:
com.rti.dds.subscription.SampleInfo.instance handle (p. 1404)
1056
Class Documentation
8.116.2
8.116.2.1
InstanceHandle t ()
Construct a new instance handle equal to the nil handle.

See also:
HANDLE NIL (p. 1057)
8.116.2.2
InstanceHandle t (InstanceHandle t src)
Construct a new instance handle equal to the given handle.

Exceptions:
NullPointerException if src is null
8.116.3
8.116.3.1
boolean is nil ()
Compare
this
handle
to
Returns:
com.rti.dds.infrastructure.true if the given instance handle is equal to
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL or com.rti.dds.infrastructure.false otherwise.
See also:
com.rti.dds.infrastructure.InstanceHandle t.equals (p. 1057)
8.116.3.2

references).
8.116 InstanceHandle t Class Reference
1057
Parameters:
Returns:
Exceptions:
8.116.3.3
boolean equals (Object other)
Compares this instance handle with another handle for equality.

Parameters:
other <<in>> ( p. 279) The other handle to be compared with this handle. Cannot be null.
Returns:
com.rti.dds.infrastructure.true if the two handles have equal values, or
com.rti.dds.infrastructure.false otherwise.
See also:
com.rti.dds.infrastructure.InstanceHandle t.is nil (p. 1056)
8.116.4
8.116.4.1
final InstanceHandle t HANDLE NIL [static]
The NIL instance handle.

Special com.rti.dds.infrastructure.InstanceHandle t (p. 1055) value
See also:
com.rti.dds.infrastructure.InstanceHandle t.is nil (p. 1056)
1058
Class Documentation
8.117
InstanceHandleSeq Class Reference

com.rti.dds.infrastructure.InstanceHandle t (p. 1055) > .

InstanceHandleSeq ()
Construct
a
new
empty
sequence
com.rti.dds.infrastructure.InstanceHandle t ( p. 1055) elements.
for
InstanceHandleSeq (int initial maximum)

Construct
a
new
empty
sequence
for
InstanceHandleSeq (Collection elements)

Construct
a
new
sequence
containing
the
given
void fill (int size)

Fill this sequence with the given number of instance handles.
8.117.1

com.rti.dds.infrastructure.InstanceHandle t (p. 1055) > .
When
reading
into
this
sequence
(as
with
com.rti.dds.publication.DataWriter.get matched subscriptions
(p. 570)
or
com.rti.dds.subscription.DataReader.get matched publications (p. 501)), the contents of any existing handles in this
sequence will be overwritten to avoid the expense of allocating new handles.
Therefore, it is generally not a good idea to add handles to a
sequence that you obtained elsewhere (e.g. from a Status object or as
a result of calling com.rti.ndds.example.FooDataWriter.register instance (p. 1014)).
Any null elements will be replaced by new handles.
To avoid allocating new handles on the fly, use the method
com.rti.dds.infrastructure.InstanceHandleSeq.fill (p. 1059).
Instantiates:
8.117 InstanceHandleSeq Class Reference
1059
See also:
com.rti.dds.infrastructure.InstanceHandle t (p. 1055)
8.117.2
8.117.2.1
InstanceHandleSeq ()
Construct a new empty sequence for com.rti.dds.infrastructure.InstanceHandle t (p. 1055) elements.

The maximum of the sequence will be set to a default value.
8.117.2.2
InstanceHandleSeq (int initial maximum)
Construct a new empty sequence for com.rti.dds.infrastructure.InstanceHandle t (p. 1055) elements.

The maximum of the sequence will be set to the given value.
Parameters:
initial maximum <<in>> ( p. 279) Maximum length of sequence.
8.117.2.3
InstanceHandleSeq (Collection elements)
Construct
a
new
sequence
containing
the
com.rti.dds.infrastructure.InstanceHandle t (p. 1055) elements.
given
The maximum of the sequence will be set to the size of the given collection.
Parameters:
elements <<in>> ( p. 279) Elements to construct a sequence with.
8.117.3
8.117.3.1
void fill (int size)
Fill this sequence with the given number of instance handles.

Ensure that this sequence has at least the given size and that all elements up
to that count are non-null.
1060
Class Documentation
Parameters:
size <<in>> ( p. 279) Size of sequence to ensure.
Exceptions:
RETCODE BAD PARAMETER ( p. 1355) If size < 0
8.118 InstanceStateKind Class Reference
8.118
1061
InstanceStateKind Class Reference
Indicates is the samples are from a live com.rti.dds.publication.DataWriter

(p. 557) or not.

static final int ALIVE INSTANCE STATE = 0x0001 << 0
Instance is currently in existence.
static final int NOT ALIVE DISPOSED INSTANCE STATE =

0x0001 << 1
Not alive disposed instance. The instance has been disposed by a DataWriter.
static final int NOT ALIVE NO WRITERS INSTANCE STATE

= 0x0001 << 2
Not
alive
no
writers
for
instance.
None
of
the
com.rti.dds.publication.DataWriter ( p. 557) objects are currently
alive (according to the LIVELINESS ( p. 82)) are writing the instance.
static final int ANY INSTANCE STATE = 0xffff

Any instance state ALIVE INSTANCE STATE | NOT ALIVE |
NOT ALIVE NO WRITERS DISPOSED INSTANCE STATE
INSTANCE STATE.
static final int NOT ALIVE INSTANCE STATE = 0x006

Not alive instance state NOT ALIVE DISPOSED INSTANCE STATE |
8.118.1
Indicates is the samples are from a live com.rti.dds.publication.DataWriter

(p. 557) or not.
For each instance, the middleware internally maintains an instance state. The
instance state can be:
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.ALIVE INTANCE STATE indicates that (a) samples have been received for
the instance, (b) there are live com.rti.dds.publication.DataWriter
(p. 557) entities writing the instance, and (c) the instance has not been
explicitly disposed (or else more samples have been received after it was
disposed).
1062
Class Documentation
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE DISPOSED INSTANCE STATE indicates the instance was
explicitly disposed by a com.rti.dds.publication.DataWriter (p. 557)
by means of the dispose operation.
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT indicates
ALIVE NO WRITERS INSTANCE STATE
the
instance
has
been
declared
as
not-alive
by
the
com.rti.dds.subscription.DataReader (p. 487) because it detected
that there are no live com.rti.dds.publication.DataWriter (p. 557)
entities writing that instance.
The precise behavior events that cause the instance state to change depends on
the setting of the OWNERSHIP QoS:
If OWNERSHIP (p. 87) is set to com.rti.dds.infrastructure.OwnershipQosPolicyKind.OwnershipQ

then
the
instance
state
becomes
OWNERSHIP QOS,
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE DISPOSED INSTANCE STATE
only
if
the
com.rti.dds.publication.DataWriter (p. 557) that owns the
instance explicitly disposes it.
The instance state becomes
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.ALIVE INTANCE STATE again only if the com.rti.dds.publication.DataWriter
(p. 557) that owns the instance writes it.
If OWNERSHIP (p. 87) is set to com.rti.dds.infrastructure.OwnershipQosPolicyKind.OwnershipQ

OWNERSHIP QOS,
then
the
instance
state
becomes
if
any
expliccom.rti.dds.publication.DataWriter
(p. 557)
itly disposes the instance.
The instance state becomes
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.ALIVE INTANCE STATE as soon as any com.rti.dds.publication.DataWriter
(p. 557) writes the instance again.
The instance state available in the com.rti.dds.subscription.SampleInfo

(p. 1398) is a snapshot of the instance state of the instance at the time the
collection was obtained (i.e. at the time read or take was called). The instance
state is therefore the same for all samples in the returned collection that refer
to the same instance.
8.118 InstanceStateKind Class Reference
1063
8.118.2
8.118.2.1
final int ALIVE INSTANCE STATE = 0x0001 << 0

[static]
Instance is currently in existence.

8.118.2.2
final int NOT ALIVE DISPOSED INSTANCE STATE =

0x0001 << 1 [static]
Not alive disposed instance. The instance has been disposed by a DataWriter.
8.118.2.3
final int NOT ALIVE NO WRITERS INSTANCE STATE = 0x0001 << 2

[static]
Not
alive
no
writers
for
instance.
None
of
the
com.rti.dds.publication.DataWriter (p. 557) objects are currently alive
(according to the LIVELINESS (p. 82)) are writing the instance.
1064
Class Documentation
8.119
IntSeq Class Reference

Inheritance diagram for IntSeq::

IntSeq ()
Constructs an empty sequence of integers with an initial maximum of zero.
IntSeq (int initialMaximum)

Constructs an empty sequence of integers with the given initial maximum.
IntSeq (int[ ] ints)

Constructs a new sequence containing the given integers.
boolean addAllInt (int[ ] elements, int offset, int length)

boolean addAllInt (int[ ] elements)

void addInt (int element)
void addInt (int index, int element)

int getInt (int index)

Returns the integer at the given index.
int setInt (int index, int element)

Set the new integer at the given index and return the old integer.
void setInt (int dstIndex, int[ ] elements, int srcIndex, int length)
int[ ] toArrayInt (int[ ] array)

8.119 IntSeq Class Reference
1065
int getMaximum ()
sequence.

A wrapper for getInt(int) ( p. 1066) that returns a java.lang.Integer.

A wrapper for setInt() ( p. 1067).

A wrapper for addInt(int, int) ( p. 1066).
8.119.1

Instantiates:
See also:
com.rti.dds.infrastructure.int
8.119.2
8.119.2.1
IntSeq ()
Constructs an empty sequence of integers with an initial maximum of zero.

8.119.2.2
IntSeq (int initialMaximum)
Constructs an empty sequence of integers with the given initial maximum.

8.119.2.3
IntSeq (int[ ] ints)
Constructs a new sequence containing the given integers.

1066
Class Documentation
Parameters:
ints the initial contents of this sequence
Exceptions:
8.119.3
8.119.3.1
boolean addAllInt (int[ ] elements, int offset, int length)
Exceptions:
8.119.3.2
boolean addAllInt (int[ ] elements)
Exceptions:
8.119.3.3
void addInt (int element)

8.119.3.4
void addInt (int index, int element)
8.119.3.5
int getInt (int index)
Returns the integer at the given index.

Exceptions:

8.119.3.6
1067
int setInt (int index, int element)
Set the new integer at the given index and return the old integer.
Exceptions:
8.119.3.7
void setInt (int dstIndex, int[ ] elements, int srcIndex,

int length)

Parameters:
Exceptions:
8.119.3.8
int [ ] toArrayInt (int[ ] array)

Parameters:
into instead.
Returns:
1068
8.119.3.9
Class Documentation
int getMaximum ()
elements.
first created.
to the sequence with add() (p. 1069), or explicitly by calling
Returns:
See also:
8.119.3.10
A wrapper for getInt(int) (p. 1066) that returns a java.lang.Integer.

See also:
8.119.3.11
A wrapper for setInt() (p. 1067).

Exceptions:
ClassCastException if the element is not of type Integer.
See also:

8.119.3.12
1069
A wrapper for addInt(int, int) (p. 1066).

Exceptions:
ClassCastException if the element is not of type Integer.
See also:
1070
Class Documentation
8.120
KeyedBytes Class Reference

that is the key.
Inheritance diagram for KeyedBytes::

KeyedBytes ()
KeyedBytes (KeyedBytes src)

Copy constructor.
KeyedBytes (int theLength)

Constructor that specifies the allocated sizes.

Public Attributes
String key
Instance key associated with the specified value.
int length
int offset
byte[ ] value
8.120.1

that is the key.
8.120 KeyedBytes Class Reference
8.120.2
8.120.2.1
KeyedBytes ()
1071
The default constructor initializes the newly created object with empty key, null
value, zero length, and zero offset.
8.120.2.2
KeyedBytes (KeyedBytes src)
Copy constructor.
Parameters:
Exceptions:
8.120.2.3
KeyedBytes (int theLength)
Constructor that specifies the allocated sizes.

After this method is called, key is initialized with the empty string and length
and offset are set to zero.
Parameters:
size <<in>> ( p. 279) Size of the allocated bytes array.
Exceptions:
IllegalArgumentException if size is negative
8.120.3
8.120.3.1

This method performs a deep copy of src and it allocates memory for the value
if required.
1072
Class Documentation
Parameters:
Returns:
this if success. Otherwise, null.
Exceptions:
8.120.4
8.120.4.1
String key

8.120.4.2
int length

8.120.4.3
int offset

The first position of the bytes array has offset 0.
8.120.4.4
byte [ ] value
8.121 KeyedBytesDataReader Class Reference
8.121
1073
KeyedBytesDataReader Class Reference
<<interface>>
( p. 279)
Instantiates
DataReader
<
Inheritance diagram for KeyedBytesDataReader::

void read (KeyedBytesSeq received data, SampleInfoSeq info seq, int
Access
a
collection
of
data
samples
from
the
void take (KeyedBytesSeq received data, SampleInfoSeq info seq, int

Access
a
collection
of
data-samples
from
the
void read w condition (KeyedBytesSeq received data, SampleInfoSeq info seq, int max samples, ReadCondition condition)
Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read
the
samples
that
match
the
criteria
specified
in
the
void take w condition (KeyedBytesSeq received data, SampleInfoSeq info seq, int max samples, ReadCondition condition)
Analogous to com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read w condition
except
it
accesses
samples
via
the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.take
operation.
void read next sample (KeyedBytes received data, SampleInfo sample info)
value
from
the
void take next sample (KeyedBytes received data, SampleInfo sample info)
value
from
the
1074
Class Documentation
void read instance (KeyedBytesSeq received data, SampleInfoSeq
Access
a
collection
of
data
samples
from
the
void take instance (KeyedBytesSeq received data, SampleInfoSeq

Access
a
collection
of
data
samples
from
the
void read instance w condition (KeyedBytesSeq received data,

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read instance the samples that match the criteria specified in the
void take instance w condition (KeyedBytesSeq received data,

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.take instance the samples that match the criteria specified in the
void read next instance (KeyedBytesSeq received data, SampleInfoSeq info seq, int max samples, InstanceHandle t a handle, int sample states, int view states, int instance states)
Access
a
collection
of
data
samples
from
the
void take next instance (KeyedBytesSeq received data, SampleInfoSeq info seq, int max samples, InstanceHandle t a handle, int sample states, int view states, int instance states)
Access
a
collection
of
data
samples
from
the
void read next instance w condition (KeyedBytesSeq received data, SampleInfoSeq info seq, int max samples, InstanceHandle t a handle, ReadCondition condition)
Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read next instance the samples that match the criteria specified in the
1075
void take next instance w condition (KeyedBytesSeq received data, SampleInfoSeq info seq, int max samples, InstanceHandle t a handle, ReadCondition condition)
Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.take next instance the samples that match the criteria specified in the
void return loan (KeyedBytesSeq received data, SampleInfoSeq

info seq)
void get key value (KeyedBytes key holder, InstanceHandle t handle)

String get key value (InstanceHandle t handle)

<<eXtension>> (p. 278) Retrieve the instance key that corresponds to an
instance handle.
InstanceHandle t lookup instance (KeyedBytes key holder)

InstanceHandle t lookup instance (String key)

<<eXtension>> (p. 278) Retrieve the instance handle that corresponds to
an instance key.
8.121.1
<<interface>>
( p. 279)
Instantiates
DataReader
See also:
<
1076
Class Documentation
8.121.2
8.121.2.1
void read (KeyedBytesSeq received data, SampleInfoSeq

Access
a
collection
of
data
samples
from
the
See also:
8.121.2.2
void take (KeyedBytesSeq received data, SampleInfoSeq

Access
a
collection
of
data-samples
from
the
See also:
8.121.2.3
void read w condition (KeyedBytesSeq received data,

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read

the
samples
that
match
the
criteria
specified
in
the
See also:
8.121.2.4
void take w condition (KeyedBytesSeq received data,

Analogous to com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read w condition

except
it
accesses
samples
via
the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.take
operation.
1077
See also:
8.121.2.5
void read next sample (KeyedBytes received data,

Copies
the
next
value
from
the
See also:
8.121.2.6
void take next sample (KeyedBytes received data,

Copies
the
next
value
from
the
See also:
8.121.2.7
void read instance (KeyedBytesSeq received data,

Access
a
collection
of
data
samples
from
the
See also:
8.121.2.8
void take instance (KeyedBytesSeq received data,

Access
a
collection
of
data
samples
from
the
1078
Class Documentation
See also:
8.121.2.9
void read instance w condition (KeyedBytesSeq

InstanceHandle t a handle, ReadCondition condition)
Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read instance the samples that match the criteria specified in the
See also:
com.rti.ndds.example.FooDataReader.read instance w condition
8.121.2.10
void take instance w condition (KeyedBytesSeq

max samples, InstanceHandle t a handle,
Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.take instance the samples that match the criteria specified in the
See also:
com.rti.ndds.example.FooDataReader.take instance w condition
8.121.2.11
void read next instance (KeyedBytesSeq received data,

Access
a
collection
of
data
samples
from
the
See also:

8.121.2.12
1079
void take next instance (KeyedBytesSeq received data,

Access
a
collection
of
data
samples
from
the
See also:
8.121.2.13
void read next instance w condition (KeyedBytesSeq

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.read next instance the samples that match the criteria specified in the
See also:
8.121.2.14
void take next instance w condition (KeyedBytesSeq

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataReader.take next instance the samples that match the criteria specified in the
See also:
8.121.2.15
void return loan (KeyedBytesSeq received data,


1080
Class Documentation

See also:
8.121.2.16
void get key value (KeyedBytes key holder,


See also:
8.121.2.17
<<eXtension>> ( p. 278) Retrieve the instance key that corresponds to an

instance handle.
See also:
8.121.2.18
InstanceHandle t lookup instance (KeyedBytes

key holder)

See also:
com.rti.ndds.example.FooDataReader.lookup instance (p. 1010)
8.121.2.19
<<eXtension>> ( p. 278) Retrieve the instance handle that corresponds to

an instance key.
See also:
8.122 KeyedBytesDataWriter Class Reference
8.122
1081
KeyedBytesDataWriter Class Reference
<<interface>>
( p. 279)
Instantiates
DataWriter
<
Inheritance diagram for KeyedBytesDataWriter::

InstanceHandle t register instance (KeyedBytes instance data)
InstanceHandle t register instance (String key)

<<eXtension>> (p. 278) Informs RTI Connext that the application will be
modifying a particular instance.
InstanceHandle t register instance w timestamp (KeyedBytes

Performs the same functions as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.register instance except that the application provides the value for the source timestamp.

(String
key,
<<eXtension>>
(p. 278)
Performs
the
same
functions
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.KeyedBytesDataWriter.register instance except that the application provides the value for the source timestamp.
void unregister instance (KeyedBytes instance data, InstanceHandle t handle)

Reverses the action of com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.register instance.
void unregister instance (String key, InstanceHandle t handle)

<<eXtension>>
(p. 278)
Reverses
the
action
of
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.KeyedBytesDataWriter.register instance.
void unregister instance w timestamp (KeyedBytes instance data,

1082
Class Documentation
Performs the same function as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.un

instance except that it also provides the value for the source timestamp.
void unregister instance w timestamp (String key, InstanceHandle t handle, Time t source timestamp)
<<eXtension>>
(p. 278)
Performs
the
same
function
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.KeyedBytesDataWriter.unregiste
void write (KeyedBytes instance data, InstanceHandle t handle)

Modifies the value of a com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes
data instance.
void write (String key, byte[ ] octets, int offset, int length, InstanceHandle t handle)
<<eXtension>>
(p. 278)
Modifies
the
value
of
a
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes data instance.
void write (String key, ByteSeq octets, InstanceHandle t handle)

<<eXtension>>
(p. 278)
Modifies
the
value
of
a
void write w timestamp (KeyedBytes instance data, InstanceHandle t handle, Time t source timestamp)
Performs the same function as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.w

void write w timestamp (String key, byte[ ] octets, int offset, int length,
Performs the same function as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.K

void write w timestamp (String key, ByteSeq octets, InstanceHandle t handle, Time t source timestamp)

void dispose (KeyedBytes instance data, InstanceHandle t instance handle)

void dispose (String key, InstanceHandle t instance handle)

<<eXtension>> (p. 278) Requests the middleware to delete the data.
1083
void dispose w timestamp (KeyedBytes instance data, InstanceHandle t instance handle, Time t source timestamp)
Performs the same functions as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.dispose
except that the application provides the value for the source timestamp
that is made available to com.rti.dds.subscription.DataReader
( p. 487) objects by means of the source timestamp attribute inside
the com.rti.dds.subscription.SampleInfo ( p. 1398).
void dispose w timestamp (String key, InstanceHandle t instance handle, Time t source timestamp)
<<eXtension>>
(p. 278)
Performs
the
same
functions
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.KeyedBytesDataWriter.dispose
void get key value (KeyedBytes key holder, InstanceHandle t handle)


instance handle.
InstanceHandle t lookup instance (KeyedBytes key holder)


an instance key.
8.122.1
<<interface>>
( p. 279)
Instantiates
DataWriter
See also:
<
1084
Class Documentation
8.122.2
8.122.2.1
InstanceHandle t register instance (KeyedBytes

instance data)
See also:
8.122.2.2
<<eXtension>> ( p. 278) Informs RTI Connext that the application will be

See also:
8.122.2.3

(KeyedBytes instance data, Time t source timestamp)
Performs the same functions as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.r

instance except that the application provides the value for the source timestamp.
See also:
com.rti.ndds.example.FooDataWriter.register instance w timestamp (p. 1015)
8.122.2.4
InstanceHandle t register instance w timestamp (String

key, Time t source timestamp)
<<eXtension>>
( p. 278)
Performs
the
same
functions
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.KeyedBytesDataWriter.register
See also:

8.122.2.5
1085
void unregister instance (KeyedBytes instance data,

Reverses the action of com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.register instance.

See also:
(p. 1016)
8.122.2.6
void unregister instance (String key, InstanceHandle t

handle)
Reverses
the
action
of
<<eXtension>>
( p. 278)
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.KeyedBytesDataWriter.register instance.
See also:
(p. 1016)
8.122.2.7
void unregister instance w timestamp (KeyedBytes

source timestamp)
Performs the same function as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.unregister instance except that it also provides the value for the source timestamp.
See also:
8.122.2.8
void unregister instance w timestamp (String key,

<<eXtension>>
( p. 278)
Performs
the
same
function
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.KeyedBytesDataWriter.unregister instance except that it also provides the value for the source timestamp.
1086
Class Documentation
See also:
8.122.2.9
void write (KeyedBytes instance data, InstanceHandle t

handle)
Modifies the value of a com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes

data instance.
See also:
8.122.2.10
void write (String key, byte[ ] octets, int offset, int

length, InstanceHandle t handle)
<<eXtension>>
( p. 278)
Modifies
the
value
of
Parameters:
key <<in>> ( p. 279) Instance key.
handle <<in>> ( p. 279) Either the handle returned by a previous call to
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.register instance,
or
else
the
special
value
com.rti.dds.infrastructure.InstanceHandle See
t.InstanceHandle t.HANDLE NIL.
See also:
8.122.2.11
void write (String key, ByteSeq octets,

<<eXtension>>
( p. 278)
Modifies
the
value
of
1087
Parameters:
or
else
the
special
value
See
See also:
8.122.2.12
void write w timestamp (KeyedBytes instance data,

Performs the same function as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.write

See also:
8.122.2.13
void write w timestamp (String key, byte[ ] octets, int

offset, int length, InstanceHandle t handle, Time t
source timestamp)
Performs the same function as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.KeyedBytesDa

Parameters:
or
else
the
special
value
See
1088
Class Documentation

See also:
8.122.2.14
void write w timestamp (String key, ByteSeq octets,


Parameters:
or
else
the
special
value
See
See also:
8.122.2.15
void dispose (KeyedBytes instance data,


See also:

8.122.2.16
1089
void dispose (String key, InstanceHandle t

instance handle)
<<eXtension>> ( p. 278) Requests the middleware to delete the data.

See also:
8.122.2.17
void dispose w timestamp (KeyedBytes instance data,

source timestamp)
Performs the same functions as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.dispose

See also:
(p. 1029)
8.122.2.18
void dispose w timestamp (String key,

source timestamp)
<<eXtension>>
( p. 278)
Performs
the
same
functions
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesDataWriter.KeyedBytesDataWriter.dispose
See also:
(p. 1029)
8.122.2.19
void get key value (KeyedBytes key holder,


1090
Class Documentation
See also:
8.122.2.20

instance handle.
See also:
8.122.2.21
InstanceHandle t lookup instance (KeyedBytes

key holder)

See also:
8.122.2.22

an instance key.
See also:
8.123 KeyedBytesSeq Class Reference
8.123
1091
KeyedBytesSeq Class Reference

Inheritance diagram for KeyedBytesSeq::

KeyedBytesSeq ()
Constructs an empty sequence of com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes
KeyedBytesSeq (int initialMaximum)

KeyedBytesSeq (Collection elements)

Constructs
a
new
sequence
containing
the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes objects.
given
Package Attributes
8.123.1

Instantiates:
See also:
1092
Class Documentation
8.123.2
8.123.2.1
KeyedBytesSeq ()

8.123.2.2
KeyedBytesSeq (int initialMaximum)

8.123.2.3
KeyedBytesSeq (Collection elements)
Constructs
a
new
sequence
containing
the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes objects.
given
Parameters:
Exceptions:
8.123.3
8.123.3.1
Parameters:
Returns:
this
Exceptions:
8.123 KeyedBytesSeq Class Reference
1093
See also:
8.123.4
8.123.4.1

[package]
1094
Class Documentation
8.124
KeyedBytesTypeSupport Class Reference
<<interface>> ( p. 279) com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes

type support.
Inheritance diagram for KeyedBytesTypeSupport::

type name)
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes data type.

type name)
Allows
an
application
to
unregister
the
data
type
from RTI Connext. After calling unregister type, no further communication
using this type is possible.

Get the default name for the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes
type.
8.124.1
<<interface>> ( p. 279) com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes

type support.
8.124.2
8.124.2.1


com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes data type.
By default, The com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes
built-in
type
is
automatically
registered
when
a
DomainParticipant
is
created
using
the
type name
returned
by
8.124 KeyedBytesTypeSupport Class Reference
1095
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesTypeSupport.get type name. Therefore, the usage of this function is optional and it is only
This
method
can
also
be
used
to
register
the
same
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesTypeSupport
with a com.rti.dds.domain.DomainParticipant (p. 654) using different
values for the type name.
is
called
multiple
times
with
the
same
If
register type
Parameters:
to
register
the
data
type
(p. 654)
com.rti.dds.type.builtin.com.rti.dds.type.builtin.Bytes with. Cannot
be null.
type
is registered with the participant; this type name is used
when creating a new com.rti.dds.topic.Topic (p. 1545). (See
Exceptions:
One of
the
Standard
Return
Codes
(p. 1363)
(p. 108),
or
MT Safety:
See also:
1096
8.124.2.2
Class Documentation
Allows an application to unregister the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes

Precondition:
The
type with type name is registered with the participant and all
(p. 1356).
Postcondition:
Parameters:
(p. 654)
to
unregister
the
data
type
from.
Cannot be null.
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes is registered with the participant. The name should match a name that has
be null.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1356)
MT Safety:
SAFE.
See also:
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesTypeSupport.register type
8.124 KeyedBytesTypeSupport Class Reference

8.124.2.3
1097
Get the default name for the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes

type.
Can be used for calling com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesTypeSupport.register type or creating com.rti.dds.topic.Topic (p. 1545).
Returns:
default name for the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytes
type.
See also:
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedBytesTypeSupport.register type
1098
Class Documentation
8.125
KeyedString Class Reference

Inheritance diagram for KeyedString::

KeyedString ()
KeyedString (String key, String value)

KeyedString (KeyedString src)
Copy constructor.

Public Attributes
String key
String value
String value.
8.125.1
8.125.2
8.125.2.1
KeyedString ()
The default constructor initializes the newly created object with empty key and
value.
8.125 KeyedString Class Reference

8.125.2.2
1099
KeyedString (String key, String value)
Creates a KeyedString (p. 1098) with a key and a value

8.125.2.3
KeyedString (KeyedString src)
Copy constructor.
Parameters:
Exceptions:
8.125.3
8.125.3.1

references).
Parameters:
Returns:
Exceptions:
8.125.4
8.125.4.1
String key

1100
8.125.4.2
Class Documentation
String value
String value.
8.126 KeyedStringDataReader Class Reference
8.126
1101
KeyedStringDataReader Class Reference
<<interface>>
( p. 279)
Instantiates
DataReader
<
Inheritance diagram for KeyedStringDataReader::

void read (KeyedStringSeq received data, SampleInfoSeq info seq,
Access
a
collection
of
data
samples
from
the
void take (KeyedStringSeq received data, SampleInfoSeq info seq,

Access
a
collection
of
data-samples
from
the
void read w condition (KeyedStringSeq received data, SampleInfoSeq info seq, int max samples, ReadCondition condition)
Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read
the
samples
that
match
the
criteria
specified
in
the
void take w condition (KeyedStringSeq received data, SampleInfoSeq info seq, int max samples, ReadCondition condition)
Analogous to com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read w condition
except
it
accesses
samples
via
the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.take
operation.
void read next sample (KeyedString received data, SampleInfo

sample info)
value
from
the
void take next sample (KeyedString received data, SampleInfo

sample info)
value
from
the
1102
Class Documentation
void read instance (KeyedStringSeq received data, SampleInfoSeq
Access
a
collection
of
data
samples
from
the
void take instance (KeyedStringSeq received data, SampleInfoSeq

Access
a
collection
of
data
samples
from
the
void read instance w condition (KeyedStringSeq received data,

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read instance the samples that match the criteria specified in the
void take instance w condition (KeyedStringSeq received data,

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.take instance the samples that match the criteria specified in the
void read next instance (KeyedStringSeq received data, SampleInfoSeq info seq, int max samples, InstanceHandle t a handle, int sample states, int view states, int instance states)
Access
a
collection
of
data
samples
from
the
void take next instance (KeyedStringSeq received data, SampleInfoSeq info seq, int max samples, InstanceHandle t a handle, int sample states, int view states, int instance states)
Access
a
collection
of
data
samples
from
the
void read next instance w condition (KeyedStringSeq received data, SampleInfoSeq info seq, int max samples, InstanceHandle t a handle, ReadCondition condition)
Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read next instance the samples that match the criteria specified in the
1103
void take next instance w condition (KeyedStringSeq received data, SampleInfoSeq info seq, int max samples, InstanceHandle t a handle, ReadCondition condition)
Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.take next instance the samples that match the criteria specified in the
void return loan (KeyedStringSeq received data, SampleInfoSeq

info seq)
void get key value (KeyedString key holder, InstanceHandle t handle)


instance handle.
InstanceHandle t lookup instance (KeyedString key holder)


an instance key.
8.126.1
<<interface>>
( p. 279)
Instantiates
DataReader
See also:
<
1104
Class Documentation
8.126.2
8.126.2.1
void read (KeyedStringSeq received data, SampleInfoSeq

Access
a
collection
of
data
samples
from
the
See also:
8.126.2.2
void take (KeyedStringSeq received data, SampleInfoSeq

Access
a
collection
of
data-samples
from
the
See also:
8.126.2.3
void read w condition (KeyedStringSeq received data,

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read

the
samples
that
match
the
criteria
specified
in
the
See also:
8.126.2.4
void take w condition (KeyedStringSeq received data,

Analogous to com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read w condition

except
it
accesses
samples
via
the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.take
operation.
1105
See also:
8.126.2.5
void read next sample (KeyedString received data,

Copies
the
next
value
from
the
See also:
8.126.2.6
void take next sample (KeyedString received data,

Copies
the
next
value
from
the
See also:
8.126.2.7
void read instance (KeyedStringSeq received data,

Access
a
collection
of
data
samples
from
the
See also:
8.126.2.8
void take instance (KeyedStringSeq received data,

Access
a
collection
of
data
samples
from
the
1106
Class Documentation
See also:
8.126.2.9
void read instance w condition (KeyedStringSeq

InstanceHandle t a handle, ReadCondition condition)
Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read instance the samples that match the criteria specified in the
See also:
com.rti.ndds.example.FooDataReader.read instance w condition
8.126.2.10
void take instance w condition (KeyedStringSeq

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.take instance the samples that match the criteria specified in the
See also:
com.rti.ndds.example.FooDataReader.take instance w condition
8.126.2.11
void read next instance (KeyedStringSeq received data,

Access
a
collection
of
data
samples
from
the
See also:

8.126.2.12
1107
void take next instance (KeyedStringSeq received data,

Access
a
collection
of
data
samples
from
the
See also:
8.126.2.13
void read next instance w condition (KeyedStringSeq

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.read next instance the samples that match the criteria specified in the
See also:
8.126.2.14
void take next instance w condition (KeyedStringSeq

Accesses via com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataReader.take next instance the samples that match the criteria specified in the
See also:
8.126.2.15
void return loan (KeyedStringSeq received data,


1108
Class Documentation

See also:
8.126.2.16
void get key value (KeyedString key holder,


See also:
8.126.2.17

instance handle.
See also:
8.126.2.18
InstanceHandle t lookup instance (KeyedString

key holder)

See also:
8.126.2.19

an instance key.
See also:
8.127 KeyedStringDataWriter Class Reference
8.127
1109
KeyedStringDataWriter Class Reference
<<interface>>
( p. 279)
Instantiates
DataWriter
<
Inheritance diagram for KeyedStringDataWriter::

InstanceHandle t register instance (KeyedString instance data)

<<eXtension>> (p. 278) Informs RTI Connext that the application will be
InstanceHandle t register instance w timestamp (KeyedString

Performs the same functions as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.register instance except that the application provides the value for the source timestamp.

(String
key,
<<eXtension>>
(p. 278)
Performs
the
same
functions
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.KeyedStringDataWriter.register instance except that the application provides the value for the source timestamp.
void unregister instance (KeyedString instance data, InstanceHandle t handle)

Reverses the action of com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.register instance.
void unregister instance (String key, InstanceHandle t handle)

<<eXtension>>
(p. 278)
Reverses
the
action
of
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.KeyedStringDataWriter.register instance.
void unregister instance w timestamp (KeyedString instance data,

1110
Class Documentation
Performs the same function as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.u

void unregister instance w timestamp (String key, InstanceHandle t handle, Time t source timestamp)
<<eXtension>>
(p. 278)
Performs
the
same
function
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.KeyedStringDataWriter.unregis
void write (KeyedString instance data, InstanceHandle t handle)

Modifies the value of a com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString
data instance.
void write (String key, String str, InstanceHandle t handle)

<<eXtension>>
(p. 278)
Modifies
the
value
of
a
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString data instance.
void write w timestamp (KeyedString instance data, InstanceHandle t handle, Time t source timestamp)
Performs the same function as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.w

void write w timestamp (String key, String str, InstanceHandle t

<<eXtension>>
(p. 278)
Performs
the
same
function
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.KeyedStringDataWriter.write
void dispose (KeyedString instance data, InstanceHandle t instance handle)

void dispose (String key, InstanceHandle t instance handle)

<<eXtension>> (p. 278) Requests the middleware to delete the data.
void dispose w timestamp (KeyedString instance data, InstanceHandle t instance handle, Time t source timestamp)
Performs the same functions as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.

void dispose w timestamp (String key, InstanceHandle t instance handle, Time t source timestamp)
1111
<<eXtension>>
(p. 278)
Performs
the
same
functions
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.KeyedStringDataWriter.dispose
void get key value (KeyedString key holder, InstanceHandle t handle)


instance handle.
InstanceHandle t lookup instance (KeyedString key holder)


an instance key.
8.127.1
<<interface>>
( p. 279)
Instantiates
DataWriter
<
See also:
8.127.2
8.127.2.1
InstanceHandle t register instance (KeyedString

instance data)
See also:
1112
8.127.2.2
Class Documentation
<<eXtension>> ( p. 278) Informs RTI Connext that the application will be

See also:
8.127.2.3

(KeyedString instance data, Time t source timestamp)
Performs the same functions as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.r

See also:
8.127.2.4
InstanceHandle t register instance w timestamp (String

key, Time t source timestamp)
<<eXtension>>
( p. 278)
Performs
the
same
functions
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.KeyedStringDataWriter.register
See also:
8.127.2.5
void unregister instance (KeyedString instance data,

Reverses the action of com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.register instance.

See also:
(p. 1016)

8.127.2.6
1113
void unregister instance (String key, InstanceHandle t

handle)
<<eXtension>>
( p. 278)
Reverses
the
action
of
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.KeyedStringDataWriter.register instance.
See also:
(p. 1016)
8.127.2.7
void unregister instance w timestamp (KeyedString

source timestamp)
Performs the same function as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.unregister instance except that it also provides the value for the source timestamp.
See also:
8.127.2.8
void unregister instance w timestamp (String key,

<<eXtension>>
( p. 278)
Performs
the
same
function
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.KeyedStringDataWriter.unregister instance except that it also provides the value for the source timestamp.
See also:
8.127.2.9
void write (KeyedString instance data, InstanceHandle t

handle)
Modifies the value of a com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString

data instance.
See also:
1114
8.127.2.10
Class Documentation
void write (String key, String str, InstanceHandle t
handle)
<<eXtension>>
( p. 278)
Modifies
the
value
of
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString data instance.
See also:
8.127.2.11
void write w timestamp (KeyedString instance data,

Performs the same function as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.w

See also:
8.127.2.12
void write w timestamp (String key, String str,

<<eXtension>>
( p. 278)
Performs
the
same
function
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.KeyedStringDataWriter.write
See also:
8.127.2.13
void dispose (KeyedString instance data,


See also:

8.127.2.14
1115
void dispose (String key, InstanceHandle t

instance handle)
<<eXtension>> ( p. 278) Requests the middleware to delete the data.

See also:
8.127.2.15
void dispose w timestamp (KeyedString instance data,

source timestamp)
Performs the same functions as com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.dispose

See also:
(p. 1029)
8.127.2.16
void dispose w timestamp (String key,

source timestamp)
<<eXtension>>
( p. 278)
Performs
the
same
functions
as
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringDataWriter.KeyedStringDataWriter.dispose
See also:
(p. 1029)
8.127.2.17
void get key value (KeyedString key holder,


1116
Class Documentation
See also:
8.127.2.18

instance handle.
See also:
8.127.2.19
InstanceHandle t lookup instance (KeyedString

key holder)

See also:
8.127.2.20

an instance key.
See also:
8.128 KeyedStringSeq Class Reference
8.128
1117
KeyedStringSeq Class Reference

Inheritance diagram for KeyedStringSeq::

KeyedStringSeq ()
Constructs an empty sequence of com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString
KeyedStringSeq (int initialMaximum)

KeyedStringSeq (Collection elements)

Constructs
a
new
sequence
containing
the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString objects.
given
Package Attributes
8.128.1

Instantiates:
See also:
1118
Class Documentation
8.128.2
8.128.2.1
KeyedStringSeq ()

8.128.2.2
KeyedStringSeq (int initialMaximum)

8.128.2.3
KeyedStringSeq (Collection elements)
Constructs
a
new
sequence
containing
the
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString objects.
given
Parameters:
Exceptions:
8.128.3
8.128.3.1
Parameters:
Returns:
this
Exceptions:
8.128 KeyedStringSeq Class Reference
1119
See also:
8.128.4
8.128.4.1

[package]
1120
Class Documentation
8.129
KeyedStringTypeSupport
ence
Class
Refer-
<<interface>> ( p. 279) Keyed string type support.

Inheritance diagram for KeyedStringTypeSupport::

type name)
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString data type.

type name)
Allows
an
application
to
unregister
the
data
type
from RTI Connext. After calling unregister type, no further communication
using this type is possible.

Get the default name for the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString
type.
8.129.1
<<interface>> ( p. 279) Keyed string type support.
8.129.2
8.129.2.1


com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString data type.
By default, The com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString
built-in
type
is
automatically
registered
when
a
DomainParticipant
is
created
using
the
type name
returned
by
8.129 KeyedStringTypeSupport Class Reference
1121
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringTypeSupport.get type name. Therefore, the usage of this function is optional and it is only
This
method
can
also
be
used
to
register
the
same
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringTypeSupport
with a com.rti.dds.domain.DomainParticipant (p. 654) using different
values for the type name.
is
called
multiple
times
with
the
same
If
register type
Parameters:
to
register
the
data
type
(p. 654)
with.
Cannot be null.
type
is registered with the participant; this type name is used
when creating a new com.rti.dds.topic.Topic (p. 1545). (See
Exceptions:
One of
the
Standard
Return
Codes
(p. 1363)
(p. 108),
or
MT Safety:
See also:
1122
8.129.2.2
Class Documentation
Allows an application to unregister the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString

Precondition:
The
type with type name is registered with the participant and all
(p. 1356).
Postcondition:
Parameters:
(p. 654)
to
unregister
the
data
type
from.
Cannot be null.
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString is registered with the participant. The name should match a name that has
be null.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1356)
MT Safety:
SAFE.
See also:
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringTypeSupport.register type
8.129 KeyedStringTypeSupport Class Reference

8.129.2.3
1123
Get the default name for the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString

type.
Can be used for calling com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringTypeSupport.register type or creating com.rti.dds.topic.Topic (p. 1545).
Returns:
default name for the com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedString
type.
See also:
com.rti.dds.type.builtin.com.rti.dds.type.builtin.KeyedStringTypeSupport.register type
1124
Class Documentation
8.130
LatencyBudgetQosPolicy Class Reference
Inheritance diagram for LatencyBudgetQosPolicy::
Public Attributes
final Duration t duration
Duration of the maximum acceptable delay.
8.130.1
This policy is a hint to a DDS implementation; it can be used to change how it
processes and sends data that has low latency requirements. The DDS specification does not mandate whether or how this policy is used.
Entity:
Status:
Properties:
RxO (p. 101) = YES
See also:
8.130 LatencyBudgetQosPolicy Class Reference
8.130.2
1125
Usage
This policy provides a means for the application to indicate to the middleware
the urgency of the data communication. By having a non-zero duration, RTI
Connext can optimize its internal operation.
RTI
Connext
uses
it
in
conjunction
with
com.rti.dds.infrastructure.PublishModeQosPolicyKind.PublishModeQosPolicyKind.ASYNCHRONOUS PUBLISH MODE QOS com.rti.dds.publication.DataWriter (p. 557) instances associated with a com.rti.dds.publication.FlowControllerSchedulingPolicy.FlowControllerSchedulingPolicy.ED
FLOW CONTROLLER SCHED POLICY com.rti.dds.publication.FlowController
only.
Together
with
the
time
of
write,
(p. 964)
determines the deadline of each individual sample. RTI Connext uses this
information to prioritize the sending of asynchronously published data; see
com.rti.dds.infrastructure.AsynchronousPublisherQosPolicy (p. 397).
8.130.3
Compatibility
if the inequality offered duration <= requested duration evaluates to TRUE.
8.130.4
8.130.4.1
Duration of the maximum acceptable delay.

[default] 0 (meaning minimize the delay)
1126
Class Documentation
8.131
LibraryVersion t Class Reference
Public Attributes
final int major
The major version of a single RTI Connext library.
final int minor

The minor version of a single RTI Connext library.
final char release

The release letter of a single RTI Connext library.
final int build

The build number of a single RTI Connext library.
8.131.1

RTI Connext is comprised of a number of separate libraries. Although RTI
Connext as a whole has a version, the individual libraries each have their own
versions as well. It may be necessary to check these individual library versions
when seeking technical support.
8.131.2
8.131.2.1
final int major
The major version of a single RTI Connext library.

8.131.2.2
final int minor
The minor version of a single RTI Connext library.

8.131.2.3
final char release
The release letter of a single RTI Connext library.

8.131 LibraryVersion t Class Reference

8.131.2.4
1127
final int build
The build number of a single RTI Connext library.
1128
Class Documentation
8.132
LifespanQosPolicy Class Reference
Specifies
how
long
the
data
written
by
the
Inheritance diagram for LifespanQosPolicy::
Public Attributes
Maximum duration for the datas validity.
8.132.1
Specifies
how
long
the
data
written
by
the
Each data sample written by the com.rti.dds.publication.DataWriter

(p. 557) has an associated expiration time beyond which the data should not
be delivered to any application. Once the sample expires, the data will be
removed from the com.rti.dds.subscription.DataReader (p. 487) caches as
well as from the transient and persistent information caches.
The
expiration
time
of
each
sample
from
the
com.rti.dds.publication.DataWriter (p. 557)s cache is computed
by adding the duration specified by this QoS policy to the samples source timestamp.
The expiration time of each sample from the
com.rti.dds.subscription.DataReader (p. 487)s cache is computed by
adding the duration to the reception timestamp.
See also:
Entity:
(p. 557)
Properties:
RxO (p. 101) = N/A
8.132 LifespanQosPolicy Class Reference
8.132.2
1129
Usage
The Lifespan QoS policy can be used to control how much data is stored by
RTI Connext. Even if it is configured to store all of the data sent or received
for a topic (p. 359) (see com.rti.dds.infrastructure.HistoryQosPolicy
(p. 1046)), the total amount of data it stores may be limited by this QoS policy.
You may also use this QoS policy to ensure that applications do not receive or
act on data, commands or messages that are too old and have expired.
To avoid inconsistencies, multiple writers of the same instance should have the
same lifespan.
See also:
com.rti.dds.subscription.SampleInfo.source timestamp (p. 1404)
com.rti.dds.subscription.SampleInfo.reception timestamp
(p. 1407)
8.132.3
8.132.3.1
Maximum duration for the datas validity.

[range] [1 nanosec, 1 year] or com.rti.dds.infrastructure.Duration t.INFINITE
1130
8.133
Class Documentation
Listener Interface Reference
<<interface>> ( p. 279) Abstract base class for all Listener (p. 1130) interfaces.
Inheritance diagram for Listener::
8.133.1
<<interface>> ( p. 279) Abstract base class for all Listener (p. 1130) interfaces.
Entity:
com.rti.dds.infrastructure.Entity (p. 931)
QoS:
Status:
All the supported kinds of concrete com.rti.dds.infrastructure.Listener
(p. 1130) interfaces (one per concrete com.rti.dds.infrastructure.Entity
(p. 931) type) derive from this root and add methods whose prototype depends
on the concrete Listener (p. 1130).
Listeners provide a way for RTI Connext to asynchronously alert the application
when there are relevant status changes.
Almost every application will have to implement listener interfaces.
Each dedicated listener presents a list of operations that correspond to the
relevant communication status changes to which an application may respond.
The same com.rti.dds.infrastructure.Listener (p. 1130) instance
may be shared among multiple entities if you so desire.
Consequently, the provided parameter contains a reference to the concerned
8.133.2
Access to Plain Communication Status
The general mapping between the plain communication statuses (see Status
Kinds (p. 110)) and the listeners operations is as follows:
8.133 Listener Interface Reference
1131
For each communication status, there is a corresponding operation whose

name is on <communication status>(), which takes a parameter of type
<communication status> as listed in Status Kinds (p. 110).
on <communication status>
is
available
on
the
relevant
com.rti.dds.infrastructure.Entity (p. 931) as well as those that
embed it, as expressed in the following figure:
When the application attaches a listener on an entity, it must set a mask.
The mask indicates to RTI Connext which operations are enabled within
the listener (cf. operation com.rti.dds.infrastructure.Entity (p. 931)
set listener() ).
When a plain communication status changes, RTI Connext triggers the
most specific relevant listener operation that is enabled. In case the most
specific relevant listener operation corresponds to an application-installed
nil listener the operation will be considered handled by a NO-OP operation that does not reset the communication status.
This behavior allows the application to set a default behavior (e.g., in the listener
associated with the com.rti.dds.domain.DomainParticipant (p. 654)) and
to set dedicated behaviors only where needed.
8.133.3
Access to Read Communication Status
The two statuses related to data arrival are treated slightly differently. Since
they constitute the core purpose of the Data Distribution Service, there is no
need to provide a default mechanism (as is done for the plain communication
statuses above).
The rule is as follows. Each time the read communication status changes:
First,
RTI
Connext
tries
to
trigger
com.rti.dds.subscription.SubscriberListener.on data (p. 1504)
with
a
parameter
of
the
on readers
com.rti.dds.subscription.Subscriber (p. 1476);
the
related
If this does not succeed (there is no listener or the

operation is not enabled),
RTI Connext tries to trigger
com.rti.dds.subscription.DataReaderListener.on data available
(p. 520)
on
all
the
related
com.rti.dds.subscription.DataReaderListener (p. 518) objects, with
a parameter of the related com.rti.dds.subscription.DataReader
(p. 487).
1132
Class Documentation
The rationale is that either the application is interested in relations

among data arrivals and it must use the first option (and then get
the corresponding com.rti.dds.subscription.DataReader (p. 487) objects
by calling com.rti.dds.subscription.Subscriber.get datareaders (p. 1489)
on the related com.rti.dds.subscription.Subscriber (p. 1476) and then
get the data by calling com.rti.ndds.example.FooDataReader.read
(p. 981) or com.rti.ndds.example.FooDataReader.take (p. 983) on the
returned com.rti.dds.subscription.DataReader (p. 487) objects), or it
wants to treat each com.rti.dds.subscription.DataReader (p. 487) independently and it may choose the second option (and then get
the data by calling com.rti.ndds.example.FooDataReader.read (p. 981)
or com.rti.ndds.example.FooDataReader.take (p. 983) on the related
com.rti.dds.subscription.DataReader (p. 487)).
Note
that
if
com.rti.dds.subscription.SubscriberListener.on data on readers (p. 1504) is called, RTI Connext will not try
to
call
com.rti.dds.subscription.DataReaderListener.on data available (p. 520).
However, an application can force a call to the
com.rti.dds.subscription.DataReader (p. 487) objects that have data
by
calling
com.rti.dds.subscription.Subscriber.notify datareaders
(p. 1491).
8.133.4
Operations Allowed in Listener Callbacks
The operations that are allowed in com.rti.dds.infrastructure.Listener

(p. 1130) callbacks depend on the com.rti.dds.infrastructure.ExclusiveAreaQosPolicy
(p. 952) QoS policy of the com.rti.dds.infrastructure.Entity (p. 931)
to which the com.rti.dds.infrastructure.Listener (p. 1130) is attached or in the case of a com.rti.dds.publication.DataWriter
(p. 557) of com.rti.dds.subscription.DataReader (p. 487) listener,
on the com.rti.dds.infrastructure.ExclusiveAreaQosPolicy (p. 952)
QoS of the parent com.rti.dds.publication.Publisher (p. 1262) or
For instance, the
com.rti.dds.infrastructure.ExclusiveAreaQosPolicy (p. 952) settings
of a com.rti.dds.subscription.Subscriber (p. 1476) will determine which
operations are allowed within the callbacks of the listeners associated with all
the DataReaders created through that com.rti.dds.subscription.Subscriber
(p. 1476).
Note: these restrictions do not apply to builtin topic (p. 359) listener callbacks.
Regardless of whether com.rti.dds.infrastructure.ExclusiveAreaQosPolicy.use shared exclusive area (p. 953) is set to com.rti.dds.infrastructure.true or
com.rti.dds.infrastructure.false, the following operations are not allowed:
Within any listener callback, deleting the entity to which the
com.rti.dds.infrastructure.Listener (p. 1130) is attached
8.133 Listener Interface Reference
1133
Within a com.rti.dds.topic.Topic (p. 1545) listener callback, any operations on any subscribers, readers, publishers or writers
An attempt to call a disallowed method from within a callback will result
in
(p. 1357).
If
com.rti.dds.infrastructure.ExclusiveAreaQosPolicy.use shared exclusive area (p. 953) is set to com.rti.dds.infrastructure.false, the setting
which allows more concurrency among RTI Connext threads, the following are
not allowed:
Within any listener callback, creating any entity
Within any listener callback, deleting any entity
Within any listener callback, enabling any entity
Within any listener callback, setting the QoS of any entities
Within
a
(p. 487)
lisor
(p. 1476)
tener
callback,
invoking
any
operation
on
any
other
(p. 1476)
or
on
any
com.rti.dds.subscription.DataReader (p. 487) belonging to another com.rti.dds.subscription.Subscriber (p. 1476).
Within a com.rti.dds.subscription.DataReader (p. 487) or
com.rti.dds.subscription.Subscriber (p. 1476) listener callback,
invoking any operation on any com.rti.dds.publication.Publisher
(p. 1262) (or on any com.rti.dds.publication.DataWriter (p. 557)
belonging to such a com.rti.dds.publication.Publisher (p. 1262))
that has com.rti.dds.infrastructure.ExclusiveAreaQosPolicy.use shared exclusive area (p. 953) set to com.rti.dds.infrastructure.true.
Within
a
(p. 557)
of
(p. 1262)
listener
callback, invoking any operation on another Publisher or on a
com.rti.dds.publication.DataWriter (p. 557) belonging to another
Within
a
(p. 557)
of
com.rti.dds.publication.Publisher (p. 1262) listener callback, invoking any operation on any com.rti.dds.subscription.Subscriber
(p. 1476) or com.rti.dds.subscription.DataReader (p. 487).
An attempt to call a disallowed method from within a callback will result
in
(p. 1357).
1134
Class Documentation
The
above
limitations
can
be
lifted
by
setting
com.rti.dds.infrastructure.ExclusiveAreaQosPolicy.use shared exclusive area
(p. 953)
to
com.rti.dds.infrastructure.true
on
the
(p. 1262)
or
(p. 1476)
(or
on
the
(p. 1262)/
of
the
(p. 1476)
(p. 557)/com.rti.dds.subscription.DataReader (p. 487)) to which the
listener is attached. However, the application will pay the cost of reduced
concurrency between the affected publishers and subscribers.
See also:
EXCLUSIVE AREA (p. 76)
(p. 1709),
8.134 LivelinessChangedStatus Class Reference
8.134
1135
LivelinessChangedStatus Class Reference

Inherits Status.

LivelinessChangedStatus ()
The no-argument constructor for this status object.
LivelinessChangedStatus (LivelinessChangedStatus src)

A copy constructor.
Public Attributes
int alive count
The total count of currently alive com.rti.dds.publication.DataWriter
( p. 557) entities that write the com.rti.dds.topic.Topic ( p. 1545) the
com.rti.dds.subscription.DataReader ( p. 487) reads.
int not alive count

The
total
count
of
currently
not alive
( p. 557)
entities
that
write
the
( p. 1545)
the
com.rti.dds.subscription.DataReader ( p. 487) reads.
int alive count change

The change in the alive count since the last time the listener was called or
int not alive count change

The change in the not alive count since the last time the listener was called
or the status was read.
final InstanceHandle t last publication handle

An instance handle to the last remote writer to change its liveliness.
1136
Class Documentation
8.134.1

The
com.rti.dds.subscription.DataReaderListener.on liveliness changed (p. 520) callback may be invoked for the following reasons:
Liveliness
is
truly
lost
a
sample
has
not
been
received
within
the
timeframe
specified
in
com.rti.dds.infrastructure.LivelinessQosPolicy.lease duration
(p. 1143)
Liveliness is recovered after being lost.
A new matching entity has been discovered.
A QoS has changed such that a pair of matching entities are no longer matching (such as a change to the
com.rti.dds.infrastructure.PartitionQosPolicy (p. 1217)).
In
this case, RTI Connext will no longer keep track of the entities liveliness.
Furthermore:
If liveliness was maintained: com.rti.dds.subscription.LivelinessChangedStatus.alive count
(p. 1137)
will
decrease
and
com.rti.dds.subscription.LivelinessChangedStatus.not alive count (p. 1137) will remain the same.
If liveliness had been lost: com.rti.dds.subscription.LivelinessChangedStatus.alive count
(p. 1137)
will
remain
the
same
and
com.rti.dds.subscription.LivelinessChangedStatus.not alive count (p. 1137) will decrease.
8.134.2
8.134.2.1
LivelinessChangedStatus ()
The no-argument constructor for this status object.

8.134.2.2
LivelinessChangedStatus (LivelinessChangedStatus src)
A copy constructor.
Exceptions:
NullPointerException if the given status is null.
8.134 LivelinessChangedStatus Class Reference
8.134.3
8.134.3.1
int alive count
1137
The total count of currently alive com.rti.dds.publication.DataWriter

(p. 557) entities that write the com.rti.dds.topic.Topic (p. 1545) the
com.rti.dds.subscription.DataReader (p. 487) reads.
8.134.3.2
int not alive count
The total count of currently not alive com.rti.dds.publication.DataWriter

(p. 557) entities that write the com.rti.dds.topic.Topic (p. 1545) the
com.rti.dds.subscription.DataReader (p. 487) reads.
8.134.3.3
int alive count change
The change in the alive count since the last time the listener was called or the
status was read.
8.134.3.4
int not alive count change
The change in the not alive count since the last time the listener was called or
8.134.3.5
An instance handle to the last remote writer to change its liveliness.
1138
Class Documentation
8.135
LivelinessLostStatus Class Reference

Inherits Status.
Public Attributes
int total count
Total
cumulative
number
of
times
that
a
previously-alive
com.rti.dds.publication.DataWriter ( p. 557) became not alive due
to a failure to to actively signal its liveliness within the offered liveliness
period.

The incremental changees in total count since the last time the listener was
called or the status was read.
8.135.1

Entity:
Listener:
The liveliness that the com.rti.dds.publication.DataWriter (p. 557) has
committed through its com.rti.dds.infrastructure.LivelinessQosPolicy
(p. 1140) was not respected; thus com.rti.dds.subscription.DataReader
(p. 487) entities will consider the com.rti.dds.publication.DataWriter
(p. 557) as no longer alive/active.
8.135.2
8.135.2.1
int total count
Total
cumulative
number
of
times
that
a
previously-alive
com.rti.dds.publication.DataWriter (p. 557) became not alive due to
8.135 LivelinessLostStatus Class Reference
1139
a failure to to actively signal its liveliness within the offered liveliness period.
This
count
does
not
change
when
an
already
not
alive
com.rti.dds.publication.DataWriter (p. 557) simply remains not alive
for another liveliness period.
8.135.2.2
The incremental changees in total count since the last time the listener was
1140
Class Documentation
8.136
LivelinessQosPolicy Class Reference
Specifies
and
configures
the
mechanism
that
allows
or dead..
Inheritance diagram for LivelinessQosPolicy::
Public Attributes
LivelinessQosPolicyKind kind
The kind of liveliness desired.
final Duration t lease duration

The duration within which a com.rti.dds.infrastructure.Entity ( p. 931)
must be asserted, or else it is assumed to be not alive.
8.136.1
Specifies
and
configures
the
mechanism
that
allows
or dead..
Liveliness must be asserted at least once every lease duration otherwise RTI
Connext will assume the corresponding com.rti.dds.infrastructure.Entity
(p. 931) or is no longer alive.
The liveliness status of a com.rti.dds.infrastructure.Entity (p. 931)
is used to maintain instance ownership in combination with the setThe application is also
ting of the OWNERSHIP (p. 87) policy.
informed via com.rti.dds.infrastructure.Listener (p. 1130) when an
com.rti.dds.infrastructure.Entity (p. 931) is no longer alive.
A com.rti.dds.subscription.DataReader (p. 487) requests that liveliness of
writers is maintained by the requested means and loss of liveliness is detected
with delay not to exceed the lease duration.
A com.rti.dds.publication.DataWriter (p. 557) commits to signalling its
liveliness using the stated means at intervals not to exceed the lease duration.
Listeners are used to notify a com.rti.dds.subscription.DataReader (p. 487)
of loss of liveliness and com.rti.dds.publication.DataWriter (p. 557) of viGenerated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
8.136 LivelinessQosPolicy Class Reference
1141
olations to the liveliness contract. The on liveliness lost() callback is only

called once, after the first time the lease duration is exceeded (when the
com.rti.dds.publication.DataWriter (p. 557) first loses liveliness).
This QoS policy can be used during system integration to ensure that applications have been coded to meet design specifications. It can also be used during
run time to detect when systems are performing outside of design specifications.
Receiving applications can take appropriate actions in response to disconnected
DataWriters.
Entity:
Status:
(p. 1135);
com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED INCOMPATIBLE QOS STATUS, com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED INCOMPATIBLE QOS STATUS
Properties:
RxO (p. 101) = YES
8.136.2
Usage
This policy controls the mechanism and parameters used by RTI Connext to
ensure that particular entities on the network are still alive. The liveliness
can also affect the ownership of a particular instance, as determined by the
OWNERSHIP (p. 87) policy.
This policy has several settings to support both data types that are updated
periodically as well as those that are changed sporadically. It also allows customisation for different application requirements in terms of the kinds of failures
that will be detected by the liveliness mechanism.
The com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.AUTOMATIC LIVELINESS QOS liveliness setting is most appropriate for applications that
only need to detect failures at the process-level, but not application-logic
failures within a process. RTI Connext takes responsibility for renewing the
leases at the required rates and thus, as long as the local process where a
1142
Class Documentation
com.rti.dds.domain.DomainParticipant (p. 654) is running and the link

connecting it to remote participants remains connected, the entities within the
com.rti.dds.domain.DomainParticipant (p. 654) will be considered alive.
This requires the lowest overhead.
The manual settings (com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.MANU

BY PARTICIPANT LIVELINESS QOS, com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQ
BY TOPIC LIVELINESS QOS) require the application on the publishing side
to periodically assert the liveliness before the lease expires to indicate the corresponding com.rti.dds.infrastructure.Entity (p. 931) is still alive. The action
can be explicit by calling the com.rti.dds.publication.DataWriter.assert liveliness (p. 574) operation or implicit by writing some data.
The two possible manual settings control the granularity at which the application must assert liveliness.
The setting com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.MANUAL

BY PARTICIPANT LIVELINESS QOS
requires
only
that
one
(p. 931)
within
a
participant is asserted to be alive to deduce all other
com.rti.dds.infrastructure.Entity (p. 931) objects within the same
com.rti.dds.domain.DomainParticipant (p. 654) are also alive.
The setting com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.MANUAL

BY TOPIC LIVELINESS QOS requires that at least one instance within
the com.rti.dds.publication.DataWriter (p. 557) is asserted.
Changes in LIVELINESS (p. 82) must be detected by the Service with a timegranularity greater or equal to the lease duration. This ensures that the value
of the com.rti.dds.subscription.LivelinessChangedStatus (p. 1135) is updated at least once during each lease duration and the related Listeners and
com.rti.dds.infrastructure.WaitSet (p. 1709) s are notified within a lease duration from the time the LIVELINESS (p. 82) changed.
8.136.3
Compatibility
if the following conditions are met:
the inequality offered kind >= requested kind evaluates to

TRUE. For the purposes of this inequality,
the values
of
com.rti.dds.infrastructure.LivelinessQosPolicyKind
kind
are
considered
ordered
such
that:
(p. 1144)
com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.AUTOMATIC LIVELINESS QOS < com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.
BY PARTICIPANT LIVELINESS QOS
<
8.136 LivelinessQosPolicy Class Reference
1143
com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.MANUAL BY TOPIC LIVELINESS QOS.

the inequality offered lease duration <= requested lease duration
evaluates to com.rti.dds.infrastructure.true.
See also:
8.136.4
8.136.4.1
LivelinessQosPolicyKind kind
The kind of liveliness desired.

[default] com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.AUTOMATIC LIVELINESS QOS
8.136.4.2
final Duration t lease duration
The duration within which a com.rti.dds.infrastructure.Entity (p. 931)

must be asserted, or else it is assumed to be not alive.
1144
Class Documentation
8.137
LivelinessQosPolicyKind Class Reference
Inheritance diagram for LivelinessQosPolicyKind::

static
final
LivelinessQosPolicyKind
LIVELINESS QOS
AUTOMATIC -
[default] The infrastructure ( p. 334) will automatically signal liveliness

for the com.rti.dds.publication.DataWriter ( p. 557) (s) at least as often
as required by the lease duration.
static
final
LivelinessQosPolicyKind
PARTICIPANT LIVELINESS QOS
MANUAL BY -
RTI Connext will assume that as long as at least one

( p. 557)
belonging
to
the
( p. 654)
(or
the
com.rti.dds.domain.DomainParticipant ( p. 654) itself ) has asserted its liveliness, then the other Entities belonging to that same
com.rti.dds.domain.DomainParticipant ( p. 654) are also alive.
static final LivelinessQosPolicyKind

LIVELINESS QOS
MANUAL BY TOPIC -
RTI
Connext
will
only
assume
liveliness
of
the
com.rti.dds.publication.DataWriter ( p. 557) if the application has
asserted liveliness of that com.rti.dds.publication.DataWriter ( p. 557)
itself.
8.137.1
QoS:
8.137 LivelinessQosPolicyKind Class Reference
8.137.2
8.137.2.1
final LivelinessQosPolicyKind AUTOMATIC LIVELINESS QOS [static]
1145
[default] The infrastructure (p. 334) will automatically signal liveliness for
the com.rti.dds.publication.DataWriter (p. 557) (s) at least as often as required by the lease duration.
A com.rti.dds.publication.DataWriter (p. 557) with this setting does not
need to take any specific action in order to be considered alive. The
com.rti.dds.publication.DataWriter (p. 557) is only not alive when the
participant to which it belongs terminates (gracefully or not), or when there is
a network problem that prevents the current participant from contacting that
remote participant.
8.137.2.2
final LivelinessQosPolicyKind MANUAL BY PARTICIPANT LIVELINESS QOS

[static]
RTI Connext will assume that as long as at least one

(p. 557)
belonging
to
the
(p. 654)
(or
the
(p. 654)
itself)
has
asserted its liveliness, then the other Entities belonging to that same
com.rti.dds.domain.DomainParticipant (p. 654) are also alive.
The user application takes responsibility to signal liveliness to RTI Connext either by calling com.rti.dds.domain.DomainParticipant.assert liveliness
(p. 718), or by calling com.rti.dds.publication.DataWriter.assert liveliness (p. 574), or com.rti.ndds.example.FooDataWriter.write
(p. 1021) on any com.rti.dds.publication.DataWriter (p. 557) belonging to
8.137.2.3
final LivelinessQosPolicyKind MANUAL BY TOPIC LIVELINESS QOS [static]
RTI
Connext
will
only
assume
liveliness
of
the
com.rti.dds.publication.DataWriter (p. 557) if the application has asserted liveliness of that com.rti.dds.publication.DataWriter (p. 557)
itself.
The user application takes responsibility to signal liveliness to RTI Connext
using the com.rti.dds.publication.DataWriter.assert liveliness (p. 574)
method, or by writing some data.
1146
Class Documentation
8.138
LoanableSequence Class Reference
A sequence capable of storing its elements directly or taking out a loan on them
from an internal middleware store.
Inheritance diagram for LoanableSequence::

LoanableSequence (Class elementType)
Construct a new sequence for elements of the given type.
LoanableSequence (Class elementType, int maximum)

LoanableSequence (Class elementType, Collection elements)


int getMaximum ()
sequence.


Replaces the element at the specified position in this sequence with the specified element.

Returns the element at the specified position in this sequence.
int size ()
Returns the length of the sequence.
8.138 LoanableSequence Class Reference
8.138.1
1147
A sequence capable of storing its elements directly or taking out a loan on them
from an internal middleware store.
See also:
com.rti.dds.subscription.DataReader.read untyped
(p. 506)(java.util.List,
(p. 1409), int, int, int, int)
com.rti.dds.subscription.DataReader.take untyped
(p. 507)(java.util.List,
(p. 1409), int, int, int, int)
8.138.2
8.138.2.1
LoanableSequence (Class elementType)
8.138.2.2
LoanableSequence (Class elementType, int maximum)
8.138.2.3
LoanableSequence (Class elementType, Collection

elements)
8.138.3
8.138.3.1

Returns:
com.rti.dds.infrastructure.true if sequence owns the underlying buffer, or
com.rti.dds.infrastructure.false if it has an outstanding loan.
1148
8.138.3.2
Class Documentation
int getMaximum ()
elements.
first created.
Returns:
See also:
8.138.3.3

maximum.
Note: If you add an element with add() (p. 391), the sequences size is increased implicitly.
Postcondition:
Parameters:
Returns:
8.138 LoanableSequence Class Reference

8.138.3.4
1149
Replaces the element at the specified position in this sequence with the specified
element.
See also:
8.138.3.5
Returns the element at the specified position in this sequence.

See also:
8.138.3.6
int size ()
Returns the length of the sequence.

See also:
1150
Class Documentation
8.139
Locator t Class Reference
<<eXtension>> ( p. 278) Type used to represent the addressing information

transports.
Inherits Struct.

Locator t ()
Constructor.
Public Attributes
int kind
The kind of locator.
int port
the port number
final byte[ ] address = new byte[ADDRESS LENGTH MAX]

A com.rti.dds.infrastructure.Locator t.ADDRESS LENGTH MAX
( p. 1152) octet field to hold the IP address.

static final int KIND INVALID
Locator of this kind is invalid.
static final int PORT INVALID

An invalid port.
static final byte[ ] ADDRESS INVALID

An invalid address.
static final Locator t INVALID

An invalid locator.
static final int KIND UDPv4

8.139 Locator t Class Reference
1151
A locator for a UDPv4 address.
static final int KIND SHMEM

A locator for an address acessed via shared memory.
static final int KIND UDPv6

static final int KIND RESERVED

Locator of this kind is reserved.
static final int ADDRESS LENGTH MAX = 16

Declares length of address field in locator.
8.139.1
<<eXtension>> ( p. 278) Type used to represent the addressing information

transports.
8.139.2
8.139.2.1
Locator t ()
Constructor.
8.139.3
8.139.3.1
final int KIND INVALID [static]
Locator of this kind is invalid.

8.139.3.2
final int PORT INVALID [static]
An invalid port.
8.139.3.3
final byte [ ] ADDRESS INVALID [static]
Initial value:
1152
Class Documentation
{0,0,0,0,
0,0,0,0,
0,0,0,0,
0,0,0,0}
An invalid address.
8.139.3.4
final Locator t INVALID [static]
Initial value:
new Locator_t(
KIND_INVALID, PORT_INVALID, ADDRESS_INVALID)
An invalid locator.
8.139.3.5
final int KIND UDPv4 [static]

8.139.3.6
final int KIND SHMEM [static]
A locator for an address acessed via shared memory.

8.139.3.7
final int KIND UDPv6 [static]

8.139.3.8
final int KIND RESERVED [static]
Locator of this kind is reserved.

8.139.3.9
final int ADDRESS LENGTH MAX = 16 [static]
Declares length of address field in locator.

8.139.3.10
int kind
The kind of locator.

If the Locator t (p. 1150) kind is com.rti.dds.infrastructure.Locator t.KIND UDPv4 (p. 1152), the address contains an IPv4 address. In this
8.139 Locator t Class Reference
1153
case, the leading 12 octets of the com.rti.dds.infrastructure.Locator The last 4 octets of

t.address (p. 1153) must be zero.
com.rti.dds.infrastructure.Locator t.address (p. 1153) are used to
store the IPv4 address.
If the Locator t (p. 1150) kind is com.rti.dds.infrastructure.Locator t.KIND UDPv6 (p. 1152), the address contains an IPv6 address. IPv6 addresses typically use a shorthand hexadecimal notation that maps one-to-one to
the 16 octets in the com.rti.dds.infrastructure.Locator t.address (p. 1153)
field.
8.139.3.11
int port
the port number

8.139.3.12
final byte [ ] address = new byte[ADDRESS LENGTH MAX]
A com.rti.dds.infrastructure.Locator t.ADDRESS LENGTH MAX

(p. 1152) octet field to hold the IP address.
1154
Class Documentation
8.140
LocatorFilter t Class Reference

DataWriter.
Inherits Struct.

LocatorFilter t ()
Constructor.
LocatorFilter t (LocatorFilter t src)

Constructor.
LocatorFilter t (LocatorSeq locators, String filter expression)

Constructor.
Public Attributes
LocatorSeq locators
Sequence
containing
from
one
to
four
com.rti.dds.infrastructure.Locator t ( p. 1150), used to specify the
multicast address locators of an individual channel within a MultiChannel
DataWriter.

channel.
8.140.1

DataWriter.
QoS:
com.rti.dds.infrastructure.LocatorFilterQosPolicy (p. 1157)
8.140 LocatorFilter t Class Reference
8.140.2
8.140.2.1
LocatorFilter t ()
1155
Constructor.
8.140.2.2
LocatorFilter t (LocatorFilter t src)
Constructor.
Parameters:
src <<in>> ( p. 279) Locator used to initialized the new locator.
8.140.2.3
LocatorFilter t (LocatorSeq locators, String

filter expression)
Constructor.
Parameters:
locators <<in>> ( p. 279) Locators.
filter expression <<in>> ( p. 279) Filter expression.
8.140.3
8.140.3.1
LocatorSeq locators
Initial value:
new LocatorSeq()
Sequence containing from one to four com.rti.dds.infrastructure.Locator t

(p. 1150), used to specify the multicast address locators of an individual channel
within a MultiChannel DataWriter.
[default] Empty sequence.
8.140.3.2
channel.
If the expression evaluates to TRUE, a sample will be published on the channel.
1156
Class Documentation
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
com.rti.dds.infrastructure.LocatorFilterQosPolicy.filter name
(p. 1158)
of
See also:
[default] NULL (invalid value)
8.141 LocatorFilterQosPolicy Class Reference
8.141
1157
LocatorFilterQosPolicy Class Reference
The QoS policy used to report the configuration of a MultiChannel DataWriter

as part of builtin.PublicationBuiltinTopicData.
Inheritance diagram for LocatorFilterQosPolicy::
Public Attributes
final LocatorFilterSeq locator filters
A sequence of com.rti.dds.infrastructure.LocatorFilter t ( p. 1154).
Each com.rti.dds.infrastructure.LocatorFilter t ( p. 1154) reports the
configuration of a single channel of a MultiChannel DataWriter.
String filter name

Name of the filter class used to describe the filter expressions of a MultiChannel DataWriter.
8.141.1
The QoS policy used to report the configuration of a MultiChannel DataWriter

as part of builtin.PublicationBuiltinTopicData.
Entity:
Properties:
RxO (p. 101) = N/A
8.141.2
8.141.2.1
final LocatorFilterSeq locator filters
A sequence of com.rti.dds.infrastructure.LocatorFilter t (p. 1154). Each

com.rti.dds.infrastructure.LocatorFilter t (p. 1154) reports the configuration of a single channel of a MultiChannel DataWriter.
A sequence length of zero indicates the com.rti.dds.infrastructure.MultiChannelQosPolicy
(p. 1187) is not in use.
1158
Class Documentation

8.141.2.2
String filter name
Name of the filter class used to describe the filter expressions of a MultiChannel
DataWriter.
The
following
builtin
filters
are
supported:
com.rti.dds.domain.DomainParticipant.SQLFILTER NAME (p. 155)
and com.rti.dds.domain.DomainParticipant.STRINGMATCHFILTER NAME (p. 155).
[default] com.rti.dds.domain.DomainParticipant.STRINGMATCHFILTER NAME (p. 155)
8.142 LocatorFilterSeq Class Reference
8.142
1159
LocatorFilterSeq Class Reference
Declares IDL
(p. 1154) >.
sequence<
8.142.1
Declares IDL
(p. 1154) >.
sequence<
A sequence of com.rti.dds.infrastructure.LocatorFilter t (p. 1154) used

to report the channels properties. If the length of the sequence is zero,
the com.rti.dds.infrastructure.MultiChannelQosPolicy (p. 1187) is not in
use.
Instantiates:
See also:
com.rti.dds.infrastructure.LocatorFilter t (p. 1154)
1160
8.143
Class Documentation
LocatorSeq Class Reference
Declares IDL sequence < com.rti.dds.infrastructure.Locator t (p. 1150)

>.
8.143.1
Declares IDL sequence < com.rti.dds.infrastructure.Locator t (p. 1150)

>.
See also:
com.rti.dds.infrastructure.Locator t (p. 1150)
8.144 LogCategory Class Reference
8.144
1161
LogCategory Class Reference

Inheritance diagram for LogCategory::

static final LogCategory NDDS CONFIG LOG CATEGORY PLATFORM
Log messages pertaining to the underlying platform (hardware and OS) on
which RTI Connext is running are in this category.
static final LogCategory NDDS CONFIG LOG CATEGORY COMMUNICATION

Log messages pertaining to data serialization and deserialization and network
traffic are in this category.
static final LogCategory NDDS CONFIG LOG CATEGORY DATABASE

Log messages pertaining to the internal database in which RTI Connext objects are stored are in this category.
static final LogCategory NDDS CONFIG LOG CATEGORY ENTITIES

Log messages pertaining to local and remote entities and to the discovery
process are in this category.
static final LogCategory NDDS CONFIG LOG CATEGORY API

Log messages pertaining to the API layer of RTI Connext (such as method
argument validation) are in this category.
8.144.1

The com.rti.ndds.config.Logger.get verbosity by category (p. 1164) and
com.rti.ndds.config.Logger.set verbosity by category (p. 1165) can be
used to specify different verbosities for different categories of messages.
1162
Class Documentation
8.144.2
8.144.2.1
final LogCategory NDDS CONFIG LOG CATEGORY PLATFORM [static]
Log messages pertaining to the underlying platform (hardware and OS) on which
RTI Connext is running are in this category.
8.144.2.2
final LogCategory NDDS CONFIG LOG CATEGORY COMMUNICATION

[static]
Log messages pertaining to data serialization and deserialization and network

traffic are in this category.
8.144.2.3
final LogCategory NDDS CONFIG LOG CATEGORY DATABASE [static]
Log messages pertaining to the internal database in which RTI Connext objects
are stored are in this category.
8.144.2.4
final LogCategory NDDS CONFIG LOG CATEGORY ENTITIES [static]
Log messages pertaining to local and remote entities and to the discovery process
are in this category.
8.144.2.5
final LogCategory NDDS CONFIG LOG CATEGORY API [static]
Log messages pertaining to the API layer of RTI Connext (such as method
argument validation) are in this category.
8.145 Logger Class Reference
8.145
1163
Logger Class Reference
<<interface>> ( p. 279) The singleton type used to configure RTI Connext

logging.

LogVerbosity get verbosity ()
Get the verbosity at which RTI Connext is currently logging diagnostic information.
LogVerbosity
gory)
get verbosity by category
(LogCategory
cate-
Get the verbosity at which RTI Connext is currently logging diagnostic information in the given category.
void set verbosity (LogVerbosity verbosity)

Set the verbosity at which RTI Connext will log diagnostic information.
void set verbosity by category (LogCategory category, LogVerbosity verbosity)

Set the verbosity at which RTI Connext will log diagnostic information in
the given category.
File get output file ()

Get the file to which the logged output is redirected.
void set output file (File out) throws IOException

Set the file to which the logged output is redirected.
LoggerDevice get output device ()

Return the user device registered with the logger.
void set output device (LoggerDevice device) throws IOException

Register a com.rti.ndds.config.LoggerDevice ( p. 1167).
LogPrintFormat get print format ()

Get the current message format that RTI Connext is using to log diagnostic
information.
boolean set print format (LogPrintFormat print format)

Set the message format that RTI Connext will use to log diagnostic information.
1164
Class Documentation

static Logger get instance ()
Get the singleton instance of this type.
8.145.1
<<interface>> ( p. 279) The singleton type used to configure RTI Connext

logging.
8.145.2
8.145.2.1
static Logger get instance () [static]

8.145.2.2
LogVerbosity get verbosity ()
Get the verbosity at which RTI Connext is currently logging diagnostic information.
The default verbosity if com.rti.ndds.config.Logger.set verbosity (p. 1164)
is never called is com.rti.ndds.config.LogVerbosity.NDDS CONFIG LOG VERBOSITY ERROR (p. 1178).
If com.rti.ndds.config.Logger.set verbosity by category (p. 1165) has
been used to set different verbosities for different categories of messages, this
method will return the maximum verbosity of all categories.
8.145.2.3
LogVerbosity get verbosity by category (LogCategory

category)
Get the verbosity at which RTI Connext is currently logging diagnostic information in the given category.
The default verbosity if com.rti.ndds.config.Logger.set verbosity (p. 1164)
and com.rti.ndds.config.Logger.set verbosity by category (p. 1165) are
never called is com.rti.ndds.config.LogVerbosity.NDDS CONFIG LOG VERBOSITY ERROR (p. 1178).
8.145.2.4
void set verbosity (LogVerbosity verbosity)
Set the verbosity at which RTI Connext will log diagnostic information.
8.145 Logger Class Reference
1165
Note:
Logging at high verbosities will be detrimental to your applications performance.
Your default setting should typically remain at com.rti.ndds.config.LogVerbosity.NDDS CONFIG LOG VERBOSITY WARNING (p. 1178) or below. (The default verbosity if
you never set it is com.rti.ndds.config.LogVerbosity.NDDS CONFIG LOG VERBOSITY ERROR (p. 1178).)
8.145.2.5
void set verbosity by category (LogCategory category,

LogVerbosity verbosity)
Set the verbosity at which RTI Connext will log diagnostic information in the
given category.
8.145.2.6
File get output file ()
Get the file to which the logged output is redirected.

If
no
output
file
has
been
registered
through
com.rti.ndds.config.Logger.set output file (p. 1165), this method will
return NULL. In this case, logged output will on most platforms go to standard
out as if through printf.
8.145.2.7
void set output file (File out) throws IOException
Set the file to which the logged output is redirected.

The file passed may be NULL, in which case further logged output will be
redirected to the platform-specific default output location (standard out on
most platforms).
8.145.2.8
LoggerDevice get output device ()
Return the user device registered with the logger.

Returns:
Registered user device or NULL if no user device is registered.
8.145.2.9
void set output device (LoggerDevice device) throws

IOException
Register a com.rti.ndds.config.LoggerDevice (p. 1167).

Register the specified logging device with the logger.
1166
Class Documentation
There can be at most only one device registered with the logger at any given
time.
When a device is installed, the logger will stop sending the log messages to the
standard output and to the file set with com.rti.ndds.config.Logger.set output file (p. 1165).
To remove an existing device, use this method with NULL as the device parameter. After a device is removed the logger will continue sending log messages to
the standard output and to the output file.
To replace an existing device with a new device, use this method providing the
new device as the device parameter.
When a device is unregistered (by setting it to
com.rti.ndds.config.LoggerDevice
(p. 1167)
calls
the
com.rti.ndds.config.LoggerDevice.close (p. 1168).
NULL),
method
Parameters:
device <<in>> ( p. 279) Logging device.
8.145.2.10
LogPrintFormat get print format ()
Get the current message format that RTI Connext is using to log diagnostic
information.
If com.rti.ndds.config.Logger.set print format (p. 1166) is never called,
the default format is com.rti.ndds.config.LogPrintFormat.NDDS CONFIG LOG PRINT FORMAT DEFAULT (p. 1175).
8.145.2.11
boolean set print format (LogPrintFormat print format)
Set the message format that RTI Connext will use to log diagnostic information.
8.146 LoggerDevice Interface Reference
8.146
1167
LoggerDevice Interface Reference
<<interface>> ( p. 279) Logging device interface. Use for user-defined logging

devices.

void close ()
Close the logging device.
Package Functions
void write (LogMessage message)
Write a log message to a specified logging device.
8.146.1
<<interface>> ( p. 279) Logging device interface. Use for user-defined logging

devices.
Interface for handling log messages.
By default, the logger sends the log messages generated by RTI Connext to the
standard output.
You can use the method com.rti.ndds.config.Logger.set output file
(p. 1165) to redirect the log messages to a file.
To further customize the management of generated log messages, the logger
offers the method com.rti.ndds.config.Logger.set output device (p. 1165)
that allows you to install a user-defined logging device.
The logging device installed by the user must implement this interface.
8.146.2
8.146.2.1
void write (LogMessage message) [package]
Write a log message to a specified logging device.

Parameters:
message <<in>> ( p. 279) Message to log.
1168
8.146.2.2
Class Documentation
void close ()
Close the logging device.
8.147 LoggingQosPolicy Class Reference
8.147
1169
LoggingQosPolicy Class Reference

Inheritance diagram for LoggingQosPolicy::
Public Attributes
LogVerbosity verbosity
LogCategory category
LogPrintFormat print format

String output file

Specifies the file to which log messages will be redirected to.
8.147.1

All the properties associated with RTI Connext logging can be configured using
this QoS policy. This allows you to configure logging using XML QoS Profiles.
See the Troubleshooting chapter in the Users Manual for details.
Entity:
Properties:
RxO (p. 101) = NO
Changeable (p. 102) = Changeable (p. 102)
8.147.2
8.147.2.1
LogVerbosity verbosity

1170
Class Documentation
[default]
com.rti.ndds.config.LogVerbosity.NDDS CONFIG LOG VERBOSITY ERROR (p. 1178)
8.147.2.2
LogCategory category

[default] Logging will be enabled for all the categories.
8.147.2.3
LogPrintFormat print format

[default]
com.rti.ndds.config.LogPrintFormat.NDDS CONFIG LOG PRINT FORMAT DEFAULT (p. 1175).
8.147.2.4
String output file
Specifies the file to which log messages will be redirected to.

If the value of ouput file is set to NULL, log messages will sent to standard
output.
[default] NULL
8.148 LogLevel Class Reference
8.148
1171
LogLevel Class Reference

device.
Inheritance diagram for LogLevel::

static final LogLevel NDDS CONFIG LOG LEVEL ERROR
The message describes an error.
static
final
WARNING
LogLevel
NDDS CONFIG LOG LEVEL -
The message describes a warning.
static final LogLevel NDDS CONFIG LOG LEVEL STATUS LOCAL

The message contains info about the lifecycles of local RTI Connext objects
will be logged.
static final LogLevel NDDS CONFIG LOG LEVEL STATUS REMOTE

The message contains info about the lifecycles of remote RTI Connext objects
will be logged.
static final LogLevel NDDS CONFIG LOG LEVEL DEBUG

The message contains debug info that might be relevant to your application.
8.148.1

device.
8.148.2
8.148.2.1
final LogLevel NDDS CONFIG LOG LEVEL ERROR

[static]
The message describes an error.

1172
Class Documentation
An error indicates something wrong in the functioning of RTI Connext. The

most common cause of errors is incorrect configuration.
8.148.2.2
final LogLevel NDDS CONFIG LOG LEVEL WARNING [static]
The message describes a warning.

A warning indicates that RTI Connext is taking an action that may or may not
be what you intended. Some configuration information is also logged at this
verbosity to aid in debugging.
8.148.2.3
final LogLevel NDDS CONFIG LOG LEVEL STATUS LOCAL [static]
The message contains info about the lifecycles of local RTI Connext objects will
be logged.
8.148.2.4
final LogLevel NDDS CONFIG LOG LEVEL STATUS REMOTE [static]
The message contains info about the lifecycles of remote RTI Connext objects
will be logged.
8.148.2.5
final LogLevel NDDS CONFIG LOG LEVEL DEBUG

[static]
The message contains debug info that might be relevant to your application.
8.149 LogMessage Class Reference
8.149
1173
LogMessage Class Reference
Log message.
Inherits Struct.
Public Attributes
String text
Message text.
LogLevel level
Message level.
8.149.1
Log message.
8.149.2
8.149.2.1
String text
Message text.
8.149.2.2
LogLevel level
Message level.
1174
Class Documentation
8.150
LogPrintFormat Class Reference

Inheritance diagram for LogPrintFormat::

static final LogPrintFormat
FORMAT DEFAULT
NDDS CONFIG LOG PRINT -
Print message, method name, and activity context (default).

FORMAT TIMESTAMPED
Print message, method name, activity context, and timestamp.

FORMAT VERBOSE
Print message with all available context information (includes thread identifier, activity context).
static final LogPrintFormat NDDS CONFIG LOG PRINT FORMAT VERBOSE TIMESTAMPED
Print message with all available context information, and timestamp.

FORMAT DEBUG
Print a set of field that may be useful for internal debug.

FORMAT MINIMAL
Print only message number and method name.

FORMAT MAXIMAL
Print all available fields.
8.150.1

8.150 LogPrintFormat Class Reference
8.150.2
8.150.2.1
final LogPrintFormat NDDS CONFIG LOG PRINT FORMAT DEFAULT

[static]
1175
Print message, method name, and activity context (default).
8.150.2.2
final LogPrintFormat NDDS CONFIG LOG PRINT FORMAT TIMESTAMPED

[static]
Print message, method name, activity context, and timestamp.
8.150.2.3
final LogPrintFormat NDDS CONFIG LOG PRINT FORMAT VERBOSE

[static]
Print message with all available context information (includes thread identifier,
activity context).
8.150.2.4
final LogPrintFormat NDDS CONFIG LOG PRINT FORMAT VERBOSE TIMESTAMPED

[static]
Print message with all available context information, and timestamp.
8.150.2.5
final LogPrintFormat NDDS CONFIG LOG PRINT FORMAT DEBUG [static]
Print a set of field that may be useful for internal debug.
8.150.2.6
final LogPrintFormat NDDS CONFIG LOG PRINT FORMAT MINIMAL

[static]
Print only message number and method name.

1176
8.150.2.7
Class Documentation
final LogPrintFormat NDDS CONFIG LOG PRINT FORMAT MAXIMAL
[static]
Print all available fields.
8.151 LogVerbosity Class Reference
8.151
1177
LogVerbosity Class Reference

Inheritance diagram for LogVerbosity::

static final LogVerbosity NDDS CONFIG LOG VERBOSITY SILENT
No further output will be logged.
static final LogVerbosity NDDS CONFIG LOG VERBOSITY ERROR

Only error messages will be logged.
static final LogVerbosity NDDS CONFIG LOG VERBOSITY WARNING

Both error and warning messages will be logged.
static final LogVerbosity NDDS CONFIG LOG VERBOSITY STATUS LOCAL

Errors, warnings, and verbose information about the lifecycles of local RTI
Connext objects will be logged.
static final LogVerbosity NDDS CONFIG LOG VERBOSITY STATUS REMOTE

Errors, warnings, and verbose information about the lifecycles of remote RTI
static final LogVerbosity NDDS CONFIG LOG VERBOSITY STATUS ALL

Errors, warnings, verbose information about the lifecycles of local and remote
RTI Connext objects, and periodic information about RTI Connext threads
will be logged.
8.151.1

1178
Class Documentation
8.151.2
8.151.2.1
final LogVerbosity NDDS CONFIG LOG VERBOSITY SILENT [static]
No further output will be logged.

8.151.2.2
final LogVerbosity NDDS CONFIG LOG VERBOSITY ERROR [static]
Only error messages will be logged.

An error indicates something wrong in the functioning of RTI Connext. The
most common cause of errors is incorrect configuration.
8.151.2.3
final LogVerbosity NDDS CONFIG LOG VERBOSITY WARNING [static]
Both error and warning messages will be logged.

A warning indicates that RTI Connext is taking an action that may or may not
be what you intended. Some configuration information is also logged at this
verbosity to aid in debugging.
8.151.2.4
final LogVerbosity NDDS CONFIG LOG VERBOSITY STATUS LOCAL

[static]
Errors, warnings, and verbose information about the lifecycles of local RTI
8.151.2.5
final LogVerbosity NDDS CONFIG LOG VERBOSITY STATUS REMOTE

[static]
Errors, warnings, and verbose information about the lifecycles of remote RTI
8.151.2.6
final LogVerbosity NDDS CONFIG LOG VERBOSITY STATUS ALL [static]
Errors, warnings, verbose information about the lifecycles of local and remote
RTI Connext objects, and periodic information about RTI Connext threads will
be logged.
8.152 LongDoubleSeq Class Reference
8.152
1179
LongDoubleSeq Class Reference

Inheritance diagram for LongDoubleSeq::

LongDoubleSeq ()
Constructs an empty sequence of long doubles with an initial maximum of
zero.
LongDoubleSeq (int initialMaximum)

Constructs an empty sequence of long doubles with the given initial maximum.
LongDoubleSeq (double[ ] doubles)

Constructs a new sequence containing the given long doubles.
8.152.1

Instantiates:
See also:
com.rti.dds.infrastructure.LongDouble
8.152.2
8.152.2.1
LongDoubleSeq ()
Constructs an empty sequence of long doubles with an initial maximum of zero.

1180
8.152.2.2
Class Documentation
LongDoubleSeq (int initialMaximum)
Constructs an empty sequence of long doubles with the given initial maximum.
8.152.2.3
LongDoubleSeq (double[ ] doubles)
Constructs a new sequence containing the given long doubles.

Parameters:
doubles the initial contents of this sequence
8.153 LongSeq Class Reference
8.153
1181
LongSeq Class Reference

long >.
Inheritance diagram for LongSeq::

LongSeq ()
Constructs an empty sequence of long integers with an initial maximum of
zero.
LongSeq (int initialMaximum)

Constructs an empty sequence of long integers with the given initial maximum.
LongSeq (long[ ] longs)

Constructs a new sequence containing the given longs.
boolean addAllLong (long[ ] elements, int offset, int length)

boolean addAllLong (long[ ] elements)

void addLong (long element)
void addLong (int index, long element)

long getLong (int index)

Returns the long at the given index.
long setLong (int index, long element)

Set the new long at the given index and return the old long.
void setLong (int dstIndex, long[ ] elements, int srcIndex, int length)
1182
Class Documentation
long[ ] toArrayLong (long[ ] array)
int getMaximum ()
sequence.

A wrapper for getLong(int) ( p. 1183) that return a java.lang.Long.

A wrapper for setLong() ( p. 1184).

A wrapper for addLong(int, int).
8.153.1

long >.
Instantiates:
See also:
long
8.153.2
8.153.2.1
LongSeq ()
Constructs an empty sequence of long integers with an initial maximum of zero.
8.153.2.2
LongSeq (int initialMaximum)
Constructs an empty sequence of long integers with the given initial maximum.

8.153.2.3
1183
LongSeq (long[ ] longs)
Constructs a new sequence containing the given longs.

Parameters:
longs the initial contents of this sequence
Exceptions:
8.153.3
8.153.3.1
boolean addAllLong (long[ ] elements, int offset, int

length)
Exceptions:
8.153.3.2
boolean addAllLong (long[ ] elements)
Exceptions:
8.153.3.3
void addLong (long element)

8.153.3.4
void addLong (int index, long element)
8.153.3.5
long getLong (int index)
Returns the long at the given index.

1184
Class Documentation
Exceptions:
8.153.3.6
long setLong (int index, long element)
Set the new long at the given index and return the old long.
Exceptions:
8.153.3.7
void setLong (int dstIndex, long[ ] elements, int


Parameters:
Exceptions:
8.153.3.8
long [ ] toArrayLong (long[ ] array)

Parameters:
into instead.
Returns:

8.153.3.9
1185
int getMaximum ()
elements.
first created.
Returns:
See also:
8.153.3.10
A wrapper for getLong(int) (p. 1183) that return a java.lang.Long.

See also:
8.153.3.11
A wrapper for setLong() (p. 1184).

Exceptions:
ClassCastException if the element is not of type Long.
See also:
1186
8.153.3.12
Class Documentation
A wrapper for addLong(int, int).

Exceptions:
ClassCastException if the element is not of type Long.
See also:
8.154 MultiChannelQosPolicy Class Reference
8.154
1187
MultiChannelQosPolicy Class Reference
Configures the ability of a DataWriter to send data on different multicast groups

(addresses) based on the value of the data.
Inheritance diagram for MultiChannelQosPolicy::
Public Attributes
final ChannelSettingsSeq channels
A sequence of com.rti.dds.infrastructure.ChannelSettings t ( p. 454)
used to configure the channels properties. If the length of the sequence is
zero, the QoS policy will be ignored.
String filter name

Name of the filter class used to describe the filter expressions of a MultiChannel DataWriter.
8.154.1
Configures the ability of a DataWriter to send data on different multicast groups

(addresses) based on the value of the data.
This QoS policy is used to partition the data published by a
com.rti.dds.publication.DataWriter (p. 557) across multiple channels.
A channel is defined by a filter expression and a sequence of multicast locators.
Entity:
Properties:
RxO (p. 101) = N/A
8.154.2
Usage
By using this QoS, a com.rti.dds.publication.DataWriter (p. 557) can be

configured to send data to different multicast groups based on the content of
the data. Using syntax similar to those used in Content-Based Filters, you can
associate different multicast addresses with filter expressions that operate on
1188
Class Documentation
the values of the fields within the data. When your applications code calls
com.rti.ndds.example.FooDataWriter.write (p. 1021), data is sent to any
multicast address for which the data passes the filter.
Multi-channel DataWriters can be used to trade off network bandwidth with the
unnecessary processing of unwanted data for situations where there are multiple
DataReaders that are interested in different subsets of data that come from the
same data stream (Topic). For example, in Financial applications, the data
stream may be quotes for different stocks at an exchange. Applications usually
only want to receive data (quotes) for only a subset of the stocks being traded.
In tracking applications, a data stream may carry information on hundreds
or thousands of objects being tracked, but again, applications may only be
interested in a subset.
The problem is that the most efficient way to deliver data to multiple applications is to use multicast, so that a data value is only sent once on the network
for any number of subscribers to the data. However, using multicast, an application will receive all of the data sent and not just the data in which it is
interested, thus extra CPU time is wasted to throw away unwanted data. With
this QoS, you can analyze the data-usage patterns of your applications and optimize network vs. CPU usage by partitioning the data into multiple multicast
streams. While network bandwidth is still being conserved by sending data only
once using multicast, most applications will only need to listen to a subset of
the multicast addresses and receive a reduced amount of unwanted data.
Your system can gain more of the benefits of using multiple multicast groups if
your network uses Layer 2 Ethernet switches. Layer 2 switches can be configured
to only route multicast packets to those ports that have added membership
to specific multicast groups. Using those switches will ensure that only the
multicast packets used by applications on a node are routed to the node; all
others are filtered-out by the switch.
8.154.3
8.154.3.1
final ChannelSettingsSeq channels
A sequence of com.rti.dds.infrastructure.ChannelSettings t (p. 454) used

to configure the channels properties. If the length of the sequence is zero, the
QoS policy will be ignored.
A sequence length of zero indicates the com.rti.dds.infrastructure.MultiChannelQosPolicy
(p. 1187) is not in use.
The
sequence
length
cannot
be
greater
than
com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.channel seq max length (p. 793).
8.154 MultiChannelQosPolicy Class Reference

8.154.3.2
1189
String filter name
Name of the filter class used to describe the filter expressions of a MultiChannel
DataWriter.
The
following
builtin
filters
are
supported:
com.rti.dds.domain.DomainParticipant.SQLFILTER NAME (p. 155)
and com.rti.dds.domain.DomainParticipant.STRINGMATCHFILTER NAME (p. 155).
[default] com.rti.dds.domain.DomainParticipant.STRINGMATCHFILTER NAME (p. 155)
1190
Class Documentation
8.155
MultiTopic Interface Reference
[Not supported (optional)] <<interface>> ( p. 279) A specialization of

com.rti.dds.topic.TopicDescription (p. 1561) that allows subscriptions that
combine/filter/rearrange data coming from several topics.
Inheritance diagram for MultiTopic::

String get subscription expression ()
Get the expression for this com.rti.dds.topic.MultiTopic ( p. 1190).


8.155.1
[Not supported (optional)] <<interface>> ( p. 279) A specialization of

com.rti.dds.topic.TopicDescription (p. 1561) that allows subscriptions that
combine/filter/rearrange data coming from several topics.
com.rti.dds.topic.MultiTopic (p. 1190) allows a more sophisticated subscription (p. 353) that can select and combine data received from multiple topics into a single resulting type (specified by the inherited type name).
The data will then be filtered (selection) and possibly re-arranged (aggregation/projection) according to a subscription expression with parameters
expression parameters.
The subscription expression is a string that identifies the selection
and re-arrangement of data from the associated topics. It is similar to an
SQL statement where the SELECT part provides the fields to be kept,
the FROM part provides the names of the topics that are searched for
those fields, and the WHERE clause gives the content filter. The Topics
combined may have different types but they are restricted in that the type
of the fields used for the NATURAL JOIN operation must be the same.
8.155 MultiTopic Interface Reference
1191
The expression parameters attribute is a sequence of strings that give

values to the parameters (i.e. %n tokens) in the subscription expression. The number of supplied parameters must fit with the requested values in the subscription expression (i.e. the number of n
tokens).
com.rti.dds.subscription.DataReader (p. 487) entities associated
with a com.rti.dds.topic.MultiTopic (p. 1190) are alerted of data
modifications by the usual com.rti.dds.infrastructure.Listener
(p. 1130) or com.rti.dds.infrastructure.WaitSet (p. 1709) /
com.rti.dds.infrastructure.Condition (p. 464) mechanisms whenever
modifications occur to the data associated with any of the topics relevant
to the com.rti.dds.topic.MultiTopic (p. 1190).
Note that the source for data may not be restricted to a single topic (p. 359).
com.rti.dds.subscription.DataReader (p. 487) entities associated with a
com.rti.dds.topic.MultiTopic (p. 1190) may access instances that are constructed at the com.rti.dds.subscription.DataReader (p. 487) side from
the instances written by multiple com.rti.dds.publication.DataWriter
(p. 557) entities. The com.rti.dds.topic.MultiTopic (p. 1190) access instance
will begin to exist as soon as all the constituting com.rti.dds.topic.Topic
(p. 1545) instances are in existence. The view state and instance state is
computed from the corresponding states of the constituting instances:
The view state of the com.rti.dds.topic.MultiTopic (p. 1190) instance is com.rti.dds.subscription.ViewStateKind.ViewStateKind.NEW VIEW STATE if at least one of the constituting instances has view state
=
com.rti.dds.subscription.ViewStateKind.ViewStateKind.NEW VIEW STATE.
Otherwise,
it
will
be
com.rti.dds.subscription.ViewStateKind.ViewStateKind.NOT NEW VIEW STATE.
The instance state of the com.rti.dds.topic.MultiTopic (p. 1190) instance is com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.ALIVE INTANCE STATE if the instance state of all the constituting
(p. 1545)
instances
is
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.ALIVE INTANCE STATE. It is com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE DISPOSED INSTANCE STATE if at least one of the
constituting
(p. 1545)
instances
is
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE DISPOSED INSTANCE STATE.
Otherwise,
it
is
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE NO WRITERS INSTANCE STATE.
1192
Class Documentation
Queries and Filters Syntax (p. 286) describes the syntax of subscription expression and expression parameters.
8.155.2
8.155.2.1
String get subscription expression ()
Get the expression for this com.rti.dds.topic.MultiTopic (p. 1190).

The expressions syntax is described in the DDS specification. It is specified
when the com.rti.dds.topic.MultiTopic (p. 1190) is created.
Returns:
subscription expression
(p. 1190).
8.155.2.2
of
the

The expressions syntax is described in the DDS specification.
The parameters is either specified on the last successful call to
com.rti.dds.topic.MultiTopic.set expression parameters
(p. 1192),
or
if
com.rti.dds.topic.MultiTopic.set expression parameters
(p. 1192) was never called, the parameters specified when the
com.rti.dds.topic.MultiTopic (p. 1190) was created.
Parameters:
parameters <<inout>> ( p. 279) Fill in this sequence with the expression parameters. Cannot be NULL.
Exceptions:
8.155.2.3

Changes
the
com.rti.dds.topic.MultiTopic (p. 1190).
associated
with
the
8.155 MultiTopic Interface Reference
1193
Parameters:
parameters <<in>> ( p. 279) the filter expression parameters
Returns:
One of the Standard Return Codes (p. 108).
1194
Class Documentation
8.156
ObjectHolder Class Reference
<<eXtension>> ( p. 278) Holder of object instance
Public Attributes
Object value = null
Instance of Object embedded in ObjectHolder ( p. 1194).
8.156.1
<<eXtension>> ( p. 278) Holder of object instance

Holder of object instance. Can be used as an output parameter in a method for
non-primitive types.
8.156.2
8.156.2.1
Object value = null
Instance of Object embedded in ObjectHolder (p. 1194).
8.157 OfferedDeadlineMissedStatus Class Reference
8.157
1195
OfferedDeadlineMissedStatus Class Reference

Inherits Status.
Public Attributes
int total count
Total
cumulative
count
of
the
number
of
times
the
com.rti.dds.publication.DataWriter ( p. 557) failed to write within
its offered deadline.

The incremental changes in total count since the last time the listener was
final InstanceHandle t last instance handle

Handle to the last instance in the com.rti.dds.publication.DataWriter
( p. 557) for which an offered deadline was missed.
8.157.1

Entity:
Listener:
The deadline that the com.rti.dds.publication.DataWriter (p. 557) has
committed through its com.rti.dds.infrastructure.DeadlineQosPolicy
(p. 628) was not respected for a specific instance.
1196
Class Documentation
8.157.2
8.157.2.1
int total count
Total
cumulative
count
of
the
number
of
times
the
com.rti.dds.publication.DataWriter (p. 557) failed to write within its
offered deadline.
Missed deadlines accumulate; that is, each deadline period the total count will
be incremented by one.
8.157.2.2
The incremental changes in total count since the last time the listener was called
8.157.2.3
Handle to the last instance in the com.rti.dds.publication.DataWriter

(p. 557) for which an offered deadline was missed.
8.158 OfferedIncompatibleQosStatus Class Reference
8.158
1197
OfferedIncompatibleQosStatus Class Reference

Inherits Status.
Public Attributes
int total count
Total
cumulative
number
of
times
the
concerned
( p. 557)
discovered
a
for
the
same
( p. 487)
( p. 1545),
common
partition
with
a
requested QoS that is incompatible with that offered by the

QosPolicyId t last policy id

The com.rti.dds.infrastructure.QosPolicyId t ( p. 1305) of one of the
policies that was found to be incompatible the last time an incompatibility
was detected.
final QosPolicyCountSeq policies

A list containing for each policy the total number of times that
the concerned com.rti.dds.publication.DataWriter ( p. 557) discovered a com.rti.dds.subscription.DataReader ( p. 487) for the
same com.rti.dds.topic.Topic ( p. 1545) and common partition
with a requested QoS that is incompatible with that offered by the
8.158.1

Entity:
1198
Class Documentation
Listener:
The qos policy value was incompatible with what was requested.
8.158.2
8.158.2.1
int total count
Total
cumulative
number
of
times
the
concerned
(p. 557)
discovered
a
for
the
same
(p. 487)
com.rti.dds.topic.Topic (p. 1545), common partition with a requested QoS that is incompatible with that offered by the
8.158.2.2
8.158.2.3
The com.rti.dds.infrastructure.QosPolicyId t (p. 1305) of one of the policies that was found to be incompatible the last time an incompatibility was
detected.
8.158.2.4
A list containing for each policy the total number of times that
the
concerned
(p. 557)
discovered a com.rti.dds.subscription.DataReader (p. 487) for the
same com.rti.dds.topic.Topic (p. 1545) and common partition with
a requested QoS that is incompatible with that offered by the
8.159 OwnershipQosPolicy Class Reference
8.159
1199
OwnershipQosPolicy Class Reference
Specifies
whether
it
is
allowed
for
multiple
Inheritance diagram for OwnershipQosPolicy::
Public Attributes
OwnershipQosPolicyKind kind
The kind of ownership.
8.159.1
Specifies
whether
it
is
allowed
for
multiple
Entity:
Status:
com.rti.dds.infrastructure.StatusKind.StatusKind.OFFERED INCOMPATIBLE QOS STATUS, com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED INCOMPATIBLE QOS STATUS
Properties:
RxO (p. 101) = YES
See also:
OWNERSHIP STRENGTH (p. 88)
8.159.2
Usage
Along with the OWNERSHIP STRENGTH (p. 88), this QoS policy
specifies if com.rti.dds.subscription.DataReader (p. 487) entities can reGenerated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
1200
Class Documentation
ceive updates to the same instance (identified by its key) from multiple
com.rti.dds.publication.DataWriter (p. 557) entities at the same time.
There are two kinds of ownership, selected by the setting of the kind: SHARED
and EXCLUSIVE.
8.159.2.1
SHARED ownership
com.rti.dds.infrastructure.OwnershipQosPolicyKind.OwnershipQosPolicyKind.SHARED OWNERSHIP QOS indicates that RTI Connext does not enforce unique ownership for each instance. In this case, multiple writers can update the same data
type instance. The subscriber to the com.rti.dds.topic.Topic (p. 1545) will be
able to access modifications from all com.rti.dds.publication.DataWriter
(p. 557) objects, subject to the settings of other QoS that may filter particular
samples (e.g. the TIME BASED FILTER (p. 117) or HISTORY (p. 79)
policy). In any case, there is no filtering of modifications made based on the
identity of the com.rti.dds.publication.DataWriter (p. 557) that causes
the modification.
8.159.2.2
EXCLUSIVE ownership
com.rti.dds.infrastructure.OwnershipQosPolicyKind.OwnershipQosPolicyKind.EXCLUSIVE OWNERSHIP QOS indicates that each instance of a data type can only be
modified by one com.rti.dds.publication.DataWriter (p. 557). In other
words, at any point in time, a single com.rti.dds.publication.DataWriter
(p. 557) owns each instance and is the only one whose modifications will be visible to the com.rti.dds.subscription.DataReader
(p. 487) objects.
The owner is determined by selecting the
com.rti.dds.publication.DataWriter (p. 557) with the highest value of
the
com.rti.dds.infrastructure.OwnershipStrengthQosPolicy.value
(p. 1210) that is currently alive, as defined by the LIVELINESS (p. 82) policy,
and has not violated its DEADLINE (p. 52) contract with regards to the data
instance.
Ownership can therefore change as a result of:
a com.rti.dds.publication.DataWriter (p. 557) in the system with a
higher value of the strength that modifies the instance,
a
change
in
the
strength
value
of
the
com.rti.dds.publication.DataWriter (p. 557) that owns the instance,
and
a change in the liveliness of the com.rti.dds.publication.DataWriter
(p. 557) that owns the instance.
1201
a deadline with regards to the instance that is missed by the

com.rti.dds.publication.DataWriter (p. 557) that owns the instance.
The behavior of the system is as if the determination was made independently by each com.rti.dds.subscription.DataReader (p. 487). Each
com.rti.dds.subscription.DataReader (p. 487) may detect the change of
ownership at a different time. It is not a requirement that at a particular
point in time all the com.rti.dds.subscription.DataReader (p. 487) objects
for that com.rti.dds.topic.Topic (p. 1545) have a consistent picture of who
owns each instance.
It is also not a requirement that the com.rti.dds.publication.DataWriter
(p. 557) objects are aware of whether they own a particular instance. There
is no error or notification given to a com.rti.dds.publication.DataWriter
(p. 557) that modifies an instance it does not currently own.
The requirements are chosen to (a) preserve the decoupling of publishers and
subscriber, and (b) allow the policy to be implemented efficiently.
It is possible that multiple com.rti.dds.publication.DataWriter (p. 557)
objects with the same strength modify the same instance. If this occurs
RTI Connext will pick one of the com.rti.dds.publication.DataWriter
(p. 557) objects as the owner. It is not specified how the owner is selected. However, the algorithm used to select the owner guarantees that all
com.rti.dds.subscription.DataReader (p. 487) objects will make the same
choice of the particular com.rti.dds.publication.DataWriter (p. 557) that is
the owner. It also guarantees that the owner remains the same until there is
a change in strength, liveliness, the owner misses a deadline on the instance,
or a new com.rti.dds.publication.DataWriter (p. 557) with higher same
strength, or a new com.rti.dds.publication.DataWriter (p. 557) with same
strength that should be deemed the owner according to the policy of the Service,
modifies the instance.
Exclusive ownership is on an instance-by-instance basis.
That
is, a subscriber can receive values written by a lower strength
com.rti.dds.publication.DataWriter (p. 557) as long as they affect instances whose values have not been set by the higher-strength
8.159.3
Compatibility
The value of the com.rti.dds.infrastructure.OwnershipQosPolicyKind

(p. 1207) offered must exactly match the one requested or else they are considered incompatible.
1202
Class Documentation
8.159.4
RELATIONSHIP BETWEEN REGISTRATION,

LIVELINESS and OWNERSHIP
The need for registering/unregistering instances stems from two use cases:
Ownership resolution on redundant systems
Detection of loss in topological connectivity
These two use cases also illustrate the semantic differences between the
com.rti.ndds.example.FooDataWriter.unregister instance (p. 1016) and
com.rti.ndds.example.FooDataWriter.dispose (p. 1027).
8.159.4.1
Ownership Resolution on Redundant Systems
It is expected that users may use DDS to set up redundant systems where multiple com.rti.dds.publication.DataWriter (p. 557) entities are capable of writing the same instance. In this situation, the
com.rti.dds.publication.DataWriter (p. 557) entities are configured such
that:
Either both are writing the instance constantly
Or else they use some mechanism to classify each other as primary
and secondary, such that the primary is the only one writing, and the
secondary monitors the primary and only writes when it detects that the
primary writer is no longer writing.
Both cases above use the com.rti.dds.infrastructure.OwnershipQosPolicyKind.OwnershipQosPolicyKind.E

OWNERSHIP QOS and arbitrate themselves by means of the
com.rti.dds.infrastructure.OwnershipStrengthQosPolicy
(p. 1209).
Regardless of the scheme, the desired behavior from the
com.rti.dds.subscription.DataReader (p. 487) point of view is that
com.rti.dds.subscription.DataReader (p. 487) normally receives data from
the primary unless the primary writer stops writing, in which case the
com.rti.dds.subscription.DataReader (p. 487) starts to receive data from
the secondary com.rti.dds.publication.DataWriter (p. 557).
This
approach
requires
some
mechanism
to
detect
that
a
com.rti.dds.publication.DataWriter (p. 557) (the primary) is no longer
writing the data as it should. There are several reasons why this may happen
and all must be detected (but not necessarily distinguished):
crash The writing process is no longer running (e.g. the whole application has
crashed)
1203
connectivity loss Connectivity to the writing application has been lost (e.g. network disconnection)
application fault The application logic that was writing the data is faulty and has stopped
calling com.rti.ndds.example.FooDataWriter.write (p. 1021).
Arbitrating from a com.rti.dds.publication.DataWriter (p. 557) to one of
a higher strength is simple and the decision can be taken autonomously by the
com.rti.dds.subscription.DataReader (p. 487). Switching ownership from
a higher strength com.rti.dds.publication.DataWriter (p. 557) to one of a
lower strength com.rti.dds.publication.DataWriter (p. 557) requires that
the com.rti.dds.subscription.DataReader (p. 487) can make a determination that the stronger com.rti.dds.publication.DataWriter (p. 557) is no
longer writing the instance.
Case where the data is periodically updated This determination is reasonably simple when the data is being written periodically
at some rate. The com.rti.dds.publication.DataWriter (p. 557) simply states its offered com.rti.dds.infrastructure.DeadlineQosPolicy
(p. 628)
(maximum
interval
between
updates)
and
the
(p. 487)
automatically
monitors
that
the
(p. 557)
indeed
updates
the
instance
at
least
once
per
com.rti.dds.infrastructure.DeadlineQosPolicy.period (p. 630).
If
the deadline is missed, the com.rti.dds.subscription.DataReader
(p. 487) considers the com.rti.dds.publication.DataWriter (p. 557)
not alive and automatically gives ownership to the next highest-strength
com.rti.dds.publication.DataWriter (p. 557) that is alive.
Case where data is not periodically updated The case where the
com.rti.dds.publication.DataWriter (p. 557) is not writing data periodically is also a very important use-case. Since the instance is not being
updated at any fixed period, the deadline mechanism cannot be used
to determine ownership. The liveliness solves this situation. Ownership
is maintained while the com.rti.dds.publication.DataWriter (p. 557) is
alive and for the com.rti.dds.publication.DataWriter (p. 557) to be
alive it must fulfill its com.rti.dds.infrastructure.LivelinessQosPolicy
(p. 1140) contract.
The different means to renew liveliness (automatic,
manual) combined by the implied renewal each time data is written
handle the three conditions above [crash], [connectivity loss], and [application fault]. Note that to handle [application fault], LIVELINESS must be
com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.MANUAL BY TOPIC LIVELINESS QOS. The com.rti.dds.publication.DataWriter
(p. 557) can retain ownership by periodically writing data or else calling
1204
Class Documentation
assert liveliness if it has no data to write. Alternatively if only protection

against [crash] or [connectivity loss] is desired, it is sufficient that some task
on the com.rti.dds.publication.DataWriter (p. 557) process periodically
writes data or calls com.rti.dds.domain.DomainParticipant.assert liveliness (p. 718).
However, this scenario requires that the
com.rti.dds.subscription.DataReader (p. 487) knows what instances
are being written by the com.rti.dds.publication.DataWriter (p. 557).
That is the only way that the com.rti.dds.subscription.DataReader
(p. 487) deduces the ownership of specific instances from the fact that the
com.rti.dds.publication.DataWriter (p. 557) is still alive. Hence the
need for the com.rti.dds.publication.DataWriter (p. 557) to register
and unregister instances. Note that while registration can be done lazily
the first time the com.rti.dds.publication.DataWriter (p. 557) writes the
instance, unregistration, in general, cannot. Similar reasoning will lead
to the fact that unregistration will also require a message to be sent to the
8.159.4.2
Detection of Loss in Topological Connectivity
There are applications that are designed in such a way that their correct operation requires some minimal topological connectivity, that is, the writer needs
to have a minimum number of readers or alternatively the reader must have a
minimum number of writers.
A common scenario is that the application does not start doing its logic until it
knows that some specific writers have the minimum configured readers (e.g the
alarm monitor is up).
A more common scenario is that the application logic will wait until some writers
appear that can provide some needed source of information (e.g. the raw sensor
data that must be processed).
Furthermore, once the application is running it is a requirement that this
minimal connectivity (from the source of the data) is monitored and the
application informed if it is ever lost. For the case where data is being
written periodically, the com.rti.dds.infrastructure.DeadlineQosPolicy
(p. 628) and the on deadline missed listener provides the notification.
The case where data is not periodically updated requires the use of
the com.rti.dds.infrastructure.LivelinessQosPolicy (p. 1140) in combination with register instance/unregister instance to detect whether the
connectivity has been lost, and the notification is provided by
means of com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE NO WRITERS INSTANCE STATE.
In terms of the required mechanisms, the scenario is very similar to the case
of maintaining ownership. In both cases, the reader needs to know whether a
writer is still managing the current value of an instance even though it is not
1205
continually writing it and this knowledge requires the writer to keep its liveliness
plus some means to know which instances the writer is currently managing
(i.e. the registered instances).
8.159.4.3
Semantic Difference between unregister instance and dispose
com.rti.ndds.example.FooDataWriter.dispose (p. 1027) is semantically different from com.rti.ndds.example.FooDataWriter.unregister instance (p. 1016).
a
(p. 1027) indicates that the data instance no longer exists (e.g.
track that has disappeared, a simulation entity that has been destroyed, a record entry that has been deleted, etc.)
whereas
(p. 1016)
indicates that the writer is no longer taking responsibility for updating the
value of the instance.
Deleting a com.rti.dds.publication.DataWriter (p. 557) is equivalent to unregistering all the instances it was writing, but is not the same as disposing
all the instances.
For
a
(p. 1545)
with
com.rti.dds.infrastructure.OwnershipQosPolicyKind.OwnershipQosPolicyKind.EXCLUSIVE OWNERSHIP QOS, if the current owner of an instance disposes it, the
readers accessing the instance will see the instance state as being DISPOSED and not see the values being written by the weaker writer (even
after the stronger one has disposed the instance). This is because the
com.rti.dds.publication.DataWriter (p. 557) that owns the instance is
saying that the instance no longer exists (e.g. the master of the database is
saying that a record has been deleted) and thus the readers should see it as
such.
For
a
(p. 1545)
with
com.rti.dds.infrastructure.OwnershipQosPolicyKind.OwnershipQosPolicyKind.EXCLUSIVE OWNERSHIP QOS, if the current owner of an instance unregisters it, then
it will relinquish ownership of the instance and thus the readers may see the
value updated by another writer (which will then become the owner). This
is because the owner said that it no longer will be providing values for the
instance and thus another writer can take ownership and provide those values.
8.159.5
8.159.5.1
OwnershipQosPolicyKind kind
The kind of ownership.

1206
Class Documentation
[default] com.rti.dds.infrastructure.OwnershipQosPolicyKind.OwnershipQosPolicyKind.SHARED OWNERSHIP QOS
8.160 OwnershipQosPolicyKind Class Reference
8.160
OwnershipQosPolicyKind
ence
1207
Class
Refer-
Kinds of ownership.
Inheritance diagram for OwnershipQosPolicyKind::

static final OwnershipQosPolicyKind SHARED OWNERSHIP QOS
[default] Indicates shared ownership for each instance.
static
final
OwnershipQosPolicyKind
OWNERSHIP QOS
EXCLUSIVE -
Indicates
each
instance
can
only
be
owned
by
one
com.rti.dds.publication.DataWriter ( p. 557), but the owner of an
instance can change dynamically.
8.160.1
Kinds of ownership.
QoS:
com.rti.dds.infrastructure.OwnershipQosPolicy (p. 1199)
8.160.2
8.160.2.1
final OwnershipQosPolicyKind SHARED OWNERSHIP QOS [static]
[default] Indicates shared ownership for each instance.

Multiple writers are allowed to update the same instance and all the updates are
made available to the readers. In other words there is no concept of an owner
for the instances.
This is the default behavior if the OWNERSHIP (p. 87) policy is not specified
or supported.
1208
8.160.2.2
Class Documentation
final OwnershipQosPolicyKind EXCLUSIVE OWNERSHIP QOS [static]
Indicates
each
instance
can
only
be
owned
by
one
com.rti.dds.publication.DataWriter (p. 557), but the owner of an instance can change dynamically.
The selection of the owner is controlled by the setting of the OWNERSHIP STRENGTH (p. 88) policy. The owner is always set to be the highest-strength
com.rti.dds.publication.DataWriter (p. 557) object among the ones currently active (as determined by the LIVELINESS (p. 82)).
8.161 OwnershipStrengthQosPolicy Class Reference
8.161
1209
OwnershipStrengthQosPolicy Class Reference

(p. 1545) + key).
Inheritance diagram for OwnershipStrengthQosPolicy::
Public Attributes
int value
The strength value used to arbitrate among multiple writers.
8.161.1

(p. 1545) + key).
This policy only applies if the OWNERSHIP (p. 87) policy is of kind
com.rti.dds.infrastructure.OwnershipQosPolicyKind.OwnershipQosPolicyKind.EXCLUSIVE OWNERSHIP QOS.
Entity:
Properties:
RxO (p. 101) = N/A
The value of the OWNERSHIP STRENGTH (p. 88) is used to determine
the ownership of a data instance (identified by the key). The arbitration is
performed by the com.rti.dds.subscription.DataReader (p. 487).
See also:
EXCLUSIVE ownership (p. 1200)
1210
Class Documentation
8.161.2
8.161.2.1
int value
The strength value used to arbitrate among multiple writers.

[default] 0
8.162 ParticipantBuiltinTopicData Class Reference
8.162
1211
ParticipantBuiltinTopicData Class Reference
Entry created when a DomainParticipant (p. 654) object is discovered.

Inherits AbstractBuiltinTopicData.
Public Attributes
final BuiltinTopicKey t key
DCPS key to distinguish entries.

Policy of the corresponding DomainParticipant ( p. 654).

<<eXtension>> (p. 278) Name value pair properties to be stored with domain ( p. 328) participant
final ProtocolVersion t rtps protocol version

<<eXtension>> (p. 278) Version number of the RTPS wire protocol used.
final VendorId t rtps vendor id

<<eXtension>> (p. 278) ID of vendor implementing the RTPS wire protocol.
int dds builtin endpoints

<<eXtension>> (p. 278) Bitmap of builtin ( p. 330) endpoints supported
by the participant.
final LocatorSeq default unicast locators

<<eXtension>> (p. 278) Unicast locators used when individual entities do
not specify unicast locators.
final ProductVersion t product version

<<eXtension>> (p. 278) This is a vendor specific parameter. It gives the
current version for rti-dds.

<<eXtension>> (p. 278) The participant name and role name.
1212
8.162.1
Class Documentation
Entry created when a DomainParticipant (p. 654) object is discovered.

Data
associated
with
the
built-in
topic
(p. 359)
builtin.ParticipantBuiltinTopicDataTypeSupport.PARTICIPANT TOPIC NAME (p. 1216). It contains QoS policies and additional information
that apply to the remote com.rti.dds.domain.DomainParticipant (p. 654).
See also:
builtin.ParticipantBuiltinTopicDataDataReader (p. 1214)
8.162.2
8.162.2.1

8.162.2.2
Policy of the corresponding DomainParticipant (p. 654).

8.162.2.3
<<eXtension>> ( p. 278) Name value pair properties to be stored with domain (p. 328) participant
8.162.2.4
<<eXtension>> ( p. 278) Version number of the RTPS wire protocol used.

8.162.2.5
<<eXtension>> ( p. 278) ID of vendor implementing the RTPS wire protocol.

8.162.2.6
int dds builtin endpoints
<<eXtension>> ( p. 278) Bitmap of builtin (p. 330) endpoints supported by

the participant.
8.162 ParticipantBuiltinTopicData Class Reference
1213
Each bit indicates a builtin (p. 330) endpoint that may be available on the
participant for use in discovery.
8.162.2.7
final LocatorSeq default unicast locators
<<eXtension>> ( p. 278) Unicast locators used when individual entities do

not specify unicast locators.
8.162.2.8
<<eXtension>> ( p. 278) This is a vendor specific parameter. It gives the

8.162.2.9
<<eXtension>> ( p. 278) The participant name and role name.

This parameter contains the name and the role name of the discovered participant.
1214
8.163
Class Documentation
ParticipantBuiltinTopicDataDataReader
Class Reference
Instantiates DataReader < builtin.ParticipantBuiltinTopicData (p. 1211)

>.
Inherits DataReaderImpl.
8.163.1
Instantiates DataReader < builtin.ParticipantBuiltinTopicData (p. 1211)

>.
of
topic
(p. 359)
(p. 487)
builtin.ParticipantBuiltinTopicDataTypeSupport.PARTICIPANT TOPIC NAME
(p. 1216)
used
for
accessing
(p. 1211)
of
the
remote
Instantiates:
<<generic>>
(p. 979)
( p. 279)
See also:
8.164 ParticipantBuiltinTopicDataSeq Class Reference
8.164
ParticipantBuiltinTopicDataSeq
Reference
1215
Class

builtin.ParticipantBuiltinTopicData (p. 1211) > .
Inherits AbstractBuiltinTopicDataSeq.
8.164.1

builtin.ParticipantBuiltinTopicData (p. 1211) > .
Instantiates:
See also:
1216
Class Documentation
8.165
ParticipantBuiltinTopicDataTypeSupport
Class Reference
Instantiates TypeSupport < builtin.ParticipantBuiltinTopicData (p. 1211)

>.
Inheritance diagram for ParticipantBuiltinTopicDataTypeSupport::

static final String PARTICIPANT TOPIC NAME
PARTICIPANT TOPIC NAME()
DDS -
Participant topic ( p. 359) name.
8.165.1
Instantiates TypeSupport < builtin.ParticipantBuiltinTopicData (p. 1211)

>.
Instantiates:
<<generic>>
(p. 1036)
( p. 279)
com.rti.ndds.example.FooTypeSupport
See also:
8.165.2
8.165.2.1
final String PARTICIPANT TOPIC NAME =

DDS PARTICIPANT TOPIC NAME() [static]
Participant topic (p. 359) name.

Topic name of builtin.ParticipantBuiltinTopicDataDataReader (p. 1214)
See also:
builtin.ParticipantBuiltinTopicDataDataReader (p. 1214)
8.166 PartitionQosPolicy Class Reference
8.166
1217
PartitionQosPolicy Class Reference
Inheritance diagram for PartitionQosPolicy::
Public Attributes
final StringSeq name
A list of partition names.
8.166.1
This QoS policy is used to set string identifiers that are used for matching
DataReaders and DataWriters for the same Topic.
A
(p. 557)
within
a
(p. 1262)
only
communicates
with
a
(p. 487)
in
a
com.rti.dds.subscription.Subscriber (p. 1476) if (in addition to
matching the com.rti.dds.topic.Topic (p. 1545) and having compatible QoS) the com.rti.dds.publication.Publisher (p. 1262) and
com.rti.dds.subscription.Subscriber (p. 1476) have a common partition name string.
Entity:
(p. 1262),
Properties:
RxO (p. 101) = NO
1218
Class Documentation
8.166.2
Usage
This policy allows the introduction of a logical partition concept inside the
physical partition induced by a domain ( p. 328).
Usually DataReaders and DataWriters are matched only by their topic (p. 359)
(so that data are only sent by DataWriters to DataReaders for the same topic
(p. 359)). The Partition QoS policy allows you to add one or more strings,
partitions, to a Publisher and/or Subscriber. If partitions are added, then
a DataWriter and DataReader for the same topic (p. 359) are only considered
matched if their Publishers and Subscribers have partitions in common (intersecting partitions).
Since the set of partitions for a publisher or subscriber can be dynamically
changed, the Partition QoS policy is useful to control which DataWriters can
send data to which DataReaders and vice versa even if all of the DataWriters
and DataReaders are for the same topic (p. 359). This facility is useful for
creating temporary separation groups among entities that would otherwise be
connected to and exchange data each other.
Failure to match partitions is not considered an incompatible QoS and does
not trigger any listeners or conditions. A change in this policy can potentially
modify the match of existing DataReader and DataWriter entities. It may
establish new matches that did not exist before, or break existing matches.
Partition strings are usually directly matched via string comparisons. However,
partition strings can also contain wildcard symbols so that partitions can be
matched via pattern matching. As long as the partitions or wildcard patterns
of a Publisher intersect with the partitions or wildcard patterns of a Subscriber,
their DataWriters and DataReaders of the same topic (p. 359) are able to match;
otherwise they are not.
These
partition
name
patterns
are
regular
expressions
as
defined
by
the
POSIX
fnmatch
API
(1003.2-1992
section
B.6).
Either com.rti.dds.publication.Publisher (p. 1262) or
com.rti.dds.subscription.Subscriber (p. 1476) may include regular expressions in partition names, but no two names that both contain wildcards
will ever be considered to match. This means that although regular expressions
may be used both at publisher as well as subscriber side, RTI Connext will not
try to match two regular expressions (between publishers and subscribers).
Each publisher and subscriber must belong to at least one logical partition. A
regular expression is not considered to be a logical partition. If a publisher or
subscriber has not specify a logical partition, it is assumed to be in the default
partition. The default partition is defined to be an empty string (). Put
another way:
An empty sequence of strings in this QoS policy is considered equivalent
to a sequence containing only a single string, the empty string.
8.166 PartitionQosPolicy Class Reference
1219
A string sequence that contains only regular expressions and no literal

strings, it is treated as if it had an additional element, the empty string.
Partitions are different from creating com.rti.dds.infrastructure.Entity
(p. 931) objects in different domains in several ways.
First, entities belonging to different domains are completely isolated from
each other; there is no traffic, meta-traffic or any other way for an application or RTI Connext itself to see entities in a domain (p. 328) it does
not belong to.
Second, a com.rti.dds.infrastructure.Entity (p. 931) can only belong
to one domain (p. 328) whereas a com.rti.dds.infrastructure.Entity
(p. 931) can be in multiple partitions.
Finally, as far as RTI Connext is concerned, each unique data instance is identified by the tuple (DomainID, com.rti.dds.topic.Topic
(p. 1545), key). Therefore two com.rti.dds.infrastructure.Entity
(p. 931) objects in different domains cannot refer to the same data instance. On the other hand, the same data instance can be made available
(published) or requested (subscribed) on one or more partitions.
8.166.3
8.166.3.1
final StringSeq name
A list of partition names.

Several restrictions apply to the partition names in this sequence.
A violation of one of the following rules will result in a
(p. 1359) when setting a com.rti.dds.publication.Publisher (p. 1262)s or
com.rti.dds.subscription.Subscriber (p. 1476)s QoS.
A partition name string cannot be NULL, nor can it contain the reserved
comma character (,).
The maximum number of partition name strings allowable
in
a
is
specified
on
a
domain
(p. 328)
basis
in
(p. 1217)
com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.max partitions (p. 792). The length of this sequence may not be greater than
that value.
The maximum
strings
in
a
cumulative length of all partition name

1220
Class Documentation
(p. 1217)
is
specified
on
a
domain
(p. 328)
basis
in
com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.max partition cumulative characters (p. 792).
[default] Empty sequence (zero-length sequence). Since no logical partition is

specified, RTI Connext will assume the entity to be in default partition (empty
string partition ).
[range] List of partition name with above restrictions
8.167 PresentationQosPolicy Class Reference
8.167
1221
PresentationQosPolicy Class Reference
Inheritance diagram for PresentationQosPolicy::
Public Attributes
PresentationQosPolicyAccessScopeKind access scope
Determines the largest scope spanning the entities for which the order and
coherency of changes can be preserved.
boolean coherent access

Specifies support for coherent access. Controls whether coherent access is
supported within the scope access scope.
boolean ordered access

Specifies support for ordered access to the samples received at the subscription ( p. 353) end. Controls whether ordered access is supported within the
scope access scope.
8.167.1
This QoS policy controls the extent to which changes to data instances can be
made dependent on each other and also the kind of dependencies that can be
propagated and maintained by RTI Connext. Specifically, this policy affects the
applications ability to:
specify and receive coherent changes to instances
specify the relative order in which changes are presented
Entity:
(p. 1262),
1222
Class Documentation
Status:
Properties:
RxO (p. 101) = YES
8.167.2
Usage
A com.rti.dds.subscription.DataReader (p. 487) will usually receive data in

the order that it was sent by a com.rti.dds.publication.DataWriter (p. 557),
and the data is presented to the com.rti.dds.subscription.DataReader
(p. 487) as soon as the application receives the next expected value.
However, sometimes, you may want a set of data for the same
com.rti.dds.publication.DataWriter (p. 557) to be presented to the
com.rti.dds.subscription.DataReader (p. 487) only after all of the elements
of the set have been received. Or you may want the data to be presented in a
different order than that in which it was received. Specifically for keyed data,
you may want the middleware to present the data in keyed or instance order,
such that samples pertaining to the same instance are presented together.
The Presentation QoS policy allows you to specify different scopes of presentation: within a com.rti.dds.publication.DataWriter (p. 557), across instances of a single com.rti.dds.publication.DataWriter (p. 557), and even
across multiple used by different writers of a publisher. It also controls whether
or not a set of changes within the scope is delivered at the same time or can be
delivered as soon as each element is received.
coherent access controls whether RTI Connext will preserve the
groupings of changes made by a publishing application by means of
the operations com.rti.dds.publication.Publisher.begin coherent changes (p. 1282) and com.rti.dds.publication.Publisher.end coherent changes (p. 1282).
ordered access controls whether RTI Connext will preserve the order of
changes.
access scope controls the granularity of the other settings. See below:
If coherent access is set, then the access scope controls the maximum extent
of coherent changes. The behavior is as follows:
1223
If access scope is set to com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPol

(the
default),
the
use
of
PRESENTATION QOS
com.rti.dds.publication.Publisher.begin coherent changes
(p. 1282) and com.rti.dds.publication.Publisher.end coherent changes (p. 1282) has no effect on how the subscriber can access the
data, because with the scope limited to each instance, changes to separate
instances are considered independent and thus cannot be grouped into a
coherent set.

PRESENTATION QOS,
then
coherent
changes
(indicated
by
their
enclosure
within
calls
to
com.rti.dds.publication.Publisher.begin coherent changes
(p. 1282) and com.rti.dds.publication.Publisher.end coherent changes (p. 1282)) will be made available as such to each remote com.rti.dds.subscription.DataReader (p. 487) independently. That is, changes made to instances within each individual
com.rti.dds.publication.DataWriter (p. 557) will be available as
coherent with respect to other changes to instances in that same
com.rti.dds.publication.DataWriter (p. 557), but will not be
grouped with changes made to instances belonging to a different
If access scope is set to com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPolic

PRESENTATION QOS, then coherent changes made to instances through
a com.rti.dds.publication.DataWriter (p. 557) attached to a common
com.rti.dds.publication.Publisher (p. 1262) are made available as a
unit to remote subscribers. (RTI does not currently support this access
scope.)
If ordered access is set, then the access scope controls the maximum extent
for which order will be preserved by RTI Connext.

PRESENTATION QOS (the lowest level), then changes to each instance
are considered unordered relative to changes to any other instance. That
means that changes (creations, deletions, modifications) made to two
instances are not necessarily seen in the order they occur. This is the
case even if it is the same application thread making the changes using
the same com.rti.dds.publication.DataWriter (p. 557).

PRESENTATION QOS, changes (creations, deletions, modifications)
made by a single com.rti.dds.publication.DataWriter (p. 557) are
made available to subscribers in the same order they occur. Changes made
1224
Class Documentation
to instances though different com.rti.dds.publication.DataWriter
(p. 557) entities are not necessarily seen in the order they occur. This
is the case, even if the changes are made by a single application thread
using com.rti.dds.publication.DataWriter (p. 557) objects attached
to the same com.rti.dds.publication.Publisher (p. 1262).
Finally, if access scope is set to com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.P

changes
made
to
instances
via
PRESENTATION QOS,
com.rti.dds.publication.DataWriter (p. 557) entities attached to
the same com.rti.dds.publication.Publisher (p. 1262) object are
made available to subscribers on the same order they occur.
Note that this QoS policy controls the scope at which related changes are
made available to the subscriber. This means the subscriber can access the
changes in a coherent manner and in the proper order; however, it does not
necessarily imply that the com.rti.dds.subscription.Subscriber (p. 1476)
will indeed access the changes in the correct order. For that to occur, the
application at the subscriber end must use the proper logic in reading the
com.rti.dds.subscription.DataReader (p. 487) objects.
For com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPolicyAccessScop
PRESENTATION QOS the subscribing application must use the
APIs
com.rti.dds.subscription.Subscriber.begin access
(p. 1497),
com.rti.dds.subscription.Subscriber.end access
(p. 1498)
and
com.rti.dds.subscription.Subscriber.get datareaders (p. 1489) to access
the changes in the proper order.
8.167.3
Compatibility
if the following conditions are met:
the inequality offered access scope >= requested access scope evaluates to TRUE or requested access scope is
com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPolicyAccessSc
OFFERED PRESENTATION QOS. For the purposes of this inequality, the values of access scope are considered ordered such that
com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPolicyAccessSc
PRESENTATION QOS < com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.Prese
PRESENTATION QOS < com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.Prese
PRESENTATION QOS.
requested
coherent access
or else both offered and
is
requested coherent access are
1225
requested ordered access is com.rti.dds.infrastructure.false, or else both

offered and requested ordered access are com.rti.dds.infrastructure.true.
8.167.4
8.167.4.1
PresentationQosPolicyAccessScopeKind access scope
Determines the largest scope spanning the entities for which the order and
coherency of changes can be preserved.
[default] com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPolicyAccessScopeKind
PRESENTATION QOS
8.167.4.2
boolean coherent access
Specifies support for coherent access. Controls whether coherent access is supported within the scope access scope.
That is, the ability to group a set of changes as a unit on the publishing end
such that they are received as a unit at the subscribing end.
Note:
To
use
this
feature,
the
DataWriter
must
be
configured
for
RELIABLE
communication
(see
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.RELIABLE RELIABILITY QOS).
8.167.4.3
boolean ordered access
Specifies support for ordered access to the samples received at the subscription
(p. 353) end. Controls whether ordered access is supported within the scope
access scope.
That is, the ability of the subscriber to see changes in the same order as they
occurred on the publishing end.
1226
Class Documentation
8.168
PresentationQosPolicyAccessScopeKind
Class Reference

Inheritance diagram for PresentationQosPolicyAccessScopeKind::

static final PresentationQosPolicyAccessScopeKind INSTANCE PRESENTATION QOS
[default] Scope spans only a single instance.
static final PresentationQosPolicyAccessScopeKind

PRESENTATION QOS
TOPIC -
Scope
spans
to
all
instances
within
the
same
( p. 557)
(or
com.rti.dds.subscription.DataReader ( p. 487)), but not across instances in different com.rti.dds.publication.DataWriter ( p. 557) (or
com.rti.dds.subscription.DataReader ( p. 487)).
static final PresentationQosPolicyAccessScopeKind GROUP PRESENTATION QOS

Scope
spans
to
all
instances
belonging
to
( p. 557)
(or
( p. 487))
entities
within
the
same
( p. 1262)
(or
com.rti.dds.subscription.Subscriber ( p. 1476)).
static final PresentationQosPolicyAccessScopeKind HIGHEST OFFERED PRESENTATION QOS

This value only applies to a com.rti.dds.subscription.Subscriber
( p. 1476).
The
( p. 1476) will use the access scope specified by each remote
8.168.1

Access scope determines the largest scope spanning the entities for which the
order and coherency of changes can be preserved.
8.168 PresentationQosPolicyAccessScopeKind Class Reference 1227

QoS:
com.rti.dds.infrastructure.PresentationQosPolicy (p. 1221)
8.168.2
8.168.2.1
final PresentationQosPolicyAccessScopeKind
INSTANCE PRESENTATION QOS [static]
[default] Scope spans only a single instance.

Indicates that changes to one instance need not be coherent nor ordered with
respect to changes to any other instance. In other words, order and coherent
changes apply to each instance separately.
8.168.2.2
TOPIC PRESENTATION QOS [static]
Scope
spans
to
all
instances
within
the
same
(p. 557)
(or
com.rti.dds.subscription.DataReader (p. 487)), but not across instances in different com.rti.dds.publication.DataWriter (p. 557) (or
8.168.2.3
GROUP PRESENTATION QOS [static]
Scope
spans
to
all
instances
belonging
to
(p. 557)
(or
(p. 487))
entities
within
the
same
(p. 1262)
(or
com.rti.dds.subscription.Subscriber (p. 1476)).
8.168.2.4
HIGHEST OFFERED PRESENTATION QOS [static]
This value only applies to a com.rti.dds.subscription.Subscriber (p. 1476).

The com.rti.dds.subscription.Subscriber (p. 1476) will use the access scope
specified by each remote com.rti.dds.publication.Publisher (p. 1262).
1228
Class Documentation
8.169
PRIVATE MEMBER Class Reference

static final short VALUE
8.169.1

See also:
com.rti.dds.typecode.Visibility.PUBLIC MEMBER
8.169.2
8.169.2.1
final short VALUE [static]
Constant value.
8.170 ProductVersion t Class Reference
8.170
1229
ProductVersion t Class Reference
<<eXtension>> ( p. 278) Type used to represent the current version of RTI

Connext.
Inherits Struct.

ProductVersion t ()
Constructor.
Public Attributes
char major
Major product version.
char minor
Minor product version.
char release
Release letter for product version.
char revision
Revision number of product.

static
final
UNKNOWN
ProductVersion t
PRODUCTVERSION -
The value used when the product version is unknown.
8.170.1
<<eXtension>> ( p. 278) Type used to represent the current version of RTI

Connext.
1230
Class Documentation
8.170.2
8.170.2.1
ProductVersion t ()
Constructor.
8.170.3
8.170.3.1
final ProductVersion t PRODUCTVERSION UNKNOWN [static]
Initial value:
new ProductVersion_t((char)0, (char)0, (char)0, (char)0)
The value used when the product version is unknown.

8.170.3.2
char major
Major product version.

8.170.3.3
char minor
Minor product version.

8.170.3.4
char release
Release letter for product version.

8.170.3.5
char revision
Revision number of product.
8.171 ProfileQosPolicy Class Reference
8.171
1231
ProfileQosPolicy Class Reference
Configures the way that XML documents containing QoS profiles are loaded by
RTI Connext.
Inheritance diagram for ProfileQosPolicy::
Public Attributes
final StringSeq string profile
Sequence of strings containing a XML document to load.
final StringSeq url profile

Sequence of URL groups ( p. 235) containing a set of XML documents to
load.
boolean ignore user profile

Ignores the file USER QOS PROFILES.xml in the current working directory.
boolean ignore environment profile

Ignores the value of the NDDS QOS PROFILES environment variable
( p. 235).
boolean ignore resource profile

Ignores
the
file
NDDS QOS PROFILES.xml
NDDSHOME/resource/qos profiles 4.4d/xml.
8.171.1
under
Configures the way that XML documents containing QoS profiles are loaded by
RTI Connext.
All QoS values for Entities can be configured in QoS profiles defined in XML
documents. XML documents can be passed to RTI Connext in string form or,
more likely, through files found on a file system.
There are also default locations where DomainParticipants will look for files to
load QoS profiles. These include the current working directory from where an
application is started, a file in the distribution directory for RTI Connext, and
the locations specified by an environment variable. You may disable any or all
of these default locations using the Profile QoS policy.
1232
Class Documentation
Entity:
Properties:
RxO (p. 101) = NO
Changeable (p. 102) = Changeable (p. 102)
8.171.2
8.171.2.1
final StringSeq string profile
Sequence of strings containing a XML document to load.

The concatenation of the strings in this sequence must be a valid XML document
according to the XML QoS profile schema.
[default] Empty sequence (zero-length).
8.171.2.2
final StringSeq url profile
Sequence of URL groups (p. 235) containing a set of XML documents to load.
Only one of the elements of each group will be loaded by RTI Connext, starting
from the left.
[default] Empty sequence (zero-length).
8.171.2.3
boolean ignore user profile
Ignores the file USER QOS PROFILES.xml in the current working directory.
When this field is set to com.rti.dds.infrastructure.true, the QoS profiles contained in the file USER QOS PROFILES.xml in the current working directory
will be ignored.
8.171.2.4
boolean ignore environment profile
Ignores the value of the NDDS QOS PROFILES environment variable

(p. 235).
When this field is set to com.rti.dds.infrastructure.true, the value of the environment variable NDDS QOS PROFILES will be ignored.
8.171 ProfileQosPolicy Class Reference

8.171.2.5
1233
boolean ignore resource profile
Ignores
the
file
NDDS QOS PROFILES.xml
NDDSHOME/resource/qos profiles 4.4d/xml.
under
When this field is set to com.rti.dds.infrastructure.true, the QoS

profiles contained in the file NDDS QOS PROFILES.xml under
NDDSHOME/resource/qos profiles 5.0.0/xml will be ignored.
1234
Class Documentation
8.172
Property t Class Reference

Inherits Struct.

Property t ()
Constructor.
Property t (Property t src)

Constructor.
Property t (String name, String value, boolean propagate)

Constructor.
Public Attributes
String name
Property name.
String value
Property value.
boolean propagate
Indicates if the property must be propagated on discovery.
8.172.1
8.172.2
8.172.2.1
Property t ()
Constructor.
8.172 Property t Class Reference

8.172.2.2
1235
Property t (Property t src)
Constructor.
Parameters:
src <<in>> ( p. 279) Property used to initialized the new property.
8.172.2.3
Property t (String name, String value, boolean

propagate)
Constructor.
Parameters:
name <<in>> ( p. 279) Property name.
value <<in>> ( p. 279) Property value.
propagate <<in>> ( p. 279) Parameter used to indicates whether or not
the property must be propagated.
8.172.3
8.172.3.1
String name
Property name.
8.172.3.2
String value
Property value.
8.172.3.3
boolean propagate
Indicates if the property must be propagated on discovery.
1236
Class Documentation
8.173
PropertyQosPolicy Class Reference
Stores name/value(string) pairs that can be used to configure certain parameters

of RTI Connext that are not exposed through formal QoS policies. Can also be
used to store and propagate application-specific name/value pairs that can be
retrieved by user code during discovery.
Inheritance diagram for PropertyQosPolicy::
Public Attributes
final PropertySeq value
Sequence of properties.
8.173.1
Stores name/value(string) pairs that can be used to configure certain parameters

of RTI Connext that are not exposed through formal QoS policies. Can also be
used to store and propagate application-specific name/value pairs that can be
retrieved by user code during discovery.
Entity:
(p. 654)
(p. 487)
Properties:
RxO (p. 101) = N/A;
See also:
(p. 711)
8.173.2
Usage
The PROPERTY QoS policy can be used to associate a set of properties in the
form of (name,value) pairs with a com.rti.dds.subscription.DataReader
8.173 PropertyQosPolicy Class Reference
1237
(p. 487),
(p. 557),
or
This is similar to
the com.rti.dds.infrastructure.UserDataQosPolicy (p. 1694), except this
policy uses (name, value) pairs, and you can select whether or not a particular
pair should be propagated (included in the builtin topic (p. 359)).
This QoS policy may be used to configure:
Durable Writer History, see Configuring Durable Writer History
(p. 227)
Durable Reader State, see Configuring Durable Reader State (p. 227)
Builtin Transport Plugins, see UDPv4 Transport Property Names
in Property QoS Policy of Domain Participant (p. 1669), UDPv6
Transport Property Names in Property QoS Policy of Domain
Participant (p. 1681), and Shared Memory Transport Property
Names in Property QoS Policy of Domain Participant (p. 1437)
Extension Transport Plugins, see Loading Transport Plugins through
Property QoS Policy of Domain Participant (p. 219)
Clock Selection (p. 145)
In addition, you may add your own name/value pairs to the Property
QoS policy of an Entity (p. 931). Via this QoS policy, you can direct
RTI Connext to propagate these name/value pairs with the discovery information for the Entity (p. 931). Applications that discover the Entity (p. 931) can then access the user-specific name/value pairs in the discovery information of the remote Entity (p. 931).
This allows you to
add meta-information about an Entity (p. 931) for application-specific use,
for example, authentication/authorization certificates (which can also be
done using the com.rti.dds.infrastructure.UserDataQosPolicy (p. 1694)
or com.rti.dds.infrastructure.GroupDataQosPolicy (p. 1039)).
8.173.2.1
Reasons for Using the PropertyQosPolicy
Supports dynamic loading of extension transports (such as RTI Secure

WAN Transport)
Supports multiple instances of the builtin transports
Allows full pluggable transport configuration for non-C/C++ language
bindings (Java, .NET, etc.)
1238
Class Documentation
Avoids the process of creating entities disabled, changing their QoS settings, then enabling them
Allows selection of clock
Some of the RTI Connext capabilities configurable via the Property QoS policy
can also be configured in code via APIs. However, the Property QoS policy
allows you to configure those parameters via XML files. In addition, some of
the configuration APIs will only work if the Entity (p. 931) was created in
a disabled state and then enabled after the configuration change was applied.
By configuring those parameters using the Property QoS policy during entity
creation, you avoid the additional work of first creating a disabled entity and
then enabling it afterwards.
There are helper functions to facilitate working with properties, see the
com.rti.dds.infrastructure.PropertyQosPolicyHelper (p. 1239) class on
the PROPERTY (p. 92) page.
8.173.3
8.173.3.1
final PropertySeq value
Initial value:
new PropertySeq()
Sequence of properties.
[default] An empty list.
8.174 PropertyQosPolicyHelper Class Reference
8.174
PropertyQosPolicyHelper
ence
1239
Class
Refer-
Policy Helpers which facilitate management of the properties in the input policy.

static int get number of properties (PropertyQosPolicy policy)
Gets the number of properties in the input policy.
static void assert property (PropertyQosPolicy policy, String name,

String value, boolean propagate)
Asserts the property identified by name in the input policy.
static void add property (PropertyQosPolicy policy, String name,

String value, boolean propagate)
Adds a new property to the input policy.
static Property t lookup property (PropertyQosPolicy policy,

String name)
Searches for a property in the input policy given its name.
static void remove property (PropertyQosPolicy policy, String

name)
Removes a property from the input policy.
static void get properties (PropertyQosPolicy policy, PropertySeq

properties, String name prefix)
Retrieves a list of properties whose names match the input prefix.
8.174.1
Policy Helpers which facilitate management of the properties in the input policy.
8.174.2
8.174.2.1
static int get number of properties (PropertyQosPolicy

policy) [static]
Gets the number of properties in the input policy.

1240
Class Documentation
Precondition:
policy cannot be null.
Parameters:
policy <<in>> ( p. 279) Input policy.
Returns:
Number of properties.
8.174.2.2
static void assert property (PropertyQosPolicy policy,

String name, String value, boolean propagate) [static]
Asserts the property identified by name in the input policy.

If the property already exists, this function replaces its current value with the
new one.
If the property identified by name does not exist, this function adds it to the
property set.
This function increases the maximum number of elements of the policy sequence
when this number is not enough to store the new property.
Precondition:
policy, name and value cannot be null.
Parameters:
propagate <<in>> ( p. 279) Indicates if the property will be propagated
on discovery.
Returns:
One
of
the
Standard
Return
Codes
(p. 108)
or
(p. 1362).

8.174.2.3
1241
static void add property (PropertyQosPolicy policy,

String name, String value, boolean propagate) [static]
Adds a new property to the input policy.

This function will allocate memory to store the (name,value) pair. The memory
allocated is owned by RTI Connext.
If the maximum number of elements of the policy sequence is not enough to
store the new property, this function will increase it.
If
the
property
already
exists
the
function
fails
with
Precondition:
The property is not in the policy.
Parameters:
propagate <<in>> ( p. 279) Indicates if the property will be propagated
on discovery.
Returns:
One
of
the
Standard
Return
Codes
(p. 108)
or
(p. 1362)
or
8.174.2.4
static Property t lookup property (PropertyQosPolicy

policy, String name) [static]
Searches for a property in the input policy given its name.

Precondition:
Parameters:
1242
Class Documentation

Returns:
On success, the function returns the first property with the given name.
Otherwise, the function returns NULL.
8.174.2.5
static void remove property (PropertyQosPolicy policy,

String name) [static]
Removes a property from the input policy.

If
the
property
does
not
exist,
the
function
fails
with
Precondition:
policy and name cannot be null.
The property is in the policy.
Parameters:
Returns:
One
of
the
Standard
Return
Codes
(p. 108)
or
8.174.2.6
static void get properties (PropertyQosPolicy policy,

PropertySeq properties, String name prefix) [static]
Retrieves a list of properties whose names match the input prefix.

If the properties sequence doesnt own its buffer, and its maximum
is less than the total number of properties matching the input prefix, it will be filled up to its maximum and fail with an error of com.rti.dds.infrastructure.RETCODE OUT OF RESOURCES
(p. 1362).
Precondition:
policy, properties and name prefix cannot be null.
1243
Parameters:
properties <<inout>> ( p. 279) A com.rti.dds.infrastructure.PropertySeq
(p. 1244) object where the set or list of properties will be returned.
name prefix Name prefix.
Returns:
One
of
the
Standard
Return
Codes
(p. 108)
or
(p. 1362).
1244
8.175
Class Documentation
PropertySeq Class Reference
Declares IDL sequence < com.rti.dds.infrastructure.Property t (p. 1234)

>.
8.175.1
Declares IDL sequence < com.rti.dds.infrastructure.Property t (p. 1234)

>.
See also:
com.rti.dds.infrastructure.Property t (p. 1234)
8.176 ProtocolVersion t Class Reference
8.176
1245
ProtocolVersion t Class Reference
<<eXtension>> ( p. 278) Type used to represent the version of the RTPS

protocol.
Inherits Struct.

ProtocolVersion t ()
Constructor.
Public Attributes
byte major
Major protocol version number.
byte minor
Minor protocol version number.

static final ProtocolVersion t PROTOCOLVERSION 1 0
The protocol version 1.0.




static final ProtocolVersion t PROTOCOLVERSION

The most recent protocol version. Currently 1.2.
1246
8.176.1
Class Documentation
<<eXtension>> ( p. 278) Type used to represent the version of the RTPS

protocol.
8.176.2
8.176.2.1
ProtocolVersion t ()
Constructor.
8.176.3
8.176.3.1
final ProtocolVersion t PROTOCOLVERSION 1 0

[static]
Initial value:
new ProtocolVersion_t((byte)1, (byte)0)
8.176.3.2

[static]
Initial value:
8.176.3.3

[static]
Initial value:

8.176 ProtocolVersion t Class Reference

8.176.3.4
1247

[static]
Initial value:

8.176.3.5

[static]
Initial value:

8.176.3.6
final ProtocolVersion t PROTOCOLVERSION [static]
Initial value:
The most recent protocol version. Currently 1.2.

8.176.3.7
byte major
Major protocol version number.

8.176.3.8
byte minor
Minor protocol version number.
1248
Class Documentation
8.177
PUBLIC MEMBER Class Reference

8.177.1

See also:
com.rti.dds.typecode.Visibility.PRIVATE MEMBER
8.177.2
8.177.2.1
Constant value.
8.178 PublicationBuiltinTopicData Class Reference
8.178
1249
PublicationBuiltinTopicData Class Reference
Entry created when a com.rti.dds.publication.DataWriter (p. 557) is discovered in association with its Publisher (p. 1262).
Public Attributes
final BuiltinTopicKey t participant key

DCPS key of the participant to which the DataWriter ( p. 557) belongs.
String topic name

Name of the related com.rti.dds.topic.Topic ( p. 1545).
String type name

Name of the type attached to the com.rti.dds.topic.Topic ( p. 1545).

durability policy of the corresponding DataWriter ( p. 557)

durability service policy of the corresponding DataWriter ( p. 557)

Policy of the corresponding DataWriter ( p. 557).




1250
Class Documentation




final PresentationQosPolicy presentation

Policy of the Publisher ( p. 1262) to which the DataWriter ( p. 557) belongs.
final PartitionQosPolicy partition

final TopicDataQosPolicy topic data

Policy of the related Topic.
final GroupDataQosPolicy group data

TypeCode type code

<<eXtension>> (p. 278) Type code information of the corresponding Topic
final BuiltinTopicKey t publisher key

<<eXtension>> (p. 278) DCPS key of the publisher to which the
DataWriter ( p. 557) belongs

<<eXtension>> (p. 278) Properties of the corresponding DataWriter
( p. 557).
final LocatorSeq unicast locators

<<eXtension>> (p. 278) Custom unicast locators that the endpoint can
specify. The default locators will be used if this is not specified.
1251
final GUID t virtual guid

<<eXtension>> (p. 278) Virtual GUID associated to the DataWriter
( p. 557).



final LocatorFilterQosPolicy locator filter

<<eXtension>> (p. 278) Policy of the corresponding DataWriter
( p. 557)

<<eXtension>> (p. 278) This is a vendor specific parameter. Determines
whether matching DataReaders send positive acknowledgements for reliability.

<<eXtension>> (p. 278) The publication ( p. 349) name and role name.
8.178.1
Entry created when a com.rti.dds.publication.DataWriter (p. 557) is discovered in association with its Publisher (p. 1262).
Data
associated
with
the
built-in
topic
(p. 359)
builtin.PublicationBuiltinTopicDataTypeSupport.PUBLICATION TOPIC NAME (p. 1258). It contains QoS policies and additional information
that apply to the remote com.rti.dds.publication.DataWriter (p. 557) the
related com.rti.dds.publication.Publisher (p. 1262).
See also:
builtin.PublicationBuiltinTopicDataTypeSupport.PUBLICATION TOPIC NAME (p. 1258)
builtin.PublicationBuiltinTopicDataDataReader (p. 1256)
1252
Class Documentation
8.178.2
8.178.2.1

8.178.2.2
DCPS key of the participant to which the DataWriter (p. 557) belongs.
8.178.2.3
String topic name
Name of the related com.rti.dds.topic.Topic (p. 1545).

The length of this string is limited to 255 characters.
8.178.2.4
String type name
Name of the type attached to the com.rti.dds.topic.Topic (p. 1545).

8.178.2.5
durability policy of the corresponding DataWriter (p. 557)

8.178.2.6
durability service policy of the corresponding DataWriter (p. 557)

8.178.2.7
Policy of the corresponding DataWriter (p. 557).

8.178.2.8

8.178.2.9


8.178.2.10
1253

8.178.2.11

8.178.2.12

8.178.2.13

8.178.2.14

8.178.2.15

8.178.2.16
Policy of the Publisher (p. 1262) to which the DataWriter (p. 557) belongs.
8.178.2.17
8.178.2.18

8.178.2.19
1254
8.178.2.20
Class Documentation
TypeCode type code
<<eXtension>> ( p. 278) Type code information of the corresponding Topic

8.178.2.21
final BuiltinTopicKey t publisher key
<<eXtension>> ( p. 278) DCPS key of the publisher to which the

DataWriter (p. 557) belongs
8.178.2.22
<<eXtension>> ( p. 278) Properties of the corresponding DataWriter

(p. 557).
8.178.2.23
<<eXtension>> ( p. 278) Custom unicast locators that the endpoint can specify. The default locators will be used if this is not specified.
8.178.2.24
<<eXtension>> ( p. 278) Virtual GUID associated to the DataWriter

(p. 557).
See also:
com.rti.dds.infrastructure.GUID t (p. 1044)
8.178.2.25

8.178.2.26

8.178.2.27


8.178.2.28
1255
final LocatorFilterQosPolicy locator filter
<<eXtension>> ( p. 278) Policy of the corresponding DataWriter (p. 557)

Related to com.rti.dds.infrastructure.MultiChannelQosPolicy (p. 1187).
8.178.2.29
<<eXtension>> ( p. 278) This is a vendor specific parameter. Determines

whether matching DataReaders send positive acknowledgements for reliability.
8.178.2.30
<<eXtension>> ( p. 278) The publication (p. 349) name and role name.
This member contains the name and the role name of the discovered publication (p. 349).
1256
8.179
Class Documentation
PublicationBuiltinTopicDataDataReader
Class Reference
Instantiates DataReader < builtin.PublicationBuiltinTopicData (p. 1249)

>.
8.179.1
Instantiates DataReader < builtin.PublicationBuiltinTopicData (p. 1249)

>.
of
topic
(p. 359)
(p. 487)
builtin.PublicationBuiltinTopicDataTypeSupport.PUBLICATION TOPIC NAME
(p. 1258)
used
for
accessing
(p. 1249)
of
the
remote
(p. 557)
and
the
associated
Instantiates:
<<generic>>
(p. 979)
( p. 279)
See also:
builtin.PublicationBuiltinTopicData (p. 1249)
builtin.PublicationBuiltinTopicDataTypeSupport.PUBLICATION TOPIC NAME (p. 1258)
8.180 PublicationBuiltinTopicDataSeq Class Reference
8.180
PublicationBuiltinTopicDataSeq
Reference
1257
Class

builtin.PublicationBuiltinTopicData (p. 1249) > .
8.180.1

builtin.PublicationBuiltinTopicData (p. 1249) > .
Instantiates:
See also:
1258
Class Documentation
8.181
PublicationBuiltinTopicDataTypeSupport
Class Reference
Instantiates TypeSupport < builtin.PublicationBuiltinTopicData (p. 1249)

>.
Inheritance diagram for PublicationBuiltinTopicDataTypeSupport::

static final String PUBLICATION TOPIC NAME
PUBLICATION TOPIC NAME()
DDS -
Publication topic ( p. 359) name.
8.181.1
Instantiates TypeSupport < builtin.PublicationBuiltinTopicData (p. 1249)

>.
Instantiates:
<<generic>>
(p. 1036)
( p. 279)
See also:
8.181.2
8.181.2.1
final String PUBLICATION TOPIC NAME =

DDS PUBLICATION TOPIC NAME() [static]
Publication topic (p. 359) name.

Topic name of builtin.PublicationBuiltinTopicDataDataReader (p. 1256)
See also:
builtin.PublicationBuiltinTopicDataDataReader (p. 1256)
8.182 PublicationMatchedStatus Class Reference
8.182
1259
PublicationMatchedStatus Class Reference

Inherits Status.
Public Attributes
int total count
The
total
cumulative
number
of
times
the
concerned
com.rti.dds.publication.DataWriter ( p. 557) discovered a match
with a com.rti.dds.subscription.DataReader ( p. 487).

int current count

The
current
number
of
readers
with
which
com.rti.dds.publication.DataWriter ( p. 557) is matched.
the
int current count peak

<<eXtension>> (p. 278) The highest value that current count has reached
until now.
int current count change

The change in current count since the last time the listener was called or the
status was read.
final InstanceHandle t last subscription handle

A handle to the last com.rti.dds.subscription.DataReader ( p. 487) that
caused the the com.rti.dds.publication.DataWriter ( p. 557)s status to
change.
8.182.1

A match happens when the com.rti.dds.publication.DataWriter
(p. 557) finds a com.rti.dds.subscription.DataReader (p. 487) for
1260
Class Documentation
the same com.rti.dds.topic.Topic (p. 1545) and common partition

with a requested QoS that is compatible with that offered by the
This status is also changed (and the listener, if any, called) when a match is
ended. A local com.rti.dds.publication.DataWriter (p. 557) will become
unmatched from a remote com.rti.dds.subscription.DataReader (p. 487)
when that com.rti.dds.subscription.DataReader (p. 487) goes away for any
reason.
8.182.2
8.182.2.1
int total count
The
total
cumulative
number
of
times
the
concerned
com.rti.dds.publication.DataWriter (p. 557) discovered a match
with a com.rti.dds.subscription.DataReader (p. 487).
This number increases whenever a new match is discovered. It does not change
when an existing match goes away.
8.182.2.2
8.182.2.3
int current count
The
current
number
of
readers
with
com.rti.dds.publication.DataWriter (p. 557) is matched.
which
the
This number increases when a new match is discovered and decreases when an
existing match goes away.
8.182.2.4
<<eXtension>> ( p. 278) The highest value that current count has reached
until now.
8.182.2.5
status was read.
8.182 PublicationMatchedStatus Class Reference

8.182.2.6
1261
final InstanceHandle t last subscription handle
A handle to the last com.rti.dds.subscription.DataReader (p. 487) that

caused the the com.rti.dds.publication.DataWriter (p. 557)s status to
change.
1262
Class Documentation
8.183
Publisher Interface Reference
<<interface>> ( p. 279) A publisher is the object responsible for the actual

Inheritance diagram for Publisher::

Copies the default com.rti.dds.publication.DataWriterQos ( p. 610) values into the provided com.rti.dds.publication.DataWriterQos ( p. 610)
instance.

Sets the default com.rti.dds.publication.DataWriterQos ( p. 610) values
for this publisher.
void set default datawriter qos with profile (String library name,
<<eXtension>>
(p. 278)
Set
com.rti.dds.publication.DataWriterQos ( p. 610)
publisher based on the input XML QoS profile.
the
values
default
for this
DataWriter create datawriter (Topic topic, DataWriterQos qos,

Creates a com.rti.dds.publication.DataWriter ( p. 557) that will be attached and belong to the com.rti.dds.publication.Publisher ( p. 1262).
DataWriter create datawriter with profile (Topic topic, String library name, String profile name, DataWriterListener listener, int
mask)
( p. 557) object using the com.rti.dds.publication.DataWriterQos

Deletes a com.rti.dds.publication.DataWriter ( p. 557) that belongs to the
DataWriter lookup datawriter (String topic name)

Retrieves the com.rti.dds.publication.DataWriter ( p. 557) for a specific
com.rti.dds.topic.Topic ( p. 1545).
8.183 Publisher Interface Reference
1263
void set qos (PublisherQos qos)

Sets the publisher QoS.
<<eXtension>> (p. 278) Change the QoS of this publisher using the input
XML QoS profile.
void get qos (PublisherQos qos)

Gets the publisher QoS.


<<eXtension>> (p. 278) Sets the default
XML
library
for

XML
profile
for

<<eXtension>> (p. 278) Gets the library where the default XML QoS profile is contained for a com.rti.dds.publication.Publisher ( p. 1262).
void set listener (PublisherListener l, int mask)

Sets the publisher listener.
PublisherListener get listener ()

Get the publisher listener.
void suspend publications ()

Indicates to RTI Connext that the application is about to make multiple modifications using com.rti.dds.publication.DataWriter ( p. 557) objects belonging to the com.rti.dds.publication.Publisher ( p. 1262).
void resume publications ()

1264
Class Documentation
Indicates
to
RTI
Connext
that
the
application
has
completed
the
multiple
changes
initiated
by
the
previous
com.rti.dds.publication.Publisher.suspend publications ( p. 1280).
void begin coherent changes ()

Indicates that the application will begin a coherent set of modifications using com.rti.dds.publication.DataWriter ( p. 557) objects attached to the
void end coherent changes ()

Terminates the coherent set initiated by the matching call to
com.rti.dds.publication.Publisher.begin coherent changes ( p. 1282).
void copy from topic qos (DataWriterQos a datawriter qos, TopicQos a topic qos)
Copies the policies in the com.rti.dds.topic.TopicQos ( p. 1566) to the
corresponding policies in the com.rti.dds.publication.DataWriterQos
( p. 610).
void get all datawriters (DataWriterSeq writers)

Retrieve all the DataWriters created from this Publisher ( p. 1262).

the com.rti.dds.publication.Publisher ( p. 1262) belongs.

Deletes all the entities that were created by means of the create operation
on the com.rti.dds.publication.Publisher ( p. 1262).

Blocks the calling thread until all data written by the Publishers reliable
DataWriters is acknowledged, or until timeout expires.
void wait for asynchronous publishing (Duration t max wait)

<<eXtension>> (p. 278) Blocks the calling thread until asynchronous sending is complete.
DataWriter lookup datawriter by name exp (String datawriter name)

<<experimental>>
(p. 278)
<<eXtension>>
(p. 278)
Retrieves
a
( p. 557)
contained within the com.rti.dds.publication.Publisher ( p. 1262) the
com.rti.dds.publication.DataWriter ( p. 557) entity name.
1265

static final DataWriterQos DATAWRITER QOS DEFAULT
Special value for creating com.rti.dds.publication.DataWriter ( p. 557)
with default QoS.
static final DataWriterQos DATAWRITER QOS USE TOPIC QOS = new DataWriterQos()
Special
value
for
creating
( p. 557)
with
a
combination
of
the
default
and
the
( p. 610)
8.183.1
<<interface>> ( p. 279) A publisher is the object responsible for the actual

QoS:
com.rti.dds.publication.PublisherQos (p. 1290)
Listener:
com.rti.dds.publication.PublisherListener (p. 1289)
A
publisher
acts
on
the
behalf
of
one
or
several
com.rti.dds.publication.DataWriter (p. 557) objects that belong to
it. When it is informed of a change to the data associated with one of its
com.rti.dds.publication.DataWriter (p. 557) objects, it decides when it is
appropriate to actually send the data-update message. In making this decision,
it considers any extra information that goes with the data (timestamp, writer,
etc.) as well as the QoS of the com.rti.dds.publication.Publisher (p. 1262)
and the com.rti.dds.publication.DataWriter (p. 557).
The
following
operations
may
be
called
even
if
the
com.rti.dds.publication.Publisher (p. 1262) is not enabled.
Other
operations will fail with the value com.rti.dds.infrastructure.RETCODE NOT ENABLED
(p. 1361)
if
called
on
a
disabled
com.rti.dds.publication.Publisher (p. 1262):
The base-class operations com.rti.dds.publication.Publisher.set qos
(p. 1275),
com.rti.dds.publication.Publisher.set qos with profile (p. 1276), com.rti.dds.publication.Publisher.get qos
(p. 1276),
com.rti.dds.publication.Publisher.set listener
1266
Class Documentation
(p. 1279),
com.rti.dds.publication.Publisher.get listener
(p. 935),
(p. 1280),
(p. 936),
com.rti.dds.infrastructure.Entity.get status changes (p. 936)
(p. 1269),
com.rti.dds.publication.Publisher.create datawriter with profile
com.rti.dds.publication.Publisher.delete datawriter
(p. 1271),
(p. 1273),
com.rti.dds.publication.Publisher.delete contained entities (p. 1284), com.rti.dds.publication.Publisher.set default datawriter qos (p. 1267), com.rti.dds.publication.Publisher.set default datawriter qos with profile
(p. 1268),
(p. 1266),
com.rti.dds.publication.Publisher.wait for acknowledgments (p. 1285), com.rti.dds.publication.Publisher.set default library (p. 1277), com.rti.dds.publication.Publisher.set default profile (p. 1278),
See also:
8.183.2
8.183.2.1
Copies the default com.rti.dds.publication.DataWriterQos (p. 610) values into the provided com.rti.dds.publication.DataWriterQos (p. 610) instance.
The retreived qos will match the set of values specified on the last successful call to com.rti.dds.publication.Publisher.set default datawriter qos
(p. 1267) or com.rti.dds.publication.Publisher.set default datawriter qos with profile (p. 1268), or else, if the call was never made, the default
values from is owning com.rti.dds.domain.DomainParticipant (p. 654).
MT Safety:
UNSAFE. It is not safe to retrieve the default QoS value from
a com.rti.dds.publication.Publisher (p. 1262) while another thread
may be simultaneously calling com.rti.dds.publication.Publisher.set default datawriter qos (p. 1267).
1267
Parameters:
qos <<inout>> ( p. 279) com.rti.dds.publication.DataWriterQos
(p. 610) to be filled-up. Cannot be NULL.
Exceptions:
See also:
8.183.2.2
Sets the default com.rti.dds.publication.DataWriterQos (p. 610) values for

this publisher.
This call causes the default values inherited from the owning
com.rti.dds.domain.DomainParticipant (p. 654) to be overridden.
This
default
value
will
be
used
for
newly
creif
ated
(p. 557)
com.rti.dds.publication.Publisher.DATAWRITER QOS DEFAULT (p. 182) is specified as the qos parameter when
com.rti.dds.publication.Publisher.create datawriter (p. 1269) is called.
Precondition:
MT Safety:
UNSAFE. It is not safe to set the default QoS value
from
a
(p. 1262)
while
another
thread
may
be
simultaneously
calling
(p. 1267),
(p. 1266)
or
calling
(p. 1269)
with
com.rti.dds.publication.Publisher.DATAWRITER QOS DEFAULT (p. 182) as the qos parameter.
1268
Class Documentation
Parameters:
The special value
com.rti.dds.subscription.Subscriber.DATAREADER QOS DEFAULT (p. 196) may be passed as qos to indicate that the default
QoS should be reset back to the initial values the factory would used if
(p. 1267) had never been called. Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.183.2.3
void set default datawriter qos with profile (String

<<eXtension>>
( p. 278)
Set
the
default
com.rti.dds.publication.DataWriterQos (p. 610) values for this publisher based on the input XML QoS profile.
This
default
value
will
be
used
for
newly
created
(p. 557)
if
com.rti.dds.publication.Publisher.DATAWRITER QOS DEFAULT (p. 182) is specified as the qos parameter when
com.rti.dds.publication.Publisher.create datawriter (p. 1269) is called.
Precondition:
The com.rti.dds.publication.DataWriterQos (p. 610) contained in the
MT Safety:
from
a
(p. 1262)
while
another
thread
may
be
simultaneously
calling
(p. 1267),
(p. 1266)
or
calling
(p. 1269)
with
com.rti.dds.publication.Publisher.DATAWRITER QOS DEFAULT (p. 182) as the qos parameter.
1269
Parameters:
QoS profile.
(p. 1278)).
fails
with
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
See also:
(p. 1271)
8.183.2.4
DataWriter create datawriter (Topic topic,

DataWriterQos qos, DataWriterListener listener, int
mask)
Creates a com.rti.dds.publication.DataWriter (p. 557) that will be attached

and belong to the com.rti.dds.publication.Publisher (p. 1262).
For each application-defined type, com.rti.ndds.example.Foo (p. 977), there
is an implied, auto-generated class com.rti.ndds.example.FooDataWriter
(p. 1012) that extends com.rti.dds.publication.DataWriter (p. 557) and
contains the operations to write data of type com.rti.ndds.example.Foo
(p. 977).
Note that a common application pattern to construct the QoS for the
com.rti.dds.publication.DataWriter (p. 557) is to:
Retrieve the QoS policies on the associated com.rti.dds.topic.Topic
(p. 1545) by means of the com.rti.dds.topic.Topic.get qos (p. 1548)
operation.
1270
Class Documentation
Retrieve the default com.rti.dds.publication.DataWriter (p. 557) qos
by means of the com.rti.dds.publication.Publisher.get default datawriter qos (p. 1266) operation.
Combine
those
two
QoS
policies
(for
example,
using
com.rti.dds.publication.Publisher.copy from topic qos (p. 1283))
and selectively modify policies as desired.
When
a
(p. 557)
is
created, only those transports already registered are available to the
See Built-in Transcom.rti.dds.publication.DataWriter (p. 557).
port Plugins (p. 222) for details on when a builtin (p. 352) transport is
registered.
Precondition:
If publisher is enabled, topic (p. 359) must have been enabled. Otherwise,
this operation will fail and no com.rti.dds.publication.DataWriter
the same participant as this publisher. If it was created from a different
participant, this method will fail.
MT Safety:
UNSAFE. If com.rti.dds.publication.Publisher.DATAWRITER QOS DEFAULT (p. 182) is used for the qos parameter, it is
not safe to create the datawriter while another thread may be simultaneously calling com.rti.dds.publication.Publisher.set default datawriter qos (p. 1267).
Parameters:
topic ( p. 359) <<in>> ( p. 279)
The special
value
com.rti.dds.publication.Publisher.DATAWRITER QOS DEFAULT (p. 182) can be used to indicate that the
com.rti.dds.publication.DataWriter (p. 557) should be created
with the default com.rti.dds.publication.DataWriterQos (p. 610)
set in the com.rti.dds.publication.Publisher (p. 1262). The special value com.rti.dds.publication.Publisher.DATAWRITER QOS USE TOPIC QOS (p. 183) can be used to indicate
that
the
1271

(p. 610)
set
on
the
(p. 1262)
of
the
and
the
(p. 1566)
com.rti.dds.topic.Topic (p. 1545). Cannot be NULL.
listener <<in>>
( p. 279)
The
listener
of
the

Returns:
See also:
entity creation
com.rti.dds.publication.Publisher.DATAWRITER QOS USE TOPIC QOS (p. 183)
(p. 1271)
(p. 1266)
8.183.2.5
DataWriter create datawriter with profile (Topic

topic, String library name, String profile name,

(p. 557) object using the com.rti.dds.publication.DataWriterQos (p. 610)
The com.rti.dds.publication.DataWriter (p. 557) will be attached and belong to the com.rti.dds.publication.Publisher (p. 1262).
1272
Class Documentation
For each application-defined type, com.rti.ndds.example.Foo (p. 977), there

is an implied, auto-generated class com.rti.ndds.example.FooDataWriter
(p. 1012) that extends com.rti.dds.publication.DataWriter (p. 557) and
contains the operations to write data of type com.rti.ndds.example.Foo
(p. 977).
is
creWhen
a
(p. 557)
ated, only those transports already registered are available to the
See Built-in Transport Plugins (p. 222) for details on when a builtin (p. 352) transport is
registered.
Precondition:
If publisher is enabled, topic (p. 359) must have been enabled. Otherwise,
this operation will fail and no com.rti.dds.publication.DataWriter
the same participant as this publisher. If it was created from a different
participant, this method will return NULL.
Parameters:
topic ( p. 359) <<in>> ( p. 279)
QoS profile.
(p. 1278)).
listener <<in>>
( p. 279)
The
listener
of
the
Returns:
See also:
1273
entity creation
(p. 1266)
8.183.2.6
Deletes a com.rti.dds.publication.DataWriter (p. 557) that belongs to the

The deletion of the com.rti.dds.publication.DataWriter (p. 557) will automatically unregister all instances.
Depending on the settings of the
WRITER DATA LIFECYCLE (p. 140) QosPolicy, the deletion of the
com.rti.dds.publication.DataWriter (p. 557) may also dispose all instances.
8.183.3
Special Instructions if Using Timestamp APIs

and BY SOURCE TIMESTAMP Destination Ordering:
If the DataWriters com.rti.dds.infrastructure.DestinationOrderQosPolicy.kind

(p. 633) is com.rti.dds.infrastructure.DestinationOrderQosPolicyKind.DestinationOrderQosPolicyKind.BY SOURCE TIMESTAMP DESTINATIONORDER QOS, calls to delete datawriter() (p. 1273) may fail if your application has previously used the
with timestamp APIs (write w timestamp(), register instance w timestamp(),
unregister instance w timestamp(), or dispose w timestamp()) with a timestamp larger (later) than the time at which delete datawriter() (p. 1273) is
called. To prevent delete datawriter() (p. 1273) from failing in this situation,
either:
Change the WRITER DATA LIFECYCLE (p. 140) QosPolicy
so that RTI Connext will not autodispose unregistered instances (set
com.rti.dds.infrastructure.WriterDataLifecycleQosPolicy.autodispose unregistered instances (p. 1739) to com.rti.dds.infrastructure.false.)
or
Explicitly call unregister instance w timestamp() for all instances modified with the w timestamp() APIs before calling delete datawriter()
(p. 1273).
1274
Class Documentation
Precondition:
If the com.rti.dds.publication.DataWriter (p. 557) does not belong to
the com.rti.dds.publication.Publisher (p. 1262), the operation will fail
with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
Postcondition:
Listener installed on the com.rti.dds.publication.DataWriter (p. 557)
Parameters:
a datawriter <<in>> ( p. 279) The com.rti.dds.publication.DataWriter
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
8.183.3.1
DataWriter lookup datawriter (String topic name)
Retrieves the com.rti.dds.publication.DataWriter (p. 557) for a specific

This returned com.rti.dds.publication.DataWriter (p. 557) is either enabled
or disabled.
Parameters:
topic name <<in>> ( p. 279) Name of the com.rti.dds.topic.Topic
(p. 557) that is to be looked up. Cannot be NULL.
Returns:
A com.rti.dds.publication.DataWriter (p. 557) that belongs to
the com.rti.dds.publication.Publisher (p. 1262) attached to the
com.rti.dds.topic.Topic (p. 1545) with topic name.
If no such
com.rti.dds.publication.DataWriter (p. 557) exists, this operation returns NULL.
If more than one com.rti.dds.publication.DataWriter (p. 557) is attached to
the com.rti.dds.publication.Publisher (p. 1262) with the same topic name,
then this operation may return any one of them.
1275
MT Safety:
UNSAFE.
It
is
not
safe
to
lookup
a
in
one
thread
(p. 557)
while another thread is simultaneously creating or destroying that
8.183.3.2
void set qos (PublisherQos qos)
Sets the publisher QoS.

This operation modifies the QoS of the com.rti.dds.publication.Publisher
(p. 1262).
The
com.rti.dds.publication.PublisherQos.group data
(p. 1291),
and
com.rti.dds.publication.PublisherQos.partition
(p. 1291)
com.rti.dds.publication.PublisherQos.entity factory
(p. 1291)
can
Parameters:
qos <<in>>
( p. 279)
com.rti.dds.publication.PublisherQos
cannot be changed after com.rti.dds.publication.Publisher
(p. 1262)
is
enabled.
The
special
value
com.rti.dds.domain.DomainParticipant.PUBLISHER QOS DEFAULT (p. 153) can be used to indicate that the QoS of the
com.rti.dds.publication.Publisher (p. 1262) should be changed to
match the current default com.rti.dds.publication.PublisherQos
(p. 1290) set in the com.rti.dds.domain.DomainParticipant
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
See also:
1276
8.183.3.3
Class Documentation
profile name)
<<eXtension>> ( p. 278) Change the QoS of this publisher using the input
XML QoS profile.
This operation modifies the QoS of the com.rti.dds.publication.Publisher
(p. 1262).
The
com.rti.dds.publication.PublisherQos.group data
(p. 1291),
com.rti.dds.publication.PublisherQos.partition
(p. 1291)
and
(p. 1291)
can
com.rti.dds.publication.PublisherQos.entity factory
Parameters:
QoS profile.
(p. 1278)).
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
See also:
8.183.3.4
void get qos (PublisherQos qos)
Gets the publisher QoS.

Parameters:
qos <<in>>
( p. 279)
com.rti.dds.publication.PublisherQos
1277
Exceptions:
See also:
8.183.3.5

Returns:
See also:
com.rti.dds.publication.Publisher.set default library (p. 1277)
8.183.3.6
<<eXtension>> ( p. 278) Sets the default

XML
library
for
a default library is needed during a call to one of this Publishers operations.
default library.
If the default library is not set, the com.rti.dds.publication.Publisher
(p. 1262) inherits the default from the com.rti.dds.domain.DomainParticipant
(p. 654) (see com.rti.dds.domain.DomainParticipant.set default library
(p. 707)).
Parameters:
Exceptions:
See also:
com.rti.dds.publication.Publisher.get default library (p. 1277)
1278
8.183.3.7
Class Documentation

Returns:
See also:
com.rti.dds.publication.Publisher.set default profile (p. 1278)
8.183.3.8

profile name)

XML
profile
for
This method specifies the profile that will be used as the default the next time
a default Publisher (p. 1262) profile is needed during a call to one of this
Publishers operations. When calling a com.rti.dds.publication.Publisher
(p. 1262) method that requires a profile name parameter, you can use NULL
to refer to the default profile. (This same information applies to setting a default
library.)
If the default profile is not set, the com.rti.dds.publication.Publisher
(p. 654) (see com.rti.dds.domain.DomainParticipant.set default profile
(p. 708)).
This
method
does
not
set
the
default
QoS
for
com.rti.dds.publication.DataWriter (p. 557) objects created by the
com.rti.dds.publication.Publisher (p. 1262); for this functionality, use
com.rti.dds.publication.Publisher.set default datawriter qos with profile (p. 1268) (you may pass in NULL after having called set default profile() (p. 1278)).
This method does not set the default QoS for newly created Publishers;
for this functionality, use com.rti.dds.domain.DomainParticipant.set default publisher qos with profile (p. 672).
Parameters:
1279
Exceptions:
See also:
com.rti.dds.publication.Publisher.get default profile (p. 1278)
com.rti.dds.publication.Publisher.get default profile library
(p. 1279)
8.183.3.9
is contained for a com.rti.dds.publication.Publisher (p. 1262).
The
default
profile
library
is
automatically
set
when
com.rti.dds.publication.Publisher.set default profile (p. 1278) is called.
This library can be different than the com.rti.dds.publication.Publisher
(p. 1262) default library (see com.rti.dds.publication.Publisher.get default library (p. 1277)).
Returns:
See also:
com.rti.dds.publication.Publisher.set default profile (p. 1278)
8.183.3.10
void set listener (PublisherListener l, int mask)
Sets the publisher listener.

Parameters:
l <<in>>
( p. 279)
(p. 1289) to set to.
with the com.rti.dds.publication.PublisherListener (p. 1289).
Exceptions:
See also:
1280
8.183.3.11
Class Documentation
PublisherListener get listener ()
Get the publisher listener.

Returns:
(p. 1289)
of
the
See also:
8.183.3.12
void suspend publications ()
Indicates to RTI Connext that the application is about to make multiple modifications using com.rti.dds.publication.DataWriter (p. 557) objects belonging to the com.rti.dds.publication.Publisher (p. 1262).
It is a hint to RTI Connext so it can optimize its performance by e.g., holding
the dissemination of the modifications and then batching them.
The use of this operation must be matched by a corresponding call
to com.rti.dds.publication.Publisher.resume publications (p. 1281) indicating that the set of modifications has completed.
If the com.rti.dds.publication.Publisher (p. 1262) is deleted before
com.rti.dds.publication.Publisher.resume publications (p. 1281) is
called, any suspended updates yet to be published will be discarded.
RTI Connext is not required and does not currently make use of this hint in
any way. However, similar results can be achieved by using asynchronous publishing. Combined with com.rti.dds.publication.FlowController (p. 964),
PUBLISH MODE QOS
(p. 557)
instances allow the user even finer control of traffic shaping and sample
coalescing.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361).
or
See also:
1281
com.rti.dds.publication.FlowController.ON DEMAND FLOW CONTROLLER NAME (p. 189)

8.183.3.13
void resume publications ()
Indicates
to
RTI
Connext
that
the
application
has
completed
the
multiple
changes
initiated
by
the
previous
com.rti.dds.publication.Publisher.suspend publications (p. 1280).
This is a hint to RTI Connext that can be used for example, to batch all the
modifications made since the com.rti.dds.publication.Publisher.suspend publications (p. 1280).
RTI Connext is not required and does not currently make use of this hint in
any way. However, similar results can be achieved by using asynchronous publishing. Combined with com.rti.dds.publication.FlowController (p. 964),
com.rti.dds.infrastructure.PublishModeQosPolicyKind.PublishModeQosPolicyKind.ASYNCHRONOUS PUBLISH MODE QOS
(p. 557)
instances allow the user even finer control of traffic shaping and sample
coalescing.
Precondition:
A
call
to
com.rti.dds.publication.Publisher.resume publications
(p. 1281)
must
match
a
previous
call
to
com.rti.dds.publication.Publisher.suspend publications
(p. 1280).
Otherwise
the
operation
will
fail
with
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
(p. 1363)
or
(p. 1361).
See also:
1282
8.183.3.14
Class Documentation
void begin coherent changes ()
Indicates that the application will begin a coherent set of modifications using com.rti.dds.publication.DataWriter (p. 557) objects attached to the
A coherent set is a set of modifications that must be propagated in such a
way that they are interpreted at the receivers side as a consistent set of modifications; that is, the receiver will only be able to access the data after all the
modifications in the set are available at the receiver end.
A connectivity change may occur in the middle of a set of coherent changes; for
example, the set of partitions used by the com.rti.dds.publication.Publisher
(p. 1262) or one of its com.rti.dds.subscription.Subscriber (p. 1476) s may
change, a late-joining com.rti.dds.subscription.DataReader (p. 487) may
appear on the network, or a communication failure may occur. In the event
that such a change prevents an entity from receiving the entire set of coherent
changes, that entity must behave as if it had received none of the set.
These calls can be nested. In that case, the coherent set terminates only with
the last call to com.rti.dds.publication.Publisher.end coherent changes
(p. 1282).
The support for coherent changes enables a publishing application to change the
value of several data-instances that could belong to the same or different topics
and have those changes be seen atomically by the readers. This is useful in cases
where the values are inter-related (for example, if there are two data-instances
representing the altitude and velocity vector of the same aircraft and both are
changed, it may be useful to communicate those values in a way the reader can
see both together; otherwise, it may e.g., erroneously interpret that the aircraft
is on a collision course).
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361).
8.183.3.15
or
void end coherent changes ()
Terminates the coherent set initiated by the matching call to

com.rti.dds.publication.Publisher.begin coherent changes (p. 1282).
Precondition:
If there is no matching call to com.rti.dds.publication.Publisher.begin coherent changes
(p. 1282)
the
operation
will
fail
with
1283

Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
com.rti.dds.infrastructure.RETCODE (p. 1363)
or
(p. 1361).
8.183.3.16
void copy from topic qos (DataWriterQos

a datawriter qos, TopicQos a topic qos)
Copies the policies in the com.rti.dds.topic.TopicQos (p. 1566) to the corresponding policies in the com.rti.dds.publication.DataWriterQos (p. 610).
Copies the policies in the com.rti.dds.topic.TopicQos (p. 1566) to the corresponding policies in the com.rti.dds.publication.DataWriterQos (p. 610)
(replacing values in the com.rti.dds.publication.DataWriterQos (p. 610),
if present).
This is a convenience operation most useful in combination with the operations com.rti.dds.publication.Publisher.get default datawriter qos
(p. 1266) and com.rti.dds.topic.Topic.get qos (p. 1548). The operation
com.rti.dds.publication.Publisher.copy from topic qos (p. 1283) can be
used to merge the com.rti.dds.publication.DataWriter (p. 557) default
QoS policies with the corresponding ones on the com.rti.dds.topic.Topic
(p. 1545).
The resulting QoS can then be used to create a new
com.rti.dds.publication.DataWriter (p. 557), or set its QoS.
This
operation
does
not
check
the
resulting
com.rti.dds.publication.DataWriterQos (p. 610) for consistency. This
is because the merged com.rti.dds.publication.DataWriterQos (p. 610)
may not be the final one, as the application can still modify some policies
prior to applying the policies to the com.rti.dds.publication.DataWriter
(p. 557).
Parameters:
a datawriter qos <<inout>> ( p. 279) com.rti.dds.publication.DataWriterQos
a topic qos <<in>> ( p. 279) com.rti.dds.topic.TopicQos (p. 1566)
to be merged with com.rti.dds.publication.DataWriterQos
1284
Class Documentation
Exceptions:
8.183.3.17
void get all datawriters (DataWriterSeq writers)
Retrieve all the DataWriters created from this Publisher (p. 1262).
Parameters:
writers <<inout>> ( p. 279) Sequence where the DataWriters will be
added
Exceptions:
8.183.3.18

com.rti.dds.publication.Publisher (p. 1262) belongs.
Returns:
the com.rti.dds.domain.DomainParticipant (p. 654) to which the
com.rti.dds.publication.Publisher (p. 1262) belongs.
8.183.3.19
Deletes all the entities that were created by means of the create operation on
the com.rti.dds.publication.Publisher (p. 1262).
Deletes all contained com.rti.dds.publication.DataWriter (p. 557) objects.
Once com.rti.dds.publication.Publisher.delete contained entities (p. 1284) completes successfully, the application may delete the
com.rti.dds.publication.Publisher (p. 1262), knowing that it has no
contained com.rti.dds.publication.DataWriter (p. 557) objects.
The operation will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363) if any of the contained entities is
in a state where it cannot be deleted.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or

8.183.3.20
1285
Blocks the calling thread until all data written by the Publishers reliable
DataWriters is acknowledged, or until timeout expires.
This operation blocks the calling thread until either all data written by the reliable entities is acknowledged by (a) all reliable
com.rti.dds.subscription.DataReader (p. 487) entities that are matched
and alive and (b) by all required subscriptions, or until the duration specified
by the max wait parameter elapses, whichever happens first. A successful
completion indicates that all the samples written have been acknowledged; a
return value of TIMEOUT indicates that max wait elapsed before all the data
was acknowledged.
Note that if a thread is blocked in the call to this operation on a
com.rti.dds.publication.Publisher (p. 1262) and a different thread writes
new samples on any of the reliable DataWriters that belong to this Publisher
(p. 1262), the new samples must be acknowledged before unblocking the thread
that is waiting on this operation.
If none of the com.rti.dds.publication.DataWriter (p. 557) instances have
com.rti.dds.infrastructure.ReliabilityQosPolicy (p. 1324) kind set to RELIABLE, the operation will complete successfully.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364)
8.183.3.21
void wait for asynchronous publishing (Duration t

max wait)
<<eXtension>> ( p. 278) Blocks the calling thread until asynchronous sending is complete.
This operation blocks the calling thread (up to max wait) until all
data written by the asynchronous com.rti.dds.publication.DataWriter
(p. 557) entities is sent and acknowledged (if reliable) by all matched
com.rti.dds.subscription.DataReader (p. 487) entities. A successful completion indicates that all the samples written have been sent and acknowledged
1286
Class Documentation
where applicable; if it times out, this indicates that max wait elapsed before all
the data was sent and/or acknowledged.
In other words,
this guarantees that sending to best effort
com.rti.dds.subscription.DataReader (p. 487) is complete in addition
to what com.rti.dds.publication.Publisher.wait for acknowledgments
(p. 1285) provides.
If none of the com.rti.dds.publication.DataWriter (p. 557) instances have
com.rti.dds.infrastructure.PublishModeQosPolicy.kind (p. 1297) set to
PUBLISH MODE QOS, the operation will complete immediately, with
Parameters:
max wait <<in>> ( p. 279) Specifies maximum time to wait for acknowledgements com.rti.dds.infrastructure.Duration t (p. 813).
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1364)
8.183.3.22
DataWriter lookup datawriter by name exp (String

datawriter name)
<<eXtension>>
( p. 278)
Re<<experimental>>
( p. 278)
trieves
a
(p. 557)
contained within the com.rti.dds.publication.Publisher (p. 1262) the
com.rti.dds.publication.DataWriter (p. 557) entity name.
Every com.rti.dds.publication.DataWriter (p. 557) in the system has an
EntityName policy, ENTITY NAME (p. 74).
This operation retrieves the com.rti.dds.publication.DataWriter (p. 557)
within the com.rti.dds.publication.Publisher (p. 1262) whose name matches
the one specified. If there are several com.rti.dds.publication.DataWriter
(p. 557) with the same name within the com.rti.dds.publication.Publisher
(p. 1262), the operation returns the first matching occurrence.
Parameters:
datawriter name <<in>>
( p. 279)
Entity
name
of
the
1287
Returns:
The first com.rti.dds.publication.DataWriter (p. 557) found with the
See also:
com.rti.dds.domain.DomainParticipant.lookup datawriter by name exp (p. 733)
1288
8.184
Class Documentation
PublisherAdapter Class Reference

methods)
Inheritance diagram for PublisherAdapter::
8.184.1

methods)
8.185 PublisherListener Interface Reference
8.185
1289
PublisherListener Interface Reference

com.rti.dds.publication.Publisher (p. 1262) status.
Inheritance diagram for PublisherListener::
8.185.1

com.rti.dds.publication.Publisher (p. 1262) status.
Entity:
com.rti.dds.publication.Publisher (p. 1262)
Status:
(p. 1195);
(p. 1197);
(p. 1259);
(p. 1333);
com.rti.dds.infrastructure.StatusKind.StatusKind.RELIABLE WRITER CACHE CHANGED STATUS, com.rti.dds.publication.ReliableWriterCacheChangedStatus
(p. 1336)
See also:
1290
Class Documentation
8.186
PublisherQos Class Reference
QoS policies supported by a com.rti.dds.publication.Publisher (p. 1262) entity.

Inheritance diagram for PublisherQos::
Public Attributes
Presentation policy, PRESENTATION ( p. 90).

Partition policy, PARTITION ( p. 89).

Group data policy, GROUP DATA ( p. 77).

final AsynchronousPublisherQosPolicy asynchronous publisher

<<eXtension>> (p. 278) Asynchronous publishing settings for the
com.rti.dds.publication.Publisher ( p. 1262) and all entities that are created by it.
final ExclusiveAreaQosPolicy exclusive area

<<eXtension>>
(p. 278)
Exclusive
com.rti.dds.publication.Publisher ( p. 1262)
are created by it.
8.186.1
area
and all
for
entities
the
that
QoS policies supported by a com.rti.dds.publication.Publisher (p. 1262) entity.

length
of
com.rti.dds.publication.PublisherQos.group data.value
<=
(p. 776)
.publisher group data max length
8.186 PublisherQos Class Reference
1291
length
of
com.rti.dds.publication.PublisherQos.partition.name
<=
(p. 776)
.max partitions
combined
number
of
characters
(including
terminating
0)
in
com.rti.dds.publication.PublisherQos.partition.name
<=
(p. 776)
.max partition cumulative characters
If any of the above are not true, com.rti.dds.publication.Publisher.set qos (p. 1275) and com.rti.dds.publication.Publisher.set qos with profile (p. 1276) will fail with com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY (p. 1359) and com.rti.dds.domain.DomainParticipant.create publisher (p. 683) will return NULL.
8.186.2
8.186.2.1
Presentation policy, PRESENTATION (p. 90).
8.186.2.2
Partition policy, PARTITION (p. 89).
8.186.2.3
Group data policy, GROUP DATA (p. 77).
8.186.2.4
8.186.2.5
final AsynchronousPublisherQosPolicy
asynchronous publisher
<<eXtension>> ( p. 278) Asynchronous publishing settings for the

com.rti.dds.publication.Publisher (p. 1262) and all entities that are created
by it.
1292
8.186.2.6
Class Documentation
<<eXtension>>
( p. 278)
Exclusive
area
for
the
com.rti.dds.publication.Publisher (p. 1262) and all entities that are
created by it.
8.187 PublisherSeq Class Reference
8.187
1293
PublisherSeq Class Reference
Declares IDL sequence < com.rti.dds.publication.Publisher (p. 1262) > .


PublisherSeq (Collection publishers)
int getMaximum ()
sequence.
8.187.1
Declares IDL sequence < com.rti.dds.publication.Publisher (p. 1262) > .

See also:
8.187.2
8.187.2.1
PublisherSeq (Collection publishers)
Exceptions:
8.187.3
8.187.3.1
int getMaximum ()
elements.
first created.
1294
Class Documentation

Returns:
See also:
8.188 PublishModeQosPolicy Class Reference
8.188
1295
PublishModeQosPolicy Class Reference
Inheritance diagram for PublishModeQosPolicy::
Public Attributes
PublishModeQosPolicyKind kind
Publishing mode.
String flow controller name

Name of the associated flow controller.
8.188.1
The publishing mode of a com.rti.dds.publication.DataWriter (p. 557) determines whether data is written synchronously in the context of the user
thread when calling com.rti.ndds.example.FooDataWriter.write (p. 1021)
or asynchronously in the context of a separate thread internal to the middleware.
Each
(p. 1262)
spawns
a
single
asynchronous
publishing
thread
(com.rti.dds.infrastructure.AsynchronousPublisherQosPolicy.thread
(p. 399)) to serve all its asynchronous com.rti.dds.publication.DataWriter
(p. 557) instances.
See also:
(p. 397)
Entity:
1296
Class Documentation
Properties:
RxO (p. 101) = N/A
8.188.2
Usage
The fastest way for RTI Connext to send data is for the user thread to execute
the middleware code that actually sends the data itself. However, there are
times when user applications may need or want an internal middleware thread
to send the data instead. For instance, to send large data reliably, you must use
an asynchronous thread.
When data is written asynchronously, a com.rti.dds.publication.FlowController
(p. 964), identified by flow controller name, can be used to shape
the network traffic.
Shaping a data flow usually means limiting the
maximum data rates at which the middleware will send data for a
com.rti.dds.publication.DataWriter (p. 557). The flow controller will
buffer any excess data and only send it when the send rate drops below
the maximum rate. The flow controllers properties determine when the
asynchronous publishing thread is allowed to send data and how much.
Asynchronous publishing may increase latency, but offers the following advantages:
- The com.rti.ndds.example.FooDataWriter.write (p. 1021) call does not
make any network calls and is therefore faster and more deterministic. This
becomes important when the user thread is executing time-critical code.
- When data is written in bursts or when sending large data types as multiple fragments, a flow controller can throttle the send rate of the asynchronous
publishing thread to avoid flooding the network.
- Asynchronously written samples for the same destination will be coalesced into
a single network packet which reduces bandwidth consumption.
The maximum number of samples that will be coalesced depends
on
com.rti.ndds.transport.Transport.Property t.gather send buffer count max (p. 1574) (each sample requires at least 2-4
gather-send buffers).
Performance can be improved by increasing
com.rti.ndds.transport.Transport.Property t.gather send buffer count max (p. 1574). Note that the maximum value is operating system
dependent.
The middleware must queue samples until they can be sent by
the asynchronous publishing thread (as determined by the corresponding com.rti.dds.publication.FlowController (p. 964)).
The
number of samples that will be queued is determined by the
When using
8.188 PublishModeQosPolicy Class Reference
1297
com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP only
the
most
recent
LAST HISTORY QOS,
com.rti.dds.infrastructure.HistoryQosPolicy.depth
(p. 1049)
samples are kept in the queue. Once unsent samples are removed from the queue,
they are no longer available to the asynchronous publishing thread and will
therefore never be sent.
8.188.3
8.188.3.1
PublishModeQosPolicyKind kind
Publishing mode.
[default] com.rti.dds.infrastructure.PublishModeQosPolicyKind.PublishModeQosPolicyKind.SYNCHRONOUS PUBLISH MODE QOS
8.188.3.2
String flow controller name
Name of the associated flow controller.

NULL
value
or
zero-length
string
refers
com.rti.dds.publication.FlowController.DEFAULT FLOW CONTROLLER NAME (p. 187).
to
See also:
(p. 681)
com.rti.dds.publication.FlowController.DEFAULT FLOW CONTROLLER NAME (p. 187)
com.rti.dds.publication.FlowController.FIXED RATE FLOW CONTROLLER NAME (p. 188)
[default] com.rti.dds.publication.FlowController.DEFAULT FLOW CONTROLLER NAME (p. 187)
1298
Class Documentation
8.189
PublishModeQosPolicyKind Class Reference

Inheritance diagram for PublishModeQosPolicyKind::

static final PublishModeQosPolicyKind
PUBLISH MODE QOS
SYNCHRONOUS -
Indicates to send data synchronously.
static final PublishModeQosPolicyKind ASYNCHRONOUS PUBLISH MODE QOS

Indicates to send data asynchronously.
8.189.1

QoS:
8.189.2
8.189.2.1
final PublishModeQosPolicyKind
SYNCHRONOUS PUBLISH MODE QOS [static]
Indicates to send data synchronously.

If com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.push on write (p. 594) is com.rti.dds.infrastructure.true, data is sent immediately in
the context of com.rti.ndds.example.FooDataWriter.write (p. 1021).
As data is sent immediately in the context of the user thread, no flow control
is applied.
See also:
com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.push on write (p. 594)
8.189 PublishModeQosPolicyKind Class Reference
1299

8.189.2.2
final PublishModeQosPolicyKind
ASYNCHRONOUS PUBLISH MODE QOS [static]
Indicates to send data asynchronously.

Configures the com.rti.dds.publication.DataWriter (p. 557) to delegate
the task of data transmission to a separate publishing thread.
The
com.rti.ndds.example.FooDataWriter.write (p. 1021) call does not send
the data, but instead schedules the data to be sent later by its associated
Each com.rti.dds.publication.Publisher (p. 1262) uses its dedicated publishing thread (com.rti.dds.publication.PublisherQos.asynchronous publisher (p. 1291)) to send data for all its asynchronous
DataWriters.
For each asynchronous DataWriter, the associated
com.rti.dds.publication.FlowController (p. 964) determines when the
publishing thread is allowed to send the data.
com.rti.dds.publication.DataWriter.wait for asynchronous publishing (p. 573) and com.rti.dds.publication.Publisher.wait for asynchronous publishing (p. 1285) enable you to determine when the data
has actually been sent.
See also:
com.rti.dds.publication.DataWriter.wait for asynchronous publishing (p. 573)
com.rti.dds.publication.Publisher.wait for asynchronous publishing (p. 1285)
com.rti.ndds.transport.Transport.Property t.gather send buffer count max (p. 1574)
1300
Class Documentation
8.190
Qos Class Reference

Inheritance diagram for Qos::

final boolean equals (Object other)
8.190.1
8.190.2
8.190.2.1
final boolean equals (Object other)
Parameters:
other <<in>> ( p. 279) Other object to compare with this QoS.
Returns:
true if the given object is a QoS of the same concrete type as this QoS and
all policies are equal, false otherwise
8.191 QosPolicy Class Reference
8.191
1301
QosPolicy Class Reference

Inheritance diagram for QosPolicy::
Public Attributes
final QosPolicyId t id
The ID of this QoS policy.
final String policy name

The name of this QoS policy.
8.191.1
8.191.2
8.191.2.1
final QosPolicyId t id
The ID of this QoS policy.

This attribute is provided for more efficient comparisons of policy types that
comparing strings.
8.191.2.2
final String policy name
The name of this QoS policy.
1302
Class Documentation
8.192
QosPolicyCount Class Reference

(p. 1305).
Inherits Struct.

QosPolicyCount (QosPolicyCount src)
Copy constructor.
Public Attributes
QosPolicyId t policy id
The QosPolicy (p. 1301) ID.
int count
a counter
8.192.1

(p. 1305).
8.192.2
8.192.2.1
QosPolicyCount (QosPolicyCount src)
Copy constructor.
Parameters:
src QosPolicyCount (p. 1302) to copy from.
Exceptions:
NullPointerException if the source object is null.
8.192 QosPolicyCount Class Reference
8.192.3
8.192.3.1
QosPolicyId t policy id
1303
The QosPolicy (p. 1301) ID.

8.192.3.2
int count
a counter
1304
8.193
Class Documentation
QosPolicyCountSeq Class Reference

(p. 1302) >.
8.193.1

(p. 1302) >.
Instantiates:
See also:
com.rti.dds.infrastructure.QosPolicyCount (p. 1302)
8.194 QosPolicyId t Class Reference
8.194
1305
QosPolicyId t Class Reference

Inheritance diagram for QosPolicyId t::

static final QosPolicyId t INVALID QOS POLICY ID
Identifier for an invalid QoS policy.
static final QosPolicyId t USERDATA QOS POLICY ID

Identifier for com.rti.dds.infrastructure.UserDataQosPolicy ( p. 1694).
static final QosPolicyId t DURABILITY QOS POLICY ID

Identifier for com.rti.dds.infrastructure.DurabilityQosPolicy ( p. 802).
static final QosPolicyId t PRESENTATION QOS POLICY ID

Identifier
( p. 1221).
for
static final QosPolicyId t DEADLINE QOS POLICY ID

Identifier for com.rti.dds.infrastructure.DeadlineQosPolicy ( p. 628).
static final QosPolicyId t LATENCYBUDGET QOS POLICY ID

Identifier
( p. 1124).
for
static final QosPolicyId t OWNERSHIP QOS POLICY ID

Identifier
( p. 1199).
for

POLICY ID
OWNERSHIPSTRENGTH QOS -

( p. 1209).
static final QosPolicyId t LIVELINESS QOS POLICY ID

Identifier for com.rti.dds.infrastructure.LivelinessQosPolicy ( p. 1140).
1306
Class Documentation
static final QosPolicyId t TIMEBASEDFILTER QOS POLICY ID
Identifier for com.rti.dds.infrastructure.TimeBasedFilterQosPolicy
( p. 1541).
static final QosPolicyId t PARTITION QOS POLICY ID

Identifier for com.rti.dds.infrastructure.PartitionQosPolicy ( p. 1217).
static final QosPolicyId t RELIABILITY QOS POLICY ID

Identifier
( p. 1324).
for
static
final
POLICY ID
QosPolicyId t
DESTINATIONORDER QOS -
Identifier for com.rti.dds.infrastructure.DestinationOrderQosPolicy

( p. 631).
static final QosPolicyId t HISTORY QOS POLICY ID

Identifier for com.rti.dds.infrastructure.HistoryQosPolicy ( p. 1046).
static final QosPolicyId t RESOURCELIMITS QOS POLICY ID

Identifier for
( p. 1348).
static final QosPolicyId t ENTITYFACTORY QOS POLICY ID

Identifier
( p. 938).
for
static final QosPolicyId t WRITERDATALIFECYCLE QOS POLICY ID

( p. 1738).
static final QosPolicyId t READERDATALIFECYCLE QOS POLICY ID

( p. 1315).
static final QosPolicyId t TOPICDATA QOS POLICY ID

Identifier
( p. 1559).
for
1307
static final QosPolicyId t GROUPDATA QOS POLICY ID

Identifier
( p. 1039).
for

POLICY ID
TRANSPORTPRIORITY QOS -
Identifier for com.rti.dds.infrastructure.TransportPriorityQosPolicy

( p. 1598).
static final QosPolicyId t LIFESPAN QOS POLICY ID

Identifier for com.rti.dds.infrastructure.LifespanQosPolicy ( p. 1128).

POLICY ID
DURABILITY SERVICE QOS -
Identifier for com.rti.dds.infrastructure.DurabilityServiceQosPolicy

( p. 810).
static
final
QosPolicyId t
TYPE CONSISTENCY ENFORCEMENT QOS POLICY ID
Identifier for com.rti.dds.infrastructure.TypeConsistencyEnforcementQosPolicy
( p. 1661).
static final QosPolicyId t WIREPROTOCOL QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.WireProtocolQosPolicy ( p. 1723)
for
static final QosPolicyId t DISCOVERY QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.DiscoveryQosPolicy ( p. 649)
for
static final QosPolicyId t DATAREADERRESOURCELIMITS QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
for
( p. 542)
static
final
QosPolicyId t
LIMITS QOS POLICY ID
DATA WRITER RESOURCE -
<<eXtension>>
(p. 278)
Identifier
for
( p. 621)
static final QosPolicyId t DATAREADERPROTOCOL QOS POLICY ID

1308
Class Documentation
<<eXtension>>
(p. 278)
Identifier
for
com.rti.dds.infrastructure.DataReaderProtocolQosPolicy ( p. 521)
static final QosPolicyId t DATAWRITERPROTOCOL QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
for
com.rti.dds.infrastructure.DataWriterProtocolQosPolicy ( p. 592)
static final QosPolicyId t DOMAINPARTICIPANTRESOURCELIMITS QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
for
( p. 778)
static final QosPolicyId t EVENT QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.EventQosPolicy ( p. 949)
for
static final QosPolicyId t DATABASE QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.DatabaseQosPolicy ( p. 482)
for
static final QosPolicyId t RECEIVERPOOL QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.ReceiverPoolQosPolicy ( p. 1318)
for
static final QosPolicyId t DISCOVERYCONFIG QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.DiscoveryConfigQosPolicy ( p. 639)
for
static final QosPolicyId t EXCLUSIVEAREA QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.ExclusiveAreaQosPolicy ( p. 952)
for
static final QosPolicyId t USEROBJECT QOS POLICY ID

<<eXtension>>
(p. 278)
com.rti.dds.infrastructure.UserObjectQosPolicy
Identifier
for
static final QosPolicyId t SYSTEMRESOURCELIMITS QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.SystemResourceLimitsQosPolicy
( p. 1523)
for

POLICY ID
1309
TRANSPORTSELECTION QOS -
<<eXtension>>
(p. 278)
Identifier
for
com.rti.dds.infrastructure.TransportSelectionQosPolicy ( p. 1600)
static
final
POLICY ID
QosPolicyId t
TRANSPORTUNICAST QOS -
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.TransportUnicastQosPolicy ( p. 1605)
for
static final QosPolicyId t TRANSPORTMULTICAST QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
for
com.rti.dds.infrastructure.TransportMulticastQosPolicy ( p. 1590)
static
final
POLICY ID
QosPolicyId t
TRANSPORTBUILTIN QOS -
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.TransportBuiltinQosPolicy ( p. 1580)
for
static final QosPolicyId t PUBLISHMODE QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.PublishModeQosPolicy ( p. 1295)

QOS POLICY ID
for
ASYNCHRONOUSPUBLISHER -
<<eXtension>>
(p. 278)
Identifier
( p. 397)
for
static final QosPolicyId t TYPESUPPORT QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
for
static final QosPolicyId t ENTITYNAME QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
for
static final QosPolicyId t BATCH QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.BatchQosPolicy ( p. 412)
static final QosPolicyId t PROFILE QOS POLICY ID

for
1310
Class Documentation
<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.ProfileQosPolicy ( p. 1231)
for
static final QosPolicyId t LOCATORFILTER QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.LocatorFilterQosPolicy ( p. 1157)
for
static final QosPolicyId t MULTICHANNEL QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.MultiChannelQosPolicy ( p. 1187)
for
static final QosPolicyId t AVAILABILITY QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.AvailabilityQosPolicy ( p. 402)
for
static final QosPolicyId t LOGGING QOS POLICY ID

<<eXtension>>
(p. 278)
Identifier
com.rti.dds.infrastructure.LoggingQosPolicy ( p. 1169)
8.194.1
for
8.194.2
8.194.2.1
final QosPolicyId t INVALID QOS POLICY ID

[static]
Identifier for an invalid QoS policy.

8.194.2.2
final QosPolicyId t TYPE CONSISTENCY ENFORCEMENT QOS POLICY ID

[static]
Identifier for com.rti.dds.infrastructure.TypeConsistencyEnforcementQosPolicy

(p. 1661).
8.194.2.3
final QosPolicyId t USEROBJECT QOS POLICY ID

[static]
<<eXtension>> ( p. 278) Identifier for com.rti.dds.infrastructure.UserObjectQosPolicy

8.195 QueryCondition Interface Reference
8.195
1311
QueryCondition Interface Reference
<<interface>>
( p. 279)
These
are
specialised
com.rti.dds.subscription.ReadCondition (p. 1313) objects that allow
the application to also specify a filter on the locally available data.
Inheritance diagram for QueryCondition::

String get query expression ()
Retrieves the query expression.
void get query parameters (StringSeq query parameters)

Retrieves the query parameters.
void set query parameters (StringSeq query parameters)

Sets the query parameters.
8.195.1
<<interface>>
( p. 279)
These
are
specialised
com.rti.dds.subscription.ReadCondition (p. 1313) objects that allow
the application to also specify a filter on the locally available data.
Each
query
condition
filter
is
composed
of
a
com.rti.dds.subscription.ReadCondition (p. 1313) state filter and a
content filter expressed as a query expression and query parameters.
The query (query expression) is similar to an SQL WHERE clause and can
be parameterised by arguments that are dynamically changeable by the set query parameters() (p. 1312) operation.
Two query conditions that have the same query expression will require unique
query condition content filters if their query paramters differ. Query conditions
that differ only in their state masks will share the same query condition content
filter.
Queries and Filters Syntax (p. 286) describes the syntax of query expression and query parameters.
1312
Class Documentation
8.195.2
8.195.2.1
String get query expression ()
Retrieves the query expression.

8.195.2.2
void get query parameters (StringSeq query parameters)
Retrieves the query parameters.

Parameters:
query parameters <<inout>> ( p. 279) the query parameters are returned here.
8.195.2.3
void set query parameters (StringSeq query parameters)
Sets the query parameters.

Parameters:
query parameters <<in>> ( p. 279) the new query parameters
8.196 ReadCondition Interface Reference
8.196
1313
ReadCondition Interface Reference
<<interface>> ( p. 279) Conditions specifically dedicated to read operations

and attached to one com.rti.dds.subscription.DataReader (p. 487).
Inheritance diagram for ReadCondition::

int get sample state mask ()
Retrieves the set of sample states for the condition.
int get view state mask ()

Retrieves the set of view states for the condition.
int get instance state mask ()

Retrieves the set of instance states for the condition.
DataReader get datareader ()

Returns the com.rti.dds.subscription.DataReader ( p. 487) associated
with the com.rti.dds.subscription.ReadCondition ( p. 1313).
8.196.1
<<interface>> ( p. 279) Conditions specifically dedicated to read operations

and attached to one com.rti.dds.subscription.DataReader (p. 487).
com.rti.dds.subscription.ReadCondition (p. 1313) objects allow an application to specify the data samples it is interested in (by specifying the desired sample states, view states as well as instance states in com.rti.ndds.example.FooDataReader.read (p. 981) and
com.rti.ndds.example.FooDataReader.take (p. 983) variants.
This allows RTI Connext to enable the condition only when suitable information
is available. They are to be used in conjunction with a WaitSet as normal
conditions.
More than one com.rti.dds.subscription.ReadCondition (p. 1313) may be
attached to the same com.rti.dds.subscription.DataReader (p. 487).
Note: If you are using a ReadCondition (p. 1313) simply to detect the presence
of new data, consider using a com.rti.dds.infrastructure.StatusCondition
1314
Class Documentation
(p. 1448) with the DATA AVAILABLE STATUS instead, which will perform
better in this situation.
8.196.2
8.196.2.1
int get sample state mask ()
Retrieves the set of sample states for the condition.

8.196.2.2
int get view state mask ()
Retrieves the set of view states for the condition.

8.196.2.3
int get instance state mask ()
Retrieves the set of instance states for the condition.

8.196.2.4
DataReader get datareader ()
Returns the com.rti.dds.subscription.DataReader (p. 487) associated with

There is exactly one com.rti.dds.subscription.DataReader (p. 487) assicated with each com.rti.dds.subscription.ReadCondition (p. 1313).
Returns:
com.rti.dds.subscription.DataReader (p. 487) associated with the
8.197 ReaderDataLifecycleQosPolicy Class Reference
8.197
1315
ReaderDataLifecycleQosPolicy Class Reference
Inheritance diagram for ReaderDataLifecycleQosPolicy::
Public Attributes
final Duration t autopurge nowriter samples delay
Maximum duration for which the com.rti.dds.subscription.DataReader
will
maintain
information
regarding
( p. 487)
an
instance
once
its
instance state
becomes
final Duration t autopurge disposed samples delay

( p. 487) will maintain samples for an instance once its instance state becomes com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE DISPOSED INSTANCE STATE.
8.197.1
When a DataReader receives data, it is stored in a receive queue for the
DataReader. The user application may either take the data from the queue
or leave it there.
This QoS policy controls whether or not RTI Connext will automatically
remove data from the receive queue (so that user applications cannot access it
afterwards) when it detects that there are no more DataWriters alive for that
data. It specifies how long a com.rti.dds.subscription.DataReader (p. 487)
must retain information regarding instances that have the instance state
Note: This policy is not concerned with keeping reliable reader state or discovery
information.
The com.rti.dds.subscription.DataReader (p. 487) internally maintains the samples that have not been taken by the application, subject to the constraints imposed by other QoS policies such
1316
Class Documentation
as
(p. 1046)
and
The com.rti.dds.subscription.DataReader (p. 487) also maintains information regarding the identity, view state and instance state of data instances
even after all samples have been taken. This is needed to properly compute the
states when future samples arrive.
Under normal circumstances the com.rti.dds.subscription.DataReader

(p. 487) can only reclaim all resources for instances for which there
are no writers and for which all samples have been taken.
The
last sample the com.rti.dds.subscription.DataReader (p. 487) will
have taken for that instance will have an instance state of either
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE NO WRITERS INSTANCE STATE or com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.N
ALIVE DISPOSED INSTANCE STATE depending on whether or not the last
writer that had ownership of the instance disposed it.
In the absence of READER DATA LIFECYCLE (p. 103), this behavior could cause problems if the application forgets to take those samples.
Untaken samples will prevent the com.rti.dds.subscription.DataReader
(p. 487) from reclaiming the resources and they would remain in the
com.rti.dds.subscription.DataReader (p. 487) indefinitely.
For keyed Topics, the consideration of removing data samples from the receive
queue is done on a per instance (key) basis. Thus when RTI Connext detects
that there are no longer DataWriters alive for a certain key value of a Topic (an
instance of the Topic), it can be configured to remove all data samples for that
instance (key).
Entity:
Properties:
RxO (p. 101) = N/A
8.197.2
8.197.2.1
final Duration t autopurge nowriter samples delay

(p. 487)
will
maintain
information
regarding
an
instance
once
its
instance state
becomes
8.197 ReaderDataLifecycleQosPolicy Class Reference
1317
After this time elapses, the com.rti.dds.subscription.DataReader (p. 487)

will purge all internal information regarding the instance, any untaken samples will also be lost.
8.197.2.2
final Duration t autopurge disposed samples delay

(p. 487) will maintain samples for an instance once its instance state
becomes com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE DISPOSED INSTANCE STATE.
After this time elapses, the com.rti.dds.subscription.DataReader (p. 487)
will purge all samples for the instance.
1318
Class Documentation
8.198
ReceiverPoolQosPolicy Class Reference
Configures threads used by RTI Connext to receive and process data from transports (for example, UDP sockets).
Inheritance diagram for ReceiverPoolQosPolicy::
Public Attributes
Receiver pool thread(s).
int buffer size

The receive buffer size.
int buffer alignment

The receive buffer alignment.
8.198.1
Configures threads used by RTI Connext to receive and process data from transports (for example, UDP sockets).
Entity:
Properties:
RxO (p. 101) = N/A
See also:
Controlling CPU Core Affinity for RTI Threads (p. 1533)
8.198.2
Usage
This QoS policy sets the thread properties such as priority level and stack size for
the threads used by the middleware to receive and process data from transports.
8.198 ReceiverPoolQosPolicy Class Reference
1319
RTI uses a separate receive thread per port per transport plug-in. To
force RTI Connext to use a separate thread to process the data for
a com.rti.dds.subscription.DataReader (p. 487), set a unique port for
the com.rti.dds.infrastructure.TransportUnicastQosPolicy (p. 1605) or
com.rti.dds.infrastructure.TransportMulticastQosPolicy (p. 1590) for
This QoS policy also sets the size of the buffer used to store packets received
from a transport. This buffer size will limit the largest single packet of data
that a com.rti.dds.domain.DomainParticipant (p. 654) will accept from a
transport. Users will often set this size to the largest packet that any of the
transports used by their application will deliver. For many applications, the
value 65,536 (64 K) is a good choice; this value is the largest packet that can
be sent/received via UDP.
8.198.3
8.198.3.1
Receiver pool thread(s).

There is at least one receive thread, possibly more.
[default] priority above normal.
For Windows: 2
For LynxOS: 29
For INTEGRITY: 100
For VxWorks: 71
For LynxOS: 4161024
1320
Class Documentation

[default] mask com.rti.dds.infrastructure.ThreadSettingsKind.THREAD (p. 1535)
|
SETTINGS FLOATING POINT
com.rti.dds.infrastructure.ThreadSettingsKind.THREAD SETTINGS STDIO (p. 1535)
8.198.3.2
int buffer size
The receive buffer size.

The receive buffer is used by the receive thread to store the raw data that arrives
over the transport.
In many applications, users will change the configuration of the built-in
transport com.rti.ndds.transport.Transport.Property t.message size max (p. 1574) to increase the size of the largest data packet that can be
sent or received through the transport. Typically, users will change the
UDPv4 transport plugins com.rti.ndds.transport.Transport.Property t.message size max (p. 1574) to 65536 (64 K), which is the largest packet
that can be sent/received via UDP.
Ihe ReceiverPoolQosPolicys buffer size should be set to be the same value as
the maximum com.rti.ndds.transport.Transport.Property t.message size max (p. 1574) across all of the transports being used.
If you are using the default configuration of the built-in transports, you should
not need to change this buffer size.
In addition, if your application only uses transports that support zerocopy, then you do not need to modify the value of buffer size, even
if the com.rti.ndds.transport.Transport.Property t.message size max
(p. 1574) of the transport is changed. Transports that support zero-copy do
not copy their data into the buffer provided by the receive thread. Instead,
they provide the receive thread data in a buffer allocated by the transport itself. The only built-in transport that supports zero-copy is the UDPv4 transport
on VxWorks platforms.
[default] 9216
[range] [1, 1 GB]
8.198.3.3
int buffer alignment
The receive buffer alignment.

Most users will not need to change this alignment.
[default] 16
8.198 ReceiverPoolQosPolicy Class Reference
1321
[range] [1,1024] Value must be a power of 2.
1322
Class Documentation
8.199
RefilterQosPolicyKind Class Reference
<<eXtension>> ( p. 278) Kinds of Refiltering

Inheritance diagram for RefilterQosPolicyKind::

static final RefilterQosPolicyKind NONE REFILTER QOS
[default] Do not filter existing samples for a new reader
static final RefilterQosPolicyKind ALL REFILTER QOS

Filter all existing samples for a new reader.
static final RefilterQosPolicyKind ON DEMAND REFILTER QOS

Filter existing samples only when they are requested by the reader.
8.199.1
<<eXtension>> ( p. 278) Kinds of Refiltering

QoS:
8.199.2
8.199.2.1
final RefilterQosPolicyKind NONE REFILTER QOS

[static]
[default] Do not filter existing samples for a new reader

On the publishing side, when a new reader matches a writer, the writer can be
configured to filter previously written samples stored in the writer queue for the
new reader. This option configures the writer to not filter any existing samples
for the reader and the reader will do the filtering.
8.199 RefilterQosPolicyKind Class Reference

8.199.2.2
1323
final RefilterQosPolicyKind ALL REFILTER QOS

[static]
Filter all existing samples for a new reader.

configured to filter previously written samples stored in the writer queue. This
option configures the writer to filter all existing samples for the reader when a
new reader is matched to the writer.
8.199.2.3
final RefilterQosPolicyKind ON DEMAND REFILTER QOS [static]
Filter existing samples only when they are requested by the reader.
configured to filter previously written samples stored in the writer queue. This
option configures the writer to filter only existing samples that are requested by
the reader.
1324
Class Documentation
8.200
ReliabilityQosPolicy Class Reference

Inheritance diagram for ReliabilityQosPolicy::
Public Attributes
ReliabilityQosPolicyKind kind
Kind of reliability.
final Duration t max blocking time

The maximum time a writer may block on a write() call.
ReliabilityQosPolicyAcknowledgmentModeKind
ment kind
acknowledg-
Kind of reliable acknowledgment.
8.200.1

Entity:
Status:
Properties:
RxO (p. 101) = YES
8.200.2
Usage
This policy indicates the level of reliability requested

com.rti.dds.subscription.DataReader (p. 487) or offered
by
by
a
a
8.200 ReliabilityQosPolicy Class Reference
1325
The reliability of a connection between a DataWriter and DataReader is entirely

user configurable. It can be done on a per DataWriter/DataReader connection.
A connection may be configured to be best effort which means that RTI
Connext will not use any resources to monitor or guarantee that the data sent
by a DataWriter is received by a DataReader.
For some use cases,
such as the periodic update of sensor values to a GUI displaying the value to a person,
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.BEST EFFORT RELIABILITY QOS delivery is often good enough. It is certainly
the fastest, most efficient, and least resource-intensive (CPU and network
bandwidth) method of getting the newest/latest value for a topic (p. 359) from
DataWriters to DataReaders. But there is no guarantee that the data sent will
be received. It may be lost due to a variety of factors, including data loss by
the physical transport such as wireless RF or even Ethernet.
However, there are data streams (topics) in which you want an absolute guarantee that all data sent by a DataWriter is received reliably by
DataReaders. This means that RTI Connext must check whether or not
data was received, and repair any data that was lost by resending a copy
of the data as many times as it takes for the DataReader to receive the
data. RTI Connext uses a reliability protocol configured and tuned by these
QoS policies: com.rti.dds.infrastructure.HistoryQosPolicy (p. 1046),
com.rti.dds.infrastructure.DataWriterProtocolQosPolicy
(p. 592),
com.rti.dds.infrastructure.DataReaderProtocolQosPolicy (p. 521), and
The Reliability QoS policy is simply a switch to turn on the reliability protocol
for a DataWriter/DataReader connection. The level of reliability provided by
RTI Connext is determined by the configuration of the aforementioned QoS
policies.
You can configure RTI Connext to deliver all data in the order they were sent
(also known as absolute or strict reliability). Or, as a tradeoff for less memory,
CPU, and network usage, you can choose a reduced level of reliability where
only the last N values are guaranteed to be delivered reliably to DataReaders
(where N is user-configurable). In the reduced level of reliability, there are no
guarantees that the data sent before the last N are received. Only the last N
data packets are monitored and repaired if necessary.
These levels are ordered, com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.BEST EFFORT RELIABILITY QOS < com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.REL
RELIABILITY QOS. A com.rti.dds.publication.DataWriter (p. 557)
offering one level is implicitly offering all levels below.
Note:
To send large data reliably, you will also need to set
com.rti.dds.infrastructure.PublishModeQosPolicyKind.PublishModeQosPolicyKind.ASYNCHRONOUS PUBLISH MODE QOS. Large in this context means that the data cannot be
sent as a single packet by the transport (for example, data larger than 63K
1326
Class Documentation
when using UDP/IP).

The setting of this policy has a dependency on the setting of the RESOURCE LIMITS (p. 106) policy. In case the reliability kind is set to
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.RELIABLE the
write
operation
on
the
RELIABILITY QOS
com.rti.dds.publication.DataWriter (p. 557) may block if the modification would cause data to be lost or else cause one of the limits in specified
in the RESOURCE LIMITS (p. 106) to be exceeded. Under these circumstances, the RELIABILITY (p. 105) max blocking time configures the
maximum duration the write operation may block.
If the com.rti.dds.infrastructure.ReliabilityQosPolicy.kind (p. 1327) is
set to com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.RELIABLE data
samples
originating
from
a
single
RELIABILITY QOS,
com.rti.dds.publication.DataWriter (p. 557) cannot be made available to the com.rti.dds.subscription.DataReader (p. 487) if there are
previous data samples that have not been received yet due to a communication error. In other words, RTI Connext will repair the error and resend
data samples as needed in order to reconstruct a correct snapshot of the
com.rti.dds.publication.DataWriter (p. 557) history before it is accessible
by the com.rti.dds.subscription.DataReader (p. 487).
If the com.rti.dds.infrastructure.ReliabilityQosPolicy.kind (p. 1327) is
set to com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.BEST EFFORT RELIABILITY QOS, the service will not re-transmit missing data samples.
However, for data samples originating from
any one DataWriter the service will ensure they are stored in the
com.rti.dds.subscription.DataReader (p. 487) history in the same order they originated in the com.rti.dds.publication.DataWriter (p. 557). In
other words, the com.rti.dds.subscription.DataReader (p. 487) may miss
some data samples, but it will never see the value of a data object change from
a newer value to an older value.
See also:
8.200.3
Compatibility
if:
the inequality offered kind >= requested kind evaluates
to TRUE. For the purposes of this inequality, the values
of
8.200 ReliabilityQosPolicy Class Reference
1327
(p. 1327)
are
considered
ordered
such
that
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.BEST EFFORT RELIABILITY QOS < com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind
RELIABILITY QOS.
The offered acknowledgment kind = com.rti.dds.infrastructure.ReliabilityQosPolicyAcknowledgmentModeKind.

ACKNOWLEDGMENT MODE and requested acknowledgment kind =
com.rti.dds.infrastructure.ReliabilityQosPolicyAcknowledgmentModeKind.ReliabilityQosPolicyAcknowledgmen
ACKNOWLEDGMENT MODE OR offered acknowledgment kind !=
com.rti.dds.infrastructure.ReliabilityQosPolicyAcknowledgmentModeKind.ReliabilityQosPolicyAcknowledgmen
ACKNOWLEDGMENT MODE.
8.200.4
8.200.4.1
ReliabilityQosPolicyKind kind
Kind of reliability.
[default] com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.BEST EFFORT RELIABILITY QOS for com.rti.dds.subscription.DataReader
(p. 487)
and
(p. 1545),
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.RELIABLE RELIABILITY QOS for com.rti.dds.publication.DataWriter (p. 557)
8.200.4.2
final Duration t max blocking time
The maximum time a writer may block on a write() call.

This
setting
applies
only
to
the
case
where
(p. 1327)
=
(p. 1021) is allowed to block if the com.rti.dds.publication.DataWriter
(p. 557) does not have space to store the value written. Only applies to
[default] 100 milliseconds
See also:
1328
8.200.4.3
Class Documentation
acknowledgment kind
Kind of reliable acknowledgment.

This
setting
applies
only
to
the
case
where
(p. 1327)
=
Sets
the
kind
acknowledgments
supported
and
(p. 557)
by
sent
a
by
[default] com.rti.dds.infrastructure.ReliabilityQosPolicyAcknowledgmentModeKind.ReliabilityQosPolicy
ACKNOWLEDGMENT MODE
8.201 ReliabilityQosPolicyAcknowledgmentModeKind Class

Reference
8.201
1329
Class Reference
Inheritance diagram for ReliabilityQosPolicyAcknowledgmentModeKind::

static final ReliabilityQosPolicyAcknowledgmentModeKind PROTOCOL ACKNOWLEDGMENT MODE
Samples are acknowledged by RTPS protocol.
static final ReliabilityQosPolicyAcknowledgmentModeKind APPLICATION AUTO ACKNOWLEDGMENT MODE

Samples are acknowleged automatically after a subscribing application has
accessed them.
static final ReliabilityQosPolicyAcknowledgmentModeKind APPLICATION EXPLICIT ACKNOWLEDGMENT MODE

Samples are acknowledged after the subscribing application explicitly calls
acknowledge on the samples.
8.201.1
QoS:
8.201.2
8.201.2.1
final ReliabilityQosPolicyAcknowledgmentModeKind
PROTOCOL ACKNOWLEDGMENT MODE [static]
Samples are acknowledged by RTPS protocol.

Samples are acknowledged according to the Real-Time Publish-Subscribe
(RTPS) interoperability protocol.
1330
8.201.2.2
Class Documentation
APPLICATION AUTO ACKNOWLEDGMENT MODE
[static]
Samples are acknowleged automatically after a subscribing application has accessed them.
A sample received by a com.rti.ndds.example.FooDataReader (p. 979) is
acknowledged after it has been taken and then returned. Specifically, all samples taken by a call to com.rti.ndds.example.FooDataReader.take (p. 983)
are acknowledged after com.rti.ndds.example.FooDataReader.return Acknowledgments are sent at a rate deloan (p. 1008) is called.
terminded by com.rti.dds.infrastructure.RtpsReliableReaderProtocol t.samples per app ack (p. 1370).
8.201.2.3
APPLICATION EXPLICIT ACKNOWLEDGMENT MODE [static]
Samples are acknowledged after the subscribing application explicitly calls acknowledge on the samples.
Samples received by a com.rti.dds.subscription.DataReader (p. 487) are
explicitly acknowledged by the subscribing application, after it calls either com.rti.dds.subscription.DataReader.acknowledge all (p. 505) or
com.rti.dds.subscription.DataReader.acknowledge sample (p. 505).
8.202 ReliabilityQosPolicyKind Class Reference
8.202
ReliabilityQosPolicyKind
ence
1331
Class
Refer-
Inheritance diagram for ReliabilityQosPolicyKind::

static
final
RELIABILITY QOS
BEST EFFORT -
Indicates that it is acceptable to not retry propagation of any samples.
static
final
RELIABILITY QOS
RELIABLE -
Specifies RTI Connext will attempt to deliver all samples in its history.
Missed samples may be retried.
8.202.1
QoS:
8.202.2
8.202.2.1
final ReliabilityQosPolicyKind BEST EFFORT RELIABILITY QOS [static]
Indicates that it is acceptable to not retry propagation of any samples.

Presumably new values for the samples are generated often enough that it is
not necessary to re-send or acknowledge any samples.
[default] for com.rti.dds.subscription.DataReader
(p. 487)
and
1332
8.202.2.2
Class Documentation
final ReliabilityQosPolicyKind RELIABLE RELIABILITY QOS [static]
Specifies RTI Connext will attempt to deliver all samples in its history. Missed
samples may be retried.
In
steady-state
(no
modifications
communicated
via
the
com.rti.dds.publication.DataWriter (p. 557)), RTI Connext guarantees
that all samples in the com.rti.dds.publication.DataWriter (p. 557) history
will eventually be delivered to all the com.rti.dds.subscription.DataReader
(p. 487) objects (subject to timeouts that indicate loss of communication with
a particular com.rti.dds.subscription.Subscriber (p. 1476)).
Outside steady state, the HISTORY (p. 79) and RESOURCE LIMITS
(p. 106) policies will determine how samples become part of the history and
whether samples can be discarded from it.
8.203 ReliableReaderActivityChangedStatus Class Reference
8.203
1333
Class Reference
<<eXtension>> ( p. 278) Describes the activity (i.e. are acknowledgements

Inherits Status.

ReliableReaderActivityChangedStatus ()
Construct a new status object with default contents.
tyChangedStatus src)
(ReliableReaderActivi-
Construct a new status identical to the given status.
Public Attributes
int active count
The current number of reliable readers currently matched with this reliable
writer.
int inactive count

The number of reliable readers that have been dropped by this reliable writer
because they failed to send acknowledgements in a timely fashion.
int active count change

The most recent change in the number of active remote reliable readers.
int inactive count change

The most recent change in the number of inactive remote reliable readers.

The instance handle of the last reliable remote reader to be determined inactive.
8.203.1
<<eXtension>> ( p. 278) Describes the activity (i.e. are acknowledgements

1334
Class Documentation
Entity:
Listener:
This
status
is
the
reciprocal
status
to
the
com.rti.dds.subscription.LivelinessChangedStatus
(p. 1135)
on
the
reader.
It
is
different
than
the
com.rti.dds.publication.LivelinessLostStatus (p. 1138) on the writer
in that the latter informs the writer about its own liveliness; this status informs
the writer about the liveliness (activity) of its matched readers.
All counts in this status will remain at zero for best effort writers.
8.203.2
8.203.2.1
ReliableReaderActivityChangedStatus ()
Construct a new status object with default contents.
8.203.2.2
(ReliableReaderActivityChangedStatus src)
Construct a new status identical to the given status.

Exceptions:
NullPointerException if the given status is null.
8.203.3
8.203.3.1
int active count
The current number of reliable readers currently matched with this reliable
writer.
8.203.3.2
int inactive count
The number of reliable readers that have been dropped by this reliable writer
because they failed to send acknowledgements in a timely fashion.
8.203 ReliableReaderActivityChangedStatus Class Reference
1335
A reader is considered to be inactive after is has been sent heartbeats com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.max heartbeat retries (p. 1378) times, each heartbeat having been separated from
the previous by the current heartbeat period.
8.203.3.3
int active count change
The most recent change in the number of active remote reliable readers.
8.203.3.4
int inactive count change
The most recent change in the number of inactive remote reliable readers.
8.203.3.5
The instance handle of the last reliable remote reader to be determined inactive.
1336
Class Documentation
8.204
Class Reference
<<eXtension>> ( p. 278) A summary of the state of a data writers cache of

unacknowledged samples written.
Inherits Status.

ReliableWriterCacheChangedStatus ()
Construct a new status object.
CacheChangedStatus src)
(ReliableWriter-
A copy constructor.
Public Attributes
final ReliableWriterCacheEventCount
cache
empty reliable writer -
The number of times the reliable writers cache of unacknowledged samples

has become empty.
final ReliableWriterCacheEventCount full reliable writer cache

= new ReliableWriterCacheEventCount()
The number of times the reliable writers cache, or send window, of unacknowledged samples has become full.
final ReliableWriterCacheEventCount low watermark reliable writer cache

has fallen to the low watermark.
final ReliableWriterCacheEventCount high watermark reliable writer cache

has risen to the high watermark.
int unacknowledged sample count

The current number of unacknowledged samples in the writers cache.
8.204 ReliableWriterCacheChangedStatus Class Reference
1337
int unacknowledged sample count peak

The highest value that unacknowledged sample count has reached until now.
8.204.1
<<eXtension>> ( p. 278) A summary of the state of a data writers cache of

unacknowledged samples written.
Entity:
Listener:
A written sample is unacknowledged (and therefore accounted for in this status)
if the writer is reliable and one or more readers matched with the writer has
not yet sent an acknowledgement to the writer declaring that it has received the
sample.
If the low watermark is zero and the unacknowledged sample count decreases
to zero, both the low watermark and cache empty events are considered to
have taken place. A single callback will be dispatched (assuming the user has
requested one) that contains both status changes. The same logic applies when
the high watermark is set equal to the maximum number of samples and the
cache becomes full.
8.204.2
8.204.2.1
ReliableWriterCacheChangedStatus ()
Construct a new status object.

8.204.2.2
(ReliableWriterCacheChangedStatus src)
A copy constructor.
Parameters:
src Source to copy from.
Exceptions:
NullPointerException if the source object is null.
1338
Class Documentation
8.204.3
8.204.3.1
empty reliable writer cache
The number of times the reliable writers cache of unacknowledged samples has
become empty.
8.204.3.2
final ReliableWriterCacheEventCount full reliable writer cache = new ReliableWriterCacheEventCount()
The number of times the reliable writers cache, or send window, of unacknowledged samples has become full.
Applies to writers cache when the send window is enabled (when both
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.min send window size (p. 1383) and com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.max send window size (p. 1384) are com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LE
UNLIMITED (p. 106)).
Otherwise, applies when the number of unacknowledged samples has reached
the send window limit.
8.204.3.3
low watermark reliable writer cache
fallen to the low watermark.
A low watermark event will only be considered to have taken place when the
number of unacknowledged samples in the writers cache decreases to this value.
A sample count that increases to this value will not result in a callback or in a
change to the total count of low watermark events.
When the writers send window is enabled, the low watermark is scaled down,
if necessary, to fit within the current send window.
8.204.3.4
high watermark reliable writer cache
risen to the high watermark.
A high watermark event will only be considered to have taken place when the
number of unacknowledged sampled increases to this value. A sample count
8.204 ReliableWriterCacheChangedStatus Class Reference
1339
that was above this value and then decreases back to it will not trigger an
event.
When the writers send window is enabled, the high watermark is scaled down,
if necessary, to fit within the current send window.
8.204.3.5
int unacknowledged sample count
The current number of unacknowledged samples in the writers cache.

A sample is considered unacknowledged if the writer has failed to receive an
acknowledgement from one or more reliable readers matched to it.
8.204.3.6
int unacknowledged sample count peak
The highest value that unacknowledged sample count has reached until now.
1340
Class Documentation
8.205
ReliableWriterCacheEventCount
Reference
Class
<<eXtension>> ( p. 278) The number of times the number of unacknowledged samples in the cache of a reliable writer hit a certain well-defined threshold.
Inherits Struct.
Public Attributes
int total count
The total number of times the event has occurred.

The incremental number of times the event has occurred since the listener
was last invoked or the status read.
8.205.1
<<eXtension>> ( p. 278) The number of times the number of unacknowledged samples in the cache of a reliable writer hit a certain well-defined threshold.
See also:
com.rti.dds.publication.ReliableWriterCacheChangedStatus
(p. 1336)
8.205.2
8.205.2.1
int total count
The total number of times the event has occurred.

8.205.2.2
The incremental number of times the event has occurred since the listener was
last invoked or the status read.
8.206 RemoteParticipantPurgeKind Class Reference
8.206
1341
RemoteParticipantPurgeKind Class Reference

Inheritance diagram for RemoteParticipantPurgeKind::

static final RemoteParticipantPurgeKind LIVELINESS BASED REMOTE PARTICIPANT PURGE
[default] Maintain knowledge of the remote participant for as long as it
maintains its liveliness contract.
static
final
RemoteParticipantPurgeKind
PARTICIPANT PURGE
NO REMOTE -
Never forget a remote participant with which discovery communication has

been lost.
8.206.1

When discovery communication with a remote participant has been lost, the
local participant must make a decision about whether to continue attempting
to communicate with that participant and its contained entities. This kind is
used to select the desired behavior.
This kind does not pertain to the situation in which a remote participant has
been gracefully deleted and notification of that deletion have been successfully
received by its peers. In that case, the local participant will immediately stop
attempting to communicate with those entities and will remove the associated
remote entity records from its internal database.
See also:
com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.remote participant purge kind (p. 642)
1342
Class Documentation
8.206.2
8.206.2.1
final RemoteParticipantPurgeKind LIVELINESS BASED REMOTE PARTICIPANT PURGE

[static]
Initial value:
new RemoteParticipantPurgeKind(
"LIVELINESS_BASED_REMOTE_PARTICIPANT_PURGE", 0)
[default] Maintain knowledge of the remote participant for as long as it maintains its liveliness contract.
A participant will continue attempting communication with its peers, even if
discovery communication with them is lost, as long as the remote participants
maintain their liveliness. If both discovery communication and participant liveliness are lost, however, the local participant will remove all records of the
remote participant and its contained endpoints, and no further data communication with them will occur until and unless they are rediscovered.
The
liveliness
contract
a
participant
promises
to
its
peers
its
liveliness
lease
duration
is
specified
in
its
com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.participant liveliness lease duration (p. 641) QoS field.
It maintains that contract by writing data to those other participants with a writer that has
a com.rti.dds.infrastructure.LivelinessQosPolicyKind (p. 1144) of
com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.AUTOMATIC LIVELINESS QOS or com.rti.dds.infrastructure.LivelinessQosPolicyKind.LivelinessQosPolicyKind.MAN
BY PARTICIPANT LIVELINESS QOS and by asserting itself (at the
com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.participant liveliness assert period (p. 642)) over the Simple Discovery Protocol.
8.206.2.2
final RemoteParticipantPurgeKind
NO REMOTE PARTICIPANT PURGE [static]
Initial value:
new RemoteParticipantPurgeKind(
"NO_REMOTE_PARTICIPANT_PURGE", 1)
Never forget a remote participant with which discovery communication has

been lost.
If a participant with this behavior loses discovery communication with a remote participant, it will nevertheless remember that remote participant and its
endpoints and continue attempting to communicate with them indefinitely.
8.206 RemoteParticipantPurgeKind Class Reference
1343
This value has consequences for a participants resource usage. If discovery

communication with a remote participant is lost, but the same participant is
later rediscovered, any relevant records that remain in the database will be
reused. However, if it is not rediscovered, the records will continue to take up
space in the database for as long as the local participant remains in existence.
1344
Class Documentation
8.207
RequestedDeadlineMissedStatus
Reference
Class

Inherits Status.
Public Attributes
int total count
Total cumulative count of the deadlines detected for any instance read by the

The incremental number of deadlines detected since the last time the listener
was called or the status was read.

Handle to the last instance in the com.rti.dds.subscription.DataReader
( p. 487) for which a deadline was detected.
8.207.1
8.207.2
8.207.2.1
int total count
Total cumulative count of the deadlines detected for any instance read by the
8.207.2.2
The incremental number of deadlines detected since the last time the listener
8.207 RequestedDeadlineMissedStatus Class Reference

8.207.2.3
1345
Handle to the last instance in the com.rti.dds.subscription.DataReader

(p. 487) for which a deadline was detected.
1346
Class Documentation
8.208
RequestedIncompatibleQosStatus
Reference
Class

Inherits Status.
Public Attributes
int total count
Total cumulative count of how many times the concerned
( p. 487)
discovered
a
for
the
same
( p. 557)
com.rti.dds.topic.Topic ( p. 1545) with an offered QoS that is incompatible
with that requested by the com.rti.dds.subscription.DataReader ( p. 487).

The change in total count since the last time the listener was called or the
status was read.

The PolicyId t of one of the policies that was found to be incompatible the
last time an incompatibility was detected.

A list containing, for each policy, the total number of times that
the concerned com.rti.dds.subscription.DataReader ( p. 487) discovered a com.rti.dds.publication.DataWriter ( p. 557) for the same
com.rti.dds.topic.Topic ( p. 1545) with an offered QoS that is incompatible
with that requested by the com.rti.dds.subscription.DataReader ( p. 487).
8.208.1

See also:
DURABILITY (p. 68)
PRESENTATION (p. 90)
RELIABILITY (p. 105)
OWNERSHIP (p. 87)
8.208 RequestedIncompatibleQosStatus Class Reference
1347
LIVELINESS (p. 82)

DEADLINE (p. 52)
LATENCY BUDGET (p. 80)
8.208.2
8.208.2.1
int total count
Total
cumulative
count
of
how
many
times
the
concerned
(p. 487)
discovered
a
for
the
same
(p. 557)
com.rti.dds.topic.Topic (p. 1545) with an offered QoS that is incompatible with that requested by the com.rti.dds.subscription.DataReader
(p. 487).
8.208.2.2
status was read.
8.208.2.3
The PolicyId t of one of the policies that was found to be incompatible the last
time an incompatibility was detected.
8.208.2.4
A list containing, for each policy, the total number of times that the
concerned
(p. 487)
discovered a com.rti.dds.publication.DataWriter (p. 557) for the same
com.rti.dds.topic.Topic (p. 1545) with an offered QoS that is incompatible with that requested by the com.rti.dds.subscription.DataReader
(p. 487).
1348
Class Documentation
8.209
ResourceLimitsQosPolicy
ence
Class
Refer-
Inheritance diagram for ResourceLimitsQosPolicy::
Public Attributes
int max samples
Represents the maximum samples the middleware can store
for any one com.rti.dds.publication.DataWriter ( p. 557) (or
int max instances

Represents
the
maximum
number
of
instances
( p. 557)
com.rti.dds.subscription.DataReader ( p. 487)) can manage.
a
(or

Represents the maximum number of samples of any one
stance
a
( p. 557)
com.rti.dds.subscription.DataReader ( p. 487)) can manage.
in(or
int initial samples

<<eXtension>> (p. 278) Represents the initial samples the middleware
will store for any one com.rti.dds.publication.DataWriter ( p. 557) (or
int initial instances

<<eXtension>> (p. 278) Represents the initial number of
stances
a
( p. 557)
com.rti.dds.subscription.DataReader ( p. 487)) will manage.
in(or
int instance hash buckets

<<eXtension>> (p. 278) Number of hash buckets for instances.
8.209 ResourceLimitsQosPolicy Class Reference
1349

static final int LENGTH UNLIMITED
8.209.1
Entity:
Status:
(p. 1418)
Properties:
RxO (p. 101) = NO
8.209.2
Usage
This policy controls the resources that RTI Connext can use to meet the requirements imposed by the application and other QoS settings.
For the reliability protocol (and com.rti.dds.infrastructure.DurabilityQosPolicy
(p. 802)), this QoS policy determines the actual maximum queue size when
the com.rti.dds.infrastructure.HistoryQosPolicy (p. 1046) is set to
com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP ALL HISTORY QOS.
In general, this QoS policy is used to limit the amount of system memory that
RTI Connext can allocate. For embedded real-time systems and safety-critical
systems, pre-determination of maximum memory usage is often required. In addition, dynamic memory allocation could introduce non-deterministic latencies
in time-critical paths.
This QoS policy can be set such that an entity does not dynamically allocate
any more memory after its initialization phase.
1350
Class Documentation
If com.rti.dds.publication.DataWriter (p. 557) objects are communicating samples faster than they are ultimately taken by the
com.rti.dds.subscription.DataReader (p. 487) objects, the middleware will
eventually hit against some of the QoS-imposed resource limits. Note that this
may occur when just a single com.rti.dds.subscription.DataReader (p. 487)
cannot keep up with its corresponding com.rti.dds.publication.DataWriter
The behavior in this case depends on the set(p. 557).
If
reliability
is
ting
for
the
RELIABILITY
(p. 105).
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.BEST EFFORT RELIABILITY QOS,
then
RTI
Connext
is
allowed
to
drop
samples.
If
the
reliability
is
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.RELIABLE RELIABILITY QOS,
RTI
Connext
will
block
the
com.rti.dds.publication.DataWriter (p. 557) or discard the sample at
the com.rti.dds.subscription.DataReader (p. 487) in order not to lose
existing samples.
The constant com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH may
be
used
to
indicate
the
UNLIMITED
(p. 106)
absence
of
a
particular
limit.
For
example
setting
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples per instance (p. 1352) to com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106) will cause RTI Connext not to enforce this particular
limit.
If these resource limits are not set sufficiently, under certain circumstances the
com.rti.dds.publication.DataWriter (p. 557) may block on a write() call
even though the com.rti.dds.infrastructure.HistoryQosPolicy (p. 1046) is
com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP LAST HISTORY QOS. To guarantee the writer does not block for
com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP LAST HISTORY QOS, make sure the resource limits are set such that:
max_samples >= max_instances * max_samples_per_instance
See also:
8.209.3
Consistency
The setting of com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples

(p. 1351)
must
be
consistent
with
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples per instance
(p. 1352).
For
these
two
values
to
be
consistent,
it
must
be
true
that
1351
(p. 1351) >= com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples per instance
(p. 1352).
As
described
above,
this
limit
will
not
be
enforced
if
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples per instance (p. 1352) is set to com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106).
The setting of RESOURCE LIMITS (p. 106) max samples per instance
must be consistent with the HISTORY (p. 79) depth. For these two QoS
to be consistent, it must be true that depth <= max samples per instance.
See also:
8.209.4
8.209.4.1
int max samples
Represents
the
maximum
samples
the
middleware
can
store
for
any
one
(p. 557)
(or
Specifies
the
maximum
number
of
data
samples
(or
a
(p. 557)
com.rti.dds.subscription.DataReader (p. 487)) can manage across all
the instances associated with it.
For unkeyed types,
this value has to be equal to max samples per instance if max samples per instance is not equal to
When
batching
is
enabled,
the
maximum
number
of
data
samples
a
(p. 557)
can
manage
will
also
be
limited
by
com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy.max batches (p. 624).
[range] [1, 100 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), >= initial samples, >= max samples per instance,
>= com.rti.dds.infrastructure.DataReaderResourceLimitsQosPolicy.max samples per remote writer
(p. 546)
or
>=
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.heartbeats per max samples (p. 1379)
1352
Class Documentation
For
(p. 610)
max samples
>=
com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.rtps reliable writer.heartbeats per max samples if batching is disabled.
8.209.4.2
int max instances
Represents
the
maximum
number
of
instances
(p. 557)
com.rti.dds.subscription.DataReader (p. 487)) can manage.
a
(or

[range] [1, 1 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), >= initial instances
8.209.4.3
Represents the maximum number of samples of any one

stance
a
(p. 557)
com.rti.dds.subscription.DataReader (p. 487)) can manage.
in(or
For unkeyed types, this value has to be equal to max samples or

[range] [1, 100 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED
(p. 106),
<=
max samples
or
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), >= com.rti.dds.infrastructure.HistoryQosPolicy.depth
(p. 1049)
8.209.4.4
int initial samples
<<eXtension>> ( p. 278) Represents the initial samples the middleware

will store for any one com.rti.dds.publication.DataWriter (p. 557) (or
Specifies
the
initial
number
of
data
samples
a
(p. 557)
(or
com.rti.dds.subscription.DataReader (p. 487)) will manage across all
the instances associated with it.
[default] 32
1353
[range] [1,100 million], <= max samples

8.209.4.5
int initial instances
<<eXtension>> ( p. 278) Represents the initial number of

stances
a
(p. 557)
com.rti.dds.subscription.DataReader (p. 487)) will manage.
in(or
[default] 32
[range] [1,1 million], <= max instances
8.209.4.6
int instance hash buckets
<<eXtension>> ( p. 278) Number of hash buckets for instances.

The instance hash table facilitates instance lookup. A higher number of buckets
decreases instance lookup time but increases the memory usage.
[default] 1 [range] [1,1 million]
1354
8.210
Class Documentation
RETCODE ALREADY DELETED Class

Reference

Inheritance diagram for RETCODE ALREADY DELETED::
8.210.1
8.211 RETCODE BAD PARAMETER Class Reference
8.211
RETCODE BAD PARAMETER

Reference
1355
Class

Inheritance diagram for RETCODE BAD PARAMETER::
8.211.1

The value of the parameter that is passed in has llegal value. Things that falls
into this category includes null parameters and parameter values that are out
of range.
1356
8.212
Class Documentation
RETCODE ERROR Class Reference

Inheritance diagram for RETCODE ERROR::
8.212.1
8.213 RETCODE ILLEGAL OPERATION Class Reference
8.213
1357
RETCODE ILLEGAL OPERATION

Class Reference

Inheritance diagram for RETCODE ILLEGAL OPERATION::
8.213.1

An
operation
was
invoked
on
an
inappropriate
object
or
at an inappropriate time.
This return code is similar to
com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363), except that there is no precondition that could be changed to
make the operation succeed.
1358
8.214
Class Documentation
RETCODE IMMUTABLE POLICY

Class Reference

Inheritance diagram for RETCODE IMMUTABLE POLICY::
8.214.1
8.215 RETCODE INCONSISTENT POLICY Class Reference 1359
8.215
RETCODE INCONSISTENT POLICY

Class Reference
other.
Inheritance diagram for RETCODE INCONSISTENT POLICY::
8.215.1
other.
1360
8.216
Class Documentation
RETCODE NO DATA Class Reference
Indicates a transient situation where the operation did not return any data but
there is no inherent error.
Inheritance diagram for RETCODE NO DATA::
8.216.1
Indicates a transient situation where the operation did not return any data but
there is no inherent error.
8.217 RETCODE NOT ENABLED Class Reference
8.217
1361
RETCODE NOT ENABLED Class Reference
Operation invoked on a com.rti.dds.infrastructure.Entity (p. 931) that is

not yet enabled.
Inheritance diagram for RETCODE NOT ENABLED::
8.217.1
Operation invoked on a com.rti.dds.infrastructure.Entity (p. 931) that is

not yet enabled.
1362
8.218
Class Documentation
RETCODE OUT OF RESOURCES

Class Reference
Inheritance diagram for RETCODE OUT OF RESOURCES::
8.218.1
8.219 RETCODE PRECONDITION NOT MET Class Reference

1363
8.219
RETCODE PRECONDITION NOT MET Class Reference

Inheritance diagram for RETCODE PRECONDITION NOT MET::
8.219.1

The system is not in the expected state when the function is called, or the
parameter itself is not in the expected state when the function is called.
1364
8.220
Class Documentation
RETCODE TIMEOUT Class Reference

Inheritance diagram for RETCODE TIMEOUT::
8.220.1
8.221 RETCODE UNSUPPORTED Class Reference
8.221
1365
RETCODE UNSUPPORTED Class Reference

Inheritance diagram for RETCODE UNSUPPORTED::
8.221.1
1366
Class Documentation
8.222
RtpsReliableReaderProtocol t Class Reference
Qos (p. 1300) related to reliable reader protocol defined in RTPS.

Inherits Struct.

RtpsReliableReaderProtocol t ()
Constructor with default values.
RtpsReliableReaderProtocol t
(Duration t
min heartbeat response delay,
Duration t
max heartbeat response delay,
Duration t heartbeat suppression duration, Duration t nack period, Duration t round trip time, Duration t app ack period,
Duration t min app ack response keep duration)
Constructor with given durations.
Public Attributes
final Duration t min heartbeat response delay
The minimum delay to respond to a heartbeat.
final Duration t max heartbeat response delay

The maximum delay to respond to a heartbeat.
final Duration t heartbeat suppression duration

The duration a reader ignores consecutively received heartbeats.
final Duration t nack period

The period at which to send NACKs.
int receive window size = 256

The number of received out-of-order samples a reader can keep at a time.
final Duration t round trip time

The duration from sending a NACK to receiving a repair of a sample.
final Duration t app ack period

The period at which application-level acknowledgment messages are sent.
8.222 RtpsReliableReaderProtocol t Class Reference
1367
final Duration t min app ack response keep duration

Minimum duration for which application-level acknowledgment response data
is kept.
int samples per app ack

The minimum number of samples acknowledged by one application-level acknowledgment message.
8.222.1
Qos (p. 1300) related to reliable reader protocol defined in RTPS.

It is used to config reliable reader according to RTPS protocol.
Properties:
RxO (p. 101) = N/A
QoS:
com.rti.dds.infrastructure.DataReaderProtocolQosPolicy (p. 521)
8.222.2
8.222.2.1
RtpsReliableReaderProtocol t ()
8.222.2.2
RtpsReliableReaderProtocol t (Duration t
min heartbeat response delay, Duration t
max heartbeat response delay, Duration t
heartbeat suppression duration, Duration t nack period,
Duration t round trip time, Duration t app ack period,
Duration t min app ack response keep duration)
Constructor with given durations.

1368
Class Documentation
8.222.3
8.222.3.1
final Duration t min heartbeat response delay
The minimum delay to respond to a heartbeat.

When a reliable reader receives a heartbeat from a remote writer and finds out
that it needs to send back an ACK/NACK message, the reader can choose to
delay a while. This sets the value of the minimum delay.
[default] 0 seconds
[range] [0, 1 year], <= max heartbeat response delay
8.222.3.2
final Duration t max heartbeat response delay
The maximum delay to respond to a heartbeat.

When a reliable reader receives a heartbeat from a remote writer and finds out
that it needs to send back an ACK/NACK message, the reader can choose to
delay a while. This sets the value of maximum delay.
[default] The default value depends on the container policy:
For com.rti.dds.infrastructure.DiscoveryConfigQosPolicy (p. 639) : 0
seconds
For com.rti.dds.infrastructure.DataReaderProtocolQosPolicy (p. 521) :
0.5 seconds
[range] [0, 1 year], >= min heartbeat response delay
8.222.3.3
final Duration t heartbeat suppression duration
The duration a reader ignores consecutively received heartbeats.

When a reliable reader receives consecutive heartbeats within a short duration
that will trigger redundant NACKs, the reader may ignore the latter heartbeat(s). This sets the duration during which additionally received heartbeats
are suppressed.
[default] 0.0625 seconds
[range] [0, 1 year],
8.222.3.4
final Duration t nack period
The period at which to send NACKs.

A reliable reader will send periodic NACKs at this rate when it first matches
1369
with a reliable writer. The reader will stop sending NACKs when it has received
all available historical data from the writer.
[default] 5 seconds
[range] [1 nanosec, 1 year]
8.222.3.5
int receive window size = 256
The number of received out-of-order samples a reader can keep at a time.

A reliable reader stores the out-of-order samples it receives until it can present
them to the application in-order. The receive window is the maximum number
of out-of-order samples that a reliable reader keeps at a given time. When the
receive window is full, subsequently received out-of-order samples are dropped.
[default] 256
[range] [>= 1]
8.222.3.6
final Duration t round trip time
The duration from sending a NACK to receiving a repair of a sample.

This round-trip time is an estimate of the time starting from when the reader
sends a NACK for a specific sample to when it receives that sample. For each
sample, the reader will not send a subsequent NACK for it until the round-trip
time has passed, thus preventing inefficient redundant requests.
[default] 0 seconds
8.222.3.7
final Duration t app ack period
The period at which application-level acknowledgment messages are sent.

A com.rti.dds.subscription.DataReader (p. 487) sends application-level acknowledgment messages to a com.rti.dds.publication.DataWriter (p. 557)
at this periodic rate, and will continue sending until it receives a message from
the com.rti.dds.publication.DataWriter (p. 557) that it has received and
processed the acknowledgment and an AppAckConfirmation has been received
by the com.rti.dds.subscription.DataReader (p. 487). Note: applicationlevel acknowledgment messages can also be sent non-periodically, as determined by com.rti.dds.infrastructure.RtpsReliableReaderProtocol t.samples per app ack (p. 1370).
[default] 5 seconds
1370
8.222.3.8
Class Documentation
final Duration t min app ack response keep duration
Minimum duration for which application-level acknowledgment response data

is kept.
The user-specified response data of an explicit application-level acknowledgment (called by com.rti.dds.subscription.DataReader.acknowledge sample (p. 505) or com.rti.dds.subscription.DataReader.acknowledge all (p. 505)) is cached by the com.rti.dds.subscription.DataReader (p. 487)
for the purpose of reliably resending the data with the acknowledgment message. After this duration has passed from the time of the first acknowledgment,
the response data is dropped from the cache and will not be resent with future
acknowledgments for the corresponding sample(s).
[default] 0 sec
[range] [0 sec, 1 year]
8.222.3.9
int samples per app ack
The minimum number of samples acknowledged by one application-level acknowledgment message.
This setting applies only when com.rti.dds.infrastructure.ReliabilityQosPolicy.acknowledgment

kind (p. 1328) = com.rti.dds.infrastructure.ReliabilityQosPolicyAcknowledgmentModeKind.ReliabilityQ
EXPLICIT ACKNOWLEDGMENT MODE or com.rti.dds.infrastructure.ReliabilityQosPolicyAcknowled
AUTO ACKNOWLEDGMENT MODE
A com.rti.dds.subscription.DataReader (p. 487) will immediately send an
application-level acknowledgment message when it has at least this many samples that have been acknowledged. It will not send an acknowledgment message
until it has at least this many samples pending acknowledgment.
For example, calling com.rti.dds.subscription.DataReader.acknowledge sample
(p. 505)
this
many
times
consecutively
will
trigger the sending of an acknowledgment message.
Calling
com.rti.dds.subscription.DataReader.acknowledge all (p. 505) may
trigger the sending of an acknowledgment message, if at least this many
samples are being acknowledged at once.
This is independent of the com.rti.dds.infrastructure.RtpsReliableReaderProtocol t.app ack period (p. 1369), where a com.rti.dds.subscription.DataReader
(p. 487) will send acknowledgement messages at the periodic rate regardless.
When this is set to com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED
(p. 106),
then
acknowledgement
messages
are
sent
only
periodically,
at
the
rate
set
by
com.rti.dds.infrastructure.RtpsReliableReaderProtocol t.app ack period (p. 1369).
1371
[default] 1
1372
Class Documentation
8.223
RtpsReliableWriterProtocol t Class Reference

Inherits Struct.
Public Attributes
int low watermark
When the number of unacknowledged samples in the cache
of a reliable writer meets or falls below this threshold, the
com.rti.dds.infrastructure.StatusKind.StatusKind.RELIABLE WRITER CACHE CHANGED STATUS is considered to have changed.
int high watermark

of a reliable writer meets or exceeds this threshold,
the
final Duration t heartbeat period

The period at which to send heartbeats.
final Duration t fast heartbeat period

An alternative heartbeat period used when a reliable writer needs to flush its
unacknowledged samples more quickly.
final Duration t late joiner heartbeat period

An alternative heartbeat period used when a reliable reader joins late and
needs to be caught up on cached samples of a reliable writer more quickly
than the normal heartbeat rate.
final Duration t virtual heartbeat period

The period at which to send virtual heartbeats. Virtual heartbeats inform the
reliable reader about the range of samples currently present, for each virtual
GUID, in the reliable writers queue.
int samples per virtual heartbeat

The number of samples that a reliable writer has to publish before sending a
virtual heartbeat.
int max heartbeat retries

8.223 RtpsReliableWriterProtocol t Class Reference
1373
The maximum number of periodic heartbeat retries before marking a remote

reader as inactive.
boolean inactivate nonprogressing readers

Whether to treat remote readers as inactive when their NACKs do not
progress.
int heartbeats per max samples

The number of heartbeats per send queue.
final Duration t min nack response delay

The minimum delay to respond to a NACK.
final Duration t max nack response delay

The maximum delay to respond to a nack.
final Duration t nack suppression duration

The duration for ignoring consecutive NACKs that may trigger redundant
repairs.
int max bytes per nack response

The maximum total message size when resending dropped samples.
final
Duration t
duration
disable positive acks min sample keep -
The minimum duration a sample is queued for ACK-disabled readers.
final
Duration t
duration
disable positive acks max sample keep -
The maximum duration a sample is queued for ACK-disabled readers.
boolean
duration
disable positive acks enable adaptive sample keep -
Enables dynamic adjustment of sample keep duration in response to congestion.
int disable positive acks decrease sample keep duration factor

Controls rate of contraction of dynamic sample keep duration.
int disable positive acks increase sample keep duration factor

Controls rate of growth of dynamic sample keep duration.
int min send window size

1374
Class Documentation
Minimum size of send window of unacknowledged samples.
int max send window size

Maximum size of send window of unacknowledged samples.
final Duration t send window update period

Period in which send window may be dynamically changed.
int send window increase factor

Increases send window size by this percentage when reacting dynamically to
network conditions.
int send window decrease factor

Decreases send window size by this percentage when reacting dynamically to
network conditions.
int multicast resend threshold

The minimum number of requesting readers needed to trigger a multicast
resend.
boolean enable multicast periodic heartbeat

Whether periodic heartbeat messages are sent over multicast.
8.223.1

It is used to configure a reliable writer according to RTPS protocol.
The reliability protocol settings are applied to batches instead of individual data
samples when batching is enabled.
Properties:
RxO (p. 101) = N/A
QoS:
com.rti.dds.infrastructure.DataWriterProtocolQosPolicy (p. 592)
8.223.2
8.223.2.1
int low watermark
1375

of a reliable writer meets or falls below this threshold, the
This value is measured in units of samples, except with batching configurations
in non-MultiChannel DataWriters where it is measured in units of batches.
The value must be greater than or equal to zero and strictly less than high watermark.
The
high
and
low
watermarks
are
used
for
switching
between
the
regular
and
fast
heartbeat
rates
(com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.heartbeat period (p. 1376) and com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.fast heartbeat period
(p. 1377),
respectively).
When
the
number
of
unacknowledged
samples
in
the
queue
of
a
reliable
(p. 557)
meets
or
exceeds
high watermark,
the
com.rti.dds.infrastructure.StatusKind.StatusKind.RELIABLE WRITER CACHE CHANGED STATUS
is
changed,
and
the
DataWriter will start heartbeating at fast heartbeat rate.
When
the number of samples meets or falls below low watermark,
com.rti.dds.infrastructure.StatusKind.StatusKind.RELIABLE WRITER CACHE CHANGED STATUS is changed, and the heartbeat rate will return
to the normal rate (heartbeat rate).
[default] 0
[range] [0, 100 million], < high watermark
See also:
Multi-channel DataWriters (p. 210) for additional details on reliability
with MultChannel DataWriters.
8.223.2.2
int high watermark

of a reliable writer meets or exceeds this threshold,
the
1376
Class Documentation
This value is measured in units of samples, except with batching configurations

in non-MultiChannel DataWriters where it is measured in units of batches.
The value must be strictly greater than low watermark and less than or equal
to a maximum that depends on the container QoS policy:
In
(p. 776):
For com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.publication writer (p. 645)

high watermark<=com.rti.dds.domain.DomainParticipantQos.resource limits.local writer allocation.max count
For com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.subscription writer (p. 645)
high watermark<=com.rti.dds.domain.DomainParticipantQos.resource limits.local reader allocation.max count
In com.rti.dds.publication.DataWriterQos.protocol (p. 614):
For
com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.rtps reliable writer (p. 596),
high watermark<=com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples (p. 1351) if batching is disabled or the DataWriter is a MultiChannel
DataWriter. Otherwise,
high watermark<=com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy.max batches (p. 624)
[default] 1
[range] [1, 100 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), > low watermark <= maximum which depends on
the container policy
See also:
Multi-channel DataWriters (p. 210) for additional details on reliability
with MultChannel DataWriters.
8.223.2.3
final Duration t heartbeat period
The period at which to send heartbeats.

A reliable writer will send periodic heartbeats at this rate.
[default] 3 seconds
1377
[range] [1 nanosec,1 year], >= com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.fast heartbeat period (p. 1377), >= com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.late joiner heartbeat period (p. 1377)
8.223.2.4
final Duration t fast heartbeat period
An alternative heartbeat period used when a reliable writer needs to flush its
unacknowledged samples more quickly.
This heartbeat period will be used when the number of unacknowledged samples
in the cache of a reliable writer meets or exceeds the writers high watermark
and has not subsequently dropped to the low watermark. The normal period
will be used at all other times.
This period must not be slower (i.e. must be of the same or shorter duration)
than the normal heartbeat period.
[default] 3 seconds
[range] [1 nanosec,1 year], <= com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.heartbeat period (p. 1376)
8.223.2.5
final Duration t late joiner heartbeat period
An alternative heartbeat period used when a reliable reader joins late and needs
to be caught up on cached samples of a reliable writer more quickly than the
normal heartbeat rate.
This heartbeat period will be used when a reliable reader joins after a reliable
writer with non-volatile durability has begun publishing samples. Once the
reliable reader has received all cached samples, it will be serviced at the same
rate as other reliable readers.
This period must not be slower (i.e. must be of the same or shorter duration)
than the normal heartbeat period.
[default] 3 seconds
[range] [1 nanosec,1 year], <= com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.heartbeat period (p. 1376)
8.223.2.6
final Duration t virtual heartbeat period
The period at which to send virtual heartbeats. Virtual heartbeats inform the
reliable reader about the range of samples currently present, for each virtual
GUID, in the reliable writers queue.
A reliable writer will send periodic virtual heartbeats at this rate.
1378
Class Documentation
[default]
com.rti.dds.infrastructure.Duration t.AUTO.
If
this
value
is
set
to
PRESENTATION QOS,
com.rti.dds.infrastructure.RtpsReliableWriterProtocol Otherwise, the value is set to
t.heartbeat period (p. 1376).
com.rti.dds.infrastructure.Duration t.INFINITE.
[range] > 1 nanosec, com.rti.dds.infrastructure.Duration t.INFINITE, or
8.223.2.7
int samples per virtual heartbeat
The number of samples that a reliable writer has to publish before sending a
virtual heartbeat.
[range] [1,1000000], com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106)
8.223.2.8
int max heartbeat retries
The maximum number of periodic heartbeat retries before marking a remote

reader as inactive.
When a remote reader has not acked all the samples the reliable writer has in
its queue, and max heartbeat retries number of periodic heartbeats has been
sent without receiving any ack/nack back, the remote reader will be marked as
inactive (not alive) and be ignored until it resumes sending ack/nack.
Note that piggyback heartbeats do NOT count towards this value.
[default] 10
[range] [1, 1 million] or com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106)
8.223.2.9
boolean inactivate nonprogressing readers
Whether to treat remote readers as inactive when their NACKs do not progress.
Nominally,
a remote reader is marked inactive when a successive number of periodic heartbeats equal or greater than
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.max heartbeat retries (p. 1378) have been sent without receiving any ack/nacks
back.
1379
By setting this com.rti.dds.infrastructure.true, it changes the conditions of

inactivating a remote reader: a reader will be considered inactive when
it either does not send any ack/nacks or keeps sending non-progressing
nacks for com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.max heartbeat retries (p. 1378) number of heartbeat periods, where a
non-progressing nack is one whose oldest sample requested has not advanced
from the oldest sample requested of the previous nack.
8.223.2.10
int heartbeats per max samples
The number of heartbeats per send queue.

If batching is disabled or the DataWriter is a MultiChannel DataWriter:
a piggyback heartbeat will be sent every
[com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples
(p. 1351)/heartbeats per max samples] number of samples.
Otherwise:
a
piggyback
heartbeat
will
be
sent
every
[com.rti.dds.infrastructure.DataWriterResourceLimitsQosPolicy.max batches (p. 624)/heartbeats per max samples] number of batches.
If set to zero, no piggyback heartbeat will be sent.
If maximum is
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), 100 million is assumed as the maximum value in the
calculation.
[default] 8
For com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.publication writer (p. 645):
heartbeats per max samples<= com.rti.dds.domain.DomainParticipantQos.resource limits.local writer allocation.max count
For com.rti.dds.infrastructure.DiscoveryConfigQosPolicy.subscription writer (p. 645):
heartbeats per max samples<= com.rti.dds.domain.DomainParticipantQos.resource limits.local reader allocation.max count
For com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.rtps reliable writer (p. 596):
heartbeats per max samples<= com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples (p. 1351) if batching is disabled or the DataWriter is a
MultiChannel DataWriter. Otherwise:
1380
Class Documentation
heartbeats per max samples<= com.rti.dds.infrastructure.DataWriterResourceLimitsQos

batches (p. 624).
8.223.2.11
final Duration t min nack response delay
The minimum delay to respond to a NACK.

When a reliable writer receives a NACK from a remote reader, the writer can
choose to delay a while before it sends repair samples or a heartbeat. This sets
the value of the minimum delay.
[default] 0 seconds
[range] [0,1 day], <= max nack response delay
8.223.2.12
final Duration t max nack response delay
The maximum delay to respond to a nack.

This set the value of maximum delay between receiving a NACK and sending
repair samples or a heartbeat.
[default] The default value depends on the container policy:
For com.rti.dds.infrastructure.DiscoveryConfigQosPolicy (p. 639) : 0
seconds
For com.rti.dds.infrastructure.DataWriterProtocolQosPolicy (p. 592) :
0.2 seconds
[range] [0,1 day], >= min nack response delay
8.223.2.13
final Duration t nack suppression duration
The duration for ignoring consecutive NACKs that may trigger redundant repairs.
A reliable writer may receive consecutive NACKs within a short duration from
a remote reader that will trigger the sending of redundant repair messages.
This specifies the duration during which consecutive NACKs are ignored to
prevent redundant repairs from being sent.
[default] 0 seconds
[range] [0,1 day],

8.223.2.14
1381
int max bytes per nack response
The maximum total message size when resending dropped samples.

As part of the reliable communication protocol, data writers send heartbeat
(HB) messages to their data readers. Each HB message contains the sequence
number of the most recent sample sent by the data writer.
In response, a data reader sends an acknowledgement (ACK) message, indicating
what sequence numbers it did not receive, if any. If the data reader is missing
some samples, the data writer will send them again.
max bytes per nack response determines the maximum size of the message sent
by the data writer in response to an ACK. This message may contain multiple
samples.
If max bytes per nack response is larger than the maximum message size supported by the underlying transport, RTI Connext will send multiple messages.
If the total size of all samples that need to be resent is larger than max bytes per nack response, the remaining samples will be resent the next time an ACK
arrives.
[default] 131072
[range] [0, 1 GB]
8.223.2.15
final Duration t disable positive acks min sample keep duration
The minimum duration a sample is queued for ACK-disabled readers.

When
positive
ACKs
are
disabled
for
a
data
writer
(com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.disable positive acks (p. 594) = com.rti.dds.infrastructure.true) or a data reader
(com.rti.dds.infrastructure.DataReaderProtocolQosPolicy.disable positive acks (p. 524) = com.rti.dds.infrastructure.true), a sample is available
from the data writers queue for at least this duration, after which the sample
may be considered to be acknowledged.
[default] 1 millisecond
[range] [0,1 year], <= com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.disable positive acks max sample keep duration (p. 1381)
8.223.2.16
final Duration t disable positive acks max sample keep duration
The maximum duration a sample is queued for ACK-disabled readers.

When
positive
ACKs
are
disabled
for
data
writer
1382
Class Documentation
(com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.disable positive acks (p. 594) = com.rti.dds.infrastructure.true) or a data reader

(com.rti.dds.infrastructure.DataReaderProtocolQosPolicy.disable positive acks (p. 524) = com.rti.dds.infrastructure.true), a sample is available
from the data writers queue for at most this duration, after which the sample
is considered to be acknowledged.
[default] 1 second
[range] [0,1 year], >= com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.disable positive acks min sample keep duration (p. 1381)
8.223.2.17
boolean disable positive acks enable adaptive sample keep duration
Enables dynamic adjustment of sample keep duration in response to congestion.

For dynamic networks where a static minimum sample keep duration may not provide sufficient performance or reliability, setting
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.disable positive acks enable adaptive sample keep duration
(p. 1382)
=
com.rti.dds.infrastructure.true, enables the sample keep duration to be dynamically adjusted to adapt to network conditions. The keep duration changes
according to the detected level of congestion, which is determined to be proportional to the rate of NACKs received. An adaptive algorithm automatically
controls the keep duration to optimize throughput and reliability.
To relieve high congestion, the keep duration is increased to effectively decrease the send rate; this lengthening of the keep duration is controlled
by com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.disable positive acks increase sample keep duration factor (p. 1383). Alternatively, when congestion is low, the keep duration is decreased to effectively increase send rate; this shortening of the keep duration is controlled
by com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.disable positive acks decrease sample keep duration factor (p. 1383).
The lower and upper bounds of the dynamic sample keep duration are
set
by
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.disable positive acks min sample keep duration
(p. 1381)
and
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.disable positive acks max sample keep duration (p. 1381), respectively.
When
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.disable positive acks enable adaptive sample keep duration
(p. 1382) = com.rti.dds.infrastructure.false, the sample keep duration is set
to com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.disable positive acks min sample keep duration (p. 1381) .

8.223.2.18
1383
int disable positive acks decrease sample keep duration factor
Controls rate of contraction of dynamic sample keep duration.

Used when com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.disable positive acks enable adaptive sample keep duration
(p. 1382) = com.rti.dds.infrastructure.true.
When the adaptive algorithm determines that the keep duration should be decreased, this factor (a percentage) is multiplied with the current keep duration
to get the new shorter keep duration. For example, if the current keep duration
is 20 milliseconds, using the default factor of 95% would result in a new keep
duration of 19 milliseconds.
[default] 95
[range] <= 100
8.223.2.19
int disable positive acks increase sample keep duration factor
Controls rate of growth of dynamic sample keep duration.

Used when com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.disable positive acks enable adaptive sample keep duration
(p. 1382) = com.rti.dds.infrastructure.true.
When the adaptive algorithm determines that the keep duration should be increased, this factor (a percentage) is multiplied with the current keep duration
to get the new longer keep duration. For example, if the current keep duration
is 20 milliseconds, using the default factor of 150% would result in a new keep
duration of 30 milliseconds.
[default] 150
[range] >= 100
8.223.2.20
int min send window size
Minimum size of send window of unacknowledged samples.

A com.rti.dds.publication.DataWriter (p. 557) has a limit on the number of
unacknowledged samples in-flight at a time. This send window can be configured
to have a minimum size (this field) and a maximum size (max send window size). The send window can dynamically change, between the min and max sizes,
to throttle the effective send rate in response to changing network congestion,
as measured by negative acknowledgements received.
When
both
min send window size
and
max send window size
are
1384
Class Documentation
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), then com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples (p. 1351) serves as the effective send window limit.
When
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples (p. 1351) is less than max send window size, then it serves as the
effective max send window. If it is less than min send window size, then
effectively both min and max send window sizes are equal to max samples. In
addition, the low and high watermarks are scaled down linearly to stay within
the send window size, and the full reliable queue status is set when the send
window is full.
[range]
>
0,
<=
max send window size,
or
See also:
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.max send window size (p. 1384)
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.low watermark (p. 1375)
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.high watermark (p. 1375)
com.rti.dds.publication.ReliableWriterCacheChangedStatus.full reliable writer cache (p. 1338)
8.223.2.21
int max send window size
Maximum size of send window of unacknowledged samples.

A com.rti.dds.publication.DataWriter (p. 557) has a limit on the number of
unacknowledged samples in-flight at a time. This send window can be configured
to have a minimum size (min send window size) and a maximum size (this field).
The send window can dynamically change, between the min and max sizes, to
throttle the effective send rate in response to changing network congestion, as
measured by negative acknowledgements received.
and
max send window size
are
When
both
min send window size
com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH UNLIMITED (p. 106), then com.rti.dds.infrastructure.ResourceLimitsQosPolicy.max samples (p. 1351) serves as the effective send window limit.
When
(p. 1351) is less than max send window size, then it serves as the effective max
1385
send window. If it is also less than min send window size, then effectively both
min and max send window sizes are equal to max samples. In addition, the low
and high watermarks are scaled down linearly to stay within the send window
size, and the full reliable queue status is set when the send window is full.
[range]
>
0,
>=
min send window size,
or
See also:
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.min send window size (p. 1383)
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.low watermark (p. 1375)
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.high watermark (p. 1375)
com.rti.dds.publication.ReliableWriterCacheChangedStatus.full reliable writer cache (p. 1338)
8.223.2.22
final Duration t send window update period
Period in which send window may be dynamically changed.

The com.rti.dds.publication.DataWriter (p. 557)s send window will dynamically change, between the min and max send window sizes, to throttle the
effective send rate in response to changing network congestion, as measured by
negative acknowledgements received.
The change in send window size happens at this update period, whereupon the
send window is either increased or decreased in size according to the increase
or decrease factors, respectively.
[default] 3 seconds
[range] > [0,1 year]
See also:
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.send window increase factor
(p. 1386),
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.send window decrease factor (p. 1386)
1386
8.223.2.23
Class Documentation
int send window increase factor
Increases send window size by this percentage when reacting dynamically to

network conditions.
After an update period during which no negative acknowledgements were received, the send window will be increased by this factor. The factor is treated
as a percentage, where a factor of 150 would increase the send window by 150%.
The increased send window size will not exceed the max send window size.
[default] 105
[range] > 100
See also:
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.send window update period
(p. 1385),
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.send window decrease factor (p. 1386)
8.223.2.24
int send window decrease factor
Decreases send window size by this percentage when reacting dynamically to

network conditions.
When increased network congestion causes a negative acknowledgement to be
received by a writer, the send window will be decreased by this factor to throttle
the effective send rate. The factor is treated as a percentage, where a factor of
80 would decrease the send window to 80% of its previous size. The decreased
send window size will not be less than the min send window size.
[default] 70
[range] [0, 100]
See also:
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.send window update period
(p. 1385),
1387
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.send window increase factor (p. 1386)
8.223.2.25
int multicast resend threshold
The minimum number of requesting readers needed to trigger a multicast resend.

Given readers with multicast destinations, when a reader NACKs for samples to
be resent, the writer can either resend them over unicast or multicast. In order
for the writer to resend over multicast, this threshold is the minimum number
of readers of the same multicast group that the writer must receive NACKs
from within a single response-delay. This allows the writer to coalesce nearsimultaneous unicast resends into a multicast resend. Note that a threshold of
1 means that all resends will be sent over multicast, if available.
[default] 2
[range] [>= 1]
8.223.2.26
boolean enable multicast periodic heartbeat
Whether periodic heartbeat messages are sent over multicast.

When enabled, if a reader has a multicast destination, then the writer will
send its periodic HEARTBEAT messages to that destination. Otherwise, if not
enabled or the reader does not have a multicast destination, the writer will send
its periodic HEARTBEATs over unicast.
1388
Class Documentation
8.224
RtpsReservedPortKind Class Reference
RTPS reserved port kind, used to identify the types of ports that can be reserved
on domain (p. 328) participant enable.

static final int BUILTIN UNICAST = 0x0001 << 0
Select the metatraffic unicast port.
static final int BUILTIN MULTICAST = 0x0001 << 1

Select the metatraffic multicast port.
static final int USER UNICAST = 0x0001 << 2

Select the usertraffic unicast port.
static final int USER MULTICAST = 0x0001 << 3

Select the usertraffic multicast port.
static final int MASK DEFAULT = BUILTIN UNICAST |

BUILTIN MULTICAST | USER UNICAST
The default value of com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps reserved port mask ( p. 1731).

No bits are set.

All bits are set.
8.224.1
RTPS reserved port kind, used to identify the types of ports that can be reserved
on domain (p. 328) participant enable.
See also:
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps reserved port mask (p. 1731)
8.224 RtpsReservedPortKind Class Reference
1389
8.224.2
8.224.2.1
final int BUILTIN UNICAST = 0x0001 << 0 [static]
Select the metatraffic unicast port.

8.224.2.2
final int BUILTIN MULTICAST = 0x0001 << 1

[static]
Select the metatraffic multicast port.

8.224.2.3
final int USER UNICAST = 0x0001 << 2 [static]
Select the usertraffic unicast port.

8.224.2.4
final int USER MULTICAST = 0x0001 << 3 [static]
Select the usertraffic multicast port.
1390
Class Documentation
8.225
RtpsWellKnownPorts t Class Reference

Inherits Struct.
Public Attributes
int port base
The base port offset.
int domain id gain

Tunable domain ( p. 328) gain parameter.
int participant id gain

Tunable participant gain parameter.
int builtin multicast port offset

Additional offset for metatraffic multicast port.
int builtin unicast port offset

Additional offset for metatraffic unicast port.
int user multicast port offset

Additional offset for usertraffic multicast port.
int user unicast port offset

Additional offset for usertraffic unicast port.

static
final
RtpsWellKnownPorts t
RTI BACKWARDS COMPATIBLE RTPS WELL KNOWN PORTS
static final RtpsWellKnownPorts t INTEROPERABLE RTPS WELL KNOWN PORTS

Assign to use well-known port mappings which are compliant with OMGs
DDS Interoperability Wire Protocol.
8.225 RtpsWellKnownPorts t Class Reference
8.225.1
1391

RTI Connext uses the RTPS wire protocol. The discovery protocols defined
by RTPS rely on well-known ports to initiate discovery. These well-known
ports define the multicast and unicast ports on which a Participant will listen
for discovery metatraffic from other Participants. The discovery metatraffic
contains all the information required to establish the presence of remote DDS
entities in the network.
The well-known ports are defined by RTPS in terms of port mapping expressions with several tunable parameters, which allow you to customize what
network ports are used by RTI Connext. These parameters are exposed in
com.rti.dds.infrastructure.RtpsWellKnownPorts t (p. 1390). In order
for all Participants in a system to correctly discover each other, it is important that they all use the same port mapping expressions.
The actual port mapping expressions, as defined by the RTPS specification, can be found below.
In addition to the parameters listed in
com.rti.dds.infrastructure.RtpsWellKnownPorts t (p. 1390), the port
numbers depend on:
- domain id, as specified in com.rti.dds.domain.DomainParticipantFactory.create participant (p. 748)
- participant id, as specified using com.rti.dds.infrastructure.WireProtocolQosPolicy.participant id (p. 1728)
The domain id parameter ensures no port conflicts exist between Participants
belonging to different domains. This also means that discovery metatraffic in
one domain (p. 328) is not visible to Participants in a different domain (p. 328).
The participant id parameter ensures that unique unicast port numbers are
assigned to Participants belonging to the same domain (p. 328) on a given host.
The metatraffic unicast port is used to exchange discovery metatraffic using unicast.
metatraffic_unicast_port = port_base + (domain_id_gain * domain_id) + (participant_id_gain * participant_id) + builtin_u
The metatraffic multicast port is used to exchange discovery metatraffic using multicast. The corresponding multicast group addresses are specified
via com.rti.dds.infrastructure.DiscoveryQosPolicy.multicast receive addresses (p. 650) on a com.rti.dds.domain.DomainParticipant (p. 654)
entity.
metatraffic_multicast_port = port_base + (domain_id_gain * domain_id) + builtin_multicast_port_offset
RTPS also defines the default multicast and unicast ports on which DataReaders and DataWriters receive usertraffic.
These default ports can be
1392
Class Documentation
overridden using the com.rti.dds.subscription.DataReaderQos.multicast

(p. 541), com.rti.dds.subscription.DataReaderQos.unicast (p. 540), or by
the com.rti.dds.publication.DataWriterQos.unicast (p. 615) QoS policies.
The usertraffic unicast port is used to exchange user data using unicast.
usertraffic_unicast_port = port_base + (domain_id_gain * domain_id) + (participant_id_gain * participant_id
The usertraffic multicast port is used to exchange user data using multicast. The corresponding multicast group addresses can be configured using
com.rti.dds.infrastructure.TransportMulticastQosPolicy (p. 1590).
usertraffic_multicast_port = port_base + (domain_id_gain * domain_id) + user_multicast_port_offset
By default,
the port mapping parameters are configured to
compliant
with
OMGs
DDS
Interoperability
Wire
Protocol
(see
also
com.rti.dds.infrastructure.RtpsWellKnownPorts t.INTEROPERABLE RTPS WELL KNOWN PORTS (p. 137)).
The OMGs DDS Interoperability Wire Protocol compliant port mapping parameters are not backwards compatible with previous versions of the RTI Connext middleware.
When modifying the port mapping parameters, care must be taken to avoid
port aliasing. This would result in undefined discovery behavior. The chosen
parameter values will also determine the maximum possible number of domains
in the system and the maximum number of participants per domain (p. 328).
Additionally, any resulting mapped port number must be within the range imposed by the underlying transport. For example, for UDPv4, this range typically
equals [1024 - 65535].
QoS:
com.rti.dds.infrastructure.WireProtocolQosPolicy (p. 1723)
8.225.2
8.225.2.1
int port base
The base port offset.

All mapped well-known ports are offset by this value.
[default] 7400
[range] [>= 1], but resulting ports must be within the range imposed by the
underlying transport.

8.225.2.2
1393
int domain id gain
Tunable domain (p. 328) gain parameter.

Multiplier of the domain id. Together with participant id gain, it determines the highest domain id and participant id allowed on this network.
In general, there are two ways to setup domain id gain and participant id gain parameters.
If domain id gain > participant id gain, it results in a port mapping layout
where all com.rti.dds.domain.DomainParticipant (p. 654) instances within
a single domain (p. 328) occupy a consecutive range of domain id gain ports.
Precisely, all ports occupied by the domain (p. 328) fall within:
(port_base + (domain_id_gain * domain_id))
and:
(port_base + (domain_id_gain * (domain_id + 1)) - 1)
Under such a case, the highest domain id is limited only by the underlying
transports maximum port. The highest participant id, however, must satisfy:
max_participant_id < (domain_id_gain / participant_id_gain)
On the contrary,
if domain id gain <= participant id gain,
it results in a port mapping layout where a given domains
com.rti.dds.domain.DomainParticipant (p. 654) instances occupy ports
spanned across the entire valid port range allowed by the underlying transport.
For instance, it results in the following potential mapping:
Mapped Port
higher port number
lower port number
Domain
Domain
Domain
Domain
Domain
Domain
Domain
Id
Id
Id
Id
Id
Id
Id
=
=
=
=
=
=
1
0
1
0
1
0
Participant
Participant
Participant
Participant
Participant
Participant
Participant
ID
ID
ID
ID
ID
ID
ID
=
=
=
=
=
=
2
2
1
1
0
0
Under this case, the highest participant id is limited only by the underlying
transports maximum port. The highest domain id, however, must satisfy:
max_domain_id < (participant_id_gain / domain_id_gain)
Additionally, domain id gain also determines the range of the port-specific offsets.
1394
Class Documentation
domain_id_gain > abs(builtin_multicast_port_offset - user_multicast_port_offset)

domain_id_gain > abs(builtin_unicast_port_offset - user_unicast_port_offset)
Violating this may result in port aliasing and undefined discovery behavior.
[default] 250
[range] [> 0], but resulting ports must be within the range imposed by the
8.225.2.3
int participant id gain
Tunable participant gain parameter.

Multiplier of the participant id. See com.rti.dds.infrastructure.RtpsWellKnownPorts t.domain id gain (p. 1393) for its implications on the highest domain id and
participant id allowed on this network.
Additionally, participant id gain also determines the range of builtin unicast port offset and user unicast port offset.
participant_id_gain > abs(builtin_unicast_port_offset - user_unicast_port_offset)
[default] 2
[range] [> 0], but resulting ports must be within the range imposed by the
8.225.2.4
int builtin multicast port offset
Additional offset for metatraffic multicast port.

It must be unique from other port-specific offsets.
[default] 0
8.225.2.5
int builtin unicast port offset
Additional offset for metatraffic unicast port.

[default] 10

8.225.2.6
1395
int user multicast port offset
Additional offset for usertraffic multicast port.

[default] 1
8.225.2.7
int user unicast port offset
Additional offset for usertraffic unicast port.

[default] 11
1396
Class Documentation
8.226
SampleIdentity t Class Reference

Inherits Struct.

SampleIdentity t (SampleIdentity t other)
Copy constructor.
Public Attributes
final GUID t writer guid = new GUID t(GUID t.GUID AUTO)
16-byte identifier identifying the virtual GUID.
final SequenceNumber t sequence number

monotonically increasing 64-bit integer that identifies the sample in the data
source.

static final SampleIdentity t AUTO SAMPLE IDENTITY
The AUTO sample identity.
static
final
IDENTITY
SampleIdentity t
UNKNOWN SAMPLE -
An invalid or unknown sample identity.
8.226.1

A SampleIdentity defines a pair (Virtual Writer GUID, Sequence Number) that
uniquely identifies a sample within a DDS domain (p. 328) and a Topic.
8.226 SampleIdentity t Class Reference
8.226.2
8.226.2.1
SampleIdentity t (SampleIdentity t other)
1397
Copy constructor.
8.226.3
8.226.3.1
final SampleIdentity t AUTO SAMPLE IDENTITY

[static]
The AUTO sample identity.

Special com.rti.dds.infrastructure.SampleIdentity t.SampleIdentity t.AUTO SAMPLE IDENTITY
value
{com.rti.dds.infrastructure.GUID t.AUTO,
com.rti.dds.infrastructure.SequenceNumber t.AUTO}
8.226.3.2
final SampleIdentity t UNKNOWN SAMPLE IDENTITY [static]
An invalid or unknown sample identity.

Special
com.rti.dds.infrastructure.SampleIdentity t.SampleIdentity t.UNKNOWN SAMPLE IDENTITY value {com.rti.dds.infrastructure.GUID t.UNKNOWN,
com.rti.dds.infrastructure.SequenceNumber t.UNKNOWN}
8.226.3.3
final GUID t writer guid = new

GUID t(GUID t.GUID AUTO)
16-byte identifier identifying the virtual GUID.

8.226.3.4
final SequenceNumber t sequence number
Initial value:
new SequenceNumber_t(SequenceNumber_t.AUTO_SEQUENCE_NUMBER)
monotonically increasing 64-bit integer that identifies the sample in the data
source.
1398
Class Documentation
8.227
SampleInfo Class Reference

Inheritance diagram for SampleInfo::

Object copy from (Object other)
Public Attributes
int sample state
The sample state of the sample.
int view state

The view state of the instance.
int instance state

The instance state of the instance.
final Time t source timestamp

The timestamp when the sample was written by a DataWriter.
final InstanceHandle t instance handle

Identifies locally the corresponding instance.
final InstanceHandle t publication handle

Identifies locally the DataWriter that modified the instance.
int disposed generation count

The disposed generation count of the instance at the time of sample reception.
int no writers generation count

The no writers generation count of the instance at the time of sample reception.
int sample rank

The sample rank of the sample.
int generation rank

8.227 SampleInfo Class Reference
1399
The generation rank of the sample.
int absolute generation rank

The absolute generation rank of the sample.
boolean valid data

Indicates whether the DataSample contains data or else it is only used to
communicate a change in the instance state of the instance.
final Time t reception timestamp

<<eXtension>> (p. 278) The timestamp when the sample was committed
by a DataReader ( p. 487).
final SequenceNumber t publication sequence number

<<eXtension>> (p. 278) The publication ( p. 349) sequence number.
final SequenceNumber t reception sequence number

<<eXtension>> (p. 278) The reception sequence number when sample was
committed by a DataReader ( p. 487)
final GUID t original publication virtual guid

<<eXtension>> (p. 278) The original publication ( p. 349) virtual GUID.
final SequenceNumber t original publication virtual sequence number

<<eXtension>> (p. 278) The original publication ( p. 349) virtual sequence number.
final GUID t related original publication virtual guid

<<eXtension>> (p. 278) The original publication ( p. 349) virtual GUID
of a related sample
final SequenceNumber t
sequence number
related original publication virtual -
<<eXtension>> (p. 278) The original publication ( p. 349) virtual sequence number of a related sample
Static Package Functions

static SampleInfo get from native (long native sample info)
1400
Class Documentation
8.227.1
8.227.2
Interpretation of the SampleInfo
The com.rti.dds.subscription.SampleInfo (p. 1398) contains information

pertaining to the associated Data instance sample including:
the sample state of the Data value (i.e., if it has already been read or
not)
the view state of the related instance (i.e., if the instance is new or not)
the instance state of the related instance (i.e., if the instance is alive or
not)
the valid data flag. This flag indicates whether there is data associated
with the sample. Some samples do not contain data indicating only a
change on the instance state of the corresponding instance.
The values of disposed generation count and no writers generation count for the related instance at the time the
sample was received.
These counters indicate the number of
times the instance had become ALIVE (with instance state=
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.ALIVE INTANCE STATE) at the time the sample was received.
The sample rank and generation rank of the sample within the returned
sequence. These ranks provide a preview of the samples that follow within
the sequence returned by the read or take operations.
The absolute generation rank of the sample within the
(p. 487).
This
rank provides a preview of what is available within the
The source timestamp of the sample. This is the timestamp provided
by the com.rti.dds.publication.DataWriter (p. 557) at the time the
sample was produced.
8.227.3
Interpretation of the
generation count and
count
SampleInfo disposed no writers generation -
For each instance, RTI Connext internally maintains two counts, the
com.rti.dds.subscription.SampleInfo.disposed generation count
1401
(p. 1405)
and
com.rti.dds.subscription.SampleInfo.no writers generation count (p. 1405), relative to each DataReader (p. 487):
The com.rti.dds.subscription.SampleInfo.disposed generation count (p. 1405) and com.rti.dds.subscription.SampleInfo.no writers generation count (p. 1405) are initialized to zero when the
com.rti.dds.subscription.DataReader (p. 487) first detects the
presence of a never-seen-before instance.
The
com.rti.dds.subscription.SampleInfo.disposed generation count (p. 1405) is incremented each time the
instance state of the corresponding instance changes from
to
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.ALIVE INTANCE STATE.
The
com.rti.dds.subscription.SampleInfo.no writers generation count (p. 1405) is incremented each time the
instance state of the corresponding instance changes from
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.NOT ALIVE NO WRITERS INSTANCE STATE
to
com.rti.dds.subscription.InstanceStateKind.InstanceStateKind.ALIVE INTANCE STATE.
These generation counts are reset to zero when the instance resource is
reclaimed.
The
(p. 1405)
and
com.rti.dds.subscription.SampleInfo.no writers generation count
(p. 1405)
available
in
the
com.rti.dds.subscription.SampleInfo (p. 1398) capture a snapshot of
the corresponding counters at the time the sample was received.
8.227.4
Interpretation of the SampleInfo sample rank,

generation rank and absolute generation rank
The com.rti.dds.subscription.SampleInfo.sample rank (p. 1405) and

com.rti.dds.subscription.SampleInfo.generation rank (p. 1405) available
in the com.rti.dds.subscription.SampleInfo (p. 1398) are computed based
solely on the actual samples in the ordered collection returned by read or take.
The com.rti.dds.subscription.SampleInfo.sample rank (p. 1405) indicates the number of samples of the same instance that follow the current
one in the collection.
1402
Class Documentation
The
com.rti.dds.subscription.SampleInfo.generation rank
(p. 1405) available in the com.rti.dds.subscription.SampleInfo
(p. 1398) indicates the difference in generations between the sample
(S) and the Most Recent Sample of the same instance that appears in
the returned Collection (MRSIC). That is, it counts the number of times
the instance transitioned from not-alive to alive in the time from the
reception of the S to the reception of MRSIC.
These generation ranks are reset to zero when the instance resource is
reclaimed.
The com.rti.dds.subscription.SampleInfo.generation rank (p. 1405) is

computed using the formula:
generation_rank = (MRSIC.disposed_generation_count
+ MRSIC.no_writers_generation_count)
- (S.disposed_generation_count
+ S.no_writers_generation_count)
The
com.rti.dds.subscription.SampleInfo.absolute generation rank
(p. 1406) available in the com.rti.dds.subscription.SampleInfo (p. 1398)
indicates the difference in generations between the sample (S) and the Most
Recent Sample of the same instance that the middleware has received (MRS).
That is, it counts the number of times the instance transitioned from not-alive
to alive in the time from the reception of the S to the time when the read or
take was called.
absolute_generation_rank = (MRS.disposed_generation_count
+ MRS.no_writers_generation_count)
- (S.disposed_generation_count
+ S.no_writers_generation_count)
8.227.5
Interpretation of the SampleInfo counters and

ranks
These counters and ranks allow the application to distinguish samples belonging
to different generations of the instance. Note that it is possible for an instance
to transition from not-alive to alive (and back) several times before the application accesses the data by means of read or take. In this case, the returned
collection may contain samples that cross generations (i.e. some samples were received before the instance became not-alive, other after the instance re-appeared
again). Using the information in the com.rti.dds.subscription.SampleInfo
(p. 1398), the application can anticipate what other information regarding the
same instance appears in the returned collection, as well as in the infrastructure (p. 334) and thus make appropriate decisions.
1403
For example, an application desiring to only consider the most current sample
for each instance would only look at samples with sample rank == 0. Similarly,
an application desiring to only consider samples that correspond to the latest
generation in the collection will only look at samples with generation rank ==
0. An application desiring only samples pertaining to the latest generation
available will ignore samples for which absolute generation rank != 0. Other
application-defined criteria may also be used.
See also:
com.rti.dds.subscription.SampleInfo.valid data (p. 1406)
8.227.6
8.227.6.1
Object copy from (Object other)
(p. 1426),
(p. 1061),
(p. 1703),
Implementation of the Copyable interface.

See also:
8.227.6.2
static SampleInfo get from native (long

native sample info) [static, package]
Given a pointer to a native SampleInfo (p. 1398) object from the queue, get a
reference to the corresponding Java SampleInfo (p. 1398) object.
8.227.7
8.227.7.1
int sample state
The sample state of the sample.

Indicates whether or not the corresponding data sample has already been read.
See also:
com.rti.dds.subscription.SampleStateKind (p. 1426)
1404
8.227.7.2
Class Documentation
int view state
The view state of the instance.

Indicates whether the com.rti.dds.subscription.DataReader (p. 487) has already seen samples for the most-current generation of the related instance.
See also:
com.rti.dds.subscription.ViewStateKind (p. 1703)
8.227.7.3
int instance state
The instance state of the instance.

Indicates whether the instance is currently in existence or, if it has been disposed, the reason why it was disposed.
See also:
com.rti.dds.subscription.InstanceStateKind (p. 1061)
8.227.7.4
final Time t source timestamp
The timestamp when the sample was written by a DataWriter.
8.227.7.5
final InstanceHandle t instance handle
Identifies locally the corresponding instance.
8.227.7.6
final InstanceHandle t publication handle
Identifies locally the DataWriter that modified the instance.

The publication handle is the same com.rti.dds.infrastructure.InstanceHandle t
(p. 1055)
that
is
returned
by
the
operation
com.rti.dds.subscription.DataReader.get matched publications
(p. 501) and can also be used as a parameter to the operation
com.rti.dds.subscription.DataReader.get matched publication data
(p. 502).

8.227.7.7
1405
int disposed generation count
The disposed generation count of the instance at the time of sample reception.
Indicates the number of times the instance had become alive after it was disposed
explicitly by a com.rti.dds.publication.DataWriter (p. 557), at the time the
sample was received.
See also:
Interpretation of the SampleInfo disposed generation count and
no writers generation count (p. 1400) Interpretation of the SampleInfo counters and ranks (p. 1402)
8.227.7.8
int no writers generation count
The no writers generation count of the instance at the time of sample reception.
Indicates the number of times the instance had become alive after it was disposed
because there were no writers, at the time the sample was received.
See also:
Interpretation of the SampleInfo disposed generation count and
no writers generation count (p. 1400) Interpretation of the SampleInfo counters and ranks (p. 1402)
8.227.7.9
int sample rank
The sample rank of the sample.

Indicates the number of samples related to the same instance that follow in the
collection returned by read or take.
See also:
Interpretation of the SampleInfo sample rank, generation rank
and absolute generation rank (p. 1401) Interpretation of the SampleInfo counters and ranks (p. 1402)
8.227.7.10
int generation rank
The generation rank of the sample.

1406
Class Documentation
Indicates the generation difference (number of times the instance was disposed
and become alive again) between the time the sample was received, and the
time the most recent sample in the collection related to the same instance was
received.
See also:
8.227.7.11
int absolute generation rank
The absolute generation rank of the sample.

Indicates the generation difference (number of times the instance was disposed
and become alive again) between the time the sample was received, and the time
the most recent sample (which may not be in the returned collection) related
to the same instance was received.
See also:
8.227.7.12
boolean valid data
Indicates whether the DataSample contains data or else it is only used to communicate a change in the instance state of the instance.
Normally
each
DataSample
contains
both
a
(p. 1398)
and
some
Data.
However there are situations where a DataSample contains only the
com.rti.dds.subscription.SampleInfo (p. 1398) and does not have any
associated data. This occurs when the RTI Connext notifies the application of a change of state for an instance that was caused by some internal
mechanism (such as a timeout) for which there is no associated data.
An example of this situation is when the RTI Connext detects that an
instance has no writers and changes the corresponding instance state to
The application can distinguish whether a particular DataSample has data
by examining the value of the valid data flag. If this flag is set to
com.rti.dds.infrastructure.true, then the DataSample contains valid Data. If
1407
the flag is set to com.rti.dds.infrastructure.false, the DataSample contains no

Data.
To ensure correctness and portability, the valid data flag must be examined
by the application prior to accessing the Data associated with the DataSample
and if the flag is set to com.rti.dds.infrastructure.false, the application should
not access the Data associated with the DataSample, that is, the application
should access only the com.rti.dds.subscription.SampleInfo (p. 1398).
8.227.7.13
final Time t reception timestamp
<<eXtension>> ( p. 278) The timestamp when the sample was committed by

a DataReader (p. 487).
8.227.7.14
final SequenceNumber t publication sequence number
<<eXtension>> ( p. 278) The publication (p. 349) sequence number.

8.227.7.15
final SequenceNumber t reception sequence number
<<eXtension>> ( p. 278) The reception sequence number when sample was

committed by a DataReader (p. 487)
8.227.7.16
final GUID t original publication virtual guid
<<eXtension>> ( p. 278) The original publication (p. 349) virtual GUID.

If
the
com.rti.dds.infrastructure.PresentationQosPolicy.access scope (p. 1225) of the com.rti.dds.publication.Publisher (p. 1262) is
PRESENTATION QOS,
this
field
contains
the
com.rti.dds.publication.Publisher (p. 1262) virtual GUID that uniquely
identifies the DataWriter group.
8.227.7.17
final SequenceNumber t original publication virtual sequence number
<<eXtension>> ( p. 278) The original publication (p. 349) virtual sequence

number.
If
the
com.rti.dds.infrastructure.PresentationQosPolicy.access scope (p. 1225) of the com.rti.dds.publication.Publisher (p. 1262) is
PRESENTATION QOS,
this
field
contains
the
1408
Class Documentation
com.rti.dds.publication.Publisher (p. 1262) virtual sequence number

that uniquely identifies a sample within the DataWriter group.
8.227.7.18
final GUID t related original publication virtual guid
<<eXtension>> ( p. 278) The original publication (p. 349) virtual GUID of

a related sample
8.227.7.19
final SequenceNumber t related original publication virtual sequence number
<<eXtension>> ( p. 278) The original publication (p. 349) virtual sequence

number of a related sample
8.228 SampleInfoSeq Class Reference
8.228
1409
SampleInfoSeq Class Reference
Declares IDL sequence < com.rti.dds.subscription.SampleInfo (p. 1398) >

.
Inheritance diagram for SampleInfoSeq::
8.228.1
Declares IDL sequence < com.rti.dds.subscription.SampleInfo (p. 1398) >

.
See also:
1410
Class Documentation
8.229
SampleLostStatus Class Reference

Inherits Status.
Public Attributes
int total count
Total cumulative count of all samples lost across all instances of data published under the com.rti.dds.topic.Topic ( p. 1545).

The incremental number of samples lost since the last time the listener was
SampleLostStatusKind last reason

Reason for rejecting the last sample rejected.
8.229.1
8.229.2
8.229.2.1
int total count
Total cumulative count of all samples lost across all instances of data published
under the com.rti.dds.topic.Topic (p. 1545).
8.229.2.2
The incremental number of samples lost since the last time the listener was
8.229.2.3
SampleLostStatusKind last reason

8.229 SampleLostStatus Class Reference
1411
See also:
com.rti.dds.subscription.SampleRejectedStatusKind (p. 1420)
1412
Class Documentation
8.230
SampleLostStatusKind Class Reference

Inheritance diagram for SampleLostStatusKind::

static final SampleLostStatusKind NOT LOST
The sample was not lost.
static final SampleLostStatusKind LOST BY WRITER

A DataWriter removed the sample before being
static final
LIMIT
SampleLostStatusKind
received
by
the
LOST BY INSTANCES -
A resource limit on the number of instances was reached.
static
final
WRITERS PER INSTANCE LIMIT
LOST BY REMOTE -
A resource limit on the number of remote writers for a single instance

from which a com.rti.dds.subscription.DataReader ( p. 487) may read
was reached.
static final SampleLostStatusKind LOST BY INCOMPLETE COHERENT SET

A sample is lost because it is part of an incomplete coherent set.
static
final
COHERENT SET
LOST BY LARGE -
A sample is lost because it is part of a large coherent set.
static final SampleLostStatusKind LOST BY SAMPLES PER REMOTE WRITER LIMIT

A resource limit on the number of samples from a given remote writer that
a com.rti.dds.subscription.DataReader ( p. 487) may store was reached.
static
final
WRITERS LIMIT
LOST BY VIRTUAL -
A resource limit on the number of virtual writers from which a

com.rti.dds.subscription.DataReader ( p. 487) may read was reached.
8.230 SampleLostStatusKind Class Reference
static
final
WRITERS PER SAMPLE LIMIT
1413
LOST BY REMOTE -
A resource limit on the number of remote writers per sample was reached.
static final SampleLostStatusKind LOST BY AVAILABILITY WAITING TIME

com.rti.dds.infrastructure.AvailabilityQosPolicy.max data availability waiting time ( p. 405) expired.
static
final
LOST BY REMOTE WRITER SAMPLES PER VIRTUAL QUEUE LIMIT
A resource limit on the number of samples published by a remote writer
on behalf of a virtual writer that a com.rti.dds.subscription.DataReader
( p. 487) may store was reached.
static
final
MEMORY
LOST BY OUT OF -
A sample was lost because there was not enough memory to store the sample.
8.230.1
8.230.2
8.230.2.1
final SampleLostStatusKind NOT LOST [static]
Initial value:
new com.rti.dds.subscription.SampleLostStatusKind(
"NOT_LOST", 0)
The sample was not lost.

See also:
1414
8.230.2.2
Class Documentation
final SampleLostStatusKind LOST BY WRITER
[static]
Initial value:
"LOST_BY_WRITER", 1)
A DataWriter removed the sample before being

received
by
the
This constant is an extension to the DDS standard.

8.230.2.3
final SampleLostStatusKind LOST BY INSTANCES LIMIT [static]
Initial value:
"LOST_BY_INSTANCES_LIMIT", 2)

See also:
8.230.2.4
final SampleLostStatusKind LOST BY REMOTE WRITERS PER INSTANCE LIMIT

[static]
Initial value:
new SampleLostStatusKind(
"LOST_BY_REMOTE_WRITERS_PER_INSTANCE_LIMIT", 3)
A resource limit on the number of remote writers for a single instance from which
a com.rti.dds.subscription.DataReader (p. 487) may read was reached.
See also:
(p. 542)

8.230.2.5
1415
final SampleLostStatusKind LOST BY INCOMPLETE COHERENT SET

[static]
Initial value:
"LOST_BY_INCOMPLETE_COHERENT_SET", 4)
A sample is lost because it is part of an incomplete coherent set.

8.230.2.6
final SampleLostStatusKind LOST BY LARGE COHERENT SET [static]
Initial value:
"LOST_BY_LARGE_COHERENT_SET", 5)
A sample is lost because it is part of a large coherent set.

8.230.2.7
final SampleLostStatusKind LOST BY SAMPLES PER REMOTE WRITER LIMIT

[static]
Initial value:
"LOST_BY_SAMPLES_PER_REMOTE_WRITER_LIMIT", 6)
A resource limit on the number of samples from a given remote writer that a
com.rti.dds.subscription.DataReader (p. 487) may store was reached.
See also:
(p. 542)
1416
8.230.2.8
Class Documentation
final SampleLostStatusKind LOST BY VIRTUAL WRITERS LIMIT [static]
Initial value:
"DDS_LOST_BY_VIRTUAL_WRITERS_LIMIT", 7)

com.rti.dds.subscription.DataReader (p. 487) may read was reached.
See also:
(p. 542)
8.230.2.9
final SampleLostStatusKind LOST BY REMOTE WRITERS PER SAMPLE LIMIT

[static]
Initial value:
"LOST_BY_REMOTE_WRITERS_PER_SAMPLE_LIMIT", 8)
See also:
(p. 542)
8.230.2.10
final SampleLostStatusKind LOST BY AVAILABILITY WAITING TIME

[static]
Initial value:
"LOST_BY_AVAILABILITY_WAITING_TIME", 9)
1417
com.rti.dds.infrastructure.AvailabilityQosPolicy.max data availability waiting time (p. 405) expired.

See also:
(p. 542)
8.230.2.11
final SampleLostStatusKind LOST BY REMOTE WRITER SAMPLES PER VIRTUAL QUEUE LIMIT
[static]
Initial value:
"LOST_BY_REMOTE_WRITER_SAMPLES_PER_VIRTUAL_QUEUE_LIMIT", 10)
A resource limit on the number of samples published by a remote writer on behalf of a virtual writer that a com.rti.dds.subscription.DataReader (p. 487)
may store was reached.
See also:
(p. 542)
8.230.2.12
final SampleLostStatusKind LOST BY OUT OF MEMORY [static]
Initial value:
"LOST_BY_OUT_OF_MEMORY", 11)
A sample was lost because there was not enough memory to store the sample.
See also:
(p. 542)
1418
Class Documentation
8.231
SampleRejectedStatus Class Reference

Inherits Status.
Public Attributes
int total count
Total
cumulative
count
of
samples
rejected
by
the

The incremental number of samples rejected since the last time the listener
SampleRejectedStatusKind last reason


Handle to the instance being updated by the last sample that was rejected.
8.231.1
8.231.2
8.231.2.1
int total count
Total
cumulative
count
of
samples
8.231.2.2
rejected
by
the
The incremental number of samples rejected since the last time the listener was
8.231 SampleRejectedStatus Class Reference

8.231.2.3
1419
SampleRejectedStatusKind last reason

See also:
com.rti.dds.subscription.SampleRejectedStatusKind (p. 1420)
8.231.2.4
Handle to the instance being updated by the last sample that was rejected.
1420
Class Documentation
8.232
SampleRejectedStatusKind Class Reference

Inheritance diagram for SampleRejectedStatusKind::

static final SampleRejectedStatusKind NOT REJECTED
Samples are never rejected.
static
final
SampleRejectedStatusKind
INSTANCES LIMIT
REJECTED BY -
static
final
SAMPLES LIMIT
REJECTED BY -
A resource limit on the number of samples was reached.
static
final
SAMPLES PER INSTANCE LIMIT
REJECTED BY -
A resource limit on the number of samples per instance was reached.
static
final
REMOTE WRITERS LIMIT
REJECTED BY -
A resource limit on the number of remote writers from which a

static
final
REJECTED BY REMOTE WRITERS PER INSTANCE LIMIT
A resource limit on the number of remote writers for a single instance
from which a com.rti.dds.subscription.DataReader ( p. 487) may read
was reached.
static
final
REJECTED BY SAMPLES PER REMOTE WRITER LIMIT
A resource limit on the number of samples from a given remote writer that
a com.rti.dds.subscription.DataReader ( p. 487) may store was reached.
static
final
VIRTUAL WRITERS LIMIT
REJECTED BY -
8.232 SampleRejectedStatusKind Class Reference
1421

static
final
REJECTED BY REMOTE WRITERS PER SAMPLE LIMIT
static
final
REJECTED BY REMOTE WRITER SAMPLES PER VIRTUAL QUEUE LIMIT
A resource limit on the number of samples published by a remote writer
on behalf of a virtual writer that a com.rti.dds.subscription.DataReader
( p. 487) may store was reached.
8.232.1
8.232.2
8.232.2.1
final SampleRejectedStatusKind NOT REJECTED

[static]
Initial value:
new com.rti.dds.subscription.SampleRejectedStatusKind(
"NOT_REJECTED", 0)
Samples are never rejected.

See also:
(p. 542)
8.232.2.2
final SampleRejectedStatusKind
REJECTED BY INSTANCES LIMIT [static]
Initial value:
new com.rti.dds.subscription.SampleRejectedStatusKind(
"REJECTED_BY_INSTANCES_LIMIT", 1)
1422
Class Documentation

See also:
(p. 542)
8.232.2.3
REJECTED BY SAMPLES LIMIT [static]
Initial value:
new SampleRejectedStatusKind(
"REJECTED_BY_SAMPLES_LIMIT", 2)
A resource limit on the number of samples was reached.

See also:
(p. 542)
8.232.2.4
final SampleRejectedStatusKind REJECTED BY SAMPLES PER INSTANCE LIMIT

[static]
Initial value:
"REJECTED_BY_SAMPLES_PER_INSTANCE_LIMIT", 3)
A resource limit on the number of samples per instance was reached.

See also:
8.232.2.5
REJECTED BY REMOTE WRITERS LIMIT [static]
Initial value:
"REJECTED_BY_REMOTE_WRITERS_LIMIT", 4)
1423
A resource limit on the number of remote writers from which a

See also:
(p. 542)
8.232.2.6
final SampleRejectedStatusKind REJECTED BY REMOTE WRITERS PER INSTANCE LIMIT

[static]
Initial value:
"REJECTED_BY_REMOTE_WRITERS_PER_INSTANCE_LIMIT", 5)
A resource limit on the number of remote writers for a single instance from which
a com.rti.dds.subscription.DataReader (p. 487) may read was reached.
See also:
(p. 542)
8.232.2.7
final SampleRejectedStatusKind REJECTED BY SAMPLES PER REMOTE WRITER LIMIT

[static]
Initial value:
"REJECTED_BY_SAMPLES_PER_REMOTE_WRITER_LIMIT", 6)
A resource limit on the number of samples from a given remote writer that a
com.rti.dds.subscription.DataReader (p. 487) may store was reached.
See also:
(p. 542)
1424
8.232.2.8
Class Documentation
REJECTED BY VIRTUAL WRITERS LIMIT
[static]
Initial value:
"REJECTED_BY_VIRTUAL_WRITERS_LIMIT", 7)

See also:
(p. 542)
8.232.2.9
final SampleRejectedStatusKind REJECTED BY REMOTE WRITERS PER SAMPLE LIMIT

[static]
Initial value:
"REJECTED_BY_REMOTE_WRITERS_PER_SAMPLE_LIMIT", 8)
See also:
(p. 542)
8.232.2.10
REJECTED BY REMOTE WRITER SAMPLES PER VIRTUAL QUEUE LIMIT
[static]
Initial value:
"REJECTED_BY_REMOTE_WRITER_SAMPLES_PER_VIRTUAL_QUEUE_LIMIT", 9)
1425
A resource limit on the number of samples published by a remote writer on behalf of a virtual writer that a com.rti.dds.subscription.DataReader (p. 487)
may store was reached.
See also:
(p. 542)
1426
Class Documentation
8.233
SampleStateKind Class Reference

static final int READ SAMPLE STATE = 0x0001 << 0
Sample has been read.
static final int NOT READ SAMPLE STATE = 0x0001 << 1

Sample has not been read.
static final int ANY SAMPLE STATE = 0xffff

8.233.1

For each sample received, the middleware internally maintains a sample state
relative to each com.rti.dds.subscription.DataReader (p. 487). The sample
state can be either:
com.rti.dds.subscription.SampleStateKind.SampleStateKind.READ SAMPLE STATE indicates that the com.rti.dds.subscription.DataReader
(p. 487) has already accessed that sample by means of a read or take
operation.
com.rti.dds.subscription.SampleStateKind.SampleStateKind.NOT READ SAMPLE STATE
indicates
that
the
com.rti.dds.subscription.DataReader (p. 487) has not accessed
that sample before.
The sample state will, in general, be different for each sample in the collection
returned by read or take.
8.233 SampleStateKind Class Reference
8.233.2
8.233.2.1
final int READ SAMPLE STATE = 0x0001 << 0

[static]
1427
Sample has been read.

8.233.2.2
final int NOT READ SAMPLE STATE = 0x0001 << 1

[static]
Sample has not been read.
1428
Class Documentation
8.234
Sequence Interface Reference
Inheritance diagram for Sequence::

int getMaximum ()
sequence.

8.234.1
For users who define data types in OMG IDL, this type corresponds to the IDL
express sequence<Foo>.
For any user-data type Foo that an application defines for the purpose of datadistribution with RTI Connext, a FooSeq is generated. We refer to an IDL
sequence<Foo> as FooSeq.
A sequence is a type-safe List that makes a distinction between its allocated
size and its logical size (much like the ArrayList class). The Collection.size()
method returns the logical size.
A new sequence is created for elements of a particular Class, which does not
change throughout the lifetime of a sequence instance.
To add an element to a sequence, use the add() method inherited from
the standard interface java.util.List; this will implicitly increase the sequences size. Or, to pre-allocate space for several elements at once, use
8.234 Sequence Interface Reference
1429
An attempt to add an element to a sequence that is not of the correct element

type will result in a ClassCastException. (Note that null is considered to belong
to any type.)
See also:
(p. 1012),
(p. 979),
8.234.2
8.234.2.1
int getMaximum ()
elements.
first created.
The maximum can be changed implicitly by adding an element to the sequence with add(),
Returns:
See also:
Implemented in BooleanSeq (p. 421), ByteSeq (p. 445), CharSeq (p. 462),
ConditionSeq (p. 466), DoubleSeq (p. 800), FloatSeq (p. 962), IntSeq
(p. 1068), LongSeq (p. 1185), ShortSeq (p. 1446), PublisherSeq (p. 1293),
DataReaderSeq (p. 555), SubscriberSeq (p. 1507), and LoanableSequence (p. 1148).
8.234.2.2

maximum.
1430
Class Documentation
Note: If you add an element with add(), the sequences size is increased implicitly.
Postcondition:
Parameters:
Returns:
Implemented in AbstractSequence
(p. 1148).
8.234.2.3
(p. 390), and LoanableSequence
Returns:
a common supertype for all elements in this sequence.
Implemented in AbstractPrimitiveSequence
quence (p. 391).
(p. 385), and AbstractSe-
8.235 SequenceNumber t Class Reference
8.235
1431
SequenceNumber t Class Reference

Inherits Struct.

SequenceNumber t ()
Constructor.
SequenceNumber t (SequenceNumber t sn)

Copy constructor.
SequenceNumber t (int high, long low)

Constructor.
int compare (SequenceNumber t sn)

Compares two sequence numbers.
void plusplus ()
Increases the value of this by one.
void minusminus ()
Decreases the value of this by one.
SequenceNumber t add (SequenceNumber t val)

Returns a sequence number whose value is (this + val).
SequenceNumber t subtract (SequenceNumber t val)

Returns a sequence number whose value is (this - val).
Public Attributes
int high
The most significant part of the sequence number.
long low
The least significant part of the sequence number.
1432
Class Documentation

static
final
UNKNOWN
SequenceNumber t
SEQUENCE NUMBER -
Unknown sequence number.
static final SequenceNumber t AUTO SEQUENCE NUMBER

The sequence number is internally determined by RTI Connext.
static final SequenceNumber t SEQUENCE NUMBER ZERO

Zero value for the sequence number.
static final SequenceNumber t SEQUENCE NUMBER MAX

Highest, most positive value for the sequence number.
8.235.1

Represents a 64-bit sequence number.
8.235.2
8.235.2.1
SequenceNumber t ()
Constructor.
8.235.2.2
SequenceNumber t (SequenceNumber t sn)
Copy constructor.
Parameters:
sn The sequence number instance to copy. It must not be null.
8.235.2.3
SequenceNumber t (int high, long low)
Constructor.
Parameters:
high must be in the interval [0,0xffffffff]
8.235 SequenceNumber t Class Reference
1433
low must be in the interval [0,0x00000000ffffffff]

Exceptions:
RETCODE BAD PARAMETER ( p. 1355)
8.235.3
8.235.3.1
int compare (SequenceNumber t sn)
Compares two sequence numbers.

Parameters:
sn <<in>> ( p. 279) Sequence number to compare. Cannot be null.
Returns:
If the two sequence numbers are equal, the function returns 0. If sn1 is
greater than sn2 the function returns a positive number; otherwise, it returns a negative number.
8.235.3.2
void plusplus ()
Increases the value of this by one.

8.235.3.3
void minusminus ()
Decreases the value of this by one.

8.235.3.4
SequenceNumber t add (SequenceNumber t val)
Returns a sequence number whose value is (this + val).

Returns:
(this+val)
8.235.3.5
SequenceNumber t subtract (SequenceNumber t val)
Returns a sequence number whose value is (this - val).

Returns:
(this-val)
1434
Class Documentation
8.235.4
8.235.4.1
final SequenceNumber t SEQUENCE NUMBER UNKNOWN [static]
Unknown sequence number.

8.235.4.2
final SequenceNumber t AUTO SEQUENCE NUMBER

[static]
The sequence number is internally determined by RTI Connext.

8.235.4.3
final SequenceNumber t SEQUENCE NUMBER ZERO

[static]
Zero value for the sequence number.

8.235.4.4
final SequenceNumber t SEQUENCE NUMBER MAX

[static]
Highest, most positive value for the sequence number.

8.235.4.5
int high
The most significant part of the sequence number.

8.235.4.6
long low
The least significant part of the sequence number.
8.236 ShmemTransport Interface Reference
8.236
1435
ShmemTransport Interface Reference
Built-in transport (p. 376) plug-in for inter-process communications using

shared memory.
Inheritance diagram for ShmemTransport::
Classes
class Property t
Subclass of com.rti.ndds.transport.Transport.Property t ( p. 1570) allowing specification of parameters that are specific to the shared-memory
transport ( p. 376).
8.236.1
Built-in transport (p. 376) plug-in for inter-process communications using

shared memory.
This plugin uses System Shared Memory to send messages between processes
on the same node.
The transport (p. 376) plugin has exactly one receive interface; since the
address bit count is 0, it can be assigned any address. Thus the interface is
located by the network address associated with the transport (p. 376) plugin.
8.236.2
Compatibility of Sender and Receiver Transports
Opening a receiver port on shared memory corresponds to creating a shared

memory segment using a name based on the port number. The transport
(p. 376) plugins properties are embedded in the shared memory segment.
When a sender tries to send to the shared memory port, it verifies that properties
of the receivers shared memory transport (p. 376) are compatible with those
specified in its transport (p. 376) plugin. If not, the sender will fail to attach
to the port and will output messages such as below (with numbers appropriate
to the properties of the transport (p. 376) plugins involved).
NDDS_Transport_Shmem_attachShmem:failed to initialize incompatible properties
NDDS_Transport_Shmem_attachShmem:countMax 0 > -19417345 or max size -19416188 > 2147482624
In this scenario, the properties of the sender or receiver transport (p. 376)
plugin instances should be adjusted, so that they are compatible.
1436
8.236.3
Class Documentation
Crashing and Restarting Programs
If a process using shared memory crashes (say because the user typed in C),
resources associated with its shared memory ports may not be properly cleaned
up. Later, if another RTI Connext process needs to open the same ports (say,
the crashed program is restarted), it will attempt to reuse the shared memory
segment left behind by the crashed process.
The reuse is allowed iff the properties of transport (p. 376) plugin are compatible with those embedded in the shared memory segment (i.e., of the original
creator). Otherwise, the process will fail to open the ports, and will output
messages such as below (with numbers appropriate to the properties of the
transport (p. 376) plugins involved).
NDDS_Transport_Shmem_create_recvresource_rrEA:failed to initialize shared
memory resource Cannot recycle existing shmem: size not compatible for key 0x1234
In this scenario, the shared memory segments must be cleaned up using appropriate platform specific commands. For details, please refer to the Platform
Notes.
8.236.4
Shared Resource Keys
The transport (p. 376) uses the shared memory segment keys, given by
the formula below.
0x400000 + port
The transport (p. 376) also uses signaling shared semaphore keys given by
the formula below.
0x800000 + port
The transport (p. 376) also uses mutex shared semaphore keys given by the
formula below.
0xb00000 + port
wher
the
port
is
a
function
of
the
domain id
and
the
participant id,
as
described
in
com.rti.dds.infrastructure.WireProtocolQosPolicy.participant id
(p. 1728)
8.236 ShmemTransport Interface Reference
1437
See also:
(p. 1728)
com.rti.ndds.transport.TransportSupport.set builtin transport property() (p. 1603)
8.236.5
Creating and Registering Shared Memory Transport Plugin
RTI Connext can implicitly create this plugin and register with the
com.rti.dds.domain.DomainParticipant (p. 654) if this transport (p. 376)
is specified in com.rti.dds.infrastructure.TransportBuiltinQosPolicy
(p. 1580).
To specify the properties of the builtin shared memory transport (p. 376) that
is implicitly registered, you can either:
call
com.rti.ndds.transport.TransportSupport.set builtin transport property (p. 1603) or
specify
the
pre-defined
property
names
in
com.rti.dds.infrastructure.PropertyQosPolicy (p. 1236) associated with the com.rti.dds.domain.DomainParticipant (p. 654). (see
Shared Memory Transport Property Names in Property QoS
Policy of Domain Participant (p. 1437)).
Builtin
transport
(p. 376)
plugin
properties
specified
in
com.rti.dds.infrastructure.PropertyQosPolicy
(p. 1236)
always
overwrite
the
ones
specified
through
com.rti.ndds.transport.TransportSupport.set builtin transport property() (p. 1603). The default value is assumed on any unspecified
property. Note that all properties should be set before the transport (p. 376)
is implicitly created and registered by RTI Connext. See Built-in Transport
Plugins (p. 222) for details on when a builtin transport (p. 376) is registered.
8.236.6
Shared Memory Transport Property Names in

Property QoS Policy of Domain Participant
The following table lists the predefined property names that can be
set in the com.rti.dds.infrastructure.PropertyQosPolicy (p. 1236) of a
com.rti.dds.domain.DomainParticipant (p. 654) to configure the builtin
shared memory transport (p. 376) plugin.
1438
Name
Class Documentation
Descriptions
See
dds.transport.shmem.builtin.parent.address
com.rti.ndds.transport.Transport.Property
bit count
t.address bit count
(p. 1573)
See
dds.transport.shmem.builtin.parent.properties
bitmap
t.properties bitmap
(p. 1574)
See
dds.transport.shmem.builtin.parent.gather
send buffer count max
t.gather send buffer count max
(p. 1574)
See
dds.transport.shmem.builtin.parent.message
size max
t.message size max
(p. 1574)
See
dds.transport.shmem.builtin.parent.allow
interfaces
t.allow interfaces list (p. 1575)
and
com.rti.ndds.transport.Transport.Property t.allow interfaces list length.
Interfaces should be specified as
comma-separated strings, with each
comma delimiting an interface. For
example (p. 375): 127.0.0.1,eth0
See
dds.transport.shmem.builtin.parent.deny
interfaces
t.deny interfaces list (p. 1575)
and
com.rti.ndds.transport.Transport.Property t.deny interfaces list length.
example (p. 375): 127.0.0.1,eth0
See
dds.transport.shmem.builtin.parent.allow
multicast interfaces
t.allow multicast interfaces list
(p. 1576) and
com.rti.ndds.transport.Transport.Property t.allow multicast interfaces list length.
for RTIdelimiting
Connext Java
API by Doxygen
comma
an interface.
For
example (p. 375): 127.0.0.1,eth0
See
dds.transport.shmem.builtin.parent.deny
t.deny multicast interfaces list
(p. 1576) and
com.rti.ndds.transport.Transport.Property t.deny multicast interfaces list -
8.237 ShmemTransport.Property t Class Reference
8.237
1439
ShmemTransport.Property t Class Reference
Subclass of com.rti.ndds.transport.Transport.Property t (p. 1570) allowing specification of parameters that are specific to the shared-memory transport (p. 376).
Inheritance diagram for ShmemTransport.Property t::

Property t ()
Public Attributes
int received message count max
Number of messages that can be buffered in the receive queue.
int receive buffer size

The total number of bytes that can be buffered in the receive queue.
8.237.1
Subclass of com.rti.ndds.transport.Transport.Property t (p. 1570) allowing specification of parameters that are specific to the shared-memory transport (p. 376).
See also:
8.237.2
8.237.2.1
Property t ()
Create an empty ShmemTransport (p. 1435) property with default values

1440
Class Documentation
8.237.3
8.237.3.1
int received message count max
Number of messages that can be buffered in the receive queue.

This does not guarantee that the Transport-Plugin will actually be able
to buffer received message count max messages of the maximum size
set in com.rti.ndds.transport.Transport.Property t.message size max
(p. 1574). The total number of bytes that can be buffered for a transport
(p. 376) plug-in is actually controlled by receive buffer size.
See also:
NDDS Transport Property t,
NDDS TRANSPORT SHMEM RECEIVED MESSAGE COUNT MAX DEFAULT
8.237.3.2
int receive buffer size
The total number of bytes that can be buffered in the receive queue.
This number controls how much memory is allocated by the plugin for the
receive queue. The actual number of bytes allocated is:
size = receive_buffer_size + message_size_max +
received_message_count_max * fixedOverhead
where fixedOverhead is some small number of bytes used by the queue data
structure. The following rules are noted:
receive buffer size < message size max received message count max, then the transport (p. 376) plugin will not be able to store
received message count max messages of size message size max.
receive buffer size > message size max received message count max, then there will be memory allocated that cannot be used by
the plugin and thus wasted.
To optimize memory usage, the user is allowed to specify a size for the receive
queue to be less than that required to hold the maximum number of messages
which are all of the maximum size.
In most situations, the average message size may be far less than the maximum
message size. So for example (p. 375), if the maximum message size is 64 K
bytes, and the user configures the plugin to buffer at least 10 messages, then 640
8.237 ShmemTransport.Property t Class Reference
1441
K bytes of memory would be needed if all messages were 64 K bytes. Should

this be desired, then receive buffer size should be set to 640 K bytes.
However, if the average message size is only 10 K bytes, then the user could set
the receive buffer size to 100 K bytes. This allows the user to optimize the
memory usage of the plugin for the average case and yet allow the plugin to
handle the extreme case.
NOTE, the queue will always be able to hold 1 message of message size max
bytes, no matter what the value of receive buffer size is.
See also:
NDDS TRANSPORT SHMEM RECEIVE BUFFER SIZE DEFAULT
1442
Class Documentation
8.238
ShortSeq Class Reference

short >.
Inheritance diagram for ShortSeq::

ShortSeq ()
Constructs an empty sequence of short integers with an initial maximum of
zero.
ShortSeq (int initialMaximum)

Constructs an empty sequence of short integers with the given initial maximum.
ShortSeq (short[ ] shorts)

Constructs a new sequence containing the given shorts.
boolean addAllShort (short[ ] elements, int offset, int length)

boolean addAllShort (short[ ] elements)

void addShort (short element)
void addShort (int index, short element)

short getShort (int index)

Returns the short at the given index.
short setShort (int index, short element)

Set the new short at the given index and return the old short.
void setShort (int dstIndex, short[ ] elements, int srcIndex, int length)
8.238 ShortSeq Class Reference
1443
short[ ] toArrayShort (short[ ] array)

int getMaximum ()
sequence.

A wrapper for getShort(int) ( p. 1444) that returns a java.lang.Short.

A wrapper for setShort() ( p. 1445).

A wrapper for addShort(int, int).
8.238.1

short >.
Instantiates:
See also:
short
8.238.2
8.238.2.1
ShortSeq ()
Constructs an empty sequence of short integers with an initial maximum of zero.
8.238.2.2
ShortSeq (int initialMaximum)
Constructs an empty sequence of short integers with the given initial maximum.
1444
8.238.2.3
Class Documentation
ShortSeq (short[ ] shorts)
Constructs a new sequence containing the given shorts.

Parameters:
shorts the initial contents of this sequence
Exceptions:
8.238.3
8.238.3.1
boolean addAllShort (short[ ] elements, int offset, int

length)
Exceptions:
8.238.3.2
boolean addAllShort (short[ ] elements)
Exceptions:
8.238.3.3
void addShort (short element)

8.238.3.4
void addShort (int index, short element)
8.238.3.5
short getShort (int index)
Returns the short at the given index.

1445
Exceptions:
8.238.3.6
short setShort (int index, short element)
Set the new short at the given index and return the old short.
Exceptions:
8.238.3.7
void setShort (int dstIndex, short[ ] elements, int


Parameters:
Exceptions:
8.238.3.8
short [ ] toArrayShort (short[ ] array)

Parameters:
into instead.
Returns:
1446
8.238.3.9
Class Documentation
int getMaximum ()
elements.
first created.
Returns:
See also:
8.238.3.10
A wrapper for getShort(int) (p. 1444) that returns a java.lang.Short.

See also:
8.238.3.11
A wrapper for setShort() (p. 1445).

Exceptions:
ClassCastException if the element is not of type Short.
See also:

8.238.3.12
1447
A wrapper for addShort(int, int).

Exceptions:
ClassCastException if the element is not of type Short.
See also:
1448
Class Documentation
8.239
StatusCondition Interface Reference

(p. 464) that is associated with each com.rti.dds.infrastructure.Entity
(p. 931).
Inheritance diagram for StatusCondition::

int get enabled statuses ()
Get the list of statuses enabled on an com.rti.dds.infrastructure.Entity
( p. 931).
void set enabled statuses (int mask)

This operation defines the list of communication statuses that determine
the trigger value of the com.rti.dds.infrastructure.StatusCondition
( p. 1448).
Entity get entity ()

Get the com.rti.dds.infrastructure.Entity ( p. 931) associated with the
com.rti.dds.infrastructure.StatusCondition ( p. 1448).
8.239.1

(p. 464) that is associated with each com.rti.dds.infrastructure.Entity
(p. 931).
The trigger value of the com.rti.dds.infrastructure.StatusCondition
(p. 1448) depends on the communication status of that entity (e.g., arrival of
data, loss of information, etc.), filtered by the set of enabled statuses on the
com.rti.dds.infrastructure.StatusCondition (p. 1448).
See also:
(p. 1709),
8.239 StatusCondition Interface Reference
8.239.2
8.239.2.1
int get enabled statuses ()
1449
Get the list of statuses enabled on an com.rti.dds.infrastructure.Entity

(p. 931).
Returns:
list of enabled statuses.
8.239.2.2
void set enabled statuses (int mask)
This operation defines the list of communication statuses that determine

the trigger value of the com.rti.dds.infrastructure.StatusCondition
(p. 1448).
This
operation
may
change
the
trigger value
of
the
com.rti.dds.infrastructure.WaitSet (p. 1709) objects behavior depends on

the changes of the trigger value of their attached conditions. Therefore, any com.rti.dds.infrastructure.WaitSet (p. 1709) to which the
com.rti.dds.infrastructure.StatusCondition (p. 1448) is attached is potentially affected by this operation.
If this function is not invoked, the default list of enabled statuses includes all
the statuses.
Parameters:
mask <<in>> ( p. 279) the list of enables statuses (see Status Kinds
(p. 110))
Exceptions:
8.239.2.3
Entity get entity ()
Get the com.rti.dds.infrastructure.Entity (p. 931) associated with the

There is exactly one com.rti.dds.infrastructure.Entity (p. 931) assocated
with each com.rti.dds.infrastructure.StatusCondition (p. 1448).
1450
Class Documentation
Returns:
com.rti.dds.infrastructure.Entity (p. 931) associated
with
the
8.240 StatusKind Class Reference
8.240
1451
StatusKind Class Reference

static final int INCONSISTENT TOPIC STATUS
Another topic ( p. 359) exists with the same name but different characteristics.
static final int OFFERED DEADLINE MISSED STATUS

The deadline that the com.rti.dds.publication.DataWriter ( p. 557) has
( p. 628) was not respected for a specific instance.
static final int REQUESTED DEADLINE MISSED STATUS

The deadline that the com.rti.dds.subscription.DataReader ( p. 487)
was expecting through its com.rti.dds.infrastructure.DeadlineQosPolicy
( p. 628) was not respected for a specific instance.
static final int OFFERED INCOMPATIBLE QOS STATUS

A QosPolicy ( p. 1301) value was incompatible with what was requested.
static final int REQUESTED INCOMPATIBLE QOS STATUS

A QosPolicy ( p. 1301) value was incompatible with what is offered.
static final int SAMPLE LOST STATUS

A sample has been lost (i.e. was never received).
static final int SAMPLE REJECTED STATUS

A (received) sample has been rejected.
static final int DATA ON READERS STATUS

New data is available.
static final int DATA AVAILABLE STATUS

One or more new data samples have been received.
static final int LIVELINESS LOST STATUS

The
liveliness
that
the
( p. 557)
has
committed
to
through
its
com.rti.dds.infrastructure.LivelinessQosPolicy ( p. 1140) was not
respected, thus com.rti.dds.subscription.DataReader ( p. 487) entities
1452
Class Documentation
will consider the com.rti.dds.publication.DataWriter ( p. 557) as no
longer alive.
static final int LIVELINESS CHANGED STATUS

The liveliness of one or more com.rti.dds.publication.DataWriter
( p. 557)
that
were
writing
instances
read
through
the
com.rti.dds.subscription.DataReader ( p. 487) has changed.
Some
com.rti.dds.publication.DataWriter ( p. 557) have become alive or
not alive.
static final int PUBLICATION MATCHED STATUS

The
( p. 557)
has
found
com.rti.dds.subscription.DataReader ( p. 487) that matches the
com.rti.dds.topic.Topic ( p. 1545) and has compatible QoS.
static final int SUBSCRIPTION MATCHED STATUS

The
( p. 487)
has
found
( p. 557)
that
matches
the
com.rti.dds.topic.Topic ( p. 1545) and has compatible QoS.
static
final
int
DATA WRITER APPLICATION ACKNOWLEDGMENT STATUS
<<eXtension>> (p. 278) A com.rti.dds.publication.DataWriter
( p. 557) has received an application-level acknowledgment for a sample
static final
STATUS
int
DATA WRITER INSTANCE REPLACED -
<<eXtension>> (p. 278) A com.rti.dds.publication.DataWriter

( p. 557) instance has been replaced
static final
STATUS
int
RELIABLE WRITER CACHE CHANGED -
<<eXtension>> (p. 278) The number of unacknowledged samples in a reliable writers cache has changed such that it has reached a pre-defined trigger
point.
static final int RELIABLE READER ACTIVITY CHANGED STATUS

<<eXtension>> (p. 278) One or more reliable readers has become active
or inactive.
static final int DDS DATA WRITER CACHE STATUS

static final int DDS DATA WRITER PROTOCOL STATUS

1453

metrics
static final int DDS DATA READER CACHE STATUS

static final int DATA READER PROTOCOL STATUS

metrics
static final int STATUS MASK NONE

No bits are set.
static final int STATUS MASK ALL

All bits are set.
8.240.1

Each concrete com.rti.dds.infrastructure.Entity (p. 931) is associated with
a set of Status objects whose values represent the communication status of
that com.rti.dds.infrastructure.Entity (p. 931).
The communication statuses whose changes can be communicated to the application depend on the com.rti.dds.infrastructure.Entity (p. 931).
Each status value can be accessed with a corresponding method
The changes
on the com.rti.dds.infrastructure.Entity (p. 931).
on these status values cause activation of the corresponding
com.rti.dds.infrastructure.StatusCondition (p. 1448) objects and trigger
invocation of the proper com.rti.dds.infrastructure.Listener (p. 1130)
objects to asynchronously inform the application.
See also:
(p. 931),
(p. 1448),
8.240.2
8.240.2.1
final int INCONSISTENT TOPIC STATUS [static]
Another topic (p. 359) exists with the same name but different characteristics.
1454
Class Documentation
Entity:
Status:
com.rti.dds.topic.InconsistentTopicStatus (p. 1052)
Listener:
8.240.2.2
final int OFFERED DEADLINE MISSED STATUS

[static]
The deadline that the com.rti.dds.publication.DataWriter (p. 557) has

Entity:
QoS:
DEADLINE (p. 52)
Status:
com.rti.dds.publication.OfferedDeadlineMissedStatus (p. 1195)
Listener:
8.240.2.3
final int REQUESTED DEADLINE MISSED STATUS

[static]
The deadline that the com.rti.dds.subscription.DataReader (p. 487)

was expecting through its com.rti.dds.infrastructure.DeadlineQosPolicy
Entity:
1455
QoS:
DEADLINE (p. 52)
Status:
com.rti.dds.subscription.RequestedDeadlineMissedStatus
(p. 1344)
Listener:
8.240.2.4
final int OFFERED INCOMPATIBLE QOS STATUS

[static]
A QosPolicy (p. 1301) value was incompatible with what was requested.
Entity:
Status:
com.rti.dds.publication.OfferedIncompatibleQosStatus (p. 1197)
Listener:
8.240.2.5
final int REQUESTED INCOMPATIBLE QOS STATUS

[static]
A QosPolicy (p. 1301) value was incompatible with what is offered.

Entity:
Status:
com.rti.dds.subscription.RequestedIncompatibleQosStatus
(p. 1346)
Listener:
1456
8.240.2.6
Class Documentation
final int SAMPLE LOST STATUS [static]
A sample has been lost (i.e. was never received).

Entity:
Status:
com.rti.dds.subscription.SampleLostStatus (p. 1410)
Listener:
8.240.2.7
final int SAMPLE REJECTED STATUS [static]
A (received) sample has been rejected.

Entity:
QoS:
RESOURCE LIMITS (p. 106)
Status:
com.rti.dds.subscription.SampleRejectedStatus (p. 1418)
Listener:
8.240.2.8
final int DATA ON READERS STATUS [static]
New data is available.

Entity:
Listener:

8.240.2.9
1457
final int DATA AVAILABLE STATUS [static]
One or more new data samples have been received.

Entity:
Listener:
8.240.2.10
final int LIVELINESS LOST STATUS [static]
The liveliness that the com.rti.dds.publication.DataWriter (p. 557) has

committed to through its com.rti.dds.infrastructure.LivelinessQosPolicy
(p. 1140) was not respected, thus com.rti.dds.subscription.DataReader
(p. 487) entities will consider the com.rti.dds.publication.DataWriter
(p. 557) as no longer alive.
Entity:
QoS:
LIVELINESS (p. 82)
Status:
com.rti.dds.publication.LivelinessLostStatus (p. 1138)
Listener:
8.240.2.11
final int LIVELINESS CHANGED STATUS [static]
The liveliness of one or more com.rti.dds.publication.DataWriter

(p. 557)
that
were
writing
instances
read
through
the
com.rti.dds.subscription.DataReader (p. 487) has changed.
Some
com.rti.dds.publication.DataWriter (p. 557) have become alive or not alive.
1458
Class Documentation
Entity:
QoS:
LIVELINESS (p. 82)
Status:
com.rti.dds.subscription.LivelinessChangedStatus (p. 1135)
Listener:
8.240.2.12
final int PUBLICATION MATCHED STATUS

[static]
The
(p. 557)
(p. 487)
that
com.rti.dds.topic.Topic (p. 1545) and has compatible QoS.
has
found
matches
the
Entity:
Status:
com.rti.dds.publication.PublicationMatchedStatus (p. 1259)
Listener:
8.240.2.13
final int SUBSCRIPTION MATCHED STATUS

[static]
The
(p. 487)
has
found
(p. 557)
that
matches
the
com.rti.dds.topic.Topic (p. 1545) and has compatible QoS.
Entity:
1459
Status:
com.rti.dds.subscription.SubscriptionMatchedStatus (p. 1519)
Listener:
8.240.2.14
final int DATA WRITER APPLICATION ACKNOWLEDGMENT STATUS

[static]
<<eXtension>> ( p. 278) A com.rti.dds.publication.DataWriter (p. 557)

has received an application-level acknowledgment for a sample
Enables
a
(p. 557)
callback
that is called when an application-level acknowledgment from a
com.rti.dds.subscription.DataReader (p. 487) is received.
The callback is called for each sample that is application-level acknowledged.
Entity:
Listener:
8.240.2.15
final int DATA WRITER INSTANCE REPLACED STATUS [static]
<<eXtension>> ( p. 278) A com.rti.dds.publication.DataWriter (p. 557)

instance has been replaced
Enables a com.rti.dds.publication.DataWriter (p. 557) callback that is
called when an instance in the writer queue is replaced.
Entity:
Listener:
1460
8.240.2.16
Class Documentation
final int RELIABLE WRITER CACHE CHANGED STATUS [static]
<<eXtension>> ( p. 278) The number of unacknowledged samples in a reliable writers cache has changed such that it has reached a pre-defined trigger
point.
This status is considered changed at the following times:
the
cache is empty (i.e.
contains no unacknowledge samples), full
(i.e.
the sample count has reached the value specified in
(p. 1351)), or the number of samples has reached a high (see
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.high watermark (p. 1375)) or low (see com.rti.dds.infrastructure.RtpsReliableWriterProtocol t.low watermark (p. 1375)) watermark.
Entity:
Status:
com.rti.dds.publication.ReliableWriterCacheChangedStatus
(p. 1336)
Listener:
8.240.2.17
final int RELIABLE READER ACTIVITY CHANGED STATUS [static]
<<eXtension>> ( p. 278) One or more reliable readers has become active or

inactive.
A reliable reader is considered active by a reliable writer with which
it is matched if that reader acknowledges the samples it has been sent
in a timely fashion.
For the definition of timely in this case, see
(p. 1372)
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t
and
(p. 1333).
See also:
com.rti.dds.infrastructure.RtpsReliableWriterProtocol t (p. 1372)
(p. 1333)

8.240.2.18
1461
final int DDS DATA WRITER CACHE STATUS

[static]

8.240.2.19
final int DDS DATA WRITER PROTOCOL STATUS

[static]

metrics
The status of a writers internal protocol related metrics, like the number of
samples pushed, pulled, filtered; and status of wire protocol traffic.
8.240.2.20
final int DDS DATA READER CACHE STATUS

[static]

8.240.2.21
final int DATA READER PROTOCOL STATUS

[static]

metrics
The status of a readers internal protocol related metrics, like the number of
samples received, filtered, rejected; and status of wire protocol traffic.
1462
Class Documentation
8.241
StringDataReader Class Reference
<<interface>>
( p. 279)
Instantiates
DataReader
<
Inheritance diagram for StringDataReader::

void read (StringSeq received data, SampleInfoSeq info seq, int max samples, int sample states, int view states, int instance states)
Access
a
collection
of
data
samples
from
the
void take (StringSeq received data, SampleInfoSeq info seq, int max samples, int sample states, int view states, int instance states)
Access
a
collection
of
data-samples
from
the
void read w condition (StringSeq received data, SampleInfoSeq

Accesses
via
com.rti.dds.type.builtin.StringDataReader.read
( p. 1463) the samples that match the criteria specified in the
void take w condition (StringSeq received data, SampleInfoSeq

Analogous
to
com.rti.dds.type.builtin.StringDataReader.read w condition
( p. 1463)
except
it
accesses
samples
via
the
com.rti.dds.type.builtin.StringDataReader.take ( p. 1463) operation.
String read next sample (SampleInfo sample info)

value
from
the
value
from
the
String take next sample (SampleInfo sample info)

8.241 StringDataReader Class Reference
8.241.1
1463
<<interface>>
( p. 279)
Instantiates
<
DataReader
See also:
8.241.2
8.241.2.1
void read (StringSeq received data, SampleInfoSeq

Access
a
collection
of
data
samples
from
the
See also:
8.241.2.2
void take (StringSeq received data, SampleInfoSeq

Access
a
collection
of
data-samples
from
the
See also:
8.241.2.3
void read w condition (StringSeq received data,

Accesses
via
com.rti.dds.type.builtin.StringDataReader.read
(p. 1463) the samples that match the criteria specified in the
See also:
1464
8.241.2.4
Class Documentation
void take w condition (StringSeq received data,
Analogous
to
com.rti.dds.type.builtin.StringDataReader.read w condition
(p. 1463)
except
it
accesses
samples
via
the
com.rti.dds.type.builtin.StringDataReader.take (p. 1463) operation.
See also:
8.241.2.5
String read next sample (SampleInfo sample info)
Copies
the
value
from
the
See also:
8.241.2.6
String take next sample (SampleInfo sample info)
Copies
the
value
from
the
See also:
8.242 StringDataWriter Class Reference
8.242
1465
StringDataWriter Class Reference
<<interface>>
( p. 279)
Instantiates
DataWriter
<
Inheritance diagram for StringDataWriter::

void write (String instance data, InstanceHandle t handle)
Modifies the value of a string data instance.
void write w timestamp (String instance data, InstanceHandle t

Performs the same function as com.rti.dds.type.builtin.StringDataWriter.write
8.242.1
<<interface>>
( p. 279)
Instantiates
DataWriter
See also:
8.242.2
8.242.2.1
void write (String instance data, InstanceHandle t

handle)
Modifies the value of a string data instance.

See also:
<
1466
8.242.2.2
Class Documentation
void write w timestamp (String instance data,
Performs the same function as com.rti.dds.type.builtin.StringDataWriter.write

See also:
8.243 StringSeq Class Reference
8.243
1467
StringSeq Class Reference

Inheritance diagram for StringSeq::

StringSeq ()
Constructs an empty sequence of strings with an initial maximum of zero.
StringSeq (int initialMaximum)

Constructs an empty sequence of strings with the given initial maximum.
StringSeq (Collection strings)

Constructs a new sequence containing the given strings.

static void readStringArray (String[ ] value, CdrObjectInput in, int
length) throws IOException
static void writeStringArray (String[ ] value, CdrObjectOutput out, int
length, int maxStringLength) throws IOException
8.243.1

See also:
com.rti.dds.infrastructure.String > with value type semantics.
StringSeq (p. 1467) is a sequence that contains strings.
Instantiates:
1468
Class Documentation
See also:
8.243.2
8.243.2.1
StringSeq ()
Constructs an empty sequence of strings with an initial maximum of zero.

8.243.2.2
StringSeq (int initialMaximum)
Constructs an empty sequence of strings with the given initial maximum.

8.243.2.3
StringSeq (Collection strings)
Constructs a new sequence containing the given strings.

Parameters:
strings the initial contents of this sequence
Exceptions:
8.243.3
8.243.3.1
Parameters:
Returns:
Exceptions:
NullPointerException If src is null OR if there are null objects contained in this sequence.
8.243 StringSeq Class Reference
1469

See also:
8.243.3.2
static void readStringArray (String[ ] value,

CdrObjectInput in, int length) throws IOException
[static]
Read array of strings. The length specified must match the expected length of
array. Otherwise, the stream will be positioned incorrectly, leading to corrupt
reads. The length of array must be at least the value of length parameter
(otherwise, ArrayOutOfBoundException will be thrown).
Parameters:
value array to read into
in Interface for reading object in CDR encoding.
length the length of array (<= value.length)
8.243.3.3
static void writeStringArray (String[ ] value,

CdrObjectOutput out, int length, int maxStringLength)
throws IOException [static]
Write array of string up to the specified length
1470
Class Documentation
8.244
StringTypeSupport Class Reference
<<interface>> ( p. 279) String type support.

Inheritance diagram for StringTypeSupport::

type name)
com.rti.dds.infrastructure.String data type.

type name)
Allows an application to unregister the com.rti.dds.infrastructure.String data
type from RTI Connext. After calling unregister type, no further communication using this type is possible.

Get the default name for the com.rti.dds.infrastructure.String type.
8.244.1
<<interface>> ( p. 279) String type support.
8.244.2
8.244.2.1


com.rti.dds.infrastructure.String data type.
By default, The com.rti.dds.infrastructure.String built-in type is automatically
registered when a DomainParticipant is created using the type name returned
by
com.rti.dds.type.builtin.com.rti.dds.type.builtin.StringTypeSupport.get type name. Therefore, the usage of this function is optional and it is only
8.244 StringTypeSupport Class Reference
1471
This
method
can
also
be
used
to
register
the
same
com.rti.dds.type.builtin.com.rti.dds.type.builtin.StringTypeSupport with a
com.rti.dds.domain.DomainParticipant (p. 654) using different values for
the type name.
If
register type
is
called
multiple
times
with
the
same
Parameters:
(p. 654) to register the data type com.rti.dds.infrastructure.String
with. Cannot be null.
com.rti.dds.infrastructure.String is registered with the participant;
this type name is used when creating a new com.rti.dds.topic.Topic
(p. 1545). (See com.rti.dds.domain.DomainParticipant.create topic (p. 697).) The name may not be null or longer than 255 characters.
Exceptions:
One of
the
Standard
Return
Codes
(p. 1363)
(p. 108),
or
MT Safety:
See also:
8.244.2.2

Allows an application to unregister the com.rti.dds.infrastructure.String data

type from RTI Connext. After calling unregister type, no further communication using this type is possible.
1472
Class Documentation
Precondition:
The com.rti.dds.infrastructure.String type with type name is registered
with the participant and all com.rti.dds.topic.Topic (p. 1545) objects referencing the type have been destroyed. If the type is not
registered with the participant, or if any com.rti.dds.topic.Topic
(p. 1545) is associated with the type, the operation will fail with
Postcondition:
Parameters:
(p. 654) to unregister the data type com.rti.dds.infrastructure.String
from. Cannot be null.
com.rti.dds.infrastructure.String is registered with the participant.
The name should match a name that has been previously used to
register a type with the participant. Cannot be null.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1356)
MT Safety:
SAFE.
See also:
com.rti.dds.type.builtin.com.rti.dds.type.builtin.StringTypeSupport.register type
8.244.2.3
Get the default name for the com.rti.dds.infrastructure.String type.

Can be used for calling com.rti.dds.type.builtin.com.rti.dds.type.builtin.StringTypeSupport.register type or creating com.rti.dds.topic.Topic (p. 1545).
8.244 StringTypeSupport Class Reference
1473
Returns:
default name for the com.rti.dds.infrastructure.String type.
See also:
com.rti.dds.type.builtin.com.rti.dds.type.builtin.StringTypeSupport.register type
1474
Class Documentation
8.245
StructMember Class Reference


StructMember (String name, boolean is pointer, short bits, boolean
is key, TypeCode type)
Public Attributes
String name
The name of the struct member.
TypeCode type
The type of the struct member.
boolean is pointer
Indicates whether the struct member is a pointer or not.
short bits
Number of bits of a bitfield member.
boolean is key
Indicates if the struct member is a key member or not.
8.245.1

See also:
com.rti.dds.typecode.TypeCodeFactory.create struct tc (p. 1651)
8.245.2
8.245.2.1
StructMember (String name, boolean is pointer, short

bits, boolean is key, TypeCode type)
Constructs a StructMember (p. 1474) object initialized with the given values.
8.245 StructMember Class Reference
8.245.3
8.245.3.1
String name
1475
The name of the struct member.

Cannot be null.
8.245.3.2
TypeCode type
The type of the struct member.

Cannot be null.
8.245.3.3
boolean is pointer
Indicates whether the struct member is a pointer or not.

8.245.3.4
short bits

If the struct member is a bitfield, this field contains the number of bits of the bitfield.
Otherwise, bits should contain
com.rti.dds.typecode.TypeCode.NOT BITFIELD (p. 1646).
8.245.3.5
boolean is key
Indicates if the struct member is a key member or not.
1476
Class Documentation
8.246
Subscriber Interface Reference
<<interface>> ( p. 279) A subscriber is the object responsible for actually

receiving data from a subscription (p. 353).
Inheritance diagram for Subscriber::

Copies the default com.rti.dds.subscription.DataReaderQos ( p. 536)
values into the provided com.rti.dds.subscription.DataReaderQos
( p. 536) instance.

Sets the default com.rti.dds.subscription.DataReaderQos ( p. 536) values for this subscriber.
void set default datareader qos with profile (String library name,
<<eXtension>>
(p. 278)
Set
the
com.rti.dds.subscription.DataReaderQos ( p. 536) values
subscriber based on the input XML QoS profile.
default
for this
DataReader
create datareader
(TopicDescription
topic,
DataReaderQos qos, DataReaderListener listener, int mask)
Creates a com.rti.dds.subscription.DataReader ( p. 487) that will be attached and belong to the com.rti.dds.subscription.Subscriber ( p. 1476).
DataReader create datareader with profile (TopicDescription

topic, String library name, String profile name, DataReaderListener
listener, int mask)
( p. 487) object using the com.rti.dds.subscription.DataReaderQos

Deletes a com.rti.dds.subscription.DataReader ( p. 487) that belongs to
the com.rti.dds.subscription.Subscriber ( p. 1476).
DataReader lookup datareader (String topic name)

Retrieves an existing com.rti.dds.subscription.DataReader ( p. 487).
8.246 Subscriber Interface Reference
1477
void get datareaders (DataReaderSeq readers, int sample states, int

Allows the application to access the com.rti.dds.subscription.DataReader
( p. 487) objects that contain samples with the specified sample states,
view states and instance states.
void get all datareaders (DataReaderSeq readers)

Retrieve all the DataReaders created from this Subscriber ( p. 1476).
void notify datareaders ()

Invokes the operation com.rti.dds.subscription.DataReaderListener.on data available() ( p. 520) on the com.rti.dds.subscription.DataReaderListener
( p. 518)
objects
attached
to
contained
entities
with
( p. 487)
com.rti.dds.infrastructure.StatusKind.StatusKind.DATA AVAILABLE STATUS that is considered changed as described in Changes in read
communication status ( p. 112).
void set qos (SubscriberQos qos)

Sets the subscriber QoS.
<<eXtension>> (p. 278) Change the QoS of this subscriber using the input
XML QoS profile.
void get qos (SubscriberQos qos)

Gets the subscriber QoS.


XML
library
for

XML
profile
for
1478
Class Documentation

<<eXtension>> (p. 278) Gets the library where the default XML QoS profile is contained for a com.rti.dds.subscription.Subscriber ( p. 1476).
void set listener (SubscriberListener l, int mask)

Sets the subscriber listener.
SubscriberListener get listener ()

Get the subscriber listener.

Call the subscriber listener.
void begin access ()

Indicates that the application is about to access the data samples in any of
the com.rti.dds.subscription.DataReader ( p. 487) objects attached to the
void end access ()

Indicates that the application has finished accessing the data samples in
com.rti.dds.subscription.DataReader ( p. 487) objects managed by the
void copy from topic qos (DataReaderQos datareader qos, TopicQos topic qos)
Copies the policies in the com.rti.dds.topic.TopicQos ( p. 1566) to the
corresponding policies in the com.rti.dds.subscription.DataReaderQos
( p. 536).

the com.rti.dds.subscription.Subscriber ( p. 1476) belongs.

Deletes all the entities that were created by means of the create operation
on the com.rti.dds.subscription.Subscriber ( p. 1476).
DataReader lookup datareader by name exp (String datareader name)

<<experimental>>
(p. 278)
<<eXtension>>
(p. 278)
Retrieves
a
( p. 487)
contained within the com.rti.dds.subscription.Subscriber ( p. 1476) the
com.rti.dds.subscription.DataReader ( p. 487) entity name.
1479

static final DataReaderQos DATAREADER QOS DEFAULT
static final DataReaderQos DATAREADER QOS USE TOPIC QOS = new DataReaderQos()
Special value for creating com.rti.dds.subscription.DataReader
( p. 487)
with
a
combination
of
the
default
( p. 536)
and
the
8.246.1
<<interface>> ( p. 279) A subscriber is the object responsible for actually

receiving data from a subscription (p. 353).
QoS:
com.rti.dds.subscription.SubscriberQos (p. 1505)
Status:
com.rti.dds.infrastructure.StatusKind.StatusKind.DATA ON READERS STATUS
Listener:
A
subscriber
acts
on
the
behalf
of
one
or
several
com.rti.dds.subscription.DataReader (p. 487) objects that are related to
it. When it receives data (from the other parts of the system), it builds the list
of concerned com.rti.dds.subscription.DataReader (p. 487) objects and
then indicates to the application that data is available through its listener or
by enabling related conditions.
The
application
can
access
the
list
of
concerned
com.rti.dds.subscription.DataReader (p. 487) objects through the
operation get datareaders() (p. 1489) and then access the data available
through operations on the com.rti.dds.subscription.DataReader (p. 487).
The
following
operations
may
be
called
even
if
the
com.rti.dds.subscription.Subscriber (p. 1476) is not enabled.
Other
operations will the value com.rti.dds.infrastructure.RETCODE NOT ENABLED
(p. 1361)
if
called
on
a
disabled
com.rti.dds.subscription.Subscriber (p. 1476):
1480
Class Documentation
The base-class operations com.rti.dds.subscription.Subscriber.set com.rti.dds.subscription.Subscriber.set qos qos
(p. 1492),
with profile (p. 1493), com.rti.dds.subscription.Subscriber.get qos (p. 1493), com.rti.dds.subscription.Subscriber.set listener
(p. 1496),
com.rti.dds.subscription.Subscriber.get listener
(p. 935),
(p. 1497),
(p. 936),
com.rti.dds.infrastructure.Entity.get status changes (p. 936)
com.rti.dds.subscription.Subscriber.create datareader (p. 1483),
com.rti.dds.subscription.Subscriber.create datareader with com.rti.dds.subscription.Subscriber.delete profile (p. 1486),
datareader (p. 1487), com.rti.dds.subscription.Subscriber.delete contained entities (p. 1500), com.rti.dds.subscription.Subscriber.set default datareader qos (p. 1481), com.rti.dds.subscription.Subscriber.set default datareader qos with profile
(p. 1482),
(p. 1480), com.rti.dds.subscription.Subscriber.set default library
(p. 1494), com.rti.dds.subscription.Subscriber.set default profile
(p. 1495)
All operations except for the base-class operations set qos() (p. 1492), set qos with profile() (p. 1493), get qos() (p. 1493), set listener() (p. 1496),
get listener() (p. 1497), enable() (p. 935) and create datareader()
(p. 1483) may fail with com.rti.dds.infrastructure.RETCODE NOT ENABLED (p. 1361).
See also:
8.246.2
8.246.2.1
Copies the default com.rti.dds.subscription.DataReaderQos (p. 536) values into the provided com.rti.dds.subscription.DataReaderQos (p. 536) instance.
call to com.rti.dds.subscription.Subscriber.set default datareader qos (p. 1481), or com.rti.dds.subscription.Subscriber.set default datareader qos with profile (p. 1482), or else, if the call was never made,
the default values from is owning com.rti.dds.domain.DomainParticipant
(p. 654).
1481
MT Safety:
UNSAFE. It is not safe to retrieve the default QoS value from
a subscriber while another thread may be simultaneously calling
(p. 1481)
Parameters:
qos <<inout>> ( p. 279) com.rti.dds.subscription.DataReaderQos
Exceptions:
See also:
com.rti.dds.subscription.Subscriber.DATAREADER QOS DEFAULT (p. 196)
8.246.2.2
Sets the default com.rti.dds.subscription.DataReaderQos (p. 536) values

for this subscriber.
This call causes the default values inherited from the owning
com.rti.dds.domain.DomainParticipant (p. 654) to be overridden.
This
default
value
will
be
used
for
newly
created
(p. 487)
if
com.rti.dds.subscription.Subscriber.DATAREADER QOS DEFAULT (p. 196) is specified as the qos parameter when
com.rti.dds.subscription.Subscriber.create datareader
(p. 1483)
is
called.
Precondition:
1482
Class Documentation
MT Safety:
UNSAFE. It is not safe to set the default QoS value from a
subscriber while another thread may be simultaneously calling
com.rti.dds.subscription.Subscriber.set default datareader com.rti.dds.subscription.Subscriber.get qos
(p. 1481),
default datareader qos
(p. 1480)
or
calling
(p. 1483)
with com.rti.dds.subscription.Subscriber.DATAREADER QOS DEFAULT (p. 196) as the qos parameter.
Parameters:
qos <<in>> ( p. 279) The default com.rti.dds.subscription.DataReaderQos
(p. 536)
to
be
set
to.
The
special
value
com.rti.dds.subscription.Subscriber.DATAREADER QOS DEFAULT (p. 196) may be passed as qos to indicate that the
would used if com.rti.dds.subscription.Subscriber.set default Cannot be
datareader qos (p. 1481) had never been called.
NULL.
Exceptions:
One of
the
Standard
Return
Codes (p. 108),
or
or
8.246.2.3
void set default datareader qos with profile (String

<<eXtension>>
( p. 278)
Set
the
default
com.rti.dds.subscription.DataReaderQos (p. 536) values for this subscriber based on the input XML QoS profile.
This
default
value
will
be
used
for
newly
created
(p. 487)
if
com.rti.dds.subscription.Subscriber.DATAREADER QOS DEFAULT (p. 196) is specified as the qos parameter when
(p. 1483)
is
called.
Precondition:
The com.rti.dds.subscription.DataReaderQos (p. 536) contained in
1483
MT Safety:
from
a
(p. 1476)
while
another
thread
may
be
simultaneously
calling
(p. 1481),
(p. 1480)
or
calling
(p. 1483)
with com.rti.dds.subscription.Subscriber.DATAREADER QOS DEFAULT (p. 196) as the qos parameter.
Parameters:
(p. 1495)).
fails
with
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
See also:
com.rti.dds.subscription.Subscriber.create datareader with profile (p. 1486)
8.246.2.4
DataReader create datareader (TopicDescription topic,

DataReaderQos qos, DataReaderListener listener, int
mask)
Creates a com.rti.dds.subscription.DataReader (p. 487) that will be attached and belong to the com.rti.dds.subscription.Subscriber (p. 1476).
1484
Class Documentation
For each application-defined type com.rti.ndds.example.Foo (p. 977), there

is an implied, auto-generated class com.rti.ndds.example.FooDataReader
(an
incarnation
of
FooDataReader)
that
extends
(p. 979)
com.rti.dds.subscription.DataReader (p. 487) and contains the operations to read data of type com.rti.ndds.example.Foo (p. 977).
Note that a common application pattern to construct the QoS for the
com.rti.dds.subscription.DataReader (p. 487) is to:
Retrieve the QoS policies on the associated com.rti.dds.topic.Topic
(p. 1545) by means of the com.rti.dds.topic.Topic.get qos (p. 1548)
operation.
Retrieve the default com.rti.dds.subscription.DataReader (p. 487)
qos by means of the com.rti.dds.subscription.Subscriber.get default datareader qos (p. 1480) operation.
Combine
those
two
QoS
policies
(for
example,
com.rti.dds.subscription.Subscriber.copy from topic qos
(p. 1499)) and selectively modify policies as desired
Use
the
resulting
QoS
policies
to
construct
using
the
When a com.rti.dds.subscription.DataReader (p. 487) is created, only those transports already registered are available to the
registered.
MT Safety:
UNSAFE. If com.rti.dds.subscription.Subscriber.DATAREADER QOS DEFAULT (p. 196) is used for the qos parameter, it is not safe to
create the datareader while another thread may be simultaneously calling
(p. 1481).
Precondition:
If subscriber is enabled, the topic (p. 359) must be enabled. If it is not,
this operation will fail and no com.rti.dds.subscription.DataReader
been created from the same participant as this subscriber. If it was created
from a different participant, this method will return NULL.
If qos is com.rti.dds.subscription.Subscriber.DATAREADER QOS USE TOPIC QOS (p. 197),
topic (p. 359) cannot be
1485
com.rti.dds.topic.MultiTopic (p. 1190), or else this method will

return NULL.
Parameters:
qos <<in>>
( p. 279)
The
qos
of
the
The special
value com.rti.dds.subscription.Subscriber.DATAREADER QOS DEFAULT (p. 196) can be used to indicate that the
com.rti.dds.subscription.DataReader (p. 487) should be created
with the default com.rti.dds.subscription.DataReaderQos
(p. 536) set in the com.rti.dds.subscription.Subscriber
(p. 1476).
If
(p. 1561) is of type com.rti.dds.topic.Topic (p. 1545) or
com.rti.dds.topic.ContentFilteredTopic (p. 471), the special
value com.rti.dds.subscription.Subscriber.DATAREADER QOS USE TOPIC QOS (p. 197) can be used to indicate
that
the
(p. 536)
set on the com.rti.dds.subscription.Subscriber (p. 1476)
and
the
(p. 1566)
(in
the
case
of
a
(p. 471),
the
(p. 1566)
of
the
related
(p. 1545)).
if
com.rti.dds.subscription.Subscriber.DATAREADER QOS USE TOPIC QOS (p. 197) is used, topic (p. 359) cannot be a
listener <<in>>
( p. 279)
The
listener
of
the

Returns:
See also:
entity creation
1486
Class Documentation

com.rti.dds.subscription.Subscriber.create datareader with profile (p. 1486)
(p. 1480)
8.246.2.5
DataReader create datareader with profile

(TopicDescription topic, String library name, String
profile name, DataReaderListener listener, int mask)

(p. 487) object using the com.rti.dds.subscription.DataReaderQos (p. 536)
The com.rti.dds.subscription.DataReader (p. 487) will be attached and belong to the com.rti.dds.subscription.Subscriber (p. 1476).
For each application-defined type com.rti.ndds.example.Foo (p. 977), there
is an implied, auto-generated class com.rti.ndds.example.FooDataReader
(p. 979)
(an
incarnation
of
FooDataReader)
that
extends
com.rti.dds.subscription.DataReader (p. 487) and contains the operations to read data of type com.rti.ndds.example.Foo (p. 977).
When a com.rti.dds.subscription.DataReader (p. 487) is created, only those transports already registered are available to the
registered.
Precondition:
If subscriber is enabled, the topic (p. 359) must be enabled. If it is not,
this operation will fail and no com.rti.dds.subscription.DataReader
been created from the same participant as this subscriber. If it was created
from a different participant, this method will return NULL.
Parameters:
1487
(p. 1495)).
listener <<in>>
( p. 279)
The
listener
of
the
Returns:
See also:
entity creation
com.rti.dds.subscription.Subscriber.DATAREADER QOS USE TOPIC QOS (p. 197)
(p. 1480)
8.246.2.6
Deletes a com.rti.dds.subscription.DataReader (p. 487) that belongs to the

Precondition:
If the com.rti.dds.subscription.DataReader (p. 487) does not belong to the com.rti.dds.subscription.Subscriber (p. 1476), or if ther
1488
Class Documentation
are any existing com.rti.dds.subscription.ReadCondition (p. 1313)

or com.rti.dds.subscription.QueryCondition (p. 1311) objects that
are attached to the com.rti.dds.subscription.DataReader (p. 487),
or if there are outstanding loans on samples (as a result of a
call to read(), take(), or one of the variants thereof), the operation fails with the error com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
Postcondition:
Listener installed on the com.rti.dds.subscription.DataReader (p. 487)
Parameters:
a datareader <<in>> ( p. 279) The com.rti.dds.subscription.DataReader
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
8.246.2.7
DataReader lookup datareader (String topic name)
Retrieves an existing com.rti.dds.subscription.DataReader (p. 487).

Use this operation on the built-in com.rti.dds.subscription.Subscriber
(p. 1476)
(Built-in
Topics
(p. 157))
to
access
the
built-in
com.rti.dds.subscription.DataReader (p. 487) entities for the built-in
topics.
The built-in com.rti.dds.subscription.DataReader (p. 487) is created when
this operation is called on a built-in topic (p. 359) for the first time. The builtin com.rti.dds.subscription.DataReader (p. 487) is deleted automatically
when the com.rti.dds.domain.DomainParticipant (p. 654) is deleted.
To ensure that builtin (p. 358) com.rti.dds.subscription.DataReader
(p. 487) entities receive all the discovery traffic, it is suggested that you
lookup the builtin (p. 358) com.rti.dds.subscription.DataReader (p. 487)
before the com.rti.dds.domain.DomainParticipant (p. 654) is enabled.
Looking up builtin (p. 358) com.rti.dds.subscription.DataReader (p. 487)
may implicitly register builtin (p. 358) transports due to creation of
com.rti.dds.subscription.DataReader (p. 487) (see Built-in Transport
Plugins (p. 222) for details on when a builtin (p. 358) transport is registered).
Therefore, if you are want to modify builtin (p. 358) transport properties, do
so before using this operation.
1489
Therefore the suggested sequence when looking up builtin (p. 358) DataReaders
is:
Create a disabled com.rti.dds.domain.DomainParticipant (p. 654).
(optional) Modify builtin (p. 358) transport properties
Call
com.rti.dds.domain.DomainParticipant.get builtin subscriber() (p. 711).
Call lookup datareader() (p. 1488).
Call enable() (p. 935) on the DomainParticipant.
Parameters:
topic name <<in>>
( p. 279)
Name
of
the
com.rti.dds.topic.TopicDescription (p. 1561) that the retrieved
com.rti.dds.subscription.DataReader (p. 487) is attached to.
Cannot be NULL.
Returns:
A com.rti.dds.subscription.DataReader (p. 487) that belongs to
the com.rti.dds.subscription.Subscriber (p. 1476) attached to the
com.rti.dds.topic.TopicDescription (p. 1561) with topic name. If no
such com.rti.dds.subscription.DataReader (p. 487) exists, this operation returns NULL.
The returned com.rti.dds.subscription.DataReader (p. 487) may be enabled or disabled.
If more than one com.rti.dds.subscription.DataReader (p. 487) is attached
to the com.rti.dds.subscription.Subscriber (p. 1476), this operation may
return any one of them.
MT Safety:
UNSAFE.
It
is
not
safe
to
lookup
a
com.rti.dds.subscription.DataReader (p. 487) in one thread
while another thread is simultaneously creating or destroying that
8.246.2.8
void get datareaders (DataReaderSeq readers, int

sample states, int view states, int instance states)
Allows the application to access the com.rti.dds.subscription.DataReader

(p. 487) objects that contain samples with the specified sample states, view states and instance states.
1490
Class Documentation
If the application is outside a begin access() (p. 1497)/end access() block,

or if the com.rti.dds.infrastructure.PresentationQosPolicy.access scope (p. 1225) of the com.rti.dds.subscription.Subscriber (p. 1476) is
com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPolicyAccessScopeKi
PRESENTATION QOS, or if the com.rti.dds.infrastructure.PresentationQosPolicy.ordered access (p. 1225) of the com.rti.dds.subscription.Subscriber (p. 1476) is
com.rti.dds.infrastructure.false, the returned collection is a set containing
each com.rti.dds.subscription.DataReader (p. 487) at most once, in no
specified order.
If the application is within a begin access() (p. 1497)/end polaccess()

block,
and
the
PRESENTATION
(p. 90)
icy
of
the
(p. 1476)
is
OFFERED PRESENTATION QOS, and com.rti.dds.infrastructure.PresentationQosPolicy.order
access (p. 1225) in the com.rti.dds.subscription.Subscriber (p. 1476) is
com.rti.dds.infrastructure.true, the returned collection is a list of DataReaders
where a DataReader (p. 487) may appear more than one time.
To
retrieve
the
samples
in
the
order
they
were
published
across
DataWriters
of
the
same
group
(com.rti.dds.publication.Publisher
(p. 1262)
configured
with
PRESENTATION QOS), the application should read()/take() from each
DataReader (p. 487) in the same order as it appears in the output sequence. The application will move to the next DataReader (p. 487) when the
read()/take() operation fails with com.rti.dds.infrastructure.RETCODE NO DATA (p. 1360).
Parameters:
readers <<inout>> ( p. 279) a com.rti.dds.subscription.DataReaderSeq
(p. 555) object where the set or list of readers will be returned. Cannot
be NULL.
sample states <<in>> ( p. 279) the returned DataReader (p. 487)
must contain samples that have one of these sample states.
view states <<in>> ( p. 279) the returned DataReader (p. 487) must
contain samples that have one of these view states.
instance states <<in>> ( p. 279) the returned DataReader (p. 487)
must contain samples that have one of these instance states.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
1491
(p. 1361).
See also:
Access to data samples (p. 356)
com.rti.dds.subscription.Subscriber.begin access (p. 1497)
com.rti.dds.subscription.Subscriber.end access (p. 1498)
8.246.2.9
void get all datareaders (DataReaderSeq readers)
Retrieve all the DataReaders created from this Subscriber (p. 1476).
Parameters:
readers <<inout>> ( p. 279) Sequence where the DataReaders will be
added
Exceptions:
8.246.2.10
void notify datareaders ()
Invokes the operation com.rti.dds.subscription.DataReaderListener.on data available() (p. 520) on the com.rti.dds.subscription.DataReaderListener
(p. 518) objects attached to contained com.rti.dds.subscription.DataReader
(p. 487) entities with com.rti.dds.infrastructure.StatusKind.StatusKind.DATA AVAILABLE STATUS that is considered changed as described in Changes in
read communication status (p. 112).
This
operation
is
typically
invoked
from
the
com.rti.dds.subscription.SubscriberListener.on data on readers
(p. 1504)
operation
in
the
com.rti.dds.subscription.SubscriberListener (p. 1503).
That way
the com.rti.dds.subscription.SubscriberListener (p. 1503) can delegate
to the com.rti.dds.subscription.DataReaderListener (p. 518) objects the
handling of the data.
The operation will notify the data readers that have a sample state
of com.rti.dds.subscription.SampleStateKind.SampleStateKind.NOT READ SAMPLE STATE, view state of com.rti.dds.subscription.SampleStateKind.ANY SAMPLE STATE
(p. 203)
and
instance state
of
com.rti.dds.subscription.InstanceStateKind.ANY INSTANCE STATE (p. 205).
1492
Class Documentation
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
(p. 1361).
8.246.2.11
or
void set qos (SubscriberQos qos)
Sets the subscriber QoS.

This operation modifies the QoS of the com.rti.dds.subscription.Subscriber
(p. 1476).
The
com.rti.dds.subscription.SubscriberQos.group data
(p. 1506),
com.rti.dds.subscription.SubscriberQos.partition
(p. 1506)
and
com.rti.dds.subscription.SubscriberQos.entity factory (p. 1506) can
Parameters:
qos <<in>>
( p. 279)
com.rti.dds.subscription.SubscriberQos
cannot be changed after com.rti.dds.subscription.Subscriber
(p. 1476)
is
enabled.
The
special
value
com.rti.dds.domain.DomainParticipant.SUBSCRIBER QOS DEFAULT (p. 153) can be used to indicate that
the
QoS
of
the
com.rti.dds.subscription.SubscriberQos (p. 1505) set in the
Cannot be
NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
See also:

8.246.2.12
1493

profile name)
<<eXtension>> ( p. 278) Change the QoS of this subscriber using the input
XML QoS profile.
This operation modifies the QoS of the com.rti.dds.subscription.Subscriber
(p. 1476).
The
com.rti.dds.subscription.SubscriberQos.group data
(p. 1506),
com.rti.dds.subscription.SubscriberQos.partition
(p. 1506)
and
com.rti.dds.subscription.SubscriberQos.entity factory (p. 1506) can
Parameters:
(p. 1495)).
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
See also:
8.246.2.13
void get qos (SubscriberQos qos)
Gets the subscriber QoS.

Parameters:
qos <<in>>
( p. 279)
com.rti.dds.subscription.SubscriberQos
1494
Class Documentation
Exceptions:
See also:
8.246.2.14

Returns:
See also:
com.rti.dds.subscription.Subscriber.set default library (p. 1494)
8.246.2.15

XML
library
for
a default library is needed during a call to one of this Subscribers operations.
default library.
If the default library is not set, the com.rti.dds.subscription.Subscriber
(p. 654) (see com.rti.dds.domain.DomainParticipant.set default library
(p. 707)).
Parameters:
Exceptions:
See also:
com.rti.dds.subscription.Subscriber.get default library (p. 1494)

8.246.2.16
1495

Returns:
See also:
com.rti.dds.subscription.Subscriber.set default profile (p. 1495)
8.246.2.17

profile name)

XML
profile
for
This method specifies the profile that will be used as the default the next time a
default Subscriber (p. 1476) profile is needed during a call to one of this Subscribers operations. When calling a com.rti.dds.subscription.Subscriber
(p. 1476) method that requires a profile name parameter, you can use NULL
to refer to the default profile. (This same information applies to setting a default
library.)
If the default profile is not set, the com.rti.dds.subscription.Subscriber
(p. 654) (see com.rti.dds.domain.DomainParticipant.set default profile
(p. 708)).
This
method
does
not
set
the
default
QoS
for
com.rti.dds.subscription.DataReader (p. 487) objects created by this
com.rti.dds.subscription.Subscriber (p. 1476); for this functionality,
use
com.rti.dds.subscription.Subscriber.set default datareader qos with profile (p. 1482) (you may pass in NULL after having called
set default profile() (p. 1495)).
This method does not set the default QoS for newly created Subscribers;
for this functionality, use com.rti.dds.domain.DomainParticipant.set default subscriber qos with profile (p. 677).
Parameters:
1496
Class Documentation
Exceptions:
See also:
com.rti.dds.subscription.Subscriber.get default profile (p. 1495)
com.rti.dds.subscription.Subscriber.get default profile library
(p. 1496)
8.246.2.18
is contained for a com.rti.dds.subscription.Subscriber (p. 1476).
The
default
profile
library
is
automatically
called.
set
when
(p. 1495)
is
This library can be different than the com.rti.dds.subscription.Subscriber

(p. 1476) default library (see com.rti.dds.subscription.Subscriber.get default library (p. 1494)).
Returns:
See also:
com.rti.dds.subscription.Subscriber.set default profile (p. 1495)
8.246.2.19
void set listener (SubscriberListener l, int mask)
Sets the subscriber listener.

Parameters:
l <<in>> ( p. 279) com.rti.dds.subscription.SubscriberListener
(p. 1503) to set to.
with the com.rti.dds.subscription.SubscriberListener (p. 1503).
Exceptions:
See also:

8.246.2.20
1497
SubscriberListener get listener ()
Get the subscriber listener.

Returns:
com.rti.dds.subscription.SubscriberListener
(p. 1503)
of
the
See also:
8.246.2.21
Call the subscriber listener.

8.246.2.22
void begin access ()
Indicates that the application is about to access the data samples in any of
the com.rti.dds.subscription.DataReader (p. 487) objects attached to the
If
the
com.rti.dds.infrastructure.PresentationQosPolicy.access scope (p. 1225) of the com.rti.dds.subscription.Subscriber (p. 1476) is
PRESENTATION QOS or com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPolicy
OFFERED PRESENTATION QOS and com.rti.dds.infrastructure.PresentationQosPolicy.ordered access (p. 1225) is com.rti.dds.infrastructure.true, the application is required
to use this operation to access the samples in order across DataWriters of the same group (com.rti.dds.publication.Publisher (p. 1262)
with
(p. 1225) set to com.rti.dds.infrastructure.PresentationQosPolicyAccessScopeKind.PresentationQosPolicyAccessScope
PRESENTATION QOS).
In the above case, the operation begin access() (p. 1497) must
be called prior to calling any of the sample-accessing operations,
com.rti.dds.subscription.Subscriber.get datareaders
(p. 1489)
on
the
(p. 1476),
and
(p. 981),
(p. 983),
(p. 990),
and com.rti.ndds.example.FooDataReader.take w condition (p. 991) on
any com.rti.dds.subscription.DataReader (p. 487).
Once the application has finished accessing the data samples, it must call
com.rti.dds.subscription.Subscriber.end access (p. 1498).
1498
Class Documentation
The application is not required to call begin access() (p. 1497) / end access() (p. 1498) to access the samples in order if the PRESENTATION (p. 90) policy in the com.rti.dds.publication.Publisher
(p. 1262) has com.rti.dds.infrastructure.PresentationQosPolicy.access scope
(p. 1225)
set
to
something
other
than
PRESENTATION QOS. In this case, calling begin access() (p. 1497) /
end access() (p. 1498) is not considered an error and has no effect.
Calls to begin access() (p. 1497) / end access() (p. 1498) may be nested and
must be balanced.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
(p. 1361).
or
See also:
Access to data samples (p. 356)
com.rti.dds.subscription.Subscriber.get datareaders (p. 1489)
8.246.2.23
void end access ()
Indicates that the application has finished accessing the data samples in
com.rti.dds.subscription.DataReader (p. 487) objects managed by the
This operation must be used to close a corresponding begin access() (p. 1497).
This
call
must
close
a
previous
call
to
com.rti.dds.subscription.Subscriber.begin access()
otherwise
the
operation
will
fail
with
the
error
(p. 1497),
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
(p. 1363)
or
(p. 1361).

8.246.2.24
1499
void copy from topic qos (DataReaderQos

datareader qos, TopicQos topic qos)
Copies the policies in the com.rti.dds.topic.TopicQos (p. 1566) to the corresponding policies in the com.rti.dds.subscription.DataReaderQos (p. 536).
Copies the policies in the com.rti.dds.topic.TopicQos (p. 1566) to the corresponding policies in the com.rti.dds.subscription.DataReaderQos (p. 536)
(replacing values in the com.rti.dds.subscription.DataReaderQos (p. 536),
if present).
This is a convenience operation most useful in combination with the operations com.rti.dds.subscription.Subscriber.get default datareader qos
(p. 1480) and com.rti.dds.topic.Topic.get qos (p. 1548). The operation
com.rti.dds.subscription.Subscriber.copy from topic qos (p. 1499) can
be used to merge the com.rti.dds.subscription.DataReader (p. 487) default
QoS policies with the corresponding ones on the com.rti.dds.topic.Topic
The resulting QoS can then be used to create a new
(p. 1545).
com.rti.dds.subscription.DataReader (p. 487), or set its QoS.
This
operation
does
not
check
the
resulting
com.rti.dds.subscription.DataReaderQos (p. 536) for consistency. This is
because the merged com.rti.dds.subscription.DataReaderQos (p. 536)
may not be the final one, as the application can still modify some policies
prior to applying the policies to the com.rti.dds.subscription.DataReader
(p. 487).
Parameters:
datareader qos <<inout>> ( p. 279) com.rti.dds.subscription.DataReaderQos
topic qos <<in>> ( p. 279) com.rti.dds.topic.TopicQos (p. 1566)
to be merged with com.rti.dds.subscription.DataReaderQos
Exceptions:
8.246.2.25

com.rti.dds.subscription.Subscriber (p. 1476) belongs.
Returns:
the com.rti.dds.domain.DomainParticipant (p. 654) to which the
com.rti.dds.subscription.Subscriber (p. 1476) belongs.
1500
8.246.2.26
Class Documentation
Deletes all the entities that were created by means of the create operation on
Deletes all contained com.rti.dds.subscription.DataReader (p. 487)
objects.
This pattern is applied recursively.
In this manner, the
operation
com.rti.dds.subscription.Subscriber.delete contained entities
(p. 1500)
on
the
(p. 1476) will end up deleting all the entities recursively contained
in
the
(p. 1476),
that
is
also the com.rti.dds.subscription.QueryCondition (p. 1311) and
com.rti.dds.subscription.ReadCondition (p. 1313) objects belonging
to the contained com.rti.dds.subscription.DataReader (p. 487).
The operation will fail with com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363) if any of the contained
entities is in a state where it cannot be deleted.
This will occur,
for example, if a contained com.rti.dds.subscription.DataReader
(p. 487) cannot be deleted because the application has called
a
(p. 981)
or
com.rti.ndds.example.FooDataReader.take (p. 983) operation and has not
called the corresponding com.rti.ndds.example.FooDataReader.return loan (p. 1008) operation to return the loaned samples.
Once
com.rti.dds.subscription.Subscriber.delete contained entities (p. 1500) completes successfully, the application may delete the
com.rti.dds.subscription.Subscriber (p. 1476), knowing that it has no
contained com.rti.dds.subscription.DataReader (p. 487) objects.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.246.2.27
DataReader lookup datareader by name exp (String

datareader name)
<<experimental>>
( p. 278)
<<eXtension>>
( p. 278)
Retrieves a com.rti.dds.subscription.DataReader (p. 487) contained
within
the
(p. 1476)
the
com.rti.dds.subscription.DataReader (p. 487) entity name.
Every com.rti.dds.subscription.DataReader (p. 487) in the system has an
EntityName policy, ENTITY NAME (p. 74).
1501
This operation retrieves the com.rti.dds.subscription.DataReader

(p. 487) within the com.rti.dds.subscription.Subscriber (p. 1476)
whose name matches the one specified.
If there are several
com.rti.dds.subscription.DataReader (p. 487) with the same name
within the com.rti.dds.subscription.Subscriber (p. 1476), the operation
returns the first matching occurrence.
Parameters:
datareader name <<in>>
( p. 279)
Entity
name
of
the
Returns:
The first com.rti.dds.subscription.DataReader (p. 487) found with the
See also:
com.rti.dds.domain.DomainParticipant.lookup datareader by name exp (p. 734)
1502
Class Documentation
8.247
SubscriberAdapter Class Reference
A listener adapter in the spirit of the Java AWT listener adapters. (The Adapter
provides empty implementations for the listener methods).
Inheritance diagram for SubscriberAdapter::

void on data on readers (Subscriber subs)
Handles the com.rti.dds.infrastructure.StatusKind.StatusKind.DATA ON READERS STATUS communication status.
8.247.1
A listener adapter in the spirit of the Java AWT listener adapters. (The Adapter
provides empty implementations for the listener methods).
8.247.2
8.247.2.1

Implements SubscriberListener (p. 1504).
8.248 SubscriberListener Interface Reference
8.248
1503
SubscriberListener Interface Reference

status about a subscriber.
Inheritance diagram for SubscriberListener::

8.248.1

status about a subscriber.
Entity:
Status:
com.rti.dds.infrastructure.StatusKind.StatusKind.DATA ON READERS STATUS;
(p. 1135);
(p. 1344);
com.rti.dds.infrastructure.StatusKind.StatusKind.REQUESTED INCOMPATIBLE QOS STATUS, com.rti.dds.subscription.RequestedIncompatibleQosStatus
(p. 1346);
com.rti.dds.infrastructure.StatusKind.StatusKind.SAMPLE LOST STATUS STATUS,
com.rti.dds.subscription.SampleLostStatus
(p. 1410);
(p. 1418);
1504
Class Documentation
com.rti.dds.infrastructure.StatusKind.StatusKind.SUBSCRIPTION MATCHED STATUS, com.rti.dds.subscription.SubscriptionMatchedStatus

(p. 1519)
See also:
8.248.2
8.248.2.1

Implemented in SubscriberAdapter (p. 1502).
8.249 SubscriberQos Class Reference
8.249
1505
SubscriberQos Class Reference
QoS policies supported by a com.rti.dds.subscription.Subscriber (p. 1476)

entity.
Inheritance diagram for SubscriberQos::
Public Attributes
Presentation policy, PRESENTATION ( p. 90).

Partition policy, PARTITION ( p. 89).

Group data policy, GROUP DATA ( p. 77).


<<eXtension>> (p. 278) Exclusive area for the subscriber and all entities
that are created by the subscriber.
8.249.1
QoS policies supported by a com.rti.dds.subscription.Subscriber (p. 1476)

entity.
length
of
com.rti.dds.subscription.SubscriberQos.group data.value
<=
com.rti.dds.domain.DomainParticipantQos.resource limits.subscriber group data max length
length
of
com.rti.dds.subscription.SubscriberQos.partition.name
<=
com.rti.dds.domain.DomainParticipantQos.resource limits.max partitions
combined
number
of
characters
(including
terminating
0)
in
com.rti.dds.subscription.SubscriberQos.partition.name
<=
com.rti.dds.domain.DomainParticipantQos.resource limits.max partition cumulative characters
1506
Class Documentation
If any of the above are not true, com.rti.dds.subscription.Subscriber.set qos (p. 1492) and com.rti.dds.subscription.Subscriber.set qos with profile (p. 1493) will fail with com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY (p. 1359)
8.249.2
8.249.2.1
Presentation policy, PRESENTATION (p. 90).

8.249.2.2
Partition policy, PARTITION (p. 89).

8.249.2.3
Group data policy, GROUP DATA (p. 77).

8.249.2.4

8.249.2.5
<<eXtension>> ( p. 278) Exclusive area for the subscriber and all entities
that are created by the subscriber.
8.250 SubscriberSeq Class Reference
8.250
1507
SubscriberSeq Class Reference
Declares IDL sequence < com.rti.dds.subscription.Subscriber (p. 1476) >

.

SubscriberSeq (Collection subscribers)
int getMaximum ()
sequence.
8.250.1
Declares IDL sequence < com.rti.dds.subscription.Subscriber (p. 1476) >

.
See also:
8.250.2
8.250.2.1
SubscriberSeq (Collection subscribers)
Exceptions:
8.250.3
8.250.3.1
int getMaximum ()
elements.
first created.
1508
Class Documentation

Returns:
See also:
8.251 SubscriptionBuiltinTopicData Class Reference
8.251
1509
SubscriptionBuiltinTopicData Class Reference
Entry created when a com.rti.dds.subscription.DataReader (p. 487) is discovered in association with its Subscriber (p. 1476).
Public Attributes

DCPS key of the participant to which the DataReader ( p. 487) belongs.
String topic name

Name of the related com.rti.dds.topic.Topic ( p. 1545).
String type name


Policy of the corresponding DataReader ( p. 487).






1510
Class Documentation



Policy of the Subscriber ( p. 1476) to which the DataReader ( p. 487) belongs.

final TypeConsistencyEnforcementQosPolicy type consistency



TypeCode type code

<<eXtension>> (p. 278) Type code information of the corresponding Topic
final BuiltinTopicKey t subscriber key

<<eXtension>> (p. 278) DCPS key of the subscriber to which the
DataReader ( p. 487) belongs.

<<eXtension>> (p. 278) Properties of the corresponding DataReader
( p. 487).

<<eXtension>> (p. 278) Custom unicast locators that the endpoint can
final LocatorSeq multicast locators

<<eXtension>> (p. 278) Custom multicast locators that the endpoint can
1511
final ContentFilterProperty t content filter property

<<eXtension>> (p. 278) This field provides all the required information to
enable content filtering on the Writer side.

<<eXtension>> (p. 278) Virtual GUID associated to the DataReader
( p. 487).




<<eXtension>> (p. 278) This is a vendor specific parameter. Determines
whether the corresponding DataReader ( p. 487) sends positive acknowledgements for reliability.

<<eXtension>> (p. 278) The subscription ( p. 353) name and role name.
8.251.1
Entry created when a com.rti.dds.subscription.DataReader (p. 487) is discovered in association with its Subscriber (p. 1476).
Data
associated
with
the
built-in
topic
(p. 359)
builtin.SubscriptionBuiltinTopicDataTypeSupport.SUBSCRIPTION TOPIC NAME (p. 1518). It contains QoS policies and additional information
that apply to the remote com.rti.dds.subscription.DataReader (p. 487)
the related com.rti.dds.subscription.Subscriber (p. 1476).
See also:
builtin.SubscriptionBuiltinTopicDataTypeSupport.SUBSCRIPTION TOPIC NAME (p. 1518)
builtin.SubscriptionBuiltinTopicDataDataReader (p. 1516)
1512
Class Documentation
8.251.2
8.251.2.1

8.251.2.2
DCPS key of the participant to which the DataReader (p. 487) belongs.
8.251.2.3
String topic name
Name of the related com.rti.dds.topic.Topic (p. 1545).

8.251.2.4
String type name

8.251.2.5
Policy of the corresponding DataReader (p. 487).

8.251.2.6

8.251.2.7

8.251.2.8

8.251.2.9


8.251.2.10
1513

8.251.2.11

8.251.2.12

8.251.2.13

8.251.2.14
Policy of the Subscriber (p. 1476) to which the DataReader (p. 487) belongs.
8.251.2.15
8.251.2.16
final TypeConsistencyEnforcementQosPolicy
type consistency

8.251.2.17

8.251.2.18
8.251.2.19
TypeCode type code
<<eXtension>> ( p. 278) Type code information of the corresponding Topic

1514
8.251.2.20
Class Documentation
final BuiltinTopicKey t subscriber key
<<eXtension>> ( p. 278) DCPS key of the subscriber to which the

DataReader (p. 487) belongs.
8.251.2.21
<<eXtension>> ( p. 278) Properties of the corresponding DataReader

(p. 487).
8.251.2.22
<<eXtension>> ( p. 278) Custom unicast locators that the endpoint can specify. The default locators will be used if this is not specified.
8.251.2.23
final LocatorSeq multicast locators
<<eXtension>> ( p. 278) Custom multicast locators that the endpoint can

8.251.2.24
final ContentFilterProperty t content filter property
<<eXtension>> ( p. 278) This field provides all the required information to

enable content filtering on the Writer side.
8.251.2.25
<<eXtension>> ( p. 278) Virtual GUID associated to the DataReader

(p. 487).
See also:
com.rti.dds.infrastructure.GUID t (p. 1044)
8.251.2.26

8.251.2.27


8.251.2.28
1515

8.251.2.29
<<eXtension>> ( p. 278) This is a vendor specific parameter. Determines

whether the corresponding DataReader (p. 487) sends positive acknowledgements for reliability.
8.251.2.30
<<eXtension>> ( p. 278) The subscription (p. 353) name and role name.
This member contains the name and the role name of the discovered subscription (p. 353).
1516
8.252
Class Documentation
SubscriptionBuiltinTopicDataDataReader
Class Reference

(p. 1509) > .
8.252.1

(p. 1509) > .
(p. 487)
of
topic
(p. 359)
builtin.SubscriptionBuiltinTopicDataTypeSupport.SUBSCRIPTION TOPIC NAME
(p. 1518)
used
for
accessing
(p. 1509)
of
the
remote
com.rti.dds.subscription.DataReader (p. 487) and the associated
Instantiates:
<<generic>>
(p. 979)
( p. 279)
See also:
builtin.SubscriptionBuiltinTopicData (p. 1509)
builtin.SubscriptionBuiltinTopicDataTypeSupport.SUBSCRIPTION TOPIC NAME (p. 1518)
8.253 SubscriptionBuiltinTopicDataSeq Class Reference
8.253
SubscriptionBuiltinTopicDataSeq
Reference
1517
Class

builtin.SubscriptionBuiltinTopicData (p. 1509) > .
8.253.1

builtin.SubscriptionBuiltinTopicData (p. 1509) > .
Instantiates:
See also:
1518
Class Documentation
8.254
SubscriptionBuiltinTopicDataTypeSupport
Class Reference
Instantiates
(p. 1509) > .
TypeSupport
<
Inheritance diagram for SubscriptionBuiltinTopicDataTypeSupport::

static final String SUBSCRIPTION TOPIC NAME = DDS SUBSCRIPTION TOPIC NAME()
Subscription topic ( p. 359) name.
8.254.1
Instantiates
(p. 1509) > .
TypeSupport
<
Instantiates:
<<generic>>
(p. 1036)
( p. 279)
See also:
8.254.2
8.254.2.1
final String SUBSCRIPTION TOPIC NAME =

DDS SUBSCRIPTION TOPIC NAME() [static]
Subscription topic (p. 359) name.

Topic name
(p. 1516)
of
builtin.SubscriptionBuiltinTopicDataDataReader
See also:
builtin.SubscriptionBuiltinTopicDataDataReader (p. 1516)
8.255 SubscriptionMatchedStatus Class Reference
8.255
1519
SubscriptionMatchedStatus Class Reference

Inherits Status.
Public Attributes
int total count
The
total
cumulative
number
of
times
the
concerned
com.rti.dds.subscription.DataReader ( p. 487) discovered a match
with a com.rti.dds.publication.DataWriter ( p. 557).

status was read.
int current count

The
current
number
of
writers
with
which
com.rti.dds.subscription.DataReader ( p. 487) is matched.
the

<<eXtension>> (p. 278) The highest value that current count has reached
until now.

status was read.

A handle to the last com.rti.dds.publication.DataWriter ( p. 557) that
caused the status to change.
8.255.1

A match happens when the com.rti.dds.subscription.DataReader
(p. 487) finds a com.rti.dds.publication.DataWriter (p. 557) for the same
1520
Class Documentation
com.rti.dds.topic.Topic (p. 1545) with an offered QoS that is compatible with

that requested by the com.rti.dds.subscription.DataReader (p. 487).
This status is also changed (and the listener, if any, called) when a match is
ended. A local com.rti.dds.subscription.DataReader (p. 487) will become
unmatched from a remote com.rti.dds.publication.DataWriter (p. 557)
when that com.rti.dds.publication.DataWriter (p. 557) goes away for any
reason.
8.255.2
8.255.2.1
int total count
The
total
cumulative
number
of
times
the
com.rti.dds.subscription.DataReader (p. 487) discovered
with a com.rti.dds.publication.DataWriter (p. 557).
concerned
match
This number increases whenever a new match is discovered. It does not change
when an existing match goes away.
8.255.2.2
The change in total count since the last time the listener was called or the status
was read.
8.255.2.3
int current count
The
current
number
of
writers
with
which
com.rti.dds.subscription.DataReader (p. 487) is matched.
the
This number increases when a new match is discovered and decreases when an
existing match goes away.
8.255.2.4
<<eXtension>> ( p. 278) The highest value that current count has reached
until now.
8.255.2.5
status was read.
8.255 SubscriptionMatchedStatus Class Reference

8.255.2.6
1521
A handle to the last com.rti.dds.publication.DataWriter (p. 557) that

caused the status to change.
1522
8.256
Class Documentation
SystemException Class Reference
System exception.
Inheritance diagram for SystemException::
8.256.1
System exception.
This class is based on a similar class in CORBA.
See also:
http://java.sun.com/javase/6/docs/api/org/omg/CORBA/SystemException.html
8.257 SystemResourceLimitsQosPolicy Class Reference
8.257
SystemResourceLimitsQosPolicy
Reference
1523
Class
Configures com.rti.dds.domain.DomainParticipant (p. 654)-independent

resources used by RTI Connext. Mainly used to change the maximum number of com.rti.dds.domain.DomainParticipant (p. 654) entities that can
be created within a single process (address space).
Inheritance diagram for SystemResourceLimitsQosPolicy::
Public Attributes
int max objects per thread
The maximum number of objects that can be stored per thread for a
8.257.1
Configures com.rti.dds.domain.DomainParticipant (p. 654)-independent

resources used by RTI Connext. Mainly used to change the maximum number of com.rti.dds.domain.DomainParticipant (p. 654) entities that can
be created within a single process (address space).
Entity:
Properties:
RxO (p. 101) = N/A
8.257.2
Usage
Within a single process (or address space for some supported realtime operating systems), applications may create and use multiple
com.rti.dds.domain.DomainParticipant (p. 654) entities. This QoS policy
sets a parameter that places an effective upper bound on the maximum number of com.rti.dds.domain.DomainParticipant (p. 654) entities that can be
created in a single process/address space.
1524
Class Documentation
8.257.3
8.257.3.1
int max objects per thread
The maximum number of objects that can be stored per thread for a
Before increasing this value to allow you to create more participants, carefully
consider the application design that requires you to create so many participants. Remember: a com.rti.dds.domain.DomainParticipant (p. 654) is
a heavy-weight object. It spawns several threads and maintains its own discovery database (see DISCOVERY (p. 56)). Creating more participants than
RTI Connext strictly requires one per domain (p. 328) per process/address
space can adversely affect the performance and resource utilization of your
application.
[default] 1024; this value allows you to create about 10 or 11
com.rti.dds.domain.DomainParticipant (p. 654) entities.
[range] [1, 1 billion]
8.258 TCKind Class Reference
8.258
1525
TCKind Class Reference
Enumeration type for com.rti.dds.typecode.TypeCode (p. 1611) kinds.

Inheritance diagram for TCKind::

static final TCKind TK NULL
Indicates that a type code does not describe anything.
static final TCKind TK SHORT

short type.
static final TCKind TK LONG

long type.
static final TCKind TK USHORT

unsigned short type.
static final TCKind TK ULONG

unsigned long type.
static final TCKind TK FLOAT

float type.
static final TCKind TK DOUBLE

double type.
static final TCKind TK BOOLEAN

boolean type.
static final TCKind TK CHAR

char type.
static final TCKind TK OCTET

octet type.
static final TCKind TK STRUCT

struct type.
1526
Class Documentation
static final TCKind TK UNION
union type.
static final TCKind TK ENUM

enumerated type.
static final TCKind TK STRING

string type.
static final TCKind TK SEQUENCE

sequence type.
static final TCKind TK ARRAY

array type.
static final TCKind TK ALIAS

alias (typedef ) type.
static final TCKind TK LONGLONG

long long type.
static final TCKind TK ULONGLONG

unsigned long long type.
static final TCKind TK LONGDOUBLE

long double type.
static final TCKind TK WCHAR

wide char type.
static final TCKind TK WSTRING

wide string type.
static final TCKind TK VALUE

value type.
static final TCKind TK SPARSE

A sparse value type.
8.258.1
1527
Enumeration type for com.rti.dds.typecode.TypeCode (p. 1611) kinds.

Type code kinds are modeled as values of this type.
8.258.2
8.258.2.1
final TCKind TK NULL [static]
Indicates that a type code does not describe anything.
8.258.2.2
final TCKind TK SHORT [static]
short type.
8.258.2.3
final TCKind TK LONG [static]
long type.
8.258.2.4
final TCKind TK USHORT [static]
unsigned short type.
8.258.2.5
final TCKind TK ULONG [static]
unsigned long type.
8.258.2.6
final TCKind TK FLOAT [static]
float type.
8.258.2.7
final TCKind TK DOUBLE [static]
double type.
8.258.2.8
final TCKind TK BOOLEAN [static]
boolean type.
1528
8.258.2.9
Class Documentation
final TCKind TK CHAR [static]
char type.
8.258.2.10
final TCKind TK OCTET [static]
octet type.
8.258.2.11
final TCKind TK STRUCT [static]
struct type.
8.258.2.12
final TCKind TK UNION [static]
union type.
8.258.2.13
final TCKind TK ENUM [static]
enumerated type.
8.258.2.14
final TCKind TK STRING [static]
string type.
8.258.2.15
final TCKind TK SEQUENCE [static]
sequence type.
8.258.2.16
final TCKind TK ARRAY [static]
array type.
8.258.2.17
final TCKind TK ALIAS [static]
alias (typedef) type.

8.258.2.18
final TCKind TK LONGLONG [static]
long long type.


8.258.2.19
1529
final TCKind TK ULONGLONG [static]
unsigned long long type.

8.258.2.20
final TCKind TK LONGDOUBLE [static]
long double type.

8.258.2.21
final TCKind TK WCHAR [static]
wide char type.

8.258.2.22
final TCKind TK WSTRING [static]
wide string type.

8.258.2.23
final TCKind TK VALUE [static]
value type.
8.258.2.24
final TCKind TK SPARSE [static]
A sparse value type.

A sparse value type is one in which all of the fields are not necessarily sent on
the network as a part of every sample.
Fields of a sparse value type fall into one of three categories:
Key fields (see com.rti.dds.typecode.TypeCode.KEY MEMBER
(p. 1645))
Non-key, but required members (see com.rti.dds.typecode.TypeCode.NONKEY REQUIRED MEMBER (p. 1646))
Non-key, optional members (see com.rti.dds.typecode.TypeCode.NONKEY MEMBER (p. 1644))
Fields of the first two kinds must appear in every sample. These are also
the only kinds of fields on which you can perform content filtering (see
com.rti.dds.topic.ContentFilteredTopic (p. 471)), because filter evaluation
on a non-existent field is not well defined.
1530
Class Documentation
8.259
ThreadSettings t Class Reference

Inherits Struct.
Public Attributes
int mask
Describes the type of thread.
int priority
Thread priority.
int stack size

The thread stack-size.
final IntSeq cpu list = new IntSeq()

The list of processors on which the thread(s) may run.
ThreadSettingsCpuRotationKind cpu rotation

Determines how processor affinity is applied to multiple threads.
8.259.1

QoS:
com.rti.dds.infrastructure.EventQosPolicy
(p. 949)
com.rti.dds.infrastructure.DatabaseQosPolicy
(p. 482)
com.rti.dds.infrastructure.ReceiverPoolQosPolicy
(p. 1318)
(p. 397)
8.259.2
8.259.2.1
int mask
Describes the type of thread.

[default] 0, use default options of the OS
8.259 ThreadSettings t Class Reference

8.259.2.2
1531
int priority
Thread priority.
Important: The interpretation of numeric thread priority values is different
based on whether the priority is specified in your application code or in an XML
QoS profile document. This is because QoS profile documents are intended to
be usable across programming languages.
[range] java.lang.Thread.MIN PRIORITY to MAX PRIORITY if set programmatically in Java code [range] Platform-dependent if set in a QoS profile document
8.259.2.3
int stack size
The thread stack-size.

[range] Platform-dependent.
8.259.2.4
final IntSeq cpu list = new IntSeq()
The list of processors on which the thread(s) may run.

A sequence of integers that represent the set of processors on which the thread(s)
controlled by this QoS may run. An empty sequence (the default) means the
middleware wlll make no CPU affinity adjustments.
Note: This feature is currently only supported on a subset of architectures (see
the Platform Notes). The API may change as more architectures are added
in future releases.
This value is only relevant to the com.rti.dds.infrastructure.ReceiverPoolQosPolicy
(p. 1318).
It is ignored within other QoS policies that include
com.rti.dds.infrastructure.ThreadSettings t (p. 1530).
See also:
[default] Empty sequence
8.259.2.5
ThreadSettingsCpuRotationKind cpu rotation
Initial value:
ThreadSettingsCpuRotationKind.THREAD_SETTINGS_CPU_NO_ROTATION
1532
Class Documentation
Determines how processor affinity is applied to multiple threads.

This value is only relevant to the com.rti.dds.infrastructure.ReceiverPoolQosPolicy
It is ignored within other QoS policies that include
(p. 1318).
com.rti.dds.infrastructure.ThreadSettings t (p. 1530).
See also:
Note: This feature is currently only supported on a subset of architectures (see
the Platform Notes). The API may change as more architectures are added
in future releases.
8.260 ThreadSettingsCpuRotationKind Class Reference
8.260
1533
Reference
Class

(p. 1531) affects processor affinity for thread-related QoS policies that apply
to multiple threads.
Inheritance diagram for ThreadSettingsCpuRotationKind::

static
final
SETTINGS CPU NO ROTATION
THREAD -
Any thread controlled by this QoS can run on any listed processor, as determined by OS scheduling.
static
final
SETTINGS CPU RR ROTATION
THREAD -
Threads controlled by this QoS will be assigned one processor from the list in
round-robin order.
8.260.1

(p. 1531) affects processor affinity for thread-related QoS policies that apply
to multiple threads.
8.260.2
Controlling CPU Core Affinity for RTI Threads
Most thread-related QoS settings apply to a single thread (such

as
for
the
com.rti.dds.infrastructure.EventQosPolicy
(p. 949),
com.rti.dds.infrastructure.DatabaseQosPolicy
(p. 482),
and
(p. 397)).
However,
the
thread
settings
in
the
com.rti.dds.infrastructure.ReceiverPoolQosPolicy (p. 1318) control
every receive thread created. In this case, there are several schemes to map M
threads to N processors; the rotation kind controls which scheme is used.
If
list
(p. 1531)
is
com.rti.dds.infrastructure.ThreadSettings t.cpu empty,

the
rotation
is
irrelevant
since
1534
Class Documentation
no affinity adjustment will occur.

Suppose instead that
com.rti.dds.infrastructure.ThreadSettings t.cpu list (p. 1531) = {0,
1} and that the middleware creates three receive threads: {A, B, C}. If
com.rti.dds.infrastructure.ThreadSettings t.cpu rotation (p. 1531) is
com.rti.dds.infrastructure.ThreadSettingsCpuRotationKind.THREAD SETTINGS CPU NO ROTATION (p. 1534), threads A, B and C will have
the same processor affinities (0-1), and the OS will control thread scheduling
within this bound. It is common to denote CPU affinities as a bitmask, where
set bits represent allowed processors to run on. This mask is printed in hex, so
a CPU core affinity of 0-1 can be represented by the mask 0x3.
If com.rti.dds.infrastructure.ThreadSettings t.cpu rotation (p. 1531) is
com.rti.dds.infrastructure.ThreadSettingsCpuRotationKind.THREAD SETTINGS CPU RR ROTATION
(p. 1534),
each
thread
will
be assigned in round-robin fashion to one of the processors in
com.rti.dds.infrastructure.ThreadSettings t.cpu list (p. 1531);
perhaps thread A to 0, B to 1, and C to 0. Note that the order in which internal
middleware threads spawn is unspecified.
Not all of these options may be relevant for all operating systems.
8.260.3
8.260.3.1
final ThreadSettingsCpuRotationKind
THREAD SETTINGS CPU NO ROTATION [static]
Any thread controlled by this QoS can run on any listed processor, as determined
by OS scheduling.
8.260.3.2
final ThreadSettingsCpuRotationKind
THREAD SETTINGS CPU RR ROTATION [static]
Threads controlled by this QoS will be assigned one processor from the list in
round-robin order.
8.261 ThreadSettingsKind Class Reference
8.261
1535
ThreadSettingsKind Class Reference

static final int THREAD SETTINGS KIND MASK DEFAULT
static final int THREAD SETTINGS FLOATING POINT

Code executed within the thread may perform floating point operations.
static final int THREAD SETTINGS STDIO

Code executed within the thread may access standard I/O.
static final int THREAD SETTINGS REALTIME PRIORITY

The thread will be schedule on a real-time basis.
static final int THREAD SETTINGS PRIORITY ENFORCE

Strictly enforce this threads priority.
8.261.1

Not all of these options may be relevant for all operating systems.
See also:
com.rti.dds.infrastructure.ThreadSettingsKindMask
8.261.2
8.261.2.1
final int THREAD SETTINGS FLOATING POINT

[static]
Code executed within the thread may perform floating point operations.
8.261.2.2
final int THREAD SETTINGS STDIO [static]
Code executed within the thread may access standard I/O.

1536
8.261.2.3
Class Documentation
final int THREAD SETTINGS REALTIME PRIORITY
[static]
The thread will be schedule on a real-time basis.

8.261.2.4
final int THREAD SETTINGS PRIORITY ENFORCE

[static]
Strictly enforce this threads priority.
8.262 Time t Class Reference
8.262
1537
Time t Class Reference

Inheritance diagram for Time t::

Time t (Time t time)
Copy constructor.
Time t (int sec, int nanosec)

Constructor.
boolean is invalid ()
boolean is zero ()
Check if time is zero.

Public Attributes
int sec
seconds
int nanosec
nanoseconds

static final int TIME INVALID SEC
A sentinel indicating an invalid second of time.
static final int TIME INVALID NSEC

A sentinel indicating an invalid nano-second of time.
static final Time t TIME INVALID

A sentinel indicating an invalid time.
1538
8.262.1
Class Documentation

A com.rti.dds.infrastructure.Time t (p. 1537) represents a moment in time.
8.262.2
8.262.2.1
Time t (Time t time)
Copy constructor.
Parameters:
time The instance to copy. It must not be null.
8.262.2.2
Time t (int sec, int nanosec)
Constructor.
Parameters:
sec must be >=0
nanosec must be >=0
Exceptions:
RETCODE BAD PARAMETER ( p. 1355) if either time value is
negative
8.262.3
8.262.3.1
boolean is invalid ()
Returns:
com.rti.dds.infrastructure.true if the given time is not valid (i.e. is negative)
8.262.3.2
boolean is zero ()
Check if time is zero.

8.262 Time t Class Reference
1539
Returns:
com.rti.dds.infrastructure.true if the given time is equal to
com.rti.dds.infrastructure.Time t.ZERO or com.rti.dds.infrastructure.false
otherwise.
8.262.3.3

references).
Parameters:
Returns:
Exceptions:
8.262.4
8.262.4.1
final int TIME INVALID SEC [static]
A sentinel indicating an invalid second of time.

8.262.4.2
final int TIME INVALID NSEC [static]
A sentinel indicating an invalid nano-second of time.

8.262.4.3
final Time t TIME INVALID [static]
A sentinel indicating an invalid time.

1540
8.262.4.4
Class Documentation
int sec
seconds
8.262.4.5
int nanosec
nanoseconds
8.263 TimeBasedFilterQosPolicy Class Reference
8.263
1541
TimeBasedFilterQosPolicy Class Reference
Inheritance diagram for TimeBasedFilterQosPolicy::
Public Attributes
final Duration t minimum separation
The minimum separation duration between subequent samples.
8.263.1
The filter states that the com.rti.dds.subscription.DataReader (p. 487)
does not want to receive more than one value each minimum separation, regardless of how fast the changes occur.
Entity:
Properties:
RxO (p. 101) = N/A
8.263.2
Usage
You can use this QoS policy to reduce the amount of data received
by
a
(p. 487).
com.rti.dds.publication.DataWriter (p. 557) entities may send data
faster than needed by a com.rti.dds.subscription.DataReader (p. 487).
For example, a com.rti.dds.subscription.DataReader (p. 487) of sensor
data that is displayed to a human operator in a GUI application does not need
to receive data updates faster than a user can reasonably perceive changes in
data values. This is often measured in tenths (0.1) of a second up to several
1542
Class Documentation
seconds. However, a com.rti.dds.publication.DataWriter (p. 557) of sensor

information may have other com.rti.dds.subscription.DataReader (p. 487)
entities that are processing the sensor information to control parts of the
system and thus need new data updates in measures of hundredths (0.01) or
thousandths (0.001) of a second.
With this QoS policy, different com.rti.dds.subscription.DataReader
(p. 487) entities can set their own time-based filters, so that data published
faster than the period set by a each com.rti.dds.subscription.DataReader
(p. 487) will not be delivered to that com.rti.dds.subscription.DataReader
(p. 487).
(p. 117)
also
applies
to
each
The
TIME BASED FILTER
instance
separately;
that
is,
the
constraint
is
that
the
com.rti.dds.subscription.DataReader (p. 487) does not want to see
more than one sample of each instance per minimum separation period.
This QoS policy allows you to optimize resource usage (CPU and possibly network bandwidth) by only delivering the required amount of data to
each com.rti.dds.subscription.DataReader (p. 487), accommodating the
fact that, for rapidly-changing data, different subscribers may have different
requirements and constraints as to how frequently they need or can handle being notified of the most current values. As such, it can also be used to protect
applications that are running on a heterogeneous network where some nodes are
capable of generating data much faster than others can consume it.
For best effort data delivery, if the data type is unkeyed and
the
(p. 557)
has
an
infinite
com.rti.dds.infrastructure.LivelinessQosPolicy.lease duration (p. 1143), RTI Connext will only send as many packets to a com.rti.dds.subscription.DataReader (p. 487) as required
by
the
TIME BASED FILTER,
no
matter
how
fast
com.rti.ndds.example.FooDataWriter.write (p. 1021) is called.
For multicast data delivery to multiple DataReaders, the one with the lowest minimum separation determines the DataWriters send rate. For example,
if a com.rti.dds.publication.DataWriter (p. 557) sends over multicast to
two DataReaders, one with minimum separation of 2 seconds and one with
minimum separation of 1 second, the DataWriter will send every 1 second.
In configurations where RTI Connext must send all the data published by
the com.rti.dds.publication.DataWriter (p. 557) (for example, when the
com.rti.dds.publication.DataWriter (p. 557) is reliable, when the data type
is keyed, or when the com.rti.dds.publication.DataWriter (p. 557) has
a finite com.rti.dds.infrastructure.LivelinessQosPolicy.lease duration
(p. 1143)), only the data that passes the TIME BASED FILTER will be stored
in the receive queue of the com.rti.dds.subscription.DataReader (p. 487).
Extra data will be accepted but dropped. Note that filtering is only applied on
alive samples (that is, samples that have not been disposed/unregistered).
8.263 TimeBasedFilterQosPolicy Class Reference
8.263.3
1543
Consistency
It is inconsistent for a com.rti.dds.subscription.DataReader (p. 487) to

have a minimum separation longer than its DEADLINE (p. 52) period.
However, it is important to be aware of certain edge cases that can occur when
your publication (p. 349) rate, minimum separation, and deadline period align
and that can cause missed deadlines that you may not expect. For example,
suppose that you nominally publish samples every second but that this rate can
vary somewhat over time. You declare a minimum separation of 1 second to
filter out rapid updates and set a deadline of two seconds so that you will be
aware if the rate falls too low. Even if your update rate never wavers, you can
still miss deadlines! Heres why:
Suppose you publish the first sample at time t=0 seconds. You then publish
your next sample at t=1 seconds. Depending on how your operating system
schedules the time-based filter execution relative to the publication (p. 349),
this second sample may be filtered. You then publish your third sample at t=2
seconds, and depending on how your OS schedules this publication (p. 349) in
relation to the deadline check, you could miss the deadline.
This scenario demonstrates a couple of rules of thumb:
Beware of setting your minimum separation to a value very close to your
publication (p. 349) rate: you may filter more data than you intend to.
Beware of setting your minimum separation to a value that is too close
to your deadline period relative to your publication (p. 349) rate. You
may miss deadlines.
See com.rti.dds.infrastructure.DeadlineQosPolicy (p. 628) for more information about the interactions between deadlines and time-based filters.
The setting of a TIME BASED FILTER (p. 117) that is, the selection
of a minimum separation with a value greater than zero is consistent with
all settings of the HISTORY (p. 79) and RELIABILITY (p. 105) QoS. The
TIME BASED FILTER (p. 117) specifies the samples that are of interest
to the com.rti.dds.subscription.DataReader (p. 487). The HISTORY
(p. 79) and RELIABILITY (p. 105) QoS affect the behavior of the middleware with respect to the samples that have been determined to be of interest to
the com.rti.dds.subscription.DataReader (p. 487); that is, they apply after
the TIME BASED FILTER (p. 117) has been applied.
In
the
case
where
the
reliability
QoS
kind
is
com.rti.dds.infrastructure.ReliabilityQosPolicyKind.ReliabilityQosPolicyKind.RELIABLE RELIABILITY QOS, in steady-state defined as the situation where
the com.rti.dds.publication.DataWriter (p. 557) does not write new
samples for a period long compared to the minimum separation
1544
Class Documentation
the system should guarantee delivery of the last sample to the

See also:
DeadlineQosPolicy (p. 628)
HistoryQosPolicy (p. 1046)
ReliabilityQosPolicy (p. 1324)
8.263.4
8.263.4.1
final Duration t minimum separation
The minimum separation duration between subequent samples.

[default] 0 (meaning the com.rti.dds.subscription.DataReader (p. 487) is
potentially interested in all values)
[range] [0,1 year], < com.rti.dds.infrastructure.DeadlineQosPolicy.period
(p. 630)
8.264 Topic Interface Reference
8.264
1545
Topic Interface Reference
<<interface>> ( p. 279) The most basic description of the data to be published and subscribed.
Inheritance diagram for Topic::

void get inconsistent topic status (InconsistentTopicStatus status)
Allows
the
application
to
retrieve
com.rti.dds.infrastructure.StatusKind.StatusKind.INCONSISTENT TOPIC STATUS status of a com.rti.dds.topic.Topic ( p. 1545).
the
void set qos (TopicQos qos)

Set the topic ( p. 359) QoS.
<<eXtension>> (p. 278) Change the QoS of this topic ( p. 359) using the
void get qos (TopicQos qos)

Get the topic ( p. 359) QoS.
void set listener (TopicListener l, int mask)

Set the topic ( p. 359) listener.
TopicListener get listener ()

Get the topic ( p. 359) listener.
8.264.1
<<interface>> ( p. 279) The most basic description of the data to be published and subscribed.
QoS:
com.rti.dds.topic.TopicQos (p. 1566)
1546
Class Documentation
Status:
com.rti.dds.infrastructure.StatusKind.StatusKind.INCONSISTENT com.rti.dds.topic.InconsistentTopicStatus
TOPIC STATUS,
(p. 1052)
Listener:
A com.rti.dds.topic.Topic (p. 1545) is identified by its name, which must
be unique in the whole domain (p. 328). In addition (by virtue of extending com.rti.dds.topic.TopicDescription (p. 1561)) it fully specifies the type
of the data that can be communicated when publishing or subscribing to the
(p. 1545)
is
the
only
com.rti.dds.topic.TopicDescription (p. 1561) that can be used for publications and therefore associated with a com.rti.dds.publication.DataWriter
(p. 557).
The following operations may be called even if the com.rti.dds.topic.Topic
(p. 1545) is not enabled.
Other operations will fail with the value
com.rti.dds.infrastructure.RETCODE NOT ENABLED (p. 1361) if
called on a disabled com.rti.dds.topic.Topic (p. 1545):
All the base-class operations set qos() (p. 1547), set qos with profile()
(p. 1548), get qos() (p. 1548), set listener() (p. 1549), get listener()
(p. 1549) enable() (p. 935), get statuscondition() (p. 936) and get status changes() (p. 936)
get inconsistent topic status() (p. 1546)
See also:
8.264.2
8.264.2.1
void get inconsistent topic status

(InconsistentTopicStatus status)
Allows the application to retrieve the com.rti.dds.infrastructure.StatusKind.StatusKind.INCONSISTENT

TOPIC STATUS status of a com.rti.dds.topic.Topic (p. 1545).
Retrieve the current com.rti.dds.topic.InconsistentTopicStatus (p. 1052)
Parameters:
status <<inout>> ( p. 279) Status to be retrieved. Cannot be NULL.
1547
Exceptions:
See also:
com.rti.dds.topic.InconsistentTopicStatus (p. 1052)
8.264.2.2
void set qos (TopicQos qos)
Set the topic (p. 359) QoS.

The
com.rti.dds.topic.TopicQos.topic data
(p. 1567)
and
com.rti.dds.topic.TopicQos.deadline
(p. 1568),
com.rti.dds.topic.TopicQos.latency budget
(p. 1568),
com.rti.dds.topic.TopicQos.transport priority
(p. 1568)
and
com.rti.dds.topic.TopicQos.lifespan (p. 1568) can be changed.
The
other policies are immutable.
Parameters:
qos <<in>> ( p. 279) Set of policies
to
be
applied
to

Immutable policies cannot be changed
after com.rti.dds.topic.Topic (p. 1545) is enabled.
The special
value
com.rti.dds.domain.DomainParticipant.TOPIC QOS DEFAULT (p. 152) can be used to indicate that the QoS of the
com.rti.dds.topic.Topic (p. 1545) should be changed to match the
current default com.rti.dds.topic.TopicQos (p. 1566) set in the
com.rti.dds.domain.DomainParticipant (p. 654). Cannot be NULL.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
See also:
QoS
1548
8.264.2.3
Class Documentation
profile name)
<<eXtension>> ( p. 278) Change the QoS of this topic (p. 359) using the
(p. 1567)
The
com.rti.dds.topic.TopicQos.topic data
and
com.rti.dds.topic.TopicQos.deadline
(p. 1568),
com.rti.dds.topic.TopicQos.latency budget
(p. 1568),
(p. 1568)
and
com.rti.dds.topic.TopicQos.transport priority
com.rti.dds.topic.TopicQos.lifespan (p. 1568) can be changed.
The
other policies are immutable.
Parameters:
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
See also:
QoS
8.264.2.4
void get qos (TopicQos qos)
Get the topic (p. 359) QoS.

Parameters:
1549
Exceptions:
See also:
8.264.2.5
void set listener (TopicListener l, int mask)
Set the topic (p. 359) listener.

Parameters:
l <<in>> ( p. 279) Listener to be installed on entity.
mask <<in>> ( p. 279) Changes of communication status to be invoked
Exceptions:
See also:
8.264.2.6
TopicListener get listener ()
Get the topic (p. 359) listener.

Returns:
Existing listener attached to the com.rti.dds.topic.Topic (p. 1545).
See also:
1550
Class Documentation
8.265
TopicAdapter Class Reference

methods)
Inheritance diagram for TopicAdapter::

status)
8.265.1

methods)
8.265.2
8.265.2.1


Parameters:
topic ( p. 359) <<out>>
callback
( p. 279)
(p. 1545) that
Locally
triggers
the
created
listener
8.265 TopicAdapter Class Reference
1551

Implements TopicListener (p. 1565).
1552
Class Documentation
8.266
TopicBuiltinTopicData Class Reference
Entry created when a Topic (p. 1545) object discovered.

Public Attributes
String name
Name of the com.rti.dds.topic.Topic ( p. 1545).
String type name


durability policy of the corresponding Topic ( p. 1545)

durability service policy of the corresponding Topic ( p. 1545)

Policy of the corresponding Topic ( p. 1545).






8.266 TopicBuiltinTopicData Class Reference
1553




8.266.1
Entry created when a Topic (p. 1545) object discovered.

Data
associated
with
the
built-in
topic
(p. 359)
(p. 1558). It contains QoS policies and additional information that apply to the
remote com.rti.dds.topic.Topic (p. 1545).
Note: The DDS TopicBuiltinTopicData built-in topic (p. 359) is meant to convey information about discovered Topics. This Topics samples are not propagated in a separate packet on the wire. Instead, the data is sent as part of the information carried by other built-in topics (builtin.PublicationBuiltinTopicData
and builtin.SubscriptionBuiltinTopicData). Therefore TopicBuiltinTopicData (p. 1552) DataReaders will not receive any data.
See also:
builtin.TopicBuiltinTopicDataTypeSupport.TOPIC TOPIC NAME (p. 1558)
builtin.TopicBuiltinTopicDataDataReader (p. 1556)
8.266.2
8.266.2.1

1554
8.266.2.2
Class Documentation
String name
Name of the com.rti.dds.topic.Topic (p. 1545).

8.266.2.3
String type name

8.266.2.4
durability policy of the corresponding Topic (p. 1545)
8.266.2.5
durability service policy of the corresponding Topic (p. 1545)
8.266.2.6
Policy of the corresponding Topic (p. 1545).
8.266.2.7
8.266.2.8
8.266.2.9
8.266.2.10

8.266 TopicBuiltinTopicData Class Reference

8.266.2.11
1555

8.266.2.12

8.266.2.13

8.266.2.14

8.266.2.15

8.266.2.16
1556
8.267
Class Documentation
TopicBuiltinTopicDataDataReader Class
Reference
Instantiates DataReader < builtin.TopicBuiltinTopicData (p. 1552) > .

8.267.1
Instantiates DataReader < builtin.TopicBuiltinTopicData (p. 1552) > .

(p. 487)
of
topic
(p. 359)
(p. 1558) used for accessing builtin.TopicBuiltinTopicData (p. 1552) of the
remote com.rti.dds.topic.Topic (p. 1545).
Note:
The builtin.TopicBuiltinTopicData (p. 1552) built-in topic
(p. 359) is meant to convey information about discovered Topics. This
Topics samples are not propagated in a separate packet on the
wire.
Instead, the data is sent as part of the information carried by other built-in topics (builtin.PublicationBuiltinTopicData and
builtin.SubscriptionBuiltinTopicData). Therefore TopicBuiltinTopicData
(p. 1552) DataReaders will not receive any data.
Instantiates:
<<generic>>
(p. 979)
( p. 279)
See also:
builtin.TopicBuiltinTopicDataTypeSupport.TOPIC TOPIC NAME (p. 1558)
8.268 TopicBuiltinTopicDataSeq Class Reference
8.268
1557
TopicBuiltinTopicDataSeq Class Reference

builtin.TopicBuiltinTopicData (p. 1552) > .
8.268.1

builtin.TopicBuiltinTopicData (p. 1552) > .
Instantiates:
See also:
1558
Class Documentation
8.269
TopicBuiltinTopicDataTypeSupport
Class Reference
Instantiates TypeSupport (p. 1665)

(p. 1552) > .
<
Inheritance diagram for TopicBuiltinTopicDataTypeSupport::

static final String TOPIC TOPIC NAME = DDS TOPIC TOPIC NAME()
Topic ( p. 1545) topic ( p. 359) name.
8.269.1
Instantiates TypeSupport (p. 1665)

(p. 1552) > .
<
Instantiates:
<<generic>>
(p. 1036)
( p. 279)
See also:
8.269.2
8.269.2.1
final String TOPIC TOPIC NAME =

DDS TOPIC TOPIC NAME() [static]
Topic (p. 1545) topic (p. 359) name.

Topic (p. 1545) name of builtin.TopicBuiltinTopicDataDataReader
(p. 1556)
See also:
builtin.TopicBuiltinTopicDataDataReader (p. 1556)
8.270 TopicDataQosPolicy Class Reference
8.270
1559
TopicDataQosPolicy Class Reference

Inheritance diagram for TopicDataQosPolicy::
Public Attributes
final ByteSeq value
8.270.1

Entity:
Properties:
RxO (p. 101) = NO
See also:
(p. 711)
8.270.2
Usage
The purpose of this QoS is to allow the application to attach additional information to the created com.rti.dds.topic.Topic (p. 1545) objects, so that when a
remote application discovers their existence, it can access that information and
use it for its own purposes. This extra data is not used by RTI Connext.
One possible use of this QoS is to attach security credentials or some other
information that can be used by the remote application to authenticate the
source.
1560
Class Documentation
In combination with com.rti.dds.subscription.DataReaderListener

(p. 518), com.rti.dds.publication.DataWriterListener (p. 586), or operations such as com.rti.dds.domain.DomainParticipant.ignore topic
(p. 715), this QoS policy can assist an application in defining and enforcing its
own security policies.
com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.topic data max length (p. 791).
8.270.3
8.270.3.1
final ByteSeq value
8.271 TopicDescription Interface Reference
8.271
1561
TopicDescription Interface Reference

Inheritance diagram for TopicDescription::

String get type name ()
Get the associated type name.
String get name ()

Get the name used to create this com.rti.dds.topic.TopicDescription
( p. 1561) .

Get the com.rti.dds.domain.DomainParticipant ( p. 654) to which the
com.rti.dds.topic.TopicDescription ( p. 1561) belongs.
8.271.1

<<interface>> ( p. 279) Base class for com.rti.dds.topic.Topic
(p. 1545),
(p. 471),
and
com.rti.dds.topic.MultiTopic (p. 1190).
com.rti.dds.topic.TopicDescription (p. 1561) represents the fact that both
publications and subscriptions are tied to a single data-type. Its attribute
type name defines a unique resulting type for the publication (p. 349) or
the subscription (p. 353) and therefore creates an implicit association with
a com.rti.dds.topic.TypeSupport (p. 1665).
com.rti.dds.topic.TopicDescription (p. 1561) has also a name that allows it
to be retrieved locally.
See also:
com.rti.ndds.example.FooTypeSupport (p. 1036)
(p. 1665),
1562
Class Documentation
8.271.2
8.271.2.1
String get type name ()
Get the associated type name.

The type name defines a locally unique type for the publication (p. 349) or the
subscription (p. 353).
The type name corresponds to a unique string used to register a type via the
com.rti.ndds.example.FooTypeSupport.register type (p. 1037) method.
Thus,
the type name implies an association with a
sponding
(p. 1665)
and
com.rti.dds.topic.TopicDescription (p. 1561).
correthis
Returns:
the type name.
The returned type name is valid until the
com.rti.dds.topic.TopicDescription (p. 1561) is deleted.
Postcondition:
The result is non-NULL.
See also:
8.271.2.2
(p. 1665),
String get name ()
Get the name used to create this com.rti.dds.topic.TopicDescription

(p. 1561) .
Returns:
the name used to create this com.rti.dds.topic.TopicDescription
(p. 1561).
The returned topic (p. 359) name is valid until the
com.rti.dds.topic.TopicDescription (p. 1561) is deleted.
Postcondition:
8.271 TopicDescription Interface Reference

8.271.2.3
1563
Get the com.rti.dds.domain.DomainParticipant (p. 654) to which the

com.rti.dds.topic.TopicDescription (p. 1561) belongs.
Returns:
The com.rti.dds.domain.DomainParticipant (p. 654) to which the
com.rti.dds.topic.TopicDescription (p. 1561) belongs.
Postcondition:
1564
Class Documentation
8.272
TopicListener Interface Reference

com.rti.dds.topic.Topic (p. 1545) entities.
Inheritance diagram for TopicListener::

status)
8.272.1

com.rti.dds.topic.Topic (p. 1545) entities.
Entity:
Status:
com.rti.dds.infrastructure.StatusKind.StatusKind.INCONSISTENT TOPIC STATUS,
com.rti.dds.topic.InconsistentTopicStatus
(p. 1052)
This is the interface that can be implemented by an application-provided class
and then registered with the com.rti.dds.topic.Topic (p. 1545) such that the
application can be notified by RTI Connext of relevant status changes.
See also:
8.272 TopicListener Interface Reference
1565
8.272.2
8.272.2.1


Parameters:
topic ( p. 359) <<out>>
callback
( p. 279)
(p. 1545) that
Locally
triggers
the
created
listener

Implemented in DomainParticipantAdapter (p. 737), and TopicAdapter
(p. 1550).
1566
Class Documentation
8.273
TopicQos Class Reference
QoS policies supported by a com.rti.dds.topic.Topic (p. 1545) entity.

Inheritance diagram for TopicQos::
Public Attributes
Topic ( p. 1545) data policy, TOPIC DATA ( p. 118).


DurabilityService policy, DURABILITY SERVICE ( p. 69).








Transport priority policy, TRANSPORT PRIORITY ( p. 126).
8.273 TopicQos Class Reference
1567

Lifespan policy, LIFESPAN ( p. 81).

8.273.1
QoS policies supported by a com.rti.dds.topic.Topic (p. 1545) entity.

length of com.rti.dds.topic.TopicQos.topic data (p. 1567) .value <=
(p. 776)
.topic data max length
If any of the above are not true, com.rti.dds.topic.Topic.set qos
(p. 1547),
com.rti.dds.topic.Topic.set qos with profile
(p. 1548)
and
com.rti.dds.domain.DomainParticipant.set default topic qos (p. 667) will fail with com.rti.dds.infrastructure.RETCODE INCONSISTENT POLICY (p. 1359) and com.rti.dds.domain.DomainParticipant.create topic (p. 697) will return NULL.
Entity:
See also:
QoS Policies (p. 94) allowed ranges within each Qos.
8.273.2
8.273.2.1
Topic (p. 1545) data policy, TOPIC DATA (p. 118).

8.273.2.2

8.273.2.3
DurabilityService policy, DURABILITY SERVICE (p. 69).

1568
8.273.2.4
Class Documentation

8.273.2.5

8.273.2.6

8.273.2.7

8.273.2.8

8.273.2.9

8.273.2.10

8.273.2.11
Transport priority policy, TRANSPORT PRIORITY (p. 126).

8.273.2.12
Lifespan policy, LIFESPAN (p. 81).

8.273.2.13
8.274 Transport Interface Reference
8.274
1569
Transport Interface Reference
RTI Connexts abstract pluggable transport (p. 376) interface.

Inheritance diagram for Transport::
Classes
class Property t
Base structure that must be inherited by derived Transport ( p. 1569) Plugin
classes.
8.274.1
RTI Connexts abstract pluggable transport (p. 376) interface.
1570
Class Documentation
8.275
Transport.Property t Class Reference
Base structure that must be inherited by derived Transport (p. 1569) Plugin
classes.
Inheritance diagram for Transport.Property t::
Public Attributes
final int classid
The Transport-Plugin Class ID.
final int address bit count

Number of bits in a 16-byte address that are used by the transport ( p. 376).
Should be between 0 and 128.
final int properties bitmap

A bitmap that defines various properties of the transport ( p. 376) to the
RTI Connext core.
int gather send buffer count max

Specifies the maximum number of buffers that RTI Connext can pass to the
send() method of a transport ( p. 376) plugin.
int message size max

The maximum size of a message in bytes that can be sent or received by the
transport ( p. 376) plugin.
final StringSeq allow interfaces list

A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., allow interfaces list length >
0), allow the use of only these interfaces. If the list is empty, allow the use
of all interfaces.
final StringSeq deny interfaces list

A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., deny interfaces list length >
0), deny the use of these interfaces.
final StringSeq allow multicast interfaces list

8.275 Transport.Property t Class Reference
1571
A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., allow multicast interfaces list length > 0), allow the use of multicast only on these interfaces; otherwise allow the use of all the allowed interfaces.
final StringSeq deny multicast interfaces list

A list of strings, each identifying a range of interface addresses or an interface name. If the list is non-empty (i.e., deny multicast interfaces list length > 0), deny the use of those interfaces for multicast.

static final int NDDS TRANSPORT CLASSID INVALID = -1
Invalid Transport ( p. 1569) Class ID.
static final int NDDS TRANSPORT CLASSID RESERVED RANGE = 1000

Transport-Plugin class IDs below this are reserved by RTI.
static
final
int
NDDS TRANSPORT PROPERTY BIT BUFFER ALWAYS LOANED = 0x2
Specified zero-copy behavior of transport ( p. 376).
static final int NDDS TRANSPORT PROPERTY GATHER SEND BUFFER COUNT MIN = 3
Minimum number of gather-send buffers that must be supported by a Transport ( p. 1569) Plugin implementation.
8.275.1
Base structure that must be inherited by derived Transport (p. 1569) Plugin
classes.
This structure contains properties that must be set before registration of any
transport (p. 376) plugin with RTI Connext. The RTI Connext core will configure itself to use the plugin based on the properties set within this structure.
A transport (p. 376) plugin may extend from this structure to add transportspecific properties.
WARNING: The transport (p. 376) properties of an instance of a Transport
(p. 1569) Plugin should be considered immutable after the plugin has been created. That means the values contained in the property structure stored as a
1572
Class Documentation
part of the transport (p. 376) plugin itself should not be changed. If those
values are modified, the results are undefined.
8.275.2
8.275.2.1
final int NDDS TRANSPORT CLASSID INVALID = -1

[static]
Invalid Transport (p. 1569) Class ID.

Transport-Plugins implementations should set their class ID to a value different
than this.
8.275.2.2
final int NDDS TRANSPORT CLASSID RESERVED RANGE = 1000 [static]
Transport-Plugin class IDs below this are reserved by RTI.

User-defined Transport-Plugins should use a class ID greater than this number.
8.275.2.3
final int NDDS TRANSPORT PROPERTY BIT BUFFER ALWAYS LOANED = 0x2
[static]
Specified zero-copy behavior of transport (p. 376).

A Transport (p. 1569) Plugin may commit to one of three behaviors for zero
copy receives:
1. Always does zero copy.
2. Sometimes does zero copy, up to the transport (p. 376) discretion.
3. Never does zero copy.
This bit should be set only if the Transport (p. 1569) Plugin commits to always
doing a zero copy receive, or more specifically, always loaning a buffer through
its receive rEA() call.
In that case, the NDDS core will not need to allocate storage for a message that
it retrieves with the receive rEA() call.

8.275.2.4
1573
final int NDDS TRANSPORT PROPERTY GATHER SEND BUFFER COUNT MIN = 3
[static]
Minimum number of gather-send buffers that must be supported by a Transport (p. 1569) Plugin implementation.
For the NDDS Transport Property t structure to be valid, the value of Transport.Property t.gather send buffer count max (p. 1574) must be greater
than or equal to this value.
8.275.2.5
final int classid
The Transport-Plugin Class ID.

Assigned by the implementor of the transport (p. 376) plugin, Class IDs below NDDS TRANSPORT CLASSID RESERVED RANGE (p. 1572)
are reserved for RTI (Real-Time Innovations) usage.
User-defined transports should set an ID above this range.
The ID should be globally unique for each Transport-Plugin class. TransportPlugin implementors should ensure that the class IDs do not conflict with each
other amongst different Transport-Plugin classes.
Invariant:
The classid is invariant for the lifecycle of a transport (p. 376) plugin.
8.275.2.6
final int address bit count
Number of bits in a 16-byte address that are used by the transport (p. 376).
Should be between 0 and 128.
A transport (p. 376) plugin should define the range of addresses (starting from
0x0) that are meaningful to the plugin. It does this by setting the number of
bits of an IPv6 address that will be used to designate an address in the network
to which the transport (p. 376) plugin is connected.
For example (p. 375), for an address range of 0-255, the address bit count
should be set to 8. For the range of addresses used by IPv4 (4 bytes), it should
be set to 32.
See also:
Transport Class Attributes (p. 379)
1574
8.275.2.7
Class Documentation
final int properties bitmap
A bitmap that defines various properties of the transport (p. 376) to the RTI
Connext core.
Currently, the only property supported is whether or not the transport (p. 376)
plugin will always loan a buffer when RTI Connext tries to receive a message
using the plugin. This is in support of a zero-copy interface.
See also:
NDDS TRANSPORT PROPERTY BIT BUFFER ALWAYS LOANED (p. 1572)
8.275.2.8
int gather send buffer count max
Specifies the maximum number of buffers that RTI Connext can pass to the
send() method of a transport (p. 376) plugin.
The transport (p. 376) plugin send() API supports a gather-send concept,
where the send() call can take several discontiguous buffers, assemble and send
them in a single message. This enables RTI Connext to send a message from
parts obtained from different sources without first having to copy the parts into
a single contiguous buffer.
However, most transports that support a gather-send concept have an upper
limit on the number of buffers that can be gathered and sent. Setting this value
will prevent RTI Connext from trying to gather too many buffers into a send
call for the transport (p. 376) plugin.
RTI Connext requires all transport-plugin implementations to support a gathersend of least a minimum number of buffers. This minimum number is defined to
be NDDS TRANSPORT PROPERTY GATHER SEND BUFFER COUNT MIN (p. 1573).
If the underlying transport (p. 376) does not support a gather-send concept
directly, then the transport (p. 376) plugin itself must copy the separate buffers
passed into the send() call into a single buffer for sending or otherwise send each
buffer individually. However this is done by the transport (p. 376) plugin, the
receive rEA() call of the destination application should assemble, if needed,
all of the pieces of the message into a single buffer before the message is passed
to the RTI Connext layer.
8.275.2.9
int message size max
The maximum size of a message in bytes that can be sent or received by the
transport (p. 376) plugin.
1575
If the maximum size of a message that can be sent by a transport (p. 376) plugin is user configurable, the transport (p. 376) plugin should provide a default
value for this property. In any case, this value must be set before the transport
(p. 376) plugin is registered, so that RTI Connext can properly use the plugin.
Note:
If this value is increased from the default for any of the
built-in transports, or if custom transports are used, then the
com.rti.dds.infrastructure.ReceiverPoolQosPolicy.buffer size
(p. 1320) on the com.rti.dds.domain.DomainParticipant (p. 654)
should also be changed.
8.275.2.10
final StringSeq allow interfaces list
A list of strings, each identifying a range of interface addresses or an interface

name. If the list is non-empty (i.e., allow interfaces list length > 0), allow
the use of only these interfaces. If the list is empty, allow the use of all interfaces.
The white list restricts reception to a particular set of interfaces for unicast
UDP.
Multicast output will be sent and may be received over the interfaces in the list.
It is up to the transport (p. 376) plugin to interpret the list of strings passed
in.
For example (p. 375), the following are acceptable strings in IPv4 format:
192.168.1.1, 192.168.1., 192.168., 192., ether0
This property is not interpreted by the RTI Connext core; it is provided merely
as a convenient and standardized way to specify the interfaces for the benefit of
the transport (p. 376) plugin developer and user.
The caller (user) must manage the memory of the list. The memory may be
freed after the com.rti.dds.domain.DomainParticipant (p. 654) is deleted.
8.275.2.11
final StringSeq deny interfaces list

name. If the list is non-empty (i.e., deny interfaces list length > 0), deny
the use of these interfaces.
This black list is applied after the allow interfaces list and filters out the
interfaces that should not be used.
The resulting list restricts reception to a particular set of interfaces for unicast
1576
Class Documentation
UDP. Multicast output will be sent and may be received over the interfaces in
the list.
in.
For example (p. 375), the following are acceptable strings in IPv4 format:
192.168.1.1, 192.168.1., 192.168., 192., ether0
8.275.2.12
final StringSeq allow multicast interfaces list

name. If the list is non-empty (i.e., allow multicast interfaces list length
> 0), allow the use of multicast only on these interfaces; otherwise allow the use
of all the allowed interfaces.
This white list sub-selects from the allowed interfaces obtained after applying the allow interfaces list white list and the deny interfaces list
black list.
After allow multicast interfaces list, the deny multicast interfaces list is applied. Multicast output will be sent and may be received over the
interfaces in the resulting list.
If this list is empty, all the allowed interfaces will be potentially used for multicast. It is up to the transport (p. 376) plugin to interpret the list of strings
passed in.
8.275.2.13
final StringSeq deny multicast interfaces list

name. If the list is non-empty (i.e., deny multicast interfaces list length
> 0), deny the use of those interfaces for multicast.
1577
This black list is applied after allow multicast interfaces list and filters
out interfaces that should not be used for multicast.
Multicast output will be sent and may be received over the interfaces in the
resulting list.
in.
1578
Class Documentation
8.276
TransportBuiltinKind Class Reference

static final int UDPv4
Built-in UDPv4 transport,
( p. 1668).
com.rti.ndds.transport.UDPv4Transport

static final int SHMEM

Built-in shared memory transport, com.rti.ndds.transport.ShmemTransport
( p. 1435).
static final String SHMEM ALIAS

static final int UDPv6

( p. 1680).


None of the built-in transports will be registered automatically
when
the
( p. 654)
is enabled.
static final int MASK DEFAULT

( p. 1581).

8.276 TransportBuiltinKind Class Reference
8.276.1
1579

See also:
8.276.2
8.276.2.1
final int UDPv4 [static]

(p. 1668).
8.276.2.2
final int SHMEM [static]
Built-in shared memory transport, com.rti.ndds.transport.ShmemTransport

(p. 1435).
8.276.2.3
final int UDPv6 [static]

(p. 1680).
1580
Class Documentation
8.277
TransportBuiltinQosPolicy Class Reference

Inheritance diagram for TransportBuiltinQosPolicy::
Public Attributes
int mask
Specifies the built-in transports that are registered automatically when the
8.277.1

Three different transport plug-ins are built into the core RTI Connext libraries
(for most supported target platforms): UDPv4, shared memory, and UDPv6.
This QoS policy allows you to control which of these built-in transport plug-ins
are used by a com.rti.dds.domain.DomainParticipant (p. 654). By default,
only the UDPv4 and shared memory plug-ins are enabled (although on some
embedded platforms, the shared memory plug-in is not available). In some
cases, users will disable the shared memory transport when they do not want
applications to use shared memory to communicate when running on the same
node.
Note: If one application is configured to use UDPv4 and shared memory, while
another application is only configured for UDPv4, and these two applications
run on the same node, they will not communicate. This is due to an internal optimization which will default to use shared memory instead of loopback.
However if the other peer application does not enable shared memory there is
no common transport, therefore they will not communicate.
Entity:
Properties:
RxO (p. 101) = N/A
8.277 TransportBuiltinQosPolicy Class Reference
8.277.2
8.277.2.1
int mask
1581
Specifies the built-in transports that are registered automatically when the
RTI Connext provides several built-in transports.
Only those that
are specified with this mask are registered automatically when the
[default]
com.rti.dds.infrastructure.TransportBuiltinKind.MASK DEFAULT (p. 121)
1582
Class Documentation
8.278
TransportMulticastMapping t Class Reference

Inherits Struct.

TransportMulticastMapping t ()
Constructor.
TransportMulticastMapping t
src)
(TransportMulticastMapping t
Copy constructor.
Public Attributes
String addresses
A string containing a comma-separated list of IP addresses
or IP address ranges to be used to receive multicast traffic for the entity with a topic ( p. 359) that matches the
com.rti.dds.infrastructure.TransportMulticastMapping t.topic expression ( p. 1584).
String topic expression

A regular expression that will be used to map topic ( p. 359) names to corresponding multicast receive addresses.
TransportMulticastMappingFunction t mapping function

Specifies a function that will define the mapping between a topic ( p. 359)
name and a specific multicast address from a list of addresses.
8.278.1

A multicast mapping element specifies a string containing a list of IP addresses,
a topic (p. 359) expression and a mapping function.
8.278 TransportMulticastMapping t Class Reference
1583
QoS:
com.rti.dds.infrastructure.TransportMulticastMappingQosPolicy
(p. 1587)
8.278.2
8.278.2.1
TransportMulticastMapping t ()
Constructor.
8.278.2.2
TransportMulticastMapping t
(TransportMulticastMapping t src)
Copy constructor.
8.278.3
8.278.3.1
String addresses
A string containing a comma-separated list of IP addresses or IP address ranges

to be used to receive multicast traffic for the entity with a topic (p. 359) that
matches the com.rti.dds.infrastructure.TransportMulticastMapping t.topic expression (p. 1584).
The string must contain IPv4 or IPv6 addresses separated by commas. For
example: 239.255.100.1,239.255.100.2,239.255.100.3
You may specify ranges of addresses by enclosing the start address and the end
address in square brackets. For example: [239.255.100.1,239.255.100.3]
You may combine the two approaches. For example:
239.255.200.1,[239.255.100.1,239.255.100.3], 239.255.200.3
IPv4 addresses must be specified in Dot-decimal notation.
IPv6 addresses must be specified using 8 groups of 16-bit hexadecimal values
separated by colons. For example: FF00:0000:0000:0000:0202:B3FF:FE1E:8329
Leading
zeroes
can
be
FF00:0:0:0:202:B3FF:FE1E:8329
skipped.
For
example:
You may replace a consecutive number of zeroes with a double colon, but only
once within an address. For example: FF00::202:B3FF:FE1E:8329
[default] NULL
1584
8.278.3.2
Class Documentation
String topic expression
A regular expression that will be used to map topic (p. 359) names to corresponding multicast receive addresses.
A topic (p. 359) name must match the expression before a corresponding address is assigned.
[default] NULL
8.278.3.3
TransportMulticastMappingFunction t mapping function
Specifies a function that will define the mapping between a topic (p. 359) name
and a specific multicast address from a list of addresses.
This function is optional. If not specified, the middleware will use a hash function to perform the mapping.
8.279 TransportMulticastMappingFunction t Class Reference
8.279
1585
TransportMulticastMappingFunction t
Class Reference

Inherits Struct.

TransportMulticastMappingFunction t ()
Constructor.
tMappingFunction t src)
(TransportMulticas-
Copy constructor.
Public Attributes
String dll
Specifies a dynamic library that contains a mapping function.
String function name

Specifies the name of a mapping function.
8.279.1

A mapping function is defined by a dynamic library name and a function name.
QoS:
(p. 1587)
8.279.2
8.279.2.1
TransportMulticastMappingFunction t ()
Constructor.
1586
8.279.2.2
Class Documentation
(TransportMulticastMappingFunction t src)
Copy constructor.
8.279.3
8.279.3.1
String dll
Specifies a dynamic library that contains a mapping function.

A relative or absolute path can be specified.
If the name is specified as foo, the library name on Linux systems will be
libfoo.so; on Windows systems it will be foo.dll.
[default] NULL
8.279.3.2
String function name
Specifies the name of a mapping function.

This function must be implemented in the library specified in
com.rti.dds.infrastructure.TransportMulticastMappingFunction t.dll (p. 1586).
The function must implement the following interface:
int function(const char topic name, int numberOfAddresses);
The function must return an integer that indicates the index of the address to
use for the given topic name. For example, if the first address in the list should
be used, it must return 0; if the second address in the list should be used, it
must return 1, etc.
8.280 TransportMulticastMappingQosPolicy Class Reference
8.280
1587
TransportMulticastMappingQosPolicy
Class Reference
Specifies
the
multicast
address
on
which
a
com.rti.dds.subscription.DataReader (p. 487) wants to receive its
data. It can also specify a port number as well as a subset of the available (at
Inheritance diagram for TransportMulticastMappingQosPolicy::
Public Attributes
final TransportMulticastMappingSeq value
A sequence of multicast communications settings.
8.280.1
Specifies
the
multicast
address
on
which
a
By default, a com.rti.dds.publication.DataWriter (p. 557) will send individually addressed packets for each com.rti.dds.subscription.DataReader
(p. 487) that subscribes to the topic (p. 359) of the DataWriter this is known
as unicast delivery. Thus, as many copies of the data will be sent over the network as there are DataReaders for the data. The network bandwidth used by a
DataWriter will thus increase linearly with the number of DataReaders.
Multicast addressing (on UDP/IP transports) allows multiple DataReaders to receive the same network packet.
By using multicast, a
com.rti.dds.publication.DataWriter (p. 557) can send a single network
packet that is received by all subscribing applications. Thus the network bandwidth usage will be constant, independent of the number of DataReaders.
Coordinating the multicast address specified by DataReaders can help optimize
network bandwidth usage in systems where there are multiple DataReaders for
the same com.rti.dds.topic.Topic (p. 1545).
1588
Class Documentation
Entity:
Properties:
RxO (p. 101) = N/A
8.280.2
8.280.2.1
final TransportMulticastMappingSeq value

An empty sequence means that multicast is not used by the entity.
The RTPS wire protocol currently limits the maximum number of multicast
locators to four.
8.281 TransportMulticastMappingSeq Class Reference
8.281
TransportMulticastMappingSeq
Reference
1589
Class
Declares IDL sequence< com.rti.dds.infrastructure.TransportMulticastSettings t (p. 1594) >.

8.281.1

Instantiates:
See also:
com.rti.dds.infrastructure.TransportMulticastSettings t (p. 1594)
1590
Class Documentation
8.282
TransportMulticastQosPolicy Class Reference
Specifies
the
multicast
address
on
which
a
Inheritance diagram for TransportMulticastQosPolicy::
Public Attributes
final TransportMulticastSettingsSeq value
TransportMulticastQosPolicyKind kind
A value that specifies a way to determine how to obtain the multicast address.
8.282.1
Specifies
the
multicast
address
on
which
a
By default, a com.rti.dds.publication.DataWriter (p. 557) will send individually addressed packets for each com.rti.dds.subscription.DataReader
(p. 487) that subscribes to the topic (p. 359) of the DataWriter this is known
as unicast delivery. Thus, as many copies of the data will be sent over the network as there are DataReaders for the data. The network bandwidth used by a
DataWriter will thus increase linearly with the number of DataReaders.
Multicast addressing (on UDP/IP transports) allows multiple DataReaders to receive the same network packet.
By using multicast, a
com.rti.dds.publication.DataWriter (p. 557) can send a single network
packet that is received by all subscribing applications. Thus the network bandwidth usage will be constant, independent of the number of DataReaders.
Coordinating the multicast address specified by DataReaders can help optimize
network bandwidth usage in systems where there are multiple DataReaders for
the same com.rti.dds.topic.Topic (p. 1545).
8.282 TransportMulticastQosPolicy Class Reference
1591
Entity:
Properties:
RxO (p. 101) = N/A
8.282.2
8.282.2.1
final TransportMulticastSettingsSeq value

An empty sequence means that multicast is not used by the entity.
The RTPS wire protocol currently limits the maximum number of multicast
locators to four.
8.282.2.2
TransportMulticastQosPolicyKind kind
A value that specifies a way to determine how to obtain the multicast address.
This field can have two values.
If it is set to com.rti.dds.infrastructure.TransportMulticastQosPolicyKind.AUTOMATIC TRANSPORT MULTICAST QOS
(p. 124)
and
the
com.rti.dds.infrastructure.TransportMulticastQosPolicy.value
(p. 1591) does not have any elements, then multicast will not be used.
(p. 124)
and
the
(p. 1591) has at least one element with a valid address, then that address
will be used.
(p. 124)
and
the
(p. 1591)
has
at
least
one
element
with
an
empty
address,
then
the
address
will
be
obtained
from
(p. 1587).
1592
Class Documentation
If it is set to com.rti.dds.infrastructure.TransportMulticastQosPolicyKind.UNICAST ONLY TRANSPORT MULTICAST QOS (p. 124), then multicast
will not be used.
[default] com.rti.dds.infrastructure.TransportMulticastQosPolicyKind.AUTOMATIC TRANSPORT MULTICAST QOS (p. 124)
8.283 TransportMulticastQosPolicyKind Class Reference
8.283
1593
TransportMulticastQosPolicyKind Class
Reference

Inheritance diagram for TransportMulticastQosPolicyKind::

static final TransportMulticastQosPolicyKind AUTOMATIC TRANSPORT MULTICAST QOS
static final TransportMulticastQosPolicyKind UNICAST ONLY TRANSPORT MULTICAST QOS

=
new
TransportMulticastQosPolicyKind(UNICAST ONLY TRANSPORT MULTICAST QOS, 1)
8.283.1

See also:
com.rti.dds.infrastructure.TransportMulticastQosPolicy (p. 1590)
1594
Class Documentation
8.284
TransportMulticastSettings t Class Reference

Inherits Struct.

TransportMulticastSettings t ()
TransportMulticastSettings t
src)
(TransportMulticastSettings t
Copy constructor.
Public Attributes
final StringSeq transports
A sequence of transport aliases that specifies the transports on which to receive multicast traffic for the entity.
InetAddress receive address

The multicast group address on which the entity can receive data.
int receive port

The multicast port on which the entity can receive data.
8.284.1

A multicast locator specifies a transport class, a multicast address, and a multicast port number on which messages can be received by an entity.
QoS:
com.rti.dds.infrastructure.TransportMulticastQosPolicy (p. 1590)
8.284 TransportMulticastSettings t Class Reference
8.284.2
8.284.2.1
TransportMulticastSettings t ()
1595

8.284.2.2
TransportMulticastSettings t
(TransportMulticastSettings t src)
Copy constructor.
8.284.3
8.284.3.1
A sequence of transport aliases that specifies the transports on which to receive

multicast traffic for the entity.
Of the transport instances available to the entity, only those with aliases matching an alias in this sequence are used to subscribe to the multicast group addresses. Thus, this list of aliases sub-selects from the transport s available to
the entity.
An empty sequence is a special value that specifies all the transports available
to the entity.
[default] Empty sequence; i.e. all the transports available to the entity.
[range] Any sequence of non-null, non-empty strings.
8.284.3.2
InetAddress receive address
The multicast group address on which the entity can receive data.
Must must be an address in the proper format (see Address Format (p. 59)).
[default] NONE/INVALID. Required to specify a multicast group address to
join.
[range] A valid IPv4 or IPv6 multicast address.
See also:
Address Format (p. 59)
1596
8.284.3.3
Class Documentation
int receive port
The multicast port on which the entity can receive data.

[default] 0, which implies that the actual port number is determined by a formula as a function of the domain id (see
(p. 1728)).
[range] [0,0xffffffff]
8.285 TransportMulticastSettingsSeq Class Reference
8.285
TransportMulticastSettingsSeq
Reference
1597
Class

8.285.1

Instantiates:
See also:
com.rti.dds.infrastructure.TransportMulticastSettings t (p. 1594)
1598
Class Documentation
8.286
TransportPriorityQosPolicy Class Reference
Inheritance diagram for TransportPriorityQosPolicy::
Public Attributes
int value
This policy is a hint to the infrastructure ( p. 334) as to how to set the
priority of the underlying transport used to send the data.
8.286.1
The Transport Priority QoS policy is optional and only supported
on certain OSs and transports.
It allows you to specify on a
per-com.rti.dds.publication.DataWriter basis that the data sent by that
com.rti.dds.publication.DataWriter (p. 557) is of a different priority.
The DDS specification does not indicate how a DDS implementation should
treat data of different priorities. It is often difficult or impossible for DDS implementations to treat data of higher priority differently than data of lower priority,
especially when data is being sent (delivered to a physical transport) directly
by the thread that called com.rti.ndds.example.FooDataWriter.write
(p. 1021). Also, many physical network transports themselves do not have a
end-user controllable level of data packet priority.
Entity:
(p. 557),
Properties:
RxO (p. 101) = N/A
8.286 TransportPriorityQosPolicy Class Reference
8.286.2
1599
Usage
In RTI Connext, for the com.rti.ndds.transport.UDPv4Transport

(p. 1668), the value set in the Transport Priority QoS policy is used in a
setsockopt call to set the TOS (type of service) bits of the IPv4 header for
datagrams sent by a com.rti.dds.publication.DataWriter (p. 557). It is
platform-dependent how and whether the setsockopt has an effect. On some
platforms, such as Windows and Linux, external permissions must be given to
the user application in order to set the TOS bits.
It is incorrect to assume that using the Transport Priority QoS
policy will have any effect at all on the end-to-end delivery of
data from a com.rti.dds.publication.DataWriter (p. 557) to a
All network elements,
including switches and routers must have the capability and be enabled to
actually use the TOS bits to treat higher priority packets differently. Thus
the ability to use the Transport Priority QoS policy must be designed and
configured at a system level; just turning it on in an application may have no
effect at all.
8.286.3
8.286.3.1
int value
This policy is a hint to the infrastructure (p. 334) as to how to set the priority
of the underlying transport used to send the data.
You may choose any value within the range of a 32-bit signed integer; higher
values indicate higher priority. However, any further interpretation of this policy
is specific to a particular transport and a particular DDS implementation. For
example, a particular transport is permitted to treat a range of priority values
as equivalent to one another.
[default] 0
1600
Class Documentation
8.287
TransportSelectionQosPolicy Class Reference

(p. 557) or com.rti.dds.subscription.DataReader (p. 487) may use to send
or receive data.
Inheritance diagram for TransportSelectionQosPolicy::
Public Attributes
A sequence of transport aliases that specifies the transport instances available
for use by the entity.
8.287.1

(p. 557) or com.rti.dds.subscription.DataReader (p. 487) may use to send
or receive data.
An application may be simultaneously connected to many different physical
transports, e.g., Ethernet, Infiniband, shared memory, VME backplane, and
wireless. By default, RTI Connext will use up to 4 transports to deliver data
from a DataWriter to a DataReader.
This QoS policy can be used to both limit and control which of the applications
available transports may be used by a com.rti.dds.publication.DataWriter
(p. 557) to send data or by a com.rti.dds.subscription.DataReader (p. 487)
to receive data.
Entity:
(p. 487),
Properties:
RxO (p. 101) = N/A
8.287 TransportSelectionQosPolicy Class Reference
8.287.2
8.287.2.1
1601
A sequence of transport aliases that specifies the transport instances available

for use by the entity.
Of
the
transport
instances
installed
with
the
com.rti.dds.domain.DomainParticipant (p. 654), only those with aliases
matching an alias in this sequence are available to the entity.
Thus, this list of aliases sub-selects from the transports available to the
An empty sequence is a special value that specifies all the transports installed
with the com.rti.dds.domain.DomainParticipant (p. 654).
[default] Empty sequence; i.e. all the transports installed with and available
to the com.rti.dds.domain.DomainParticipant (p. 654).
[range] A sequence of non-null, non-empty strings.
See also:
com.rti.dds.domain.DomainParticipantQos.transport builtin
(p. 775).
1602
Class Documentation
8.288
TransportSupport Class Reference
<<interface>> ( p. 279) The utility class used to configure RTI Connext pluggable transports.

static void get builtin transport property (DomainParticipant
participant in, Transport.Property t builtin transport property inout)
Get the properties used to create a builtin transport ( p. 376) plugin.
static void set builtin transport property (DomainParticipant participant in, Transport.Property t builtin transport property in)
Set the properties used to create a builtin transport ( p. 376) plugin.
8.288.1
<<interface>> ( p. 279) The utility class used to configure RTI Connext pluggable transports.
8.288.2
8.288.2.1
static void get builtin transport property

(DomainParticipant participant in, Transport.Property t
builtin transport property inout) [static]
Get the properties used to create a builtin transport (p. 376) plugin.
Retrieves the properties that will be used to create a builtin transport (p. 376)
plugin.
Precondition:
The builtin transport property inout parameter must be of the type
specified by the builtin transport kind in.
Parameters:
participant in <<in>>
( p. 279)
A
valid
non-null
8.288 TransportSupport Class Reference
1603
Parameters:
builtin transport property inout <<inout>> ( p. 279) The storage
area where the retrieved property will be output. The specific type
required by the builtin transport kind in must be used.
Returns:
One
of
the
Standard
Return
Codes
(p. 108),
or
See also:
8.288.2.2
static void set builtin transport property

(DomainParticipant participant in, Transport.Property t
builtin transport property in) [static]
Set the properties used to create a builtin transport (p. 376) plugin.
Specifies the properties that will be used to create a builtin transport (p. 376)
plugin.
If the builtin transport (p. 376) is already registered when this operation is
called, these property changes will not have any effect. Builtin transport
(p. 376) properties should always be set before the transport (p. 376) is registered. See Built-in Transport Plugins (p. 222) for details on when a builtin
transport (p. 376) is registered.
Precondition:
A disabled com.rti.dds.domain.DomainParticipant (p. 654). The
builtin transport property inout parameter must be of the type specified by the builtin transport kind in.
Parameters:
participant in <<in>>
( p. 279)
A
not been enabled.
valid
(p. 654)
non-null
that has
Parameters:
builtin transport property in <<inout>> ( p. 279) The new transport (p. 376) property that will be used to the create the builtin
transport (p. 376) plugin.
The specific type required by the
builtin transport kind in must be used.
1604
Class Documentation
Returns:
One
of
the
Standard
Return
Codes
(p. 108),
or
See also:
com.rti.ndds.transport.TransportSupport.get builtin transport property() (p. 1602)
8.289 TransportUnicastQosPolicy Class Reference
8.289
1605
TransportUnicastQosPolicy Class Reference

Entity (p. 931) to receive data.
Inheritance diagram for TransportUnicastQosPolicy::
Public Attributes
final TransportUnicastSettingsSeq value
A sequence of unicast communication settings.
8.289.1

Entity (p. 931) to receive data.
Entity:
(p. 654),
(p. 487),
Properties:
RxO (p. 101) = N/A
8.289.2
Usage
RTI Connext may send data to a variety of Entities, not just DataReaders. For
example, reliable DataWriters may receive ACK/NACK packets from reliable
DataReaders.
During discovery, each com.rti.dds.infrastructure.Entity (p. 931) announces
to remote applications a list of (up to 4) unicast addresses to which the remote
application should send data (either user data packets or reliable protocol metadata such as ACK/NACKs and heartbeats).
1606
Class Documentation
By default, the list of addresses is populated automatically with values obtained from the enabled transport plug-ins allowed to be used by the Entity (p. 931) (see com.rti.dds.infrastructure.TransportBuiltinQosPolicy
(p. 1580) and com.rti.dds.infrastructure.TransportSelectionQosPolicy
(p. 1600)). Also, the associated ports are automatically determined (see
com.rti.dds.infrastructure.RtpsWellKnownPorts t (p. 1390)).
Use this QoS policy to manually set the receive address list for an Entity
(p. 931). You may optionally set a port to use a non-default receive port as
well. Only the first 4 addresses will be used.
RTI Connext will create a receive thread for every unique port number that it
encounters (on a per transport basis).
For a com.rti.dds.domain.DomainParticipant (p. 654), this QoS policy sets the default list of addresses used by other applications to send
user data for local DataReaders.
For a com.rti.dds.subscription.DataReader (p. 487), if set, then other
applications will use the specified list of addresses to send user data
(and reliable protocol packets for reliable DataReaders). Otherwise,
if not set, the other applications will use the addresses set by the
For a reliable com.rti.dds.publication.DataWriter (p. 557), if set,
then other applications will use the specified list of addresses to send reliable protocol packets (ACKS/NACKS) on the behalf of reliable DataReaders. Otherwise, if not set, the other applications will use the addresses set
by the com.rti.dds.domain.DomainParticipant (p. 654).
8.289.3
8.289.3.1
final TransportUnicastSettingsSeq value
A sequence of unicast communication settings.

An empty sequence means that applicable defaults specified by elsewhere (e.g. com.rti.dds.domain.DomainParticipantQos.default unicast
(p. 776)) should be used.
The RTPS wire protocol currently limits the maximum number of unicast locators to four.
See also:
com.rti.dds.domain.DomainParticipantQos.default unicast
8.289 TransportUnicastQosPolicy Class Reference
1607
(p. 776)
1608
Class Documentation
8.290
TransportUnicastSettings t Class Reference

Inherits Struct.

TransportUnicastSettings t ()
Constructor.
TransportUnicastSettings t (TransportUnicastSettings t src)

Copy constructor.
Public Attributes
A sequence of transport aliases that specifies the unicast interfaces on which
to receive unicast traffic for the entity.
int receive port

The unicast port on which the entity can receive data.
8.290.1

A unicast locator specifies a transport class, a unicast address, and a unicast
port number on which messages can be received by an entity.
QoS:
com.rti.dds.infrastructure.TransportUnicastQosPolicy (p. 1605)
8.290.2
8.290.2.1
TransportUnicastSettings t ()
Constructor.
8.290 TransportUnicastSettings t Class Reference

8.290.2.2
1609
TransportUnicastSettings t (TransportUnicastSettings t
src)
Copy constructor.
8.290.3
8.290.3.1
A sequence of transport aliases that specifies the unicast interfaces on which to

receive unicast traffic for the entity.
Of the transport instances available to the entity, only those with aliases matching an alias on this sequence are used to determine the unicast interfaces used
by the entity.
Thus, this list of aliases sub-selects from the transports available to the entity.
Each unicast interface on a transport results in a unicast locator for the entity.
An empty sequence is a special value that specifies all the transports available
to the entity.
[default] Empty sequence; i.e. all the transports available to the entity.
[range] Any sequence of non-null, non-empty strings.
8.290.3.2
int receive port
The unicast port on which the entity can receive data.

Must be an unused unicast port on the system.
[default] 0, which implies that the actual port number is determined by a formula as a function of the domain id, and the
(p. 1728).
See also:
(p. 1728).
1610
8.291
Class Documentation
TransportUnicastSettingsSeq Class Reference
Declares IDL sequence< com.rti.dds.infrastructure.TransportUnicastSettings t (p. 1608) >.

8.291.1
Declares IDL sequence< com.rti.dds.infrastructure.TransportUnicastSettings t (p. 1608) >.

Instantiates:
See also:
com.rti.dds.infrastructure.TransportUnicastSettings t (p. 1608)
8.292 TypeCode Class Reference
8.292
1611
TypeCode Class Reference
The definition of a particular data type, which you can use to inspect the name,
members, and other properties of types generated with rtiddsgen (p. 298) or
to modify types you define yourself at runtime.

TCKind kind ()
Gets the com.rti.dds.typecode.TCKind ( p. 1525) value of a type code.
ExtensibilityKind extensibility kind ()

Gets the com.rti.dds.typecode.ExtensibilityKind ( p. 956) value of a type
code.
boolean equal (TypeCode tc)

Compares two com.rti.dds.typecode.TypeCode ( p. 1611) objects for equality.
boolean equals (Object tc)

Compares two com.rti.dds.typecode.TypeCode ( p. 1611) objects for equality.
boolean assignable (TypeCode from)

Checks if this com.rti.dds.typecode.TypeCode ( p. 1611) is assignable from
the input com.rti.dds.typecode.TypeCode ( p. 1611).
int length () throws BadKind

Returns the number of elements in the type described by this type code.
String name () throws BadKind

Retrieves the simple name identifying this com.rti.dds.typecode.TypeCode
( p. 1611) object within its enclosing scope.
boolean is alias pointer () throws BadKind

Function that tells if an alias is a pointer or not.
short type modifier () throws BadKind

Returns a constant indicating the modifier of the value type that this
com.rti.dds.typecode.TypeCode ( p. 1611) object describes.
TypeCode concrete base type () throws BadKind

1612
Class Documentation
Returns
the
( p. 1611)
describes the concrete base type of the value type that
com.rti.dds.typecode.TypeCode ( p. 1611) object describes.
that
this
TypeCode content type () throws BadKind

Returns the com.rti.dds.typecode.TypeCode ( p. 1611) object representing the type for the members of the object described by this
com.rti.dds.typecode.TypeCode ( p. 1611) object.
int array dimension count () throws BadKind

This function returns the number of dimensions of an array type code.
int array dimension (int index) throws BadKind,Bounds

This function returns the index-th dimension of an array type code.
int element count () throws BadKind

The number of elements in an array.
int member count () throws BadKind

Returns the number of members of the type code.
String member name (int index) throws BadKind,Bounds

Returns the name of a type code member identified by the given index.
TypeCode member type (int index) throws BadKind,Bounds

Retrieves the com.rti.dds.typecode.TypeCode ( p. 1611) object describing
the type of the member identified by the given index.
int member id (int index) throws BadKind,Bounds

Returns the ID of a sparse type code member identified by the given index.
int member label count (int index) throws BadKind,Bounds

Returns the number of labels associated to the index-th union member.
int member label (int member index, int label index) throws BadKind,Bounds
Return the label index-th label associated to the member index-th member.
int member ordinal (int index) throws BadKind,Bounds

Returns the ordinal that corresponds to the index-th enum value.
boolean is member key (int index) throws BadKind,Bounds

Function that tells if a member is a key or not.
1613
boolean is member required (int index) throws BadKind,Bounds

Indicates whether a given member of a type is required to be present in every
sample of that type.
boolean is member pointer (int index) throws BadKind,Bounds

Function that tells if a member is a pointer or not.
boolean is member bitfield (int index) throws BadKind,Bounds

Function that tells if a member is a bitfield or not.
short member bitfield bits (int index) throws BadKind,Bounds

Returns the number of bits of a bitfield member.
short member visibility (int index) throws BadKind,Bounds

Returns the constant that indicates the visibility of the index-th member.
TypeCode discriminator type () throws BadKind

Returns the discriminator type code.
int default index () throws BadKind

Returns the index of the default member, or -1 if there is no default member.
int find member by id (int id) throws BadKind

Get the index of the member of the given ID.
int find member by name (String name) throws BadKind

Get the index of the member of the given name.
void print IDL (int indent)

Prints a com.rti.dds.typecode.TypeCode ( p. 1611) in a pseudo-IDL notation.
void print IDL (int indent, java.io.Writer out) throws IOException

Prints a com.rti.dds.typecode.TypeCode ( p. 1611) in a pseudo-IDL notation.
int add member (String name, int id, TypeCode tc, byte member flags)
throws BadKind,BadMemberName,BadMemberId
Add a new member to this com.rti.dds.typecode.TypeCode ( p. 1611).
1614
Class Documentation
synchronized int add member (String name, int id, TypeCode tc, byte member flags, short visibility, boolean is pointer,
short bits) throws BadKind,BadMemberName,BadMemberId,BAD PARAM,IllegalStateException
Add a new member to this com.rti.dds.typecode.TypeCode ( p. 1611).
synchronized int add member to enum (String name, int ordinal)

throws BadKind,BadMemberName
Add
a
new
enumerated
constant
to
this
enum
String signature () throws RETCODE ERROR

Gets an MD5 signature of the com.rti.dds.typecode.TypeCode ( p. 1611).

static final TypeCode TC NULL
Basic null type.
static final TypeCode TC SHORT

Basic 16-bit signed integer type.
static final TypeCode TC LONG

static final TypeCode TC USHORT

Basic unsigned 16-bit integer type.
static final TypeCode TC ULONG

static final TypeCode TC FLOAT

Basic 32-bit floating point type.
static final TypeCode TC DOUBLE

static final TypeCode TC BOOLEAN

Basic Boolean type.
static final TypeCode TC CHAR

1615
Basic single-byte character type.
static final TypeCode TC OCTET

Basic octet/byte type.
static final TypeCode TC LONGLONG

Basic 64-bit integer type.
static final TypeCode TC ULONGLONG

static final TypeCode TC LONGDOUBLE

static final TypeCode TC WCHAR

Basic four-byte character type.
static final int MEMBER ID INVALID

A sentinel indicating an invalid com.rti.dds.typecode.TypeCode ( p. 1611)
member ID.
static final int MEMBER ID SPARSE UNSPECIFIED = 0

static final int INDEX INVALID
A sentinel indicating an invalid com.rti.dds.typecode.TypeCode ( p. 1611)
member index.
static final byte NONKEY MEMBER

A flag indicating that a type member is optional and not part of the key.
static final byte KEY MEMBER

A flag indicating that a type member is part of the key for that type, and
therefore required.
static final byte NONKEY REQUIRED MEMBER

A flag indicating that a type member is not part of the key but is nevertheless
required.
static final short NOT BITFIELD

Indicates that a member of a type is not a bitfield.
1616
8.292.1
Class Documentation
The definition of a particular data type, which you can use to inspect the name,
members, and other properties of types generated with rtiddsgen (p. 298) or
to modify types you define yourself at runtime.
You create com.rti.dds.typecode.TypeCode (p. 1611) objects using the
com.rti.dds.typecode.TypeCodeFactory (p. 1647) singleton. Then you can
use the methods on this class to inspect and modify the data type definition.
This class is based on a similar class from CORBA.
MT Safety:
SAFE for read-only access, UNSAFE for modification.
Modifying a single com.rti.dds.typecode.TypeCode (p. 1611) object concurrently from multiple threads is unsafe.
Modifying a
com.rti.dds.typecode.TypeCode (p. 1611) from a single thread while
concurrently reading the state of that com.rti.dds.typecode.TypeCode
(p. 1611) from another thread is also unsafe. However, reading the state
of a com.rti.dds.typecode.TypeCode (p. 1611) concurrently from
multiple threads, without any modification, is safe.
See also:
http://java.sun.com/javase/6/docs/api/org/omg/CORBA/TypeCode.html
8.292.2
8.292.2.1
TCKind kind ()
Gets the com.rti.dds.typecode.TCKind (p. 1525) value of a type code.

Retrieves the kind of this com.rti.dds.typecode.TypeCode (p. 1611) object.
The kind of a type code determines which com.rti.dds.typecode.TypeCode
(p. 1611) methods may legally be invoked on it.
MT Safety:
SAFE.
Returns:
The type code kind.

8.292.2.2
1617
ExtensibilityKind extensibility kind ()
Gets the com.rti.dds.typecode.ExtensibilityKind (p. 956) value of a type

code.
Retrieves the extensibility kind of this com.rti.dds.typecode.TypeCode
(p. 1611) object.
In some cases, it is desirable for types to evolve without breaking interoperability
with deployed components already using those types. For example:
A new set of applications to be integrated into an existing system may
want to introduce additional fields into a structure. These new fields can
be safely ignored by already deployed applications, but applications that
do understand the new fields can benefit from their presence.
A new set of applications to be integrated into an existing system may
want to increase the maximum size of some sequence or string in a Type.
Existing applications can receive data samples from these new applications
as long as the actual number of elements (or length of the strings) in
the received data sample does not exceed what the receiving applications
expects. If a received data sample exceeds the limits expected by the
receiving application, then the sample can be safely ignored (filtered out)
by the receiver.
In order to support use cases such as these, the type system introduces the
concept of extensible and mutable types.
A type may be final, indicating that the range of its possible data values is
strictly defined. In particular, it is not possible to add elements to members of collection or aggregated types while maintaining type assignability.
A type may be extensible, indicating that two types, where one contains all
of the elements/members of the other plus additional elements/members
appended to the end, may remain assignable.
A type may be mutable, indicating that two types may differ from
one another in the additional, removal, and/or transposition of elements/members while remaining assignable.
The extensibility of
(p. 1528),
(p. 1528),
(p. 1529),
and
com.rti.dds.typecode.TCKind.TK ENUM (p. 1528) can be change
using the built-in Extensibility annotation when the type is declared.
IDL example:
1618
Class Documentation
struct MyType {
long member_1;
} //@Extensibility EXTENSIBLE_EXTENSIBILITY
XML example:
<struct name="MyType" extensibility="extensible">
<member name="member_1" type="long"/>
</struct>
XSD example:
<xsd:complexType name="MyType">
<xsd:sequence>
<xsd:element name="member_1" minOccurs="1" maxOccurs="1" type="xsd:int"/>
</xsd:sequence>
</xsd:complexType>


For
TypeCodes
built
at
run-time
using
the
com.rti.dds.typecode.TypeCodeFactory (p. 1647) API, the extensibility
can be provided as a parameter of the following APIs:
com.rti.dds.typecode.TypeCodeFactory.create value tc (p. 1652)
com.rti.dds.typecode.TypeCodeFactory.create union tc (p. 1654)
See also:
com.rti.dds.typecode.ExtensibilityKind (p. 956)
MT Safety:
SAFE.
Returns:
The type code extensibility kind.

8.292.2.3
1619
boolean equal (TypeCode tc)
Compares two com.rti.dds.typecode.TypeCode (p. 1611) objects for equality.

MT Safety:
SAFE.
For equality and assignability purposes, com.rti.dds.typecode.TCKind.TK STRUCT (p. 1528) and com.rti.dds.typecode.TCKind.TK VALUE
(p. 1529) are considered equivalent.
The com.rti.dds.typecode.TypeCode (p. 1611) of structs inheriting from
other structs has a com.rti.dds.typecode.TCKind.TK VALUE (p. 1529)
kind.
For example:
struct MyStruct: MyBaseStruct {
long member_1;
};
The
code
generation
for
the
previous
type
will
ate
a
(p. 1611)
com.rti.dds.typecode.TCKind.TK VALUE (p. 1529) kind.
generwith
Parameters:
tc <<in>> ( p. 279) Type code that will be compared with this
Exceptions:
com.rti.dds.infrastructure.ExceptionCode t.BAD PARAM if tc is
null.
Returns:
com.rti.dds.infrastructure.true if the type codes are equal.
Otherwise,
See also:
http://java.sun.com/javase/6/docs/api/org/omg/CORBA/TypeCode.html#equal(org.omg.CORBA.TypeCod
1620
8.292.2.4
Class Documentation
boolean equals (Object tc)
Compares two com.rti.dds.typecode.TypeCode (p. 1611) objects for equality.

MT Safety:
SAFE.
Parameters:
tc <<in>> ( p. 279) Type code that will be compared with this
Returns:
com.rti.dds.infrastructure.true if the type codes are equal.
Otherwise,
See also:
http://java.sun.com/javase/6/docs/api/java/lang/Object.html#equals(java.lang.Object
8.292.2.5
boolean assignable (TypeCode from)
Checks if this com.rti.dds.typecode.TypeCode (p. 1611) is assignable from

the input com.rti.dds.typecode.TypeCode (p. 1611).
MT Safety:
SAFE.
This method checks if this type code is assignable from the type code provided
as a parameter.
In order to maintain the loose coupling between data producers and consumers,
especially as systems change over time, it is desirable that the two be permitted
to use slightly different versions of a type, and that the infrastructure (p. 334)
perform any necessary translation. To support type evolution and inheritance
the type system defines the is-assignable-from directed binary relationship between every pair of types in the Type System.
Intuitively, if T1 is-assignable-from T2, it means that in general it is possible,
in a structural way, to set the contents of an object of type T1 to the contents
of an object of T2 (or perhaps a subset of those contents) without leading to
incorrect interpretations of that information.
For example:
1621
struct MyBaseType {
long member_1;
};
struct MyDerivedType: MyBaseType {
long member_2;
};
The previous two types that are related to each other by an inheritance relationship are assignable.
For additional information on type assignability refer to the OMG Extensible
and Dynamic Topic Types for DDS Specification.
Parameters:
from <<in>> ( p. 279) From type code
Returns:
com.rti.dds.infrastructure.true if the this is assignable from from. Otherwise, com.rti.dds.infrastructure.false.
8.292.2.6
int length () throws BadKind
Returns the number of elements in the type described by this type code.
Length is:
The maximum length of the string for string type codes.
The maximum length of the sequence for sequence type codes.
The first dimension of the array for array type codes.
Precondition:
self kind is com.rti.dds.typecode.TCKind.TK ARRAY (p. 1528),
(p. 1528),
com.rti.dds.typecode.TCKind.TK STRING
(p. 1528)
or
com.rti.dds.typecode.TCKind.TK WSTRING (p. 1529).
MT Safety:
SAFE.
Exceptions:
com.rti.dds.infrastructure.ExceptionCode t.BadKind if the method
is invoked on an inappropriate kind of TypeCode (p. 1611) object.
1622
Class Documentation
Returns:
The bound for strings and sequences, or the number of elements for arrays
if no errors.
8.292.2.7
String name () throws BadKind
Retrieves the simple name identifying this com.rti.dds.typecode.TypeCode

(p. 1611) object within its enclosing scope.
Precondition:
self
kind
is
(p. 1528),
(p. 1528),
com.rti.dds.typecode.TCKind.TK ENUM
(p. 1528),
(p. 1529),
com.rti.dds.typecode.TCKind.TK SPARSE
(p. 1529)
or
com.rti.dds.typecode.TCKind.TK ALIAS (p. 1528).
MT Safety:
SAFE.
Exceptions:
Returns:
Name of the type code if no errors.
8.292.2.8
boolean is alias pointer () throws BadKind
Function that tells if an alias is a pointer or not.

This function is an RTI Connext extension to the CORBA Type Code Specification.
Precondition:
self kind is com.rti.dds.typecode.TCKind.TK ALIAS (p. 1528).
MT Safety:
SAFE.
1623
Exceptions:
Returns:
com.rti.dds.infrastructure.true if an alias is a pointer to the aliased type.
Otherwise, com.rti.dds.infrastructure.false.
8.292.2.9
short type modifier () throws BadKind
Returns a constant indicating the modifier of the value type that this
com.rti.dds.typecode.TypeCode (p. 1611) object describes.
Precondition:
self kind is com.rti.dds.typecode.TCKind.TK VALUE (p. 1529),
(p. 1528),
or
For com.rti.dds.typecode.TCKind.TK STRUCT (p. 1528), this method
always returns com.rti.dds.typecode.ValueModifier.VM NONE.
MT Safety:
SAFE.
Exceptions:
Returns:
One of the following type modifiers: com.rti.dds.typecode.ValueModifier.VM NONE,
com.rti.dds.typecode.ValueModifier.VM ABSTRACT,
com.rti.dds.typecode.ValueModifier.VM CUSTOM
or
com.rti.dds.typecode.ValueModifier.VM TRUNCATABLE.
8.292.2.10
TypeCode concrete base type () throws BadKind
Returns
the
(p. 1611)
that
describes the concrete base type of the value type that this
com.rti.dds.typecode.TypeCode (p. 1611) object describes.
1624
Class Documentation
Precondition:
(p. 1528),
or
MT Safety:
SAFE.
always returns com.rti.dds.typecode.TCKind.TK NULL (p. 1527).
The com.rti.dds.typecode.TypeCode (p. 1611) of structs inheriting from
other structs has a com.rti.dds.typecode.TCKind.TK VALUE (p. 1529)
kind.
For example:
struct MyStruct: MyBaseStruct {
long member_1;
};
The
code
generation
for
the
previous
type
will
ate
a
(p. 1611)
com.rti.dds.typecode.TCKind.TK VALUE (p. 1529) kind.
generwith
Exceptions:
Returns:
com.rti.dds.typecode.TypeCode (p. 1611) that describes the concrete
base type or null if there is no a concrete base type.
8.292.2.11
TypeCode content type () throws BadKind
Returns the com.rti.dds.typecode.TypeCode (p. 1611) object representing the type for the members of the object described by this
com.rti.dds.typecode.TypeCode (p. 1611) object.
For sequences and arrays, it returns the element type. For aliases, it returns
the original type.
1625
Precondition:
self kind is com.rti.dds.typecode.TCKind.TK ARRAY (p. 1528),
(p. 1528)
or
com.rti.dds.typecode.TCKind.TK ALIAS (p. 1528).
MT Safety:
SAFE.
Exceptions:
Returns:
A com.rti.dds.typecode.TypeCode (p. 1611) object representing the element type for sequences and arrays, and the original type for aliases.
8.292.2.12
int array dimension count () throws BadKind
This function returns the number of dimensions of an array type code.

Precondition:
self kind is com.rti.dds.typecode.TCKind.TK ARRAY (p. 1528).
MT Safety:
SAFE.
Exceptions:
Returns:
Number of dimensions if no errors.
8.292.2.13
int array dimension (int index) throws BadKind,Bounds
This function returns the index-th dimension of an array type code.

1626
Class Documentation
Precondition:
self kind is com.rti.dds.typecode.TCKind.TK ARRAY (p. 1528).
Dimension index in the interval [0,(dimensions count-1)].
MT Safety:
SAFE.
Parameters:
index <<in>> ( p. 279) Dimension index in the interval [0,(dimensions
count-1)].
Exceptions:
com.rti.dds.infrastructure.ExceptionCode t.Bounds - if the index
parameter/s are out of range.
Returns:
Requested dimension if no errors.
8.292.2.14
int element count () throws BadKind
The number of elements in an array.

This operation isnt relevant for other kinds of types.
MT Safety:
SAFE.
8.292.2.15
int member count () throws BadKind
Returns the number of members of the type code.

The method member count can be invoked on structure, union, and enumeration
com.rti.dds.typecode.TypeCode (p. 1611) objects.
Precondition:
self
kind
is
(p. 1528),
(p. 1528),
(p. 1528),
(p. 1529)
or
1627
MT Safety:
SAFE.
Exceptions:
Returns:
The number of members constituting the type described by this
com.rti.dds.typecode.TypeCode (p. 1611) object if no errors.
8.292.2.16
String member name (int index) throws

BadKind,Bounds
Returns the name of a type code member identified by the given index.
The method member name can be invoked on structure, union, and enumeration
Precondition:
self
kind
is
(p. 1528),
(p. 1528),
(p. 1528),
(p. 1529)
or
The index param must be in the interval [0,(member count-1)].
MT Safety:
SAFE.
Parameters:
index <<in>> ( p. 279) Member index in the interval [0,(member count1)].
Exceptions:
Returns:
Name of the member if no errors.
1628
8.292.2.17
Class Documentation
TypeCode member type (int index) throws
BadKind,Bounds
Retrieves the com.rti.dds.typecode.TypeCode (p. 1611) object describing

the type of the member identified by the given index.
The method member type can be invoked on structure and union type codes.
Precondition:
self
kind
is
com.rti.dds.typecode.TCKind.TK UNION (p. 1528),
(p. 1528),
(p. 1529)
or
MT Safety:
SAFE.
Parameters:
Exceptions:
Returns:
The com.rti.dds.typecode.TypeCode (p. 1611) object describing the
member at the given index if no errors.
8.292.2.18
int member id (int index) throws BadKind,Bounds
Returns the ID of a sparse type code member identified by the given index.
The method can be invoked on sparse com.rti.dds.typecode.TypeCode
(p. 1611) objects.
1629
Precondition:
self kind is com.rti.dds.typecode.TCKind.TK SPARSE (p. 1529).
Member index in the interval [0,(member count-1)].
MT Safety:
SAFE.
Parameters:
Exceptions:
Returns:
ID of the member if no errors.
8.292.2.19
int member label count (int index) throws

BadKind,Bounds
Returns the number of labels associated to the index-th union member.

The method can be invoked on union com.rti.dds.typecode.TypeCode
(p. 1611) objects.
Precondition:
self kind is com.rti.dds.typecode.TCKind.TK UNION (p. 1528).
MT Safety:
SAFE.
Parameters:
1630
Class Documentation
Exceptions:
Returns:
Number of labels if no errors.
8.292.2.20
int member label (int member index, int label index)

throws BadKind,Bounds
Return the label index-th label associated to the member index-th member.
This method has been modified for RTI Connext from the CORBA Type code
Specification.
Example:
case 1: Label index 0
case 2: Label index 1
short short member;
The method can be invoked on union com.rti.dds.typecode.TypeCode
(p. 1611) objects.
Precondition:
The member index param must be in the interval [0,(member count-1)].
The label index param must be in the interval [0,(member labels count-1)].
MT Safety:
SAFE.
Parameters:
member index <<in>> ( p. 279) Member index.
label index <<in>> ( p. 279) Label index.
Exceptions:
1631

Returns:
The evaluated value of the label if no errors.
8.292.2.21
int member ordinal (int index) throws BadKind,Bounds
Returns the ordinal that corresponds to the index-th enum value.

The method can be invoked on enum com.rti.dds.typecode.TypeCode
(p. 1611) objects.
Precondition:
self kind is com.rti.dds.typecode.TCKind.TK ENUM (p. 1528).
Member index in the interval [0,(member count-1)].
MT Safety:
SAFE.
Parameters:
Exceptions:
Returns:
Ordinal that corresponds to the index-th enumerator if no errors.
8.292.2.22
boolean is member key (int index) throws

BadKind,Bounds
Function that tells if a member is a key or not.

1632
Class Documentation
Precondition:
self
kind
is
(p. 1528),
(p. 1529)
or com.rti.dds.typecode.TCKind.TK SPARSE (p. 1529).
MT Safety:
SAFE.
Parameters:
Exceptions:
Returns:
com.rti.dds.infrastructure.true if the member is a key.
8.292.2.23
Otherwise,
boolean is member required (int index) throws

BadKind,Bounds
Indicates whether a given member of a type is required to be present in every

sample of that type.
Which fields are required depends on the com.rti.dds.typecode.TCKind
For example,
in a type of kind
(p. 1525) of the type.
com.rti.dds.typecode.TCKind.TK SPARSE (p. 1529), key fields are
required. In com.rti.dds.typecode.TCKind.TK STRUCT (p. 1528) and
com.rti.dds.typecode.TCKind.TK VALUE (p. 1529) types, all fields are
required.
MT Safety:
SAFE.

8.292.2.24
1633
boolean is member pointer (int index) throws

BadKind,Bounds
Function that tells if a member is a pointer or not.

The method is member pointer can be invoked on union and structs type objects
Precondition:
self
kind
is
(p. 1528)
(p. 1528),
or com.rti.dds.typecode.TCKind.TK VALUE (p. 1529).
MT Safety:
SAFE.
Parameters:
index <<in>> ( p. 279) Index of the member for which type information
is begin requested.
Exceptions:
Returns:
com.rti.dds.infrastructure.true if the member is a pointer.
8.292.2.25
Otherwise,
boolean is member bitfield (int index) throws

BadKind,Bounds
Function that tells if a member is a bitfield or not.

The method can be invoked on struct type objects.
1634
Class Documentation
Precondition:
self kind is com.rti.dds.typecode.TCKind.TK STRUCT (p. 1528) or
com.rti.dds.typecode.TCKind.TK VALUE (p. 1529).
MT Safety:
SAFE.
Parameters:
Exceptions:
Returns:
com.rti.dds.infrastructure.true if the member is a bitfield.
8.292.2.26
Otherwise,
short member bitfield bits (int index) throws

BadKind,Bounds
Returns the number of bits of a bitfield member.

The method can be invoked on struct type objects.
Precondition:
self kind is com.rti.dds.typecode.TCKind.TK STRUCT (p. 1528) or
com.rti.dds.typecode.TCKind.TK VALUE (p. 1529).
MT Safety:
SAFE.
Parameters:
1635
Exceptions:
Returns:
The
number
of
bits
of
the
com.rti.dds.typecode.TypeCode.NOT BITFIELD
the member is not a bitfield.
8.292.2.27
bitfield
(p. 1646)
or
if
short member visibility (int index) throws

BadKind,Bounds
Returns the constant that indicates the visibility of the index-th member.
Precondition:
(p. 1528)
or
MT Safety:
SAFE.
always returns com.rti.dds.typecode.Visibility.PUBLIC MEMBER.
Parameters:
Exceptions:
Returns:
One of the following constants: com.rti.dds.typecode.Visibility.PRIVATE MEMBER or com.rti.dds.typecode.Visibility.PUBLIC MEMBER.
1636
8.292.2.28
Class Documentation
TypeCode discriminator type () throws BadKind
Returns the discriminator type code.

The method discriminator type can be invoked
only
on
union
Precondition:
MT Safety:
SAFE.
Exceptions:
Returns:
com.rti.dds.typecode.TypeCode (p. 1611) object describing the discriminator of the union type if no errors.
8.292.2.29
int default index () throws BadKind
Returns the index of the default member, or -1 if there is no default member.

can
be
invoked
The
method
default index
only
on
union
Precondition:
self kind is com.rti.dds.typecode.TCKind.TK UNION (p. 1528)
MT Safety:
SAFE.
Exceptions:
Returns:
The index of the default member, or -1 if there is no default member.

8.292.2.30
1637
int find member by id (int id) throws BadKind
Get the index of the member of the given ID.

MT Safety:
SAFE.
8.292.2.31
int find member by name (String name) throws

BadKind
Get the index of the member of the given name.

MT Safety:
SAFE.
8.292.2.32
void print IDL (int indent)
Prints a com.rti.dds.typecode.TypeCode (p. 1611) in a pseudo-IDL notation.

MT Safety:
SAFE.
Parameters:
indent <<in>> ( p. 279) Indent.
8.292.2.33
void print IDL (int indent, java.io.Writer out) throws

IOException
Prints a com.rti.dds.typecode.TypeCode (p. 1611) in a pseudo-IDL notation.

MT Safety:
SAFE.
Parameters:
indent <<in>> ( p. 279) Indent.
out <<out>> ( p. 279) Output stream.
1638
8.292.2.34
Class Documentation
int add member (String name, int id,
TypeCode tc, byte member flags) throws
BadKind,BadMemberName,BadMemberId
Add a new member to this com.rti.dds.typecode.TypeCode (p. 1611).

This method is applicable to com.rti.dds.typecode.TypeCode (p. 1611)
objects representing structures (com.rti.dds.typecode.TCKind.TK STRUCT (p. 1528)), value types (com.rti.dds.typecode.TCKind.TK VALUE (p. 1529)), sparse value types (com.rti.dds.typecode.TCKind.TK SPARSE (p. 1529)), and unions (com.rti.dds.typecode.TCKind.TK To add a constant to an enumeration, see
UNION (p. 1528)).
com.rti.dds.typecode.TypeCode.add member to enum (p. 1640).
Modifying a com.rti.dds.typecode.TypeCode (p. 1611) such as by adding
a member is important if you are using the Dynamic Data (p. 175) APIs.
Heres a simple code example that adds two fields to a data type, one an integer
and another a sequence of integers.
// Integer:
myTypeCode.add_member(
"myFieldName",
// If the type is sparse, specify an ID. Otherwise, use this sentinel:
TypeCode.MEMBER_ID_INVALID,
TypeCode.TC_LONG,
// New field is not a key:
TypeCode.NONKEY_REQUIRED_MEMBER);
// Sequence of 10 or fewer integers:
myTypeCode.add_member(
"myFieldName",
// If the type is sparse, specify an ID. Otherwise, use this sentinel:
TypeCode.MEMBER_ID_INVALID,
TypeCodeFactory.get_instance().create_sequence_tc(10, TypeCode.TC_LONG),
// New field is not a key:
TypeCode.NONKEY_REQUIRED_MEMBER);
MT Safety:
UNSAFE.
Parameters:
name <<in>> ( p. 279) The name of the new member.
id <<in>>
( p. 279)
The
ID
of
the
new
member.
This should only be specified for members of kind
(p. 1529)
and
com.rti.dds.typecode.TCKind.TK UNION (p. 1528); otherwise,
it should be com.rti.dds.typecode.TypeCode.MEMBER ID INVALID (p. 1644).
1639
tc <<in>> ( p. 279) The type of the new member. You can get or
create this com.rti.dds.typecode.TypeCode (p. 1611) with the
com.rti.dds.typecode.TypeCodeFactory (p. 1647).
member flags <<in>> ( p. 279) Indicates whether the member is part
of the key and whether it is required.
Returns:
The zero-based index of the new member relative to any other members
that previously existed.
See also:
com.rti.dds.typecode.TypeCode.add member (p. 1638)
com.rti.dds.typecode.TypeCode.add member to enum (p. 1640)
com.rti.dds.typecode.TypeCodeFactory (p. 1647)
com.rti.dds.typecode.TypeCode.NONKEY MEMBER (p. 1644)
com.rti.dds.typecode.TypeCode.KEY MEMBER (p. 1645)
com.rti.dds.typecode.TypeCode.NONKEY REQUIRED MEMBER (p. 1646)
8.292.2.35
synchronized int add member (String name, int

id, TypeCode tc, byte member flags, short
visibility, boolean is pointer, short bits) throws
BadKind,BadMemberName,BadMemberId,BAD PARAM,IllegalStateException
Add a new member to this com.rti.dds.typecode.TypeCode (p. 1611).

MT Safety:
UNSAFE.
Parameters:
name <<in>> ( p. 279) The name of the new member.
id <<in>>
( p. 279)
The
ID
of
the
new
member.
This should only be specified for members of kind
(p. 1529)
and
com.rti.dds.typecode.TCKind.TK UNION (p. 1528); otherwise,
it should be com.rti.dds.typecode.TypeCode.MEMBER ID INVALID (p. 1644).
1640
Class Documentation
tc <<in>> ( p. 279) The type of the new member. You can get or
create this com.rti.dds.typecode.TypeCode (p. 1611) with the
com.rti.dds.typecode.TypeCodeFactory (p. 1647).
member flags <<in>> ( p. 279) Indicates whether the member is part
of the key and whether it is required.
visibility <<in>> ( p. 279) Whether the new member is public or
private.
Non-public members are only relevant for types of
kind com.rti.dds.typecode.TCKind.TK VALUE (p. 1529) and
com.rti.dds.typecode.TCKind.TK SPARSE (p. 1529). Possible
values include:
com.rti.dds.typecode.Visibility.PRIVATE MEMBER
com.rti.dds.typecode.Visibility.PUBLIC MEMBER
is pointer <<in>> ( p. 279) Whether the data member, in its deserialized form, should be stored by pointer as opposed to by value.
bits <<in>> ( p. 279) The number of bits, if this new member is a bit field,
or com.rti.dds.typecode.TypeCode.NOT BITFIELD (p. 1646).
Returns:
See also:
8.292.2.36
synchronized int add member to enum (String name,

int ordinal) throws BadKind,BadMemberName
Add
a
new
enumerated
constant
to
this
enum
This method is applicable to com.rti.dds.typecode.TypeCode (p. 1611)

objects representing enumerations (com.rti.dds.typecode.TCKind.TK ENUM (p. 1528)).
To add a field to a structured type, see
com.rti.dds.typecode.TypeCode.add member to enum (p. 1640).
1641
MT Safety:
UNSAFE.
Parameters:
name <<in>> ( p. 279) The name of the new member. This string must
be unique within this type and must not be null.
ordinal <<in>> ( p. 279) The relative order of the new member in this
enum or a custom integer value. The value must be unique within the
type.
Returns:
See also:
8.292.2.37
String signature () throws RETCODE ERROR
Gets an MD5 signature of the com.rti.dds.typecode.TypeCode (p. 1611).

MT Safety:
SAFE.
Returns:
MD5 signature.
8.292.3
8.292.3.1
final TypeCode TC NULL [static]
Basic null type.

See also:
com.rti.dds.typecode.TypeCodeFactory.get primitive tc (p. 1660)
1642
8.292.3.2
Class Documentation
final TypeCode TC SHORT [static]

See also:
8.292.3.3
final TypeCode TC LONG [static]

See also:
8.292.3.4
final TypeCode TC USHORT [static]

See also:
8.292.3.5
final TypeCode TC ULONG [static]

See also:
8.292.3.6
final TypeCode TC FLOAT [static]

See also:

8.292.3.7
1643
final TypeCode TC DOUBLE [static]

See also:
8.292.3.8
final TypeCode TC BOOLEAN [static]
Basic Boolean type.

See also:
8.292.3.9
final TypeCode TC CHAR [static]
Basic single-byte character type.

See also:
8.292.3.10
final TypeCode TC OCTET [static]
Basic octet/byte type.

See also:
8.292.3.11
final TypeCode TC LONGLONG [static]
Basic 64-bit integer type.

See also:
1644
8.292.3.12
Class Documentation
final TypeCode TC ULONGLONG [static]

See also:
8.292.3.13
final TypeCode TC LONGDOUBLE [static]

See also:
8.292.3.14
final TypeCode TC WCHAR [static]
Basic four-byte character type.

See also:
8.292.3.15
final int MEMBER ID INVALID [static]
A sentinel indicating an invalid com.rti.dds.typecode.TypeCode (p. 1611)

member ID.
8.292.3.16
final int MEMBER ID SPARSE UNSPECIFIED = 0

[static]
8.292.3.17
final int INDEX INVALID [static]
A sentinel indicating an invalid com.rti.dds.typecode.TypeCode (p. 1611)

member index.
8.292.3.18
final byte NONKEY MEMBER [static]
A flag indicating that a type member is optional and not part of the key.
1645
Only sparse value types (i.e. types of com.rti.dds.typecode.TCKind

(p. 1525) com.rti.dds.typecode.TCKind.TK SPARSE (p. 1529)) support this flag. Non-key members of other type kinds should use the flag
com.rti.dds.typecode.TypeCode.NONKEY REQUIRED MEMBER
(p. 1646).
If a type is used with the Dynamic Data (p. 175) facility, a
com.rti.dds.dynamicdata.DynamicData (p. 817) sample of the type will
only contain a value for a com.rti.dds.typecode.TypeCode.NONKEY MEMBER (p. 1644) field if one has been explicitly set (see, for example, com.rti.dds.dynamicdata.DynamicData.DynamicData.set int). The middleware will not assume any default value.
See also:
com.rti.dds.typecode.TypeCode.is member key (p. 1631)
com.rti.dds.typecode.TypeCode.is member required (p. 1632)
com.rti.dds.typecode.StructMember.is key (p. 1475)
com.rti.dds.typecode.ValueMember.is key (p. 1698)
8.292.3.19
final byte KEY MEMBER [static]
A flag indicating that a type member is part of the key for that type, and
therefore required.
If a type is used with the Dynamic Data (p. 175) facility, all
com.rti.dds.dynamicdata.DynamicData (p. 817) samples of the type
will contain a value for all com.rti.dds.typecode.TypeCode.KEY MEMBER (p. 1645) fields, even if the type is a sparse value type
(i.e.
of kind com.rti.dds.typecode.TCKind.TK SPARSE (p. 1529)).
If you do not set a value of the member explicitly (see, for example,
com.rti.dds.dynamicdata.DynamicData.DynamicData.set int), the middleware
will assume a default zero value: numeric values will be set to zero; strings
and sequences will be of zero length.
See also:
1646
Class Documentation

8.292.3.20
final byte NONKEY REQUIRED MEMBER [static]
A flag indicating that a type member is not part of the key but is nevertheless
required.
This is the most common kind of member.
If a type is used with the Dynamic Data (p. 175) facility, all
com.rti.dds.dynamicdata.DynamicData (p. 817) samples of the type will
contain a value for all com.rti.dds.typecode.TypeCode.NONKEY REQUIRED MEMBER (p. 1646) fields, even if the type is a sparse value
type (i.e. of kind com.rti.dds.typecode.TCKind.TK SPARSE (p. 1529)).
If you do not set a value of the member explicitly (see, for example,
com.rti.dds.dynamicdata.DynamicData.DynamicData.set int), the middleware
will assume a default zero value: numeric values will be set to zero; strings
and sequences will be of zero length.
See also:
8.292.3.21
final short NOT BITFIELD [static]
Indicates that a member of a type is not a bitfield.
8.293 TypeCodeFactory Class Reference
8.293
1647
TypeCodeFactory Class Reference
dynamically.

TypeCode create struct tc (String name, ExtensibilityKind extensibility kind, StructMember[ ] members) throws BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK STRUCT ( p. 1528)
TypeCode create struct tc (String name, StructMember[ ] members) throws BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK STRUCT ( p. 1528)
TypeCode create value tc (String name, ExtensibilityKind

extensibility kind, short type modifier, TypeCode concrete base,
ValueMember[ ] members) throws BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK VALUE
( p. 1529)
TypeCode create value tc (String name, short type modifier, TypeCode concrete base, ValueMember[ ] members) throws BAD PARAM
( p. 1529)
TypeCode create sparse tc (String name, short type modifier, TypeCode concrete base) throws BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK SPARSE
( p. 1529)
TypeCode create union tc (String name, ExtensibilityKind extensibility kind, TypeCode discriminator type, int default index,
UnionMember[ ] members) throws BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK UNION
( p. 1528)
TypeCode create union tc (String name, TypeCode discriminator type, int default index, UnionMember[ ] members) throws BAD PARAM
1648
Class Documentation
( p. 1528)
TypeCode create enum tc (String name, ExtensibilityKind extensibility kind, EnumMember[ ] members) throws BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK ENUM
( p. 1528)
TypeCode create enum tc (String name, EnumMember[ ] members)

throws BAD PARAM
( p. 1528)
TypeCode create alias tc (String name, TypeCode original type,

boolean is pointer) throws BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK ALIAS ( p. 1528) (typedef ) com.rti.dds.typecode.TypeCode ( p. 1611).
TypeCode create string tc (int bound) throws BAD PARAM

Constructs a com.rti.dds.typecode.TCKind.TK STRING ( p. 1528)
TypeCode create wstring tc (int bound) throws BAD PARAM

Constructs a com.rti.dds.typecode.TCKind.TK WSTRING ( p. 1529)
TypeCode create sequence tc (int bound, TypeCode element type)

throws BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK SEQUENCE ( p. 1528)
TypeCode create array tc (int[ ] dimensions, TypeCode element type) throws BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK ARRAY
( p. 1528)
TypeCode create array tc (int length, TypeCode element type)

throws BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK ARRAY ( p. 1528)
com.rti.dds.typecode.TypeCode ( p. 1611) for a single-dimensional array.
TypeCode clone tc (TypeCode tc)

Creates and returns a copy of the input com.rti.dds.typecode.TypeCode
( p. 1611).
1649
void delete tc (TypeCode tc)

Deletes the input com.rti.dds.typecode.TypeCode ( p. 1611).
TypeCode get primitive tc (TCKind kind) throws BAD PARAM

Get the com.rti.dds.typecode.TypeCode ( p. 1611) for a primitive
type (integers, floating point values, etc.)
identified by the given
com.rti.dds.typecode.TCKind ( p. 1525).

static final TypeCodeFactory get instance ()
8.293.1
dynamically.
You can access the singleton with the com.rti.dds.typecode.TypeCodeFactory.get instance (p. 1650) method.
If you want to publish and subscribe to data of types that are not known to
you at system design time, this class will be your starting point. After creating
a data type definition with this class, you will modify that definition using the
com.rti.dds.typecode.TypeCode (p. 1611) class and then register it with the
Dynamic Data (p. 175) API.
The methods of this class fall into several categories:
Getting definitions for primitive types:
Type definitions for primitive types (e.g. integers, floating point values, etc.)
are pre-defined; your application only needs to get them, not create them.
Creating definitions for strings, arrays, and sequences:
Type definitions for strings, arrays, and sequences (i.e. variables-size lists) must
be created as you need them, because the type definition includes the maximum
length of those containers.
com.rti.dds.typecode.TypeCodeFactory.create wstring tc
(p. 1658)
1650
Class Documentation
com.rti.dds.typecode.TypeCodeFactory.TypeCodeFactory.create array tc
com.rti.dds.typecode.TypeCodeFactory.create sequence tc
(p. 1658)
Creating definitions for structured types:

Structured types include structures, value types, sparse value types, and unions.
com.rti.dds.typecode.TypeCodeFactory.create sparse tc (p. 1653)
Creating definitions for other types:
The type system also supports enumerations and aliases (i.e. typedefs in C
and C++).
com.rti.dds.typecode.TypeCodeFactory.create alias tc (p. 1657)
Deleting type definitions:
When youre finished using a type definition, you should delete it. (Note
that you only need to delete a com.rti.dds.typecode.TypeCode
that
you
created ;
if
you
got
the
object
from
(p. 1611)
(p. 1660),
you must not delete it.)
com.rti.dds.typecode.TypeCodeFactory.delete tc (p. 1660)
Copying type definitions:
You can also create deep copies of type definitions:
com.rti.dds.typecode.TypeCodeFactory.clone tc (p. 1660)
8.293.2
8.293.2.1
static final TypeCodeFactory get instance () [static]

1651
Returns:
The com.rti.dds.typecode.TypeCodeFactory (p. 1647) instance if no
errors. Otherwise, null.
8.293.2.2
TypeCode create struct tc (String name,

ExtensibilityKind extensibility kind, StructMember[ ]
members) throws BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK STRUCT

(p. 1528)
Parameters:
name <<in>> ( p. 279) Name of the struct type. Cannot be null.
extensibility kind <<in>> ( p. 279) Type extensibility.
members <<in>>
( p. 279)
Initial
members
of
the
structure.
This
list
may
be
empty
(that
is,
may return zero). If the list is not empty, the elements must describe
valid struct members. (For example, the names must be unique
within the type.) This argument may be null.
Exceptions:
com.rti.dds.infrastructure.ExceptionCode t.BAD PARAM.
Returns:
A newly-created com.rti.dds.typecode.TypeCode (p. 1611) object describing a struct.
8.293.2.3
TypeCode create struct tc (String name,

StructMember[ ] members) throws BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK STRUCT

(p. 1528)
Parameters:
name <<in>> ( p. 279) Name of the struct type. Cannot be null.
members <<in>>
structure.
( p. 279)
This
list
Initial
may
be
members
empty
of
(that
the
is,
1652
Class Documentation
may return zero). If the list is not empty, the elements must describe
valid struct members. (For example, the names must be unique
Exceptions:
Returns:
A newly-created com.rti.dds.typecode.TypeCode (p. 1611) object describing a struct.
8.293.2.4
TypeCode create value tc (String name,

ExtensibilityKind extensibility kind, short type modifier,
TypeCode concrete base, ValueMember[ ] members)
throws BAD PARAM

(p. 1529)
Parameters:
name <<in>> ( p. 279) Name of the value type. Cannot be null.
type modifier <<in>> ( p. 279) One of the value type modifier
constants:
com.rti.dds.typecode.ValueModifier.VM NONE,
com.rti.dds.typecode.ValueModifier.VM CUSTOM,
com.rti.dds.typecode.ValueModifier.VM ABSTRACT
or
concrete base <<in>> ( p. 279) com.rti.dds.typecode.TypeCode
(p. 1611) object describing the concrete valuetype base. It may be
null if the valuetype does not have a concrete base.
members <<in>> ( p. 279) Initial members of the value type. This list
may be empty. If the list is not empty, the elements must describe
valid value type members. (For example, the names must be unique
Exceptions:
1653
Returns:
A newly-created com.rti.dds.typecode.TypeCode (p. 1611) object describing a value.
8.293.2.5
TypeCode create value tc (String name, short

type modifier, TypeCode concrete base, ValueMember[ ]

(p. 1529)
Parameters:
constants:
or
members <<in>> ( p. 279) Initial members of the value type. This list
may be empty. If the list is not empty, the elements must describe
valid value type members. (For example, the names must be unique
Exceptions:
Returns:
8.293.2.6
TypeCode create sparse tc (String name, short

type modifier, TypeCode concrete base) throws
BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK SPARSE

(p. 1529)
1654
Class Documentation
A sparse value type is similar to other value types but with one major difference:
not all members need to be present in every sample.
It is not possible to generate code for sparse value types; they must be created
at runtime using these APIs. You will interact with samples of sparse types
using the Dynamic Data (p. 175) APIs.
Parameters:
constants:
or
Exceptions:
Returns:
8.293.2.7
TypeCode create union tc (String name,

ExtensibilityKind extensibility kind, TypeCode
discriminator type, int default index, UnionMember[ ]

(p. 1528)
Parameters:
name <<in>> ( p. 279) Name of the union type. Cannot be null.
discriminator type <<in>> ( p. 279) Discriminator Type Code. Cannot be null.
default index <<in>> ( p. 279) Index of the default member, or -1 if
there is no default member.
1655
members <<in>> ( p. 279) Initial members of the union. This list may
be empty. If the list is not empty, the elements must describe valid
struct members. (For example, the names must be unique within the
type.) This argument may be null.
Exceptions:
Returns:
A newly-created com.rti.dds.typecode.TypeCode (p. 1611) object describing a union.
8.293.2.8
TypeCode create union tc (String name, TypeCode

discriminator type, int default index, UnionMember[ ]

(p. 1528)
Parameters:
name <<in>> ( p. 279) Name of the union type. Cannot be null.
discriminator type <<in>> ( p. 279) Discriminator Type Code. Cannot be null.
default index <<in>> ( p. 279) Index of the default member, or -1 if
there is no default member.
members <<in>> ( p. 279) Initial members of the union. This list may
be empty. If the list is not empty, the elements must describe valid
struct members. (For example, the names must be unique within the
type.) This argument may be null.
Exceptions:
Returns:
A newly-created com.rti.dds.typecode.TypeCode (p. 1611) object describing a union.
1656
8.293.2.9
Class Documentation
TypeCode create enum tc (String name,
ExtensibilityKind extensibility kind, EnumMember[ ]

(p. 1528)
Parameters:
name <<in>> ( p. 279) Name of the enum type. Cannot be null.
members <<in>> ( p. 279) Initial members of the enumeration. All
members must have non-null names, and both names and ordinal values must be unique within the type. Note that it is also possible to
add members later with com.rti.dds.typecode.TypeCode.add member to enum (p. 1640). This argument may be null.
Exceptions:
Returns:
A newly-created com.rti.dds.typecode.TypeCode (p. 1611) object describing an enumeration.
8.293.2.10
TypeCode create enum tc (String name,

EnumMember[ ] members) throws BAD PARAM

(p. 1528)
Parameters:
name <<in>> ( p. 279) Name of the enum type. Cannot be null.
members <<in>> ( p. 279) Initial members of the enumeration. All
members must have non-null names, and both names and ordinal values must be unique within the type. Note that it is also possible to
add members later with com.rti.dds.typecode.TypeCode.add member to enum (p. 1640). This argument may be null.
Exceptions:
1657
Returns:
A newly-created com.rti.dds.typecode.TypeCode (p. 1611) object describing an enumeration.
8.293.2.11
TypeCode create alias tc (String name, TypeCode

original type, boolean is pointer) throws BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK ALIAS (p. 1528) (typedef) com.rti.dds.typecode.TypeCode (p. 1611).

Parameters:
name <<in>> ( p. 279) Name of the alias. Cannot be null.
original type <<in>> ( p. 279) Aliased type code. Cannot be null.
is pointer <<in>> ( p. 279) Indicates if the alias is a pointer to the
aliased type code.
Exceptions:
Returns:
A newly-created com.rti.dds.typecode.TypeCode (p. 1611) object describing an alias.
8.293.2.12
TypeCode create string tc (int bound) throws

BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK STRING

(p. 1528)
Parameters:
bound <<in>> ( p. 279) Maximum length of the string. It cannot be
negative.
Exceptions:
Returns:
A newly-created com.rti.dds.typecode.TypeCode (p. 1611) object describing a string.
1658
8.293.2.13
Class Documentation
TypeCode create wstring tc (int bound) throws
BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK WSTRING (p. 1529)

Parameters:
bound <<in>> ( p. 279) Maximum length of the wide string. It cannot
be negative.
Exceptions:
Returns:
A newly-created com.rti.dds.typecode.TypeCode (p. 1611) object describing a wide string.
8.293.2.14
TypeCode create sequence tc (int bound, TypeCode

element type) throws BAD PARAM
Constructs a com.rti.dds.typecode.TCKind.TK SEQUENCE (p. 1528)

Parameters:
bound <<in>> ( p. 279) The bound for the sequence (> 0).
element type <<in>> ( p. 279) com.rti.dds.typecode.TypeCode
(p. 1611) object describing the sequence elements.
Exceptions:
Returns:
A newly-created com.rti.dds.typecode.TypeCode (p. 1611) object describing a sequence.

8.293.2.15
1659
TypeCode create array tc (int[ ] dimensions, TypeCode

Constructs a com.rti.dds.typecode.TCKind.TK ARRAY

(p. 1528)
Parameters:
dimensions <<in>> ( p. 279) Dimensions of the array. Each dimension
has to be greater than 0.
(p. 1611) describing the array elements. Cannot be null.
Exceptions:
Returns:
8.293.2.16
TypeCode create array tc (int length, TypeCode

Constructs a com.rti.dds.typecode.TCKind.TK ARRAY (p. 1528)

com.rti.dds.typecode.TypeCode (p. 1611) for a single-dimensional array.
Parameters:
length <<in>> ( p. 279) Length of the single-dimensional array.
(p. 1611) describing the array elements. Cannot be null.
Exceptions:
Returns:
1660
8.293.2.17
Class Documentation
TypeCode clone tc (TypeCode tc)
Creates and returns a copy of the input com.rti.dds.typecode.TypeCode

(p. 1611).
Parameters:
tc <<in>> ( p. 279) Type code that will be copied. Cannot be null.
Returns:
A clone of tc.
8.293.2.18
void delete tc (TypeCode tc)
Deletes the input com.rti.dds.typecode.TypeCode (p. 1611).

Calling this method is optional. If you do not call it, the garbage collector will
perform the deletion when it is able.
Parameters:
tc <<inout>> ( p. 279) Type code that will be deleted. Cannot be null.
8.293.2.19
TypeCode get primitive tc (TCKind kind) throws

BAD PARAM
Get the com.rti.dds.typecode.TypeCode (p. 1611) for a primitive

type (integers, floating point values, etc.)
identified by the given
com.rti.dds.typecode.TCKind (p. 1525).
See also:
com.rti.dds.typecode.TypeCode.TypeCode.TC
LONG
ULONG
SHORT
USHORT
FLOAT
DOUBLE
LONGDOUBLE
OCTET
BOOLEAN
CHAR
WCHAR
8.294 TypeConsistencyEnforcementQosPolicy Class Reference 1661
8.294
TypeConsistencyEnforcementQosPolicy
Class Reference
(p. 359) is consistent with that used to subscribe to it.
Inheritance diagram for TypeConsistencyEnforcementQosPolicy::
Public Attributes
TypeConsistencyKind kind
Type consistency kind.
8.294.1
(p. 359) is consistent with that used to subscribe to it.
This
policy
defines
a
type
consistency
kind,
which
allows applications to select from among a set of predetermined policies.
The following consistency kinds are specified:
com.rti.dds.infrastructure.TypeConsistencyKind.TypeConsistencyKind.DISALLOW TYPE COERCION and com.rti.dds.infrastructure.TypeConsistencyKind.TypeConsistencyKind.ALLOW TYPE COERCION.
The default enforcement kind is com.rti.dds.infrastructure.TypeConsistencyKind.TypeConsistencyKind.ALLOW TYPE COERCION. However, when the middleware is introspecting the
built-in topic (p. 359) data declaration of a remote DataReader in order
to determine whether it can match with a local DataWriter, if it observes
that no TypeConsistencyEnforcementQosPolicy (p. 1661) value is
provided (as would be the case when communicating with a Service implementation not in conformance with this specification), it assumes a kind of
com.rti.dds.infrastructure.TypeConsistencyKind.TypeConsistencyKind.DISALLOW TYPE COERCION.
Entity:
Properties:
RxO (p. 101) = N/A
1662
Class Documentation
8.294.2
8.294.2.1
TypeConsistencyKind kind
Type consistency kind.

[default] com.rti.dds.infrastructure.TypeConsistencyKind.TypeConsistencyKind.ALLOW TYPE COERCION
8.295 TypeConsistencyKind Class Reference
8.295
1663
TypeConsistencyKind Class Reference

Inheritance diagram for TypeConsistencyKind::

static
final
COERCION
TypeConsistencyKind
DISALLOW TYPE -
The DataWriter and the DataReader must support the same data type in
order for them to communicate.
static final TypeConsistencyKind ALLOW TYPE COERCION

The DataWriter and the DataReader need not support the same data type in
order for them to communicate as long as the DataReaders type is assignable
from the DataWriters type.
8.295.1

QoS:
com.rti.dds.infrastructure.TypeConsistencyEnforcementQosPolicy
(p. 1661)
8.295.2
8.295.2.1
final TypeConsistencyKind DISALLOW TYPE COERCION [static]
The DataWriter and the DataReader must support the same data type in order
for them to communicate.
This is the degree of type consistency enforcement required by the OMG DDS
Specification prior to the OMG Extensible and Dynamic Topic Types for
DDS Specification.
1664
8.295.2.2
Class Documentation
final TypeConsistencyKind ALLOW TYPE COERCION
[static]
The DataWriter and the DataReader need not support the same data type in
order for them to communicate as long as the DataReaders type is assignable
from the DataWriters type.
For example, the following two extensible types will be assignable to each other
since MyDerivedType contains all the members of MyBaseType (member 1)
plus some additional elements (member 2).
struct MyBaseType {
long member_1;
};
struct MyDerivedType: MyBaseType {
long member_2;
};
Even if MyDerivedType was not explicitly inheriting from MyBaseType the

types would still be assignable. For example:
struct MyBaseType {
long member_1;
};
struct MyDerivedType {
long member_1;
long member_2;
};
For additional information on type assignability refer to the OMG Extensible

and Dynamic Topic Types for DDS Specification.
[default]
8.296 TypeSupport Interface Reference
8.296
1665
TypeSupport Interface Reference
<<interface>> ( p. 279) An abstract marker interface that has to be specialized for each concrete user data type that will be used by the application.
Inheritance diagram for TypeSupport::
8.296.1
<<interface>> ( p. 279) An abstract marker interface that has to be specialized for each concrete user data type that will be used by the application.
The implementation provides an automatic means to generate a type-specific
class, com.rti.ndds.example.FooTypeSupport (p. 1036), from a description
of the type in IDL.
A com.rti.dds.topic.TypeSupport (p. 1665) must be registered using
the com.rti.ndds.example.FooTypeSupport.register type (p. 1037) operation on this type-specific class before it can be used to create
com.rti.dds.topic.Topic (p. 1545) objects.
See also:
rtiddsgen (p. 298)
1666
Class Documentation
8.297
TypeSupportQosPolicy Class Reference
Allows you to attach application-specific values to a DataWriter or DataReader

that are passed to the serialization or deserialization routine of the associated
data type.
Inheritance diagram for TypeSupportQosPolicy::
Public Attributes
transient Object plugin data
Value to pass into the type plugins de-/serialization function.
8.297.1
Allows you to attach application-specific values to a DataWriter or DataReader

that are passed to the serialization or deserialization routine of the associated
data type.
The purpose of this QoS is to allow a user application to pass data to a type
plugins support functions.
Entity:
(p. 487),
Properties:
RxO (p. 101) = N/A
8.297.2
Usage
This QoS policy allows you to associate a pointer to an obor

ject
with
a
(p. 557)
com.rti.dds.subscription.DataReader (p. 487). This object pointer is
passed to the serialization routine of the data type associated with the
com.rti.dds.publication.DataWriter (p. 557) or the deserialization routine
of the data type associated with the com.rti.dds.subscription.DataReader
(p. 487).
8.297 TypeSupportQosPolicy Class Reference
1667
You can modify the rtiddsgen-generated code so that the de/serialization routines act differently depending on the information passed in via the object
pointer. (The generated serialization and deserialization code does not use the
pointer.)
This functionality can be used to
ized on a per DataWriter and DataReader
change how data sent by a

or
received
by
a
(p. 557)
(p. 487) is serialized or deserialbasis.
It can also be used to dynamically change how serialization (or for a less common case, deserialization) occurs. For example, a data type could represent
a table, including the names of the rows and columns. However, since the
row/column names of an instance of the table (a Topic) dont change, they
only need to be sent once. The information passed in through the TypeSupport QoS policy could be used to signal the serialization routine to send the
row/column names the first time a com.rti.dds.publication.DataWriter
(p. 557) calls com.rti.ndds.example.FooDataWriter.write (p. 1021), and
then never again.
8.297.3
8.297.3.1
transient Object plugin data
Value to pass into the type plugins de-/serialization function.

[default] NULL
1668
Class Documentation
8.298
UDPv4Transport Interface Reference
Built-in transport (p. 376) plug-in using UDP/IPv4.

Inheritance diagram for UDPv4Transport::

static final int BLOCKING NEVER
Value for com.rti.ndds.transport.UDPv4Transport.Property t.send blocking ( p. 1677) to specify non-blocking sockets.
static final int BLOCKING ALWAYS

[default] Value for com.rti.ndds.transport.UDPv4Transport.Property t.send blocking ( p. 1677) to specify blocking sockets.
Classes
class Property t
Configurable IPv4/UDP Transport-Plugin properties.
8.298.1

This transport (p. 376) plugin uses UDPv4 sockets to send and receive messages. It supports both unicast and multicast communications in a single instance of the plugin. By default, this plugin will use all interfaces that it finds
enabled and UP at instantiation time to send and receive messages.
The
user
can
configure
an
instance
of
this
plugin
to
only
use
unicast
or
only
use
multicast,
see
com.rti.ndds.transport.UDPv4Transport.Property t.unicast enabled
(p. 1674)
and
com.rti.ndds.transport.UDPv4Transport.Property t.multicast enabled (p. 1674).
In addition, the user can configure an instance of this plugin to selectively use the network interfaces of a node (and restrict a plugin from sending multicast messages on specific interfaces) by specifying the white and black lists in the base propertys fields
8.298 UDPv4Transport Interface Reference
1669
(com.rti.ndds.transport.Transport.Property t.allow interfaces com.rti.ndds.transport.Transport.Property t.deny list (p. 1575),

interfaces list (p. 1575), com.rti.ndds.transport.Transport.Property t.allow multicast interfaces list (p. 1576), com.rti.ndds.transport.Transport.Property t.deny multicast interfaces list (p. 1576)).
RTI Connext can implicitly create this plugin and register with the
is specified in com.rti.dds.infrastructure.TransportBuiltinQosPolicy
(p. 1580).
To specify the properties of the builtin UDPv4 transport (p. 376) that is implicitly registered, you can either:
call
specify
the
predefined
property
names
in
UDPv4 Transport Property Names in Property QoS Policy of
Domain Participant (p. 1669)). Builtin transport (p. 376) plugin properties specified in com.rti.dds.infrastructure.PropertyQosPolicy
(p. 1236)
always
overwrite
the
ones
specified
through
com.rti.ndds.transport.TransportSupport.set builtin transport property() (p. 1603). The default value is assumed on
any unspecified property.
Note that all properties should be set before the transport (p. 376) is implicitly created and registered by RTI Connext. Any properties set after the builtin
transport (p. 376) is registered will be ignored. See Built-in Transport Plugins (p. 222) for details on when a builtin transport (p. 376) is registered.
8.298.2
UDPv4 Transport Property Names in Property

QoS Policy of Domain Participant
set in com.rti.dds.infrastructure.PropertyQosPolicy (p. 1236) of a
UDPv4 transport (p. 376) plugin.
See also:
1670
Class Documentation
8.298.3
8.298.3.1
final int BLOCKING NEVER [static]
Value for com.rti.ndds.transport.UDPv4Transport.Property t.send blocking (p. 1677) to specify non-blocking sockets.
8.298.3.2
final int BLOCKING ALWAYS [static]
[default] Value for com.rti.ndds.transport.UDPv4Transport.Property t.send blocking (p. 1677) to specify blocking sockets.

Property Name
1671
Description
See
dds.transport.UDPv4.builtin.parent.address
bit count
t.address bit count
(p. 1573)
See
dds.transport.UDPv4.builtin.parent.properties
bitmap
t.properties bitmap
(p. 1574)
See
dds.transport.UDPv4.builtin.parent.gather
(p. 1574)
See
dds.transport.UDPv4.builtin.parent.message
size max
t.message size max
(p. 1574)
See
dds.transport.UDPv4.builtin.parent.allow
interfaces
and
example (p. 375), 127.0.0.1,eth0
See
dds.transport.UDPv4.builtin.parent.deny
interfaces
and
example (p. 375): 127.0.0.1,eth0
See
(p. 1576) and
Generated on Mon Aug 13 09:02:20 2012 for comma
RTI Connext
Java API
by DoxygenFor
delimiting
an interface.
example (p. 375): 127.0.0.1,eth0
See
(p. 1576) and
1672
Class Documentation
8.299
UDPv4Transport.Property t Class Reference

Inheritance diagram for UDPv4Transport.Property t::

Property t ()
Public Attributes
int send socket buffer size
Size in bytes of the send buffer of a socket used for sending.
int recv socket buffer size

Size in bytes of the receive buffer of a socket used for receiving.
int unicast enabled

Allows the transport ( p. 376) plugin to use unicast for sending and receiving.
int multicast enabled

Allows the transport ( p. 376) plugin to use multicast for sending and receiving.
int multicast ttl

Value for the time-to-live parameter for all multicast sends using this plugin.
int multicast loopback disabled

Prevents the transport ( p. 376) plugin from putting multicast packets onto
the loopback interface.
int ignore loopback interface

Prevents the transport ( p. 376) plugin from using the IP loopback interface.
int ignore nonup interfaces

Prevents the transport ( p. 376) plugin from using a network interface that
is not reported as UP by the operating system.
int ignore nonrunning interfaces

8.299 UDPv4Transport.Property t Class Reference
1673
is not reported as RUNNING by the operating system.
int no zero copy

Prevents the transport ( p. 376) plugin from doing a zero copy.
int send blocking

Control blocking behavior of send sockets. CHANGING THIS FROM THE
DEFAULT CAN CAUSE SIGNIFICANT PERFORMANCE PROBLEMS.
long transport priority mask

Set mask for use of transport ( p. 376) priority field.
int transport priority mapping low

Set low value of output range to IPv4 TOS.
int transport priority mapping high

Set high value of output range to IPv4 TOS.
long interface poll period

Specifies the period in milliseconds to query for changes in the state of all
the interfaces.
int reuse multicast receive resource

Controls whether or not to reuse multicast receive resources.
int protocol overhead max

Maximum size in bytes of protocol overhead, including headers.
8.299.1

The properties in this structure can be modified by the end user to configure the
plugin. However, the properties must be set before the plugin is instantiated.
See also:
1674
Class Documentation
8.299.2
8.299.2.1
Property t ()
Create an empty UDPv4Transport (p. 1668) property with default values
8.299.3
8.299.3.1

On most operating systems, setsockopt() will be called to set the SENDBUF
to the value of this parameter.
This
value
must
be
greater
than
or
equal
(p. 1574). The maximum value is operating system-dependent.
8.299.3.2
to

On most operating systems, setsockopt() will be called to set the RECVBUF
This
value
must
be
greater
than
or
equal
8.299.3.3
to
int unicast enabled
Allows the transport (p. 376) plugin to use unicast for sending and receiving.
This value turns unicast UDP on (if set to 1) or off (if set to 0) for this plugin.
By default, it will be turned on (1). Also by default, the plugin will use all
the allowed network interfaces that it finds up and running when the plugin is
instanced.
8.299.3.4
Allows the transport (p. 376) plugin to use multicast for sending and receiving.
This value turns multicast UDP on (if set to 1) or off (if set to 0) for this
plugin. By default, it will be turned on (1) for those platforms that support
1675
multicast. Also by default, the plugin will use the all network interfaces allowed
for multicast that it finds up and running when the plugin is instanced.
8.299.3.5
int multicast ttl
This value is used to set the TTL of multicast packets sent by this transport
(p. 376) plugin.
See also:
NDDS TRANSPORT UDPV4 MULTICAST TTL DEFAULT
8.299.3.6
Prevents the transport (p. 376) plugin from putting multicast packets onto the
loopback interface.
If multicast loopback is disabled (this value is set to 1), then when sending multicast packets, RTI Connext will not put a copy of the packets on the loopback
interface. This prevents applications on the same node (including itself) from
receiving those packets.
This value is set to 0 by default, meaning multicast loopback is enabled .
Disabling multicast loopback (setting this value to 1) may result in minor performance gains when using multicast.
[NOTE: Windows CE systems do not support multicast loopback. This field is
ignored for Windows CE targets.]
8.299.3.7
Prevents the transport (p. 376) plugin from using the IP loopback interface.
Currently three values are allowed:
0: Forces local traffic to be sent over loopback, even if a more efficient
transport (p. 376) (such as shared memory) is installed (in which case
traffic will be sent over both transports).
1: Disables local traffic via this plugin. The IP loopback interface is
not used, even if no NICs are discovered. This is useful when you want
applications running on the same node to use a more efficient plugin (such
as shared memory) instead of the IP loopback.
1676
Class Documentation
-1: Automatic. Lets RTI Connext decide between the above two choices.
The current automatic (-1) RTI Connext policy is as follows.

If a shared memory transport (p. 376) plugin is available for local traffic,
the effective value is 1 (i.e., disable UPV4 local traffic).
Otherwise, the effective value is 0 (i.e., use UDPv4 for local traffic also).
[default] -1 Automatic RTI Connext policy based on availability of the shared
memory transport (p. 376).
8.299.3.8
int ignore nonup interfaces
Prevents the transport (p. 376) plugin from using a network interface that is
not reported as UP by the operating system.
The transport (p. 376) checks the flags reported by the operating system for
each network interface upon initialization. An interface which is not reported as
UP will not be used. This property allows the user to configure the transport
(p. 376) to start using even the interfaces which were not reported as UP.
Two values are allowed:
0: Allow the use of interfaces which were not reported as UP.
1: Do not use interfaces which were not reported as UP.
[default] 1
8.299.3.9
not reported as RUNNING by the operating system.
UP will not be used. This property allows the same check to be extended to the
IFF RUNNING flag implemented by some operating systems. The RUNNING
flag is defined to mean that all resources are allocated, and may be off if there
is no link detected, e.g., the network cable is unplugged.
0: Do not check the RUNNING flag when enumerating interfaces, just
make sure the interface is UP.
1677
1: Check the flag when enumerating interfaces, and ignore those that are
not reported as RUNNING. This can be used on some operating systems
to cause the transport (p. 376) to ignore interfaces that are enabled but
not connected to the network.
[default] 0 (i.e., do not check RUNNING flag)
8.299.3.10
int no zero copy
Prevents the transport (p. 376) plugin from doing a zero copy.
By default, this plugin will use the zero copy on OSs that offer it. While this is
good for performance, it may sometime tax the OS resources in a manner that
cannot be overcome by the application.
The best example (p. 375) is if the hardware/device driver lends the buffer to
the application itself. If the application does not return the loaned buffers soon
enough, the node may error or malfunction. In case you cannot reconfigure the
H/W, device driver, or the OS to allow the zero copy feature to work for your
application, you may have no choice but to turn off zero copy use.
By default this is set to 0, so RTI Connext will use the zero-copy API if offered
by the OS.
8.299.3.11
int send blocking

Currently two values are defined:
NDDS TRANSPORT UDPV4 BLOCKING ALWAYS:
are blocking (default socket options for Operating System).
Sockets
NDDS TRANSPORT UDPV4 BLOCKING NEVER:

Sockets
are modified to make them non-blocking. THIS IS NOT A SUPPORTED CONFIGURATION AND MAY CAUSE SIGNIFICANT
PERFORMANCE PROBLEMS.
[default] NDDS TRANSPORT UDPV4 BLOCKING ALWAYS.
8.299.3.12
Set mask for use of transport (p. 376) priority field.

1678
Class Documentation
This is used in conjunction with com.rti.ndds.transport.UDPv4Transport.Property (p. 1678)

and
t.transport priority mapping low
com.rti.ndds.transport.UDPv4Transport.Property t.transport priority mapping high (p. 1678) to define the mapping from DDS transport
(p. 376) priority (see TRANSPORT PRIORITY (p. 126)) to the IPv4 TOS
field. Defines a contiguous region of bits in the 32-bit transport (p. 376)
priority value that is used to generate values for the IPv4 TOS field on an
outgoing socket.
For example (p. 375), the value 0x0000ff00 causes bits 9-16 (8 bits) to be used
in the mapping. The value will be scaled from the mask range (0x0000 - 0xff00
in this case) to the range specified by low and high.
If the mask is set to zero, then the transport (p. 376) will not set IPv4 TOS
for send sockets.
[default] 0.
8.299.3.13
Set low value of output range to IPv4 TOS.

This is used in conjunction with com.rti.ndds.transport.UDPv4Transport.Property t.transport priority mask (p. 1677) and com.rti.ndds.transport.UDPv4Transport.Property t.transport priority mapping high (p. 1678) to define the mapping from
DDS transport (p. 376) priority to the IPv4 TOS field. Defines the low value
of the output range for scaling.
Note that IPv4 TOS is generally an 8-bit value.
[default] 0.
8.299.3.14
Set high value of output range to IPv4 TOS.

This is used in conjunction with com.rti.ndds.transport.UDPv4Transport.Property t.transport priority mask (p. 1677) and com.rti.ndds.transport.UDPv4Transport.Property t.transport priority mapping low (p. 1678) to define the mapping from
DDS transport (p. 376) priority to the IPv4 TOS field. Defines the high value
of the output range for scaling.
Note that IPv4 TOS is generally an 8-bit value.
[default] 0xff.

8.299.3.15
1679
long interface poll period
Specifies the period in milliseconds to query for changes in the state of all the
interfaces.
The value of this property is ignored if ignore non interfaces is 1. If ignore nonup interfaces is 0 then the UDPv4 transport (p. 376) creates a new thread
to query the status of the interfaces. This property specifies the polling period
in milliseconds for performing this query.
[default] 500 milliseconds.
8.299.3.16
int reuse multicast receive resource
Controls whether or not to reuse multicast receive resources.

Setting this to 0 (FALSE) prevents multicast crosstalk by uniquely configuring
a port and creating a receive thread for each multicast group address.
[default] 0.
8.299.3.17
int protocol overhead max
Maximum size in bytes of protocol overhead, including headers.

This value is the maximum size, in bytes, of protocol-related overhead. Normally, the overhead accounts for UDP and IP headers. The default value is set
to accommodate the most common UDP/IP header size.
Note that when com.rti.ndds.transport.Transport.Property t.message size max (p. 1574) plus this overhead is larger than the UDPv4 maximum message size (65535 bytes), the middleware will automatically reduce the effective
message size max, to 65535 minus this overhead.
[default] 28.
See also:
(p. 1574)
1680
Class Documentation
8.300
UDPv6Transport Interface Reference

Inheritance diagram for UDPv6Transport::

static final int BLOCKING NEVER
Value for com.rti.ndds.transport.UDPv6Transport.Property t.send blocking ( p. 1688) to specify non-blocking sockets.
static final int BLOCKING ALWAYS

[default] Value for com.rti.ndds.transport.UDPv6Transport.Property t.send blocking ( p. 1688) to specify blocking sockets.
Classes
class Property t
8.300.1

This transport (p. 376) plugin uses UDPv6 sockets to send and receive messages. It supports both unicast and multicast communications in a single instance of the plugin. By default, this plugin will use all interfaces that it finds
enabled and UP at instantiation time to send and receive messages.
The
user
can
configure
an
instance
of
this
plugin
to
only
use
unicast
or
only
use
multicast,
see
com.rti.ndds.transport.UDPv6Transport.Property t.unicast enabled
(p. 1686)
and
com.rti.ndds.transport.UDPv6Transport.Property t.multicast enabled (p. 1686).
In addition, the user can configure an instance of this plugin to selectively use the network interfaces of a node (and restrict a plugin from sending multicast messages on specific interfaces) by specifying the white and black lists in the base propertys fields
1681
(com.rti.ndds.transport.Transport.Property t.allow interfaces com.rti.ndds.transport.Transport.Property t.deny list (p. 1575),

interfaces list (p. 1575), com.rti.ndds.transport.Transport.Property t.allow multicast interfaces list (p. 1576), com.rti.ndds.transport.Transport.Property t.deny multicast interfaces list (p. 1576)).
RTI Connext can implicitly create this plugin and register it with the
is specified in the com.rti.dds.infrastructure.TransportBuiltinQosPolicy
(p. 1580).
To specify the properties of the builtin UDPv6 transport (p. 376) that is implicitly registered, you can either:
call
specify
the
predefined
property
names
in
UDPv6 Transport Property Names in Property QoS Policy of
Domain Participant (p. 1681)). Builtin transport (p. 376) plugin properties specified in com.rti.dds.infrastructure.PropertyQosPolicy
(p. 1236)
always
overwrite
the
ones
specified
through
com.rti.ndds.transport.TransportSupport.set builtin transport property() (p. 1603). The default value is assumed on
any unspecified property.
Note that all properties should be set before the transport (p. 376) is implicitly created and registered by RTI Connext. Any properties that are set
after the builtin transport (p. 376) is registered will be ignored. See Built-in
Transport Plugins (p. 222) for details on when a builtin transport (p. 376)
is registered.
8.300.2
UDPv6 Transport Property Names in Property

QoS Policy of Domain Participant
set in com.rti.dds.infrastructure.PropertyQosPolicy (p. 1236) of a
UDPv6 transport (p. 376) plugin.
1682
Class Documentation
See also:
8.300.3
8.300.3.1
final int BLOCKING NEVER [static]
Value for com.rti.ndds.transport.UDPv6Transport.Property t.send blocking (p. 1688) to specify non-blocking sockets.
8.300.3.2
final int BLOCKING ALWAYS [static]
[default] Value for com.rti.ndds.transport.UDPv6Transport.Property t.send blocking (p. 1688) to specify blocking sockets.

Property Name
1683
Description
See
dds.transport.UDPv6.builtin.parent.address
bit count
t.address bit count
(p. 1573)
See
dds.transport.UDPv6.builtin.parent.properties
bitmap
t.properties bitmap
(p. 1574)
See
dds.transport.UDPv6.builtin.parent.gather
(p. 1574)
See
dds.transport.UDPv6.builtin.parent.message
size max
t.message size max
(p. 1574)
See
interfaces
and
example (p. 375): 127.0.0.1,eth0
See
interfaces
and
example (p. 375): 127.0.0.1,eth0
See
(p. 1576) and
Generated on Mon Aug 13 09:02:20 2012 for comma
RTI Connext
Java API
by DoxygenFor
delimiting
an interface.
example (p. 375): 127.0.0.1,eth0
See
(p. 1576) and
1684
Class Documentation
8.301
UDPv6Transport.Property t Class Reference

Inheritance diagram for UDPv6Transport.Property t::

Property t ()
Public Attributes

int unicast enabled

Allows the transport ( p. 376) plugin to use unicast for sending and receiving.

Allows the transport ( p. 376) plugin to use multicast for sending and receiving.
int multicast ttl


Prevents the transport ( p. 376) plugin from putting multicast packets onto
the loopback interface.

Prevents the transport ( p. 376) plugin from using the IP loopback interface.

is not reported as RUNNING by the operating system.
int no zero copy

1685
Prevents the transport ( p. 376) plugin from doing zero copy.
int send blocking

int enable v4mapped

Specify whether UDPv6 transport ( p. 376) will process IPv4 addresses.

Set mask for use of transport ( p. 376) priority field.

Set low value of output range to IPv6 TCLASS.

Set high value of output range to IPv6 TCLASS.
8.301.1

The properties in this structure can be modified by the end user to configure the
plugin. However, the properties must be set before the plugin is instantiated.
See also:
8.301.2
8.301.2.1
Property t ()
Create an empty UDPv6Transport (p. 1680) property with default values
8.301.3
8.301.3.1

1686
Class Documentation
On most operating systems, setsockopt() will be called to set the SENDBUF

This
value
must
be
greater
than
or
equal
8.301.3.2
to

On most operating systems, setsockopt() will be called to set the RECVBUF
This
value
must
be
greater
than
or
equal
8.301.3.3
to
int unicast enabled
Allows the transport (p. 376) plugin to use unicast for sending and receiving.
This value turns unicast UDP on (if set to 1) or off (if set to 0) for this plugin.
By default, it will be turned on (1). Also by default, the plugin will use all
the allowed network interfaces that it finds up and running when the plugin is
instanced.
8.301.3.4
Allows the transport (p. 376) plugin to use multicast for sending and receiving.
This value turns multicast UDP on (if set to 1) or off (if set to 0) for this
plugin. By default, it will be turned on (1) for those platforms that support
multicast. Also by default, the plugin will use the all network interfaces allowed
for multicast that it finds up and running when the plugin is instanced.
8.301.3.5
int multicast ttl
This is used to set the TTL of multicast packets sent by this transport (p. 376)
plugin.
See also:
NDDS TRANSPORT UDPV6 MULTICAST TTL DEFAULT

8.301.3.6
1687
Prevents the transport (p. 376) plugin from putting multicast packets onto the
loopback interface.
If multicast loopback is disabled (this value is set to 1), then when sending multicast packets, RTI Connext will not put a copy of the packets on the loopback
interface. This prevents applications on the same node (including itself) from
receiving those packets.
This value is set to 0 by default, meaning multicast loopback is enabled .
Disabling multicast loopback (setting this value to 1) may result in minor performance gains when using multicast.
8.301.3.7
Prevents the transport (p. 376) plugin from using the IP loopback interface.
Currently three values are allowed:
0: Forces local traffic to be sent over loopback, even if a more efficient
transport (p. 376) (such as shared memory) is installed (in which case
traffic will be sent over both transports).
1: Disables local traffic via this plugin. Do not use the IP loopback
interface even if no NICs are discovered. This is useful when you want
applications running on the same node to use a more efficient transport
(p. 376) (such as shared memory) instead of the IP loopback.
-1: Automatic. Lets RTI Connext decide between the above two choices.
The current automatic (-1) RTI Connext policy is as follows.
If a shared memory transport (p. 376) plugin is available for local traffic,
the effective value is 1 (i.e., disable UDPv6 local traffic).
Otherwise, the effective value is 0 (i.e., use UDPv6 for local traffic also).
[default] -1 Automatic RTI Connext policy based on availability of the shared
memory transport (p. 376).
8.301.3.8
not reported as RUNNING by the operating system.
1688
Class Documentation
UP will not be used. This property allows the same check to be extended to the
IFF RUNNING flag implemented by some operating systems. The RUNNING
flag is defined to mean that all resources are allocated, and may be off if there
is no link detected, e.g., the network cable is unplugged.
0: Do not check the RUNNING flag when enumerating interfaces, just
make sure interface is UP.
1: Check flag when enumerating interfaces and ignore those that are not
reported as RUNNING. This can be used on some operating systems to
cause the transport (p. 376) to ignore interfaces that are enabled but not
connected to the network.
[default] 0 (i.e., do not check RUNNING flag)
8.301.3.9
int no zero copy
Prevents the transport (p. 376) plugin from doing zero copy.
By default, this plugin will use the zero copy on OSs that offer it. While this is
good for performance, it may sometimes tax the OS resources in a manner that
cannot be overcome by the application.
The best example (p. 375) is if the hardware/device driver lends the buffer
to the application itself. If the application does not return the loaned buffers
soon enough, the node may error or malfunction. If you cannot reconfigure the
H/W, device driver, or the OS to allow the zero copy feature to work for your
application, you may have no choice but to turn off the use of zero copy.
By default this is set to 0, so RTI Connext will use the zero copy API if offered
by the OS.
8.301.3.10
int send blocking

Currently two values are defined:
NDDS TRANSPORT UDPV6 BLOCKING ALWAYS:
are blocking (default socket options for Operating System).
Sockets
1689
NDDS TRANSPORT UDPV6 BLOCKING NEVER:

Sockets
are modified to make them non-blocking. THIS IS NOT A SUPPORTED CONFIGURATION AND MAY CAUSE SIGNIFICANT
PERFORMANCE PROBLEMS.
[default] NDDS TRANSPORT UDPV6 BLOCKING ALWAYS.
8.301.3.11
int enable v4mapped
Specify whether UDPv6 transport (p. 376) will process IPv4 addresses.
Set this to 1 to turn on processing of IPv4 addresses. Note that this may make
it incompatible with use of the UDPv4 transport (p. 376) within the same
domain participant.
[default] 0.
8.301.3.12
Set mask for use of transport (p. 376) priority field.

If
transport
(p. 376)
priority
mapping
is
supported
on
the
platform,
this
mask
is
used
in
conjunction
with
com.rti.ndds.transport.UDPv6Transport.Property t.transport priority mapping low
(p. 1689)
and
com.rti.ndds.transport.UDPv6Transport.Property t.transport priority mapping high (p. 1690) to define the mapping from DDS transport (p. 376) priority (see TRANSPORT PRIORITY (p. 126)) to the IPv6
TCLASS field. Defines a contiguous region of bits in the 32-bit transport
(p. 376) priority value that is used to generate values for the IPv6 TCLASS
field on an outgoing socket. (See the Getting Started Guide to find out if
the transport (p. 376) priority is supported on a specific platform.)
For example (p. 375), the value 0x0000ff00 causes bits 9-16 (8 bits) to be used
in the mapping. The value will be scaled from the mask range (0x0000 - 0xff00
in this case) to the range specified by low and high.
If the mask is set to zero, then the transport (p. 376) will not set IPv6 TCLASS
for send sockets.
[default] 0.
8.301.3.13
Set low value of output range to IPv6 TCLASS.

This is used in conjunction with com.rti.ndds.transport.UDPv6Transport.Property t.transport priority mask (p. 1689) and com.rti.ndds.transport.UDPv6Transport.Property Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen
1690
Class Documentation
t.transport priority mapping high (p. 1690) to define the mapping from
DDS transport (p. 376) priority to the IPv6 TCLASS field. Defines the low
value of the output range for scaling.
Note that IPv6 TCLASS is generally an 8-bit value.
[default] 0.
8.301.3.14
Set high value of output range to IPv6 TCLASS.

This is used in conjunction with com.rti.ndds.transport.UDPv6Transport.Property t.transport priority mask (p. 1689) and com.rti.ndds.transport.UDPv6Transport.Property t.transport priority mapping low (p. 1689) to define the mapping from
DDS transport (p. 376) priority to the IPv6 TCLASS field. Defines the high
value of the output range for scaling.
Note that IPv6 TCLASS is generally an 8-bit value.
[default] 0xff.
8.302 Union Class Reference
8.302
1691
Union Class Reference
Inherited by TypeId.
8.302.1
Base class for all generated unions. The purpose of this class is to recognize a
nddsgen generated union using reflection
Author:
jaime c
Version:
Revision
1.2
Date
2006/09/24 08:28:59
1692
Class Documentation
8.303
UnionMember Class Reference


UnionMember (String name, boolean is pointer, int[ ] labels, TypeCode type)
Public Attributes
String name
The name of the union member.
boolean is pointer
Indicates whether the union member is a pointer or not.
int[ ] labels
The labels of the union member.
TypeCode type
The type of the union member.
8.303.1

See also:
8.303.2
8.303.2.1
UnionMember (String name, boolean is pointer, int[ ]

labels, TypeCode type)
Constructs a UnionMember (p. 1692) object initialized with the given values.
8.303 UnionMember Class Reference
8.303.3
8.303.3.1
String name
1693
The name of the union member.

Cannot be null.
8.303.3.2
boolean is pointer
Indicates whether the union member is a pointer or not.

8.303.3.3
int [ ] labels
The labels of the union member.

Each union member should contain at least one label. If the union discriminator
type is not com.rti.dds.infrastructure.int the label value should be evaluated to
an integer value. For instance, a would be evaluated to 97.
8.303.3.4
TypeCode type
The type of the union member.

Cannot be null.
1694
Class Documentation
8.304
UserDataQosPolicy Class Reference

Inheritance diagram for UserDataQosPolicy::
Public Attributes
final ByteSeq value
8.304.1

Entity:
(p. 654),
(p. 487),
Properties:
RxO (p. 101) = NO;
See also:
(p. 711)
8.304.2
Usage
The purpose of this QoS is to allow the application to attach additional information to the created com.rti.dds.infrastructure.Entity (p. 931) objects,
so that when a remote application discovers their existence, it can access that
information and use it for its own purposes. This information is not used by
RTI Connext.
8.304 UserDataQosPolicy Class Reference
1695
One possible use of this QoS is to attach security credentials or some other
information that can be used by the remote application to authenticate the
source.
In combination with operations such as com.rti.dds.domain.DomainParticipant.ignore participant (p. 714), com.rti.dds.domain.DomainParticipant.ignore publication (p. 716), com.rti.dds.domain.DomainParticipant.ignore subscription (p. 717), and com.rti.dds.domain.DomainParticipant.ignore topic (p. 715), this QoS policy can assist an application to define and enforce
its own security policies.
com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.participant user data max length (p. 790), com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPolicy.w
user data max length (p. 791), and com.rti.dds.infrastructure.DomainParticipantResourceLimitsQosPol
user data max length (p. 791).
8.304.3
8.304.3.1
final ByteSeq value
1696
8.305
Class Documentation
UserException Class Reference
User exception.
Inheritance diagram for UserException::
8.305.1
User exception.
This class is based on a similar class in CORBA.
See also:
http://java.sun.com/javase/6/docs/api/org/omg/CORBA/UserException.html
8.306 ValueMember Class Reference
8.306
1697
ValueMember Class Reference


ValueMember (String name, boolean is pointer, short bits, boolean
is key, short access, TypeCode type)
Public Attributes
String name
The name of the value member.
TypeCode type
The type of the value member.
boolean is pointer
Indicates whether the value member is a pointer or not.
short bits
boolean is key
Indicates if the value member is a key member or not.
short access
The type of access (public, private) for the value member.
8.306.1

See also:
1698
Class Documentation
8.306.2
8.306.2.1
ValueMember (String name, boolean is pointer, short

bits, boolean is key, short access, TypeCode type)
Constructs a ValueMember (p. 1697) object initialized with the given values.
8.306.3
8.306.3.1
String name
The name of the value member.

Cannot be null.
8.306.3.2
TypeCode type
The type of the value member.

Cannot be null.
8.306.3.3
boolean is pointer
Indicates whether the value member is a pointer or not.

8.306.3.4
short bits

If the struct member is a bitfield, this field contains the number of bits of the bitfield.
Otherwise, bits should contain
com.rti.dds.typecode.TypeCode.NOT BITFIELD (p. 1646).
8.306.3.5
boolean is key
Indicates if the value member is a key member or not.

8.306.3.6
short access
The type of access (public, private) for the value member.

It can take the values: com.rti.dds.typecode.Visibility.PRIVATE MEMBER or
com.rti.dds.typecode.Visibility.PUBLIC MEMBER.
8.307 VendorId t Class Reference
8.307
1699
VendorId t Class Reference
<<eXtension>> ( p. 278) Type used to represent the vendor of the service

Inherits Struct.

VendorId t ()
Constructor.
Public Attributes
final byte[ ] vendorId = new byte[LENGTH MAX]
The vendor Id.

static final VendorId t UNKNOWN
The ID used when the vendor of the service implementing the RTPS protocol
is not known.
static final int LENGTH MAX = 2

Length of vendor id.
8.307.1
<<eXtension>> ( p. 278) Type used to represent the vendor of the service

8.307.2
8.307.2.1
VendorId t ()
Constructor.
1700
Class Documentation
8.307.3
8.307.3.1
final VendorId t UNKNOWN [static]
The ID used when the vendor of the service implementing the RTPS protocol
is not known.
8.307.3.2
final int LENGTH MAX = 2 [static]
Length of vendor id.

8.307.3.3
final byte [ ] vendorId = new byte[LENGTH MAX]
The vendor Id.
8.308 Version Class Reference
8.308
1701
Version Class Reference
<<interface>> ( p. 279) The version of an RTI Connext distribution.

ProductVersion t get product version ()
Get the RTI Connext product version.
LibraryVersion t get java api version ()

Get the version of the Java API library.
LibraryVersion t get c api version ()

Get the version of the C API library.
LibraryVersion t get core version ()

Get the version of the core library.
String toString ()
Get this version in string form.

static Version get instance ()
8.308.1
<<interface>> ( p. 279) The version of an RTI Connext distribution.

The complete version is made up of the versions of the individual libraries that
make up the product distribution.
8.308.2
8.308.2.1
static Version get instance () [static]

1702
8.308.2.2
Class Documentation
ProductVersion t get product version ()
Get the RTI Connext product version.

8.308.2.3
LibraryVersion t get java api version ()
Get the version of the Java API library.

8.308.2.4
LibraryVersion t get c api version ()
Get the version of the C API library.

8.308.2.5
LibraryVersion t get core version ()
Get the version of the core library.

8.308.2.6
String toString ()
Get this version in string form.

Combine all of the constituent library versions into a single string.
8.309 ViewStateKind Class Reference
8.309
1703
ViewStateKind Class Reference

static final int NEW VIEW STATE = 0x0001 << 0
New instance. This latest generation of the instance has not previously been
accessed.
static final int NOT NEW VIEW STATE = 0x0001 << 1

Not a new instance. This latest generation of the instance has previously
been accessed.
static final int ANY VIEW STATE = 0xffff

8.309.1

For each instance (identified by the key), the middleware internally maintains a
view state relative to each com.rti.dds.subscription.DataReader (p. 487).
The view state can be either:
com.rti.dds.subscription.ViewStateKind.ViewStateKind.NEW VIEW STATE indicates that either this is the first time
that
the
(p. 487)
has ever accessed samples of that instance, or else that
the
(p. 487)
has
accessed previous samples of the instance, but the instance
has since been reborn (i.e.
become not-alive and then alive
again).
These two cases are distinguished by examining the
(p. 1405) and the com.rti.dds.subscription.SampleInfo.no writers generation count (p. 1405).
com.rti.dds.subscription.ViewStateKind.ViewStateKind.NOT NEW VIEW STATE
indicates
that
the
com.rti.dds.subscription.DataReader (p. 487) has already accessed samples of the same instance and that the instance has not been
reborn since.
1704
Class Documentation
The view state available in the com.rti.dds.subscription.SampleInfo

(p. 1398) is a snapshot of the view state of the instance relative to the
com.rti.dds.subscription.DataReader (p. 487) used to access the samples
at the time the collection was obtained (i.e. at the time read or take was
called). The view state is therefore the same for all samples in the returned
collection that refer to the same instance.
Once an instance has been detected as not having any live writers
and all the samples associated with the instance are taken from the
com.rti.dds.subscription.DataReader (p. 487), the middleware can reclaim
all local resources regarding the instance. Future samples will be treated as
never seen.
8.309.2
8.309.2.1
final int NEW VIEW STATE = 0x0001 << 0 [static]
New instance. This latest generation of the instance has not previously been
accessed.
8.309.2.2
final int NOT NEW VIEW STATE = 0x0001 << 1

[static]
Not a new instance. This latest generation of the instance has previously been
accessed.
8.310 VM ABSTRACT Class Reference
8.310
1705
VM ABSTRACT Class Reference

8.310.1
An abstract value type may not be instantiated.
8.310.2
8.310.2.1
Constant value.
1706
Class Documentation
8.311
VM CUSTOM Class Reference

8.311.1
This modifier is used to specify whether the value type uses custom marshaling.
8.311.2
8.311.2.1
Constant value.
8.312 VM NONE Class Reference
8.312
1707
VM NONE Class Reference

8.312.1
8.312.2
8.312.2.1
Constant value.
1708
Class Documentation
8.313
VM TRUNCATABLE Class Reference

8.313.1
A value with a state that derives from another value with a state can be declared
as truncatable. A truncatable type means the object can be truncated to the
base type.
8.313.2
8.313.2.1
Constant value.
8.314 WaitSet Class Reference
8.314
1709
WaitSet Class Reference
<<interface>> ( p. 279) Allows an application to wait until one or more of

the attached com.rti.dds.infrastructure.Condition (p. 464) objects has a
trigger value of com.rti.dds.infrastructure.true or else until the timeout expires.
Inherits AbstractNativeObject.

WaitSet ()
Default no-argument constructor.
WaitSet (WaitSetProperty t prop)

<<eXtension>>
(p. 278)
Constructor
for
a
com.rti.dds.infrastructure.WaitSet ( p. 1709) that may delay for
more while specifying that will be woken up after the given number of events
or delay period, whichever happens first
void wait (ConditionSeq active conditions, Duration t timeout)

Allows an application thread to wait for the occurrence of certain conditions.
void attach condition (Condition cond)

Attaches a com.rti.dds.infrastructure.Condition
com.rti.dds.infrastructure.WaitSet ( p. 1709).
( p. 464)
to
the
void detach condition (Condition cond)

Detaches a com.rti.dds.infrastructure.Condition ( p. 464) from the
com.rti.dds.infrastructure.WaitSet ( p. 1709).
void get conditions (ConditionSeq attached conditions)

Retrieves the list of attached com.rti.dds.infrastructure.Condition
( p. 464) (s).
void set property (WaitSetProperty t prop)

<<eXtension>> (p. 278) Sets the com.rti.dds.infrastructure.WaitSetProperty to
configure
the
associated
t
( p. 1719),
com.rti.dds.infrastructure.WaitSet ( p. 1709) to return after one
or more trigger events have occurred.
void get property (WaitSetProperty t prop)

<<eXtension>>
(p. 278)
Retrieves
the
com.rti.dds.infrastructure.WaitSetProperty t ( p. 1719) configuration of the associated com.rti.dds.infrastructure.WaitSet ( p. 1709).
1710
Class Documentation
void delete ()
Destructor.
8.314.1
<<interface>> ( p. 279) Allows an application to wait until one or more of

the attached com.rti.dds.infrastructure.Condition (p. 464) objects has a
trigger value of com.rti.dds.infrastructure.true or else until the timeout expires.
8.314.2
Usage
com.rti.dds.infrastructure.Condition (p. 464) (s) (in conjunction with waitsets) provide an alternative mechanism to allow the middleware to communicate
communication status changes (including arrival of data) to the application.
This mechanism is wait-based. Its general use pattern is as follows:
The application indicates which relevant information it wants
to
get
by
creating
(p. 464)
objects
(com.rti.dds.infrastructure.StatusCondition
(p. 1448), com.rti.dds.subscription.ReadCondition (p. 1313) or
com.rti.dds.subscription.QueryCondition (p. 1311)) and attaching
them to a com.rti.dds.infrastructure.WaitSet (p. 1709).
It then waits on that com.rti.dds.infrastructure.WaitSet
(p. 1709)
until
the
trigger value
of
one
or
several
com.rti.dds.infrastructure.Condition (p. 464) objects become
It then uses the result of the wait (i.e., active conditions, the
list of com.rti.dds.infrastructure.Condition (p. 464) objects with
trigger value == com.rti.dds.infrastructure.true) to actually get the information:
by
calling
com.rti.dds.infrastructure.Entity.get status changes (p. 936) and then get <communication status>() on
the relevant com.rti.dds.infrastructure.Entity (p. 931), if the
condition is a com.rti.dds.infrastructure.StatusCondition
(p. 1448) and the status changes, refer to plain communication
status;
1711
by
calling
com.rti.dds.infrastructure.Entity.get (p. 936)
and
then
status changes
com.rti.dds.subscription.Subscriber.get on
the
relevant
datareaders
(p. 1489)
com.rti.dds.subscription.Subscriber (p. 1476) (and then
or
com.rti.ndds.example.FooDataReader.read()
(p. 981)
com.rti.ndds.example.FooDataReader.take (p. 983) on the returned com.rti.dds.subscription.DataReader (p. 487) objects),
if the condition is a com.rti.dds.infrastructure.StatusCondition
(p. 1448)
and
the
status
changes
refers
to
com.rti.dds.infrastructure.StatusKind.StatusKind.DATA ON READERS STATUS;
by
calling
com.rti.dds.infrastructure.Entity.get status changes
(p. 936)
and
then
com.rti.ndds.example.FooDataReader.read()
(p. 981)
or
com.rti.ndds.example.FooDataReader.take (p. 983) on the
relevant com.rti.dds.subscription.DataReader (p. 487), if the
condition is a com.rti.dds.infrastructure.StatusCondition
(p. 1448)
and
the
status
changes
refers
to
by calling directly com.rti.ndds.example.FooDataReader.read w condition (p. 990) or com.rti.ndds.example.FooDataReader.take w condition (p. 991) on a com.rti.dds.subscription.DataReader
(p. 487) with the com.rti.dds.infrastructure.Condition (p. 464)
as a parameter if it is a com.rti.dds.subscription.ReadCondition
(p. 1313) or a com.rti.dds.subscription.QueryCondition
(p. 1311).
Usually the first step is done in an initialization phase, while the others are put
in the application main loop.
As there is no extra information passed from the middleware
to the application when a wait returns (only the list of triggered
(p. 464)
objects),
com.rti.dds.infrastructure.Condition (p. 464) objects are meant to
embed all that is needed to react properly when enabled. In particular,
com.rti.dds.infrastructure.Entity (p. 931)-related conditions are related
to exactly one com.rti.dds.infrastructure.Entity (p. 931) and cannot be
shared.
The blocking behavior of the com.rti.dds.infrastructure.WaitSet (p. 1709)
is illustrated below.
The result of a com.rti.dds.infrastructure.WaitSet.WaitSet.wait operation depends on the state of the com.rti.dds.infrastructure.WaitSet
(p. 1709), which in turn depends on whether at least one attached
1712
Class Documentation
(p. 464)
has
a
trigger value of com.rti.dds.infrastructure.true.
If the wait operation is
called on com.rti.dds.infrastructure.WaitSet (p. 1709) with state
BLOCKED, it will block the calling thread.
If wait is called on
a com.rti.dds.infrastructure.WaitSet (p. 1709) with state UNBLOCKED, it will return immediately.
In addition, when the
com.rti.dds.infrastructure.WaitSet (p. 1709) transitions from BLOCKED
to UNBLOCKED it wakes up any threads that had called wait on it.
A
key
aspect
of
the
(p. 464)/com.rti.dds.infrastructure.WaitSet (p. 1709) mechanism is the
setting of the trigger value of each com.rti.dds.infrastructure.Condition
(p. 464).
8.314.3
Trigger State of a com.rti.dds.infrastructure.StatusCondition
The trigger value of a com.rti.dds.infrastructure.StatusCondition

(p. 1448) is the boolean OR of the ChangedStatusFlag of all the communication statuses (see Status Kinds (p. 110)) to which it is sensitive. That is,
trigger value == com.rti.dds.infrastructure.false only if all the values of the
ChangedStatusFlags are com.rti.dds.infrastructure.false.
The sensitivity of the com.rti.dds.infrastructure.StatusCondition
(p. 1448) to a particular communication status is controlled by the
list of enabled statuses set on the condition by means of the
com.rti.dds.infrastructure.StatusCondition.set enabled statuses
(p. 1449) operation.
8.314.4
Trigger State of a com.rti.dds.subscription.ReadCondition
Similar
to
the
(p. 1448),
a
(p. 1313) also has a trigger value that determines whether
the
attached
(p. 1709)
is
BLOCKED
or
UNBLOCKED.
However,
unlike
the
com.rti.dds.infrastructure.StatusCondition (p. 1448), the trigger value of the com.rti.dds.subscription.ReadCondition (p. 1313)
is tied to the presence of at least a sample managed by RTI Connext with com.rti.dds.subscription.SampleStateKind (p. 1426) and
com.rti.dds.subscription.ViewStateKind (p. 1703) matching those of
Furthermore,
for the com.rti.dds.subscription.QueryCondition (p. 1311) to have
a trigger value == com.rti.dds.infrastructure.true, the data associated
with the sample must be such that the query expression evaluates to
1713
The fact that the trigger value of a com.rti.dds.subscription.ReadCondition

(p. 1313) depends on the presence of samples on the associated
com.rti.dds.subscription.DataReader (p. 487) implies that a single take operation can potentially change the trigger value of
several
(p. 1313)
or
com.rti.dds.subscription.QueryCondition (p. 1311) conditions. For example, if all samples are taken, any com.rti.dds.subscription.ReadCondition
(p. 1313) and com.rti.dds.subscription.QueryCondition (p. 1311) conditions associated with the com.rti.dds.subscription.DataReader (p. 487)
that had their trigger value==TRUE before will see the trigger value change to FALSE. Note that this does not guarantee that
com.rti.dds.infrastructure.WaitSet (p. 1709) objects that were separately attached to those conditions will not be woken up.
Once we
have trigger value==TRUE on a condition, it may wake up the attached
com.rti.dds.infrastructure.WaitSet (p. 1709), the condition transitioning
to trigger value==FALSE does not necessarily unwakeup the WaitSet
(p. 1709) as unwakening may not be possible in general.
The
consequence
is
that
an
application
blocked
on
a
com.rti.dds.infrastructure.WaitSet (p. 1709) may return from the
wait with a list of conditions, some of which are not no longer active.
This is unavoidable if multiple threads are concurrently waiting on separate
com.rti.dds.infrastructure.WaitSet (p. 1709) objects and taking data
associated with the same com.rti.dds.subscription.DataReader (p. 487)
entity.
To
elaborate
further,
consider
the
following
example:
A
(p. 1313)
that
has
a
sample state mask
=
{com.rti.dds.subscription.SampleStateKind.SampleStateKind.NOT READ SAMPLE STATE} will have trigger value of com.rti.dds.infrastructure.true
whenever
a
new
sample
arrives
and
will
transition
to
com.rti.dds.infrastructure.false as soon as all the newly-arrived samples
are either read (so their sample state changes to READ) or taken (so
they are no longer managed by RTI Connext).
However if the same
com.rti.dds.subscription.ReadCondition (p. 1313) had a sample state mask = { com.rti.dds.subscription.SampleStateKind.SampleStateKind.READ SAMPLE STATE, com.rti.dds.subscription.SampleStateKind.SampleStateKind.NOT READ SAMPLE STATE }, then the trigger value would only become com.rti.dds.infrastructure.false once all the newly-arrived samples are taken (it is not sufficient to read them as that would only
change the sample state to READ), which overlaps the mask on the
1714
8.314.5
Class Documentation
Trigger State of a com.rti.dds.infrastructure.GuardCondition
The trigger value of a com.rti.dds.infrastructure.GuardCondition

(p. 1041) is completely controlled by the application via the operation
com.rti.dds.infrastructure.GuardCondition.set trigger value (p. 1042).
Important:
The com.rti.dds.infrastructure.WaitSet (p. 1709) allocates native resources.
When com.rti.dds.infrastructure.WaitSet
(p. 1709)
is
no
longer
being
used,
user
should
call
com.rti.dds.infrastructure.WaitSet.WaitSet.delete explicitly to properly
cleanup all native resources.
See also:
com.rti.dds.infrastructure.GuardCondition (p. 1041)
8.314.6
8.314.6.1
WaitSet ()
(p. 1448),
Default no-argument constructor.

Construct a new com.rti.dds.infrastructure.WaitSet (p. 1709).
Important:
The com.rti.dds.infrastructure.WaitSet (p. 1709) allocates native resources. When the com.rti.dds.infrastructure.WaitSet
(p. 1709)
is
no
longer
being
used,
users
should
call
clean up all native resources.
Exceptions:
if a new com.rti.dds.infrastructure.WaitSet (p. 1709) could not
be allocated.
8.314.6.2
WaitSet (WaitSetProperty t prop)
<<eXtension>>
( p. 278)
Constructor
for
a
com.rti.dds.infrastructure.WaitSet (p. 1709) that may delay for more
while specifying that will be woken up after the given number of events or
delay period, whichever happens first
Constructs a new com.rti.dds.infrastructure.WaitSet (p. 1709).
1715
Important:
The com.rti.dds.infrastructure.WaitSet (p. 1709) allocates native resources. When the com.rti.dds.infrastructure.WaitSet
is
no
longer
being
used,
users
should
call
(p. 1709)
clean up all native resources.
Parameters:
prop <<in>> ( p. 279) Property of wait set controlling when the wait set
should be woken up
Exceptions:
if a new com.rti.dds.infrastructure.WaitSet (p. 1709) could not
be allocated.
8.314.7
8.314.7.1
void wait (ConditionSeq active conditions, Duration t

timeout)
Allows an application thread to wait for the occurrence of certain conditions.

If none of the conditions attached to the com.rti.dds.infrastructure.WaitSet
(p. 1709) have a trigger value of com.rti.dds.infrastructure.true, the wait operation will block suspending the calling thread.
The result of the wait operation is the list of all the attached conditions that
have a trigger value of com.rti.dds.infrastructure.true (i.e., the conditions
that unblocked the wait).
Note: The resolution of the timeout period is constrained by the resolution of
the system clock.
The wait operation takes a timeout argument that specifies the maximum duration for the wait.
If this duration is exceeded and none
of the attached com.rti.dds.infrastructure.Condition (p. 464) objects
is com.rti.dds.infrastructure.true, wait will return with the return code
com.rti.dds.infrastructure.RETCODE TIMEOUT (p. 1364). In this
case, the resulting list of conditions will be empty.
Note: The resolution of the timeout period is constrained by the resolution of
the system clock.
(p. 1364)
will not be returned when the timeout duration is exceeded
obif
attached
(p. 464)
jects are com.rti.dds.infrastructure.true,
or in the case of a
1716
Class Documentation
com.rti.dds.infrastructure.WaitSet (p. 1709) waiting for more than

one trigger event, if one or more trigger events have occurred.
It is not allowable for for more than one application thread to be waiting on
the same com.rti.dds.infrastructure.WaitSet (p. 1709). If the wait operation is invoked on a com.rti.dds.infrastructure.WaitSet (p. 1709) that already has a thread blocking on it, the operation will return immediately with
the value com.rti.dds.infrastructure.RETCODE PRECONDITION NOT MET (p. 1363).
Parameters:
active conditions <<inout>>
( p. 279)
a
valid
non-null
com.rti.dds.infrastructure.ConditionSeq
(p. 465)
object.
Note that RTI Connext will not allocate a new object if active conditions is null; the method will return
timeout <<in>> ( p. 279) a wait timeout
Exceptions:
One of
the
Standard
Return
Codes
(p. 108)
or
(p. 1363)
or
com.rti.dds.infrastructure.RETCODE TIMEOUT (p. 1364).
8.314.7.2
void attach condition (Condition cond)
Attaches a com.rti.dds.infrastructure.Condition
(p. 464)
to
the
It is possible to attach a com.rti.dds.infrastructure.Condition (p. 464)

on a com.rti.dds.infrastructure.WaitSet (p. 1709) that is currently being waited upon (via the wait operation).
In this case, if the
com.rti.dds.infrastructure.Condition (p. 464) has a trigger value of
com.rti.dds.infrastructure.true, then attaching the condition will unblock the
Parameters:
cond <<in>> ( p. 279) Contition to be attached.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or

8.314.7.3
1717
void detach condition (Condition cond)
Detaches a com.rti.dds.infrastructure.Condition
(p. 464)
from
the
If the com.rti.dds.infrastructure.Condition (p. 464) was not attached to

the com.rti.dds.infrastructure.WaitSet (p. 1709) the operation will return
Parameters:
cond <<in>> ( p. 279) Condition (p. 464) to be detached.
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.314.7.4
void get conditions (ConditionSeq attached conditions)
Retrieves the list of attached com.rti.dds.infrastructure.Condition (p. 464)

(s).
Parameters:
attached conditions <<inout>>
( p. 279)
a
com.rti.dds.infrastructure.ConditionSeq (p. 465) object where
the list of attached conditions will be returned
Exceptions:
One of
the
Standard
Return
Codes
(p. 108),
or
8.314.7.5
void set property (WaitSetProperty t prop)
<<eXtension>> ( p. 278) Sets the com.rti.dds.infrastructure.WaitSetProperty t (p. 1719), to configure the associated com.rti.dds.infrastructure.WaitSet
(p. 1709) to return after one or more trigger events have occurred.
Parameters:
prop <<in>> ( p. 279)
1718
Class Documentation
Exceptions:
8.314.7.6
void get property (WaitSetProperty t prop)
<<eXtension>> ( p. 278) Retrieves the com.rti.dds.infrastructure.WaitSetProperty configuration

of
the
associated
t
(p. 1719)
Parameters:
prop <<out>> ( p. 279)
Exceptions:
8.314.7.7
void delete ()
Destructor.
Releases
the
resources
asociated
with
this
Calling
this
method
multiple
times
on
the
same
com.rti.dds.infrastructure.WaitSet (p. 1709) is safe; subsequent deletions will have no effect.
8.315 WaitSetProperty t Class Reference
8.315
1719
WaitSetProperty t Class Reference
<<eXtension>> ( p. 278) Specifies the com.rti.dds.infrastructure.WaitSet

(p. 1709) behavior for multiple trigger events.
Inherits Struct.
Public Attributes
int max event count
Maximum
number
of
trigger
events
to
com.rti.dds.infrastructure.WaitSet ( p. 1709) to awaken.
cause
final Duration t max event delay

Maximum delay from occurrence of first trigger event to cause a
com.rti.dds.infrastructure.WaitSet ( p. 1709) to awaken.
8.315.1
<<eXtension>> ( p. 278) Specifies the com.rti.dds.infrastructure.WaitSet

(p. 1709) behavior for multiple trigger events.
In simple use,
a com.rti.dds.infrastructure.WaitSet (p. 1709)
returns when a single trigger event occurs on one of its attached
(p. 464)
(s),
or
when the timeout maximum wait duration specified in the
com.rti.dds.infrastructure.WaitSet.WaitSet.wait call expires.
The com.rti.dds.infrastructure.WaitSetProperty t (p. 1719) allows configuration of the waiting behavior of a com.rti.dds.infrastructure.WaitSet
(p. 1709). If no conditions are true at the time of the call to wait, then the
max event count parameter may be used to configure the WaitSet (p. 1709)
to wait for max event count trigger events to occur before returning, or to wait
for up to max event delay time from the occurrence of the first trigger event
before returning.
The
timeout
maximum
wait
duration
specified
in
com.rti.dds.infrastructure.WaitSet.WaitSet.wait call continues to apply.
Entity:
Properties:
RxO (p. 101) = N/A
the
1720
Class Documentation
8.315.2
8.315.2.1
int max event count
Maximum
number
of
trigger
events
to
com.rti.dds.infrastructure.WaitSet (p. 1709) to awaken.
cause
The com.rti.dds.infrastructure.WaitSet (p. 1709) will wait until up to

max event count trigger events have occurred before returning.
The
com.rti.dds.infrastructure.WaitSet (p. 1709) may return earlier if either the
timeout duration has expired, or max event delay has elapsed since the occurrence of the first trigger event. max event count may be used to collect
multiple trigger events for processing at the same time.
[default] 1
[range] >= 1
8.315.2.2
final Duration t max event delay
Maximum delay from occurrence of first trigger event to cause a

com.rti.dds.infrastructure.WaitSet (p. 1709) to awaken.
The com.rti.dds.infrastructure.WaitSet (p. 1709) will return no later
than max event delay after the first trigger event. max event delay may
be used to establish a maximum latency for events reported by the
Note
that
(p. 1364)
is
not
returned
if
max event delay
is
exceeded.
com.rti.dds.infrastructure.RETCODE TIMEOUT (p. 1364) is returned
only if the timeout duration expires before any trigger events occur.
8.316 WcharSeq Class Reference
8.316
1721
WcharSeq Class Reference

Inheritance diagram for WcharSeq::

WcharSeq ()
Constructs an empty sequence of wide characters with an initial maximum
of zero.
WcharSeq (int initialMaximum)

Constructs an empty sequence of wide characters with the given initial maximum.
WcharSeq (char[ ] chars)

Constructs a new sequence containing the given wide characters.
8.316.1

Instantiates:
See also:
com.rti.dds.infrastructure.char
8.316.2
8.316.2.1
WcharSeq ()
Constructs an empty sequence of wide characters with an initial maximum of

zero.
1722
8.316.2.2
Class Documentation
WcharSeq (int initialMaximum)
Constructs an empty sequence of wide characters with the given initial maximum.
8.316.2.3
WcharSeq (char[ ] chars)
Constructs a new sequence containing the given wide characters.

Parameters:
chars the initial contents of this sequence
Exceptions:
8.317 WireProtocolQosPolicy Class Reference
8.317
1723
WireProtocolQosPolicy Class Reference
Specifies
the
attributes
for
the
Inheritance diagram for WireProtocolQosPolicy::
Public Attributes
int participant id
A value used to distinguish among different participants belonging to the same
domain ( p. 328) on the same host.
RtpsWellKnownPorts t rtps well known ports

Configures the RTPS well-known port mappings.
int rtps host id

The RTPS Host ID of the domain ( p. 328) participant.
int rtps app id

The RTPS App ID of the domain ( p. 328) participant.
int rtps instance id

The RTPS Instance ID of the com.rti.dds.domain.DomainParticipant
( p. 654).
int rtps reserved port mask

Specifies which well-known ports to reserve when enabling the participant.
WireProtocolQosPolicyAutoKind rtps auto id kind = WireProtocolQosPolicyAutoKind.RTPS AUTO ID FROM IP


static final int RTPS AUTO ID = 0
Indicates that RTI Connext should choose an appropriate host, app, instance
or object ID automatically.
1724
8.317.1
Class Documentation
Specifies
the
attributes
for
the
Entity:
Properties:
RxO (p. 101) = N/A
8.317.2
Usage
This QoS policy configures some participant-wide properties of the

DDS Real-Time Publish Subscribe (RTPS) on-the-wire protocol.
(com.rti.dds.infrastructure.DataWriterProtocolQosPolicy
(p. 592)
and
com.rti.dds.infrastructure.DataReaderProtocolQosPolicy
(p. 521)
configure
RTPS
and
reliability
properties
on
or
a
per
(p. 557)
com.rti.dds.subscription.DataReader (p. 487) basis.)
NOTE: The default QoS policies returned by RTI Connext contain the correctly
initialized wire protocol attributes. The defaults are not normally expected to be
modified, but are available to the advanced user customizing the implementation
behavior.
The default values should not be modified without an understanding of the
underlying Real-Time Publish Subscribe (RTPS) wire protocol.
In order for the discovery process to work correctly,
each
com.rti.dds.domain.DomainParticipant (p. 654) must have a unique
identifier. This QoS policy specifies how that identifier should be generated.
RTPS
defines
a
96-bit
prefix
to
this
identifier;
each
com.rti.dds.domain.DomainParticipant (p. 654) must have a unique
value for this prefix relative to all other participants in its domain (p. 328).
To make it easier to control how this 96-bit value is generated, RTI Connext
divides it into three integers: a host ID, the value of which is based on the
identity of the identity of the machine on which the participant is executing; an
application ID, the value of which is based on the process or task in which the
particpant is contained; and an instance ID, which identifies the participant
itself.
This QoS policy provides you with a choice of algorithms for generating these
values automatically. In case none of these algorithms suit your needs, you may
also choose to specify some or all of them yourself.
1725
The following three fields:

com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps host id
(p. 1729)
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps app id
(p. 1730)
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps instance id (p. 1730)
comprise
the
GUID
prefix
and
by
default
are
set
to
com.rti.dds.infrastructure.WireProtocolQosPolicy.RTPS AUTO ID (p. 1728). The meaning of this flag depends on the value assigned to the
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps auto id kind
(p. 1731) field.
Depending on the com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps auto id kind (p. 1731) value, there are two different scenarios:
1. In
the
default
and
most
common
scenario,
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps auto id kind (p. 1731) is set to com.rti.dds.infrastructure.WireProtocolQosPolicyAutoKind.RTPS AUTO ID FROM IP (p. 138). Doing so, each field is interpreted as
follows:
rtps host id: The 32-bit value of the IPv4 of the first up and running interface of the host machine is assigned.
rtps app id: The process (or task) ID is assigned.
rtps instance id: A counter is assigned that is incremented per new
participant.
NOTE: If the IP assigned to the interface is not unique within the network (for instance, if it is not configured), it is possible that the GUID
(specifically, the rtps host id portion) may also not be unique.
2. In
this
situation,
RTI
Connext
provides
a
different
value
for
rtps auto id kind:
com.rti.dds.infrastructure.WireProtocolQosPolicyAutoKind.RTPS AUTO ID FROM MAC (p. 139). As the name suggests, this alternative mechanism uses the MAC address instead of the IPv4 address.
Since the MAC address size is up to 64 bits, the logical mapping of the
host information, the application ID, and the instance identifiers has to
change.
Note to Solaris Users: To use com.rti.dds.infrastructure.WireProtocolQosPolicyAutoKind.RTPS AUTO ID FROM MAC (p. 139), you must run the RTI Connext
application while logged in as root.
1726
Class Documentation
Using com.rti.dds.infrastructure.WireProtocolQosPolicyAutoKind.RTPS AUTO ID FROM MAC (p. 139), the default value of each field is
interpreted as follows:
rtps host id: The first 32 bits of the MAC address of the first up
and running interface of the host machine are assigned.
rtps app id: The last 32 bits of the MAC address of the first up
and running interface of the host machine are assigned.
rtps instance id: This field is split into two different parts. The
process (or task) ID is assigned to the first 24 bits. A counter is
assigned to the last 8 bits. This counter is incremented per new
participant. In both scenarios, you can change the value of each field
independently.
If com.rti.dds.infrastructure.WireProtocolQosPolicyAutoKind.RTPS AUTO ID FROM MAC (p. 139) is used, the rtps instance id has been
logically split into two parts: 24 bits for the process/task ID and 8 bits for
the per new participant counter. To give to users the ability to manually
set the two parts independently, a bit-field mechanism has been introduced for the rtps instance id field when it is used in combination with
com.rti.dds.infrastructure.WireProtocolQosPolicyAutoKind.RTPS AUTO ID FROM MAC (p. 139). If one of the two parts is set to 0,
only this part will be handled by RTI Connext and you will be able to
handle the other one manually.
Some examples are provided to clarify the behavior of this

QoSPolicy in case you want to change the default behavior with
com.rti.dds.infrastructure.WireProtocolQosPolicyAutoKind.RTPS AUTO ID FROM MAC (p. 139).
First, get the participant QoS from the DomainParticipantFactory:
DomainParticipantFactory.TheParticipantFactory.
get_default_participant_qos(participant_qos); <P>
Second, change the com.rti.dds.infrastructure.WireProtocolQosPolicy

(p. 1723) using one of the options shown below.
Third, create the com.rti.dds.domain.DomainParticipant (p. 654) as usual,
using the modified QoS structure instead of the default one.
Option 1: Use com.rti.dds.infrastructure.WireProtocolQosPolicyAutoKind.RTPS AUTO ID FROM MAC (p. 139) to explicitly set just the application/task
identifier portion of the rtps instance id field.
participant_qos.wire_protocol.rtps_auto_id_kind =
WireProtocolQosPolicyAutoKind.RTPS_AUTO_ID_FROM_MAC;
1727
participant_qos.wire_protocol.rtps_host_id
=
WireProtocolQosPolicy.RTPS_AUTO_ID;
participant_qos.wire_protocol.rtps_app_id
=
WireProtocolQosPolicy.RTPS_AUTO_ID;
participant_qos.wire_protocol.rtps_instance_id = (/* App ID */ (12 << 8) |
/* Instance ID*/ (WireProtocolQosPolicy.RTPS_AUTO_ID));
Option 2: Handle only the per participant counter and let RTI Connext handle
the application/task identifier:
= WireProtocolQosPolicy.RTPS_AUTO_ID;
participant_qos.wire_protocol.rtps_instance_id = (/* App ID */ (WireProtocolQosPolicy.RTPS_AUTO_ID) |
/* Instance ID*/ (12));
Option 3: Handle the entire rtps instance id field yourself:

participant_qos.wire_protocol.rtps_auto_id_kind = WireProtocolQosPolicyAutoKind.RTPS_AUTO_ID_FROM_MAC;
participant_qos.wire_protocol.rtps_instance_id = ( /* App ID */ (12 << 8)) |
/* Instance ID */ (9) )
NOTE: If you are using com.rti.dds.infrastructure.WireProtocolQosPolicyAutoKind.RTPS AUTO ID FROM MAC (p. 139) as rtps auto id kind and you decide to
manually handle the rtps instance id field, you must ensure that both parts
are non-zero (otherwise RTI Connext will take responsibility for them). RTI
recommends that you always specify the two parts separately in order to avoid
errors.
Option 4: Let RTI Connext handle the entire rtps instance id field:
participant_qos.wire_protocol.rtps_instance_id = WireProtocolQosPolicy.RTPS_AUTO_ID;
NOTE: If you are using com.rti.dds.infrastructure.WireProtocolQosPolicyAutoKind.RTPS AUTO ID FROM MAC (p. 139) as rtps auto id kind and you decide
to manually handle the rtps instance id field, you must ensure that both
parts are non-zero (otherwise RTI Connext will take responsibility for them).
RTI recommends that you always specify the two parts separately in order to
clearly show the difference.
1728
Class Documentation
8.317.3
8.317.3.1
final int RTPS AUTO ID = 0 [static]
Indicates that RTI Connext should choose an appropriate host, app, instance
or object ID automatically.
If this special value is assigned to com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps host id (p. 1729), com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps app id (p. 1730), com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps instance id (p. 1730), com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.rtps object id (p. 594) or com.rti.dds.infrastructure.DataReaderProtocolQosPolicy.rtps object id (p. 523) RTI Connext will assign the ID automatically.
The actual ID value is chosen when the QoS is set:
the QoS
returned
from
com.rti.dds.domain.DomainParticipant.get qos
(p. 706),
com.rti.dds.publication.DataWriter.get qos
(p. 564)
or
com.rti.dds.subscription.DataReader.get qos (p. 497) will never have
this value.
QoS:
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps host id
(p. 1729) com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps app id (p. 1730) com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps instance id (p. 1730)
8.317.3.2
int participant id
A value used to distinguish among different participants belonging to the same

domain (p. 328) on the same host.
Determines the unicast port on which meta-traffic is received.
Also defines the default unicast port for receiving user-traffic
for DataReaders and DataWriters (can be overridden by the
com.rti.dds.subscription.DataReaderQos.unicast
(p. 540)
or
com.rti.dds.publication.DataWriterQos.unicast (p. 615)).
For
more
information
on
port
mapping,
please
refer
com.rti.dds.infrastructure.RtpsWellKnownPorts t (p. 1390).
to
Each com.rti.dds.domain.DomainParticipant (p. 654) in the same domain

(p. 328) and running on the same host, must have a unique participant id.
The participants may be in the same address space or in distinct address spaces.
A negative number (-1) means that RTI Connext will automatically resolve the
participant ID as follows.
1729
RTI Connext will pick the smallest participant ID based on the unicast
ports available on the transports enabled for discovery.
RTI Connext will attempt to resolve an automatic port index either when
a DomainPartcipant is enabled, or when a DataReader or DataWriter is
created. Therefore, all the transports enabled for discovery must have been
registered by this time. Otherwise, the discovery transports registered
after resolving the automatic port index may produce port conflicts when
the DomainPartcipant is enabled.
[default] -1 [automatic], i.e. RTI Connext will automatically pick the
participant id, as described above.
[range] [>= 0], or -1, and does not violate guidelines stated in
com.rti.dds.infrastructure.RtpsWellKnownPorts t (p. 1390).
See also:
com.rti.dds.infrastructure.Entity.enable() (p. 935)
8.317.3.3
RtpsWellKnownPorts t rtps well known ports
Configures the RTPS well-known port mappings.

Determines the well-known multicast and unicast port mappings for discovery
(meta) traffic and user traffic.
[default]
com.rti.dds.infrastructure.RtpsWellKnownPorts t.INTEROPERABLE RTPS WELL KNOWN PORTS (p. 137)
8.317.3.4
int rtps host id
The RTPS Host ID of the domain (p. 328) participant.

A machine/operating system specific host ID that is unique in the domain
(p. 328).
[default] com.rti.dds.infrastructure.WireProtocolQosPolicy.RTPS AUTO ID (p. 1728). The default value is interpreted as follows:
If
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps auto id kind (p. 1731) is equal to RTPS AUTO ID FROM IP (the default value),
the value will be interpreted as the IPv4 address of the first up and running
interface of the host machine.
If
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps auto id kind (p. 1731) is equal to RTPS AUTO ID FROM MAC , the value will be
1730
Class Documentation
interpreted as the first 32 bits of the MAC address assigned to the first up and
running interface of the host machine.
8.317.3.5
int rtps app id
The RTPS App ID of the domain (p. 328) participant.

A participant specific ID that, together with the rtps instance id, is unique
within the scope of the rtps host id.
If a participant dies and is restarted, it is recommended that it be given an
app ID that is distinct from the previous one so that other participants in the
domain (p. 328) can distinguish between them.
If
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps auto id kind (p. 1731) is equal to RTPS AUTO ID FROM IP (default value for this
field) the value will be the process (or task) ID.
If
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps auto id kind (p. 1731) is equal to RTPS AUTO ID FROM MAC the value will be the
last 32 bits of the MAC address assigned to the first up and running interface
of the host machine. [range] [0,0xffffffff]
8.317.3.6
int rtps instance id
The RTPS Instance ID of the com.rti.dds.domain.DomainParticipant

(p. 654).
This is an instance-specific ID of a participant that, together with the rtps app id, is unique within the scope of the rtps host id.
If a participant dies and is restarted, it is recommended that it be given an
instance ID that is distinct from the previous one so that other participants in
the domain (p. 328) can distinguish between them.
If
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps auto id kind (p. 1731) is equal to RTPS AUTO ID FROM IP (the default value), a
counter is assigned that is incremented per new participant. For VxWorks-653,
the first 8 bits are assigned to the partition id for the application.
If
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps auto id kind (p. 1731) is equal to RTPS AUTO ID FROM MAC , the first 24 bits are
1731
assigned to the application/task identifier and the last 8 bits are assigned to a
counter that is incremented per new paricipant.
[range] [0,0xffffffff] NOTE: If you use DDS RTPS AUTO ID FROM MAC as
rtps auto id kind and you decide to manually handle the rtps instance id field, you must ensure that both the two parts are non-zero, otherwise the
middleware will take responsibility for them. We recommend that you always
specify the two parts separately in order to avoid errors. (examples)
8.317.3.7
int rtps reserved port mask
Specifies which well-known ports to reserve when enabling the participant.

Specifies which of the well-known multicast and unicast ports will be reserved
when the DomainParticipant is enabled. Failure to allocate a port that is computed based on the com.rti.dds.infrastructure.RtpsWellKnownPorts t
(p. 1390) will be detected at this time, and the enable operation will fail.
[default] com.rti.dds.infrastructure.RtpsReservedPortKind.MASK DEFAULT (p. 135)
8.317.3.8
WireProtocolQosPolicyAutoKind rtps auto id kind =

WireProtocolQosPolicyAutoKind.RTPS AUTO ID FROM IP

[default] RTPS AUTO ID FROM IP
1732
Class Documentation
8.318
WireProtocolQosPolicyAutoKind
Reference
Class

Inheritance diagram for WireProtocolQosPolicyAutoKind::

static final WireProtocolQosPolicyAutoKind RTPS AUTO ID FROM IP = new WireProtocolQosPolicyAutoKind(RTPS AUTO ID FROM IP, 0)
static final WireProtocolQosPolicyAutoKind RTPS AUTO ID FROM MAC = new WireProtocolQosPolicyAutoKind(RTPS AUTO ID FROM MAC, 1)
8.318.1

See also:
com.rti.dds.infrastructure.WireProtocolQosPolicy.rtps auto id kind (p. 1731)
8.319 WriteParams t Class Reference
8.319
1733
WriteParams t Class Reference
Input
parameters
for
writing
with
(p. 1026),
(p. 1031),
(p. 1016), com.rti.ndds.example.FooDataWriter.unregister instance w params (p. 1021)
Inheritance diagram for WriteParams t::

WriteParams t ()
Construct a new WriteParams t ( p. 1733).
WriteParams t (SampleIdentity t identity, Time t source timestamp, Cookie t cookie, InstanceHandle t handle, SampleIdentity t related sample identity, boolean replace auto)
Construct a new WriteParams t ( p. 1733) with the given members.

Public Attributes
SampleIdentity t identity
Identity of the sample.
final SampleIdentity t related sample identity

The identity of another sample related to this one.
Time t source timestamp

INVALID)
new
Time t(Time t.TIME -
Source timestamp upon write.
InstanceHandle t handle = new InstanceHandle t()

Instance handle.
1734
8.319.1
Class Documentation
Input
parameters
for
writing
with
(p. 1026),
(p. 1031),
(p. 1016), com.rti.ndds.example.FooDataWriter.unregister instance w params (p. 1021)
8.319.2
8.319.2.1
WriteParams t ()
Construct a new WriteParams t (p. 1733).

8.319.2.2
WriteParams t (SampleIdentity t identity, Time t

source timestamp, Cookie t cookie, InstanceHandle t
handle, SampleIdentity t related sample identity,
boolean replace auto)
Construct a new WriteParams t (p. 1733) with the given members.
8.319.3
8.319.3.1

references).
Parameters:
Returns:
Exceptions:
8.319 WriteParams t Class Reference
1735

8.319.4
8.319.4.1
SampleIdentity t identity
Initial value:
new SampleIdentity_t(SampleIdentity_t.AUTO_SAMPLE_IDENTITY)
Identity of the sample.

Identifies the sample being written. The identity consists of a pair (Virtual
Writer GUID, Virtual Sequence Number).
Use the default value to let RTI Connext determine the sample identity as
follows:
The Virtual Writer GUID is the virtual GUID associated with the
writer writing the sample. This virtual GUID is configured using
com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.virtual guid (p. 593).
The sequence number is increased by one with respect to the previous
value.
The virtual sequence numbers for a virtual writer must be strictly monotonically
increasing. If the user tries to write a sample with a sequence number smaller
or equal to the last sequence number, the write operation will fail.
A DataReader can access the identity of a received sample by using the fields
com.rti.dds.subscription.SampleInfo.original publication virtual guid (p. 1407) and com.rti.dds.subscription.SampleInfo.original publication virtual sequence number
(p. 1407)
in
the
[default]
com.rti.dds.infrastructure.SampleIdentity t.SampleIdentity t.AUTO SAMPLE IDENTITY.
8.319.4.2
final SampleIdentity t related sample identity
Initial value:
new SampleIdentity_t(SampleIdentity_t.UNKNOWN_SAMPLE_IDENTITY)
1736
Class Documentation
The identity of another sample related to this one.

Identifies another sample that is logically related to the one that is written.
When this field is set, the related sample identity is propagated an subscribing
applications can retrieve it from the com.rti.dds.subscription.SampleInfo
(p. 1398) (see com.rti.dds.subscription.SampleInfo.get related sample identity).
The
default
value
is
com.rti.dds.infrastructure.SampleIdentity t.SampleIdentity t.UNKNOWN SAMPLE IDENTITY, and is not propagated.
A DataReader can access the related identity of a received sample
by using the fields com.rti.dds.subscription.SampleInfo.related (p. 1408)
and
original publication virtual guid
com.rti.dds.subscription.SampleInfo.related original publication virtual sequence number
(p. 1408)
in
the
[default]
com.rti.dds.infrastructure.SampleIdentity t.SampleIdentity t.UNKNOWN SAMPLE IDENTITY
8.319.4.3
Time t source timestamp = new

Time t(Time t.TIME INVALID)
Source timestamp upon write.

Specifies
the
source
timestamp
that
will
be
available
to
objects
the
(p. 487)
by
means
of
the
source timestamp
attribute
within
the
[default] com.rti.dds.infrastructure.Time t.INVALID.
8.319.4.4
InstanceHandle t handle = new InstanceHandle t()
Instance handle.
Either
the
handle
returned
by
a
previous
call
to
com.rti.ndds.example.FooDataWriter.register instance (p. 1014), or else
the special value com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL.
[default]
com.rti.dds.infrastructure.InstanceHandle t.InstanceHandle t.HANDLE NIL
8.320 WriterContentFilter Interface Reference
8.320
1737
WriterContentFilter Interface Reference
Inheritance diagram for WriterContentFilter::

void writer attach (ObjectHolder writer filter data)
void writer detach (Object writer filter data)
void writer compile (Object writer filter data, ExpressionProperty
prop, String expression, StringSeq parameters, TypeCode type code,
String type class name, Cookie t cookie)
CookieSeq writer evaluate (Object writer filter data, Object sample,
FilterSampleInfo meta data)
void writer finalize (Object writer filter data, Cookie t cookie)
8.320.1
8.320.2
8.320.2.1
void writer attach (ObjectHolder writer filter data)
8.320.2.2
void writer detach (Object writer filter data)
8.320.2.3
void writer compile (Object writer filter data,

ExpressionProperty prop, String expression,
StringSeq parameters, TypeCode type code, String
type class name, Cookie t cookie)
8.320.2.4
CookieSeq writer evaluate (Object writer filter data,

Object sample, FilterSampleInfo meta data)
8.320.2.5
void writer finalize (Object writer filter data, Cookie t

cookie)
1738
Class Documentation
8.321
WriterDataLifecycleQosPolicy Class Reference
Controls how a com.rti.dds.publication.DataWriter (p. 557) handles the

Inheritance diagram for WriterDataLifecycleQosPolicy::
Public Attributes
boolean autodispose unregistered instances
Boolean
flag
that
controls
the
behavior
when
the
com.rti.dds.publication.DataWriter ( p. 557) unregisters an instance by
means of the unregister operations.
final Duration t autopurge unregistered instances delay

<<eXtension>>
(p. 278) Maximum duration for which the
com.rti.dds.publication.DataWriter ( p. 557) will maintain information
regarding an instance once it has unregistered the instance.
8.321.1
Controls how a com.rti.dds.publication.DataWriter (p. 557) handles the

Entity:
Properties:
RxO (p. 101) = N/A
8.321.2
Usage
This policy determines how the com.rti.dds.publication.DataWriter

(p. 557) acts with regards to the lifecycle of the data instances it manages (data instances that have been either explicitly registered with the
com.rti.dds.publication.DataWriter (p. 557) or implicitly registered by directly writing the data).
8.321 WriterDataLifecycleQosPolicy Class Reference
1739
Since the deletion of a DataWriter automatically unregisters all data

instances it manages, the setting of the autodispose unregistered instances flag will only determine whether instances are ultimately disposed
when the com.rti.dds.publication.DataWriter (p. 557) is deleted either
directly by means of the com.rti.dds.publication.Publisher.delete datawriter (p. 1273) operation or indirectly as a consequence of calling
com.rti.dds.publication.Publisher.delete contained entities (p. 1284)
or com.rti.dds.domain.DomainParticipant.delete contained entities
(p. 719) that contains the DataWriter.
You may use com.rti.ndds.example.FooDataWriter.unregister instance
(p. 1016) to indicate that the com.rti.dds.publication.DataWriter (p. 557)
no longer wants to send data for a com.rti.dds.topic.Topic (p. 1545).
The behavior controlled by this QoS policy applies on a per instance (key)
basis for keyed Topics, so that when a com.rti.dds.publication.DataWriter
(p. 557) unregisters an instance, RTI Connext can automatically also dispose
that instance. This is the default behavior.
In many cases where the ownership of a Topic is shared (see
com.rti.dds.infrastructure.OwnershipQosPolicy (p. 1199)), DataWriters
may want to relinquish their ownership of a particular instance of the Topic to
allow other DataWriters to send updates for the value of that instance regardless of Ownership Strength. In that case, you may only want a DataWriter to
unregister an instance without disposing the instance. Disposing an instance is
a statement that an instance no longer exists. User applications may be coded
to trigger on the disposal of instances, thus the ability to unregister without
disposing may be useful to properly maintain the semantic of disposal.
8.321.3
8.321.3.1
boolean autodispose unregistered instances
Boolean
flag
that
controls
by means of the unregister operations.
the
behavior
when
the
(p. 557) unregisters an instance
com.rti.dds.infrastructure.true (default)
The com.rti.dds.publication.DataWriter (p. 557) will dispose the instance each time it is unregistered. The behavior is identical to explicitly
calling one of the dispose operations on the instance prior to calling the
unregister operation.
The com.rti.dds.publication.DataWriter (p. 557) will not dispose the
instance. The application can still call one of the dispose operations prior
1740
Class Documentation
to unregistering the instance and accomplish the same effect.
8.321.3.2
final Duration t autopurge unregistered instances delay
<<eXtension>>
( p. 278)
Maximum
duration
for
which
the
com.rti.dds.publication.DataWriter (p. 557) will maintain information
regarding an instance once it has unregistered the instance.
After this time elapses, the com.rti.dds.publication.DataWriter (p. 557)
will purge all internal information regarding the instance, including historical
samples.
When the duration is zero, the instance is purged as soon as all the samples
have been acknowledged by all the live DataReaders.
[default] com.rti.dds.infrastructure.Duration t.INFINITE (disabled)
[range] [0, 1 year] or com.rti.dds.infrastructure.Duration t.INFINITE
8.322 WstringSeq Class Reference
8.322
1741
WstringSeq Class Reference

Inheritance diagram for WstringSeq::

WstringSeq ()
Constructs an empty sequence of wide strings with an initial maximum of
zero.
WstringSeq (int initialMaximum)

Constructs an empty sequence of wide strings with the given initial maximum.
WstringSeq (Collection strings)

Constructs a new sequence containing the given wide strings.

static void readWstringArray (String[ ] value, CdrObjectInput in, int
length) throws IOException
static void writeWstringArray (String[ ] value, CdrObjectOutput out,
int length, int maxStringLength) throws IOException
8.322.1

Instantiates:
See also:
com.rti.dds.infrastructure.char
com.rti.dds.infrastructure.StringSeq (p. 1467)
1742
Class Documentation
8.322.2
8.322.2.1
WstringSeq ()
Constructs an empty sequence of wide strings with an initial maximum of zero.

8.322.2.2
WstringSeq (int initialMaximum)
Constructs an empty sequence of wide strings with the given initial maximum.
8.322.2.3
WstringSeq (Collection strings)
Constructs a new sequence containing the given wide strings.

Parameters:
strings the initial contents of this sequence
8.322.3
8.322.3.1
static void readWstringArray (String[ ] value,

CdrObjectInput in, int length) throws IOException
[static]
Read array of strings. The length specified must match the expected length of
array. Otherwise, the stream will be positioned incorrectly, leading to corrupt
reads. The length of array must be at least the value of length parameter
(otherwise, ArrayOutOfBoundException will be thrown).
Parameters:
value array to read into
in Interface for reading object in CDR encoding.
length the length of array (<= value.length)
8.322.3.2
static void writeWstringArray (String[ ] value,

CdrObjectOutput out, int length, int maxStringLength)
throws IOException [static]
Write array of wstring up to the specified length.
Chapter 9
Example Documentation
9.1
HelloWorld.idl
9.1.1
IDL Type Description
The data type to be disseminated by RTI Connext is described in language

independent IDL. The IDL file is input to rtiddsgen (p. 298), which produces
the following files.
The programming language specific type representation of the type Foo = HelloWorld, for use in the application code.
HelloWorld.java
HelloWorldSeq.java
User Data Type Support (p. 164) types as required by the DDS specification
for use in the application code.
HelloWorldTypeSupport.java
HelloWorldDataWriter.java
HelloWorldDataReader.java
9.1.1.1
HelloWorld.idl
[ (NDDSHOME)/example/JAVA/helloWorld/HelloWorld.idl]
1744
struct HelloWorld {
string<128> msg;
};
9.2 HelloWorldDataReader.java
9.2
1745
9.2.1
Files generated by rtiddsgen (p. 298) that implement the type specific APIs
required by the DDS specification, as described in the User Data Type Support (p. 164), where:
FooTypeSupport = HelloWorldTypeSupport
FooDataWriter = HelloWorldDataWriter
FooDataReader = HelloWorldDataReader
9.2.1.1
HelloWorldTypeSupport.java
[ (NDDSHOME)/example/JAVA/helloWorld/HelloWorldTypeSupport.java]
/*
WARNING: THIS FILE IS AUTO-GENERATED. DO NOT MODIFY.
This file was generated from .idl using "rtiddsgen".
The rtiddsgen tool is part of the RTI Connext distribution.
For more information, type rtiddsgen -help at a command shell
or consult the RTI Connext manual.
*/
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
import
com.rti.dds.cdr.CdrEncapsulation;
com.rti.dds.cdr.CdrInputStream;
com.rti.dds.cdr.CdrOutputStream;
com.rti.dds.cdr.CdrPrimitiveType;
com.rti.dds.cdr.CdrBuffer;
com.rti.dds.cdr.CdrHelper;
com.rti.dds.cdr.CdrMemberInfo;
com.rti.dds.domain.DomainParticipant;
com.rti.dds.publication.DataWriter;
com.rti.dds.publication.DataWriterListener;
com.rti.dds.subscription.DataReader;
com.rti.dds.subscription.DataReaderListener;
com.rti.dds.topic.KeyHash_t;
com.rti.dds.topic.TypeSupportImpl;
com.rti.dds.topic.TypeSupportType;
com.rti.dds.util.Sequence;
com.rti.dds.topic.DefaultEndpointData;
com.rti.dds.infrastructure.RETCODE_ERROR;
import com.rti.dds.topic.TypeSupportParticipantInfo;
import com.rti.dds.topic.TypeSupportEndpointInfo;
import com.rti.dds.typecode.TypeCode;
1746
import com.rti.dds.infrastructure.Copyable;
public
//
//
//
class HelloWorldTypeSupport extends TypeSupportImpl {

----------------------------------------------------------------------Private Fields
-----------------------------------------------------------------------
private static final String TYPE_NAME = "HelloWorld";

private static final char[] PLUGIN_VERSION = {2, 0, 0, 0};
public static final int LAST_MEMBER_ID = 0;
private static final HelloWorldTypeSupport _singleton

= new HelloWorldTypeSupport();
// ----------------------------------------------------------------------// Public Methods
// ----------------------------------------------------------------------// --- External methods: ------------------------------------------------/* The methods in this section are for use by users of RTI Connext
*/
public static String get_type_name() {
return _singleton.get_type_nameI();
}
public static void register_type(DomainParticipant participant,
String type_name) {
_singleton.register_typeI(participant, type_name);
}
public static void unregister_type(DomainParticipant participant,
String type_name) {
_singleton.unregister_typeI(participant, type_name);
}
/* The methods in this section are for use by RTI Connext

* itself and by the code generated by rtiddsgen for other types.
* They should be used directly or modified only by advanced users and are
* subject to change in future versions of RTI Connext.
*/
public static HelloWorldTypeSupport get_instance() {
return _singleton;
}
public static HelloWorldTypeSupport getInstance() {
return get_instance();
}
public Object create_data() {
1747
return new HelloWorld();

}
public void destroy_data(Object data) {
return;
}
public Object create_key() {
}
public void destroy_key(Object key) {
return;
}
public Class get_type() {
return HelloWorld.class;
}
public Object copy_data(Object destination, Object source) {
HelloWorld typedDst = (HelloWorld) destination;
HelloWorld typedSrc = (HelloWorld) source;
return typedDst.copy_from(typedSrc);
}
public long get_serialized_sample_max_size(Object endpoint_data,boolean include_encapsulation,short encapsulation_id

long origAlignment = currentAlignment;
long encapsulation_size = currentAlignment;
if(include_encapsulation) {
if (!CdrEncapsulation.isValidEncapsulationKind(encapsulation_id)) {
throw new RETCODE_ERROR("Unsupported encapsulation");
}
encapsulation_size
encapsulation_size
encapsulation_size
currentAlignment =
origAlignment = 0;
+= CdrPrimitiveType.SHORT.getMaxSizeSerialized(encapsulation_size);
-= currentAlignment;
0;
currentAlignment +=
CdrPrimitiveType.getStringMaxSizeSerialized(currentAlignment, ((128)) + 1);
if (include_encapsulation) {
currentAlignment += encapsulation_size;
}
return currentAlignment - origAlignment;
1748
public long get_serialized_sample_min_size(Object endpoint_data,boolean include_encapsulation,short enc

}
encapsulation_size
encapsulation_size
encapsulation_size
currentAlignment =
origAlignment = 0;
0;
currentAlignment +=
CdrPrimitiveType.getStringMaxSizeSerialized(currentAlignment, 1);
}
}
public long get_serialized_sample_size(

Object endpoint_data, boolean include_encapsulation,
short encapsulation_id, long currentAlignment,
Object sample)
{
HelloWorld typedSrc = (HelloWorld) sample;
}
encapsulation_size
encapsulation_size
encapsulation_size
currentAlignment =
origAlignment = 0;
0;
1749
currentAlignment += CdrPrimitiveType.getStringSerializedSize(currentAlignment, typedSrc.msg);

}
}
public long get_serialized_key_max_size(

Object endpoint_data,
boolean include_encapsulation,
short encapsulation_id,
long currentAlignment)
{
}
encapsulation_size
encapsulation_size
encapsulation_size
currentAlignment =
origAlignment = 0;
0;
currentAlignment += get_serialized_sample_max_size(
endpoint_data,false,encapsulation_id,currentAlignment);
}
}
public void serialize(Object endpoint_data,Object src, CdrOutputStream dst,boolean serialize_encapsulation,

short encapsulation_id, boolean serialize_sample, Object endpoint_plugin_qos) {
int position = 0;
if(serialize_encapsulation) {
dst.serializeAndSetCdrEncapsulation(encapsulation_id);;
1750
position = dst.resetAlignment();
}
if(serialize_sample) {
HelloWorld typedSrc = (HelloWorld) src;
dst.writeString(typedSrc.msg,(128));
}
if (serialize_encapsulation) {
dst.restoreAlignment(position);
}
}
public void serialize_key(

Object src,
CdrOutputStream dst,
boolean serialize_encapsulation,
short encapsulation_id,
boolean serialize_key,
Object endpoint_plugin_qos)
{
int position = 0;
dst.serializeAndSetCdrEncapsulation(encapsulation_id);
position = dst.resetAlignment();
}
if (serialize_key) {
serialize(endpoint_data, src, dst, false, CdrEncapsulation.CDR_ENCAPSULATION_ID_CDR_BE, true, e

}
dst.restoreAlignment(position);
}
}
1751
public Object deserialize_sample(

Object dst,
CdrInputStream src, boolean deserialize_encapsulation,
boolean deserialize_sample,
{
int position = 0;
if(deserialize_encapsulation) {
src.deserializeAndSetCdrEncapsulation();
position = src.resetAlignment();
}
if(deserialize_sample) {
HelloWorld typedDst = (HelloWorld) dst;
try {
typedDst.msg = src.readString((128));
} catch (Exception e) {
if (src.available() > 0) {
throw new RETCODE_ERROR("Error deserializing sample! Remainder: " + src.available() + "\n" +
"Exception caused by: " + e.getMessage());
}
}
}
if (deserialize_encapsulation) {
src.restoreAlignment(position);
}
return dst;
}
public Object deserialize_key_sample(

Object dst,
CdrInputStream src,
boolean deserialize_encapsulation,
boolean deserialize_key,
{
int position = 0;
1752
}
if(deserialize_key) {
HelloWorld typedDst = (HelloWorld) dst;
deserialize_sample(endpoint_data, dst, src, false, true, endpoint_plugin_qos);

}
}
return dst;
}
public void skip(Object endpoint_data,

CdrInputStream src,
boolean skip_encapsulation,
boolean skip_sample,
{
int position = 0;
if (skip_encapsulation) {
src.skipEncapsulation();
}
if (skip_sample) {
src.skipString();
}
if (skip_encapsulation) {
}
}
public Object serialized_sample_to_key(
Object sample,
1753
CdrInputStream src,
boolean deserialize_encapsulation,
boolean deserialize_key,
{
int position = 0;
}
if (deserialize_key) {
HelloWorld typedDst = (HelloWorld) sample;
deserialize_sample(
endpoint_data, sample, src, false,
true, endpoint_plugin_qos);
}
}
return sample;
}
// ----------------------------------------------------------------------// Callbacks
// ----------------------------------------------------------------------public Object on_participant_attached(Object registration_data,
TypeSupportParticipantInfo participant_info,
boolean top_level_registration,
Object container_plugin_context,
TypeCode type_code) {
return super.on_participant_attached(
registration_data, participant_info, top_level_registration,
container_plugin_context, type_code);
}
public void on_participant_detached(Object participant_data) {
super.on_participant_detached(participant_data);
}
public Object on_endpoint_attached(Object participantData,
TypeSupportEndpointInfo endpoint_info,
boolean top_level_registration,
Object container_plugin_context) {
1754
return super.on_endpoint_attached(
participantData, endpoint_info,
top_level_registration, container_plugin_context);
}
public void on_endpoint_detached(Object endpoint_data) {
super.on_endpoint_detached(endpoint_data);
}
// ----------------------------------------------------------------------// Protected Methods
// ----------------------------------------------------------------------protected DataWriter create_datawriter(long native_writer,
DataWriterListener listener,
int mask) {
return new HelloWorldDataWriter(native_writer, listener, mask, this);
}
protected DataReader create_datareader(long native_reader,
DataReaderListener listener,
int mask) {
return new HelloWorldDataReader(native_reader, listener, mask, this);
}
// ----------------------------------------------------------------------// Constructor
// ----------------------------------------------------------------------protected HelloWorldTypeSupport() {
/* If the user data type supports keys, then the second argument
to the constructor below should be true. Otherwise it should
be false. */
super(TYPE_NAME, false,HelloWorldTypeCode.VALUE,HelloWorld.class,TypeSupportType.TST_STRUCT, PLUGIN

}
protected HelloWorldTypeSupport(boolean enableKeySupport) {
super(TYPE_NAME, enableKeySupport,HelloWorldTypeCode.VALUE,HelloWorld.class,TypeSupportType.TST_STR
}
}
9.2.1.2
HelloWorldDataWriter.java
[ (NDDSHOME)/example/JAVA/helloWorld/HelloWorldDataWriter.java]
/*
1755

*/
import
import
import
import
import
import
com.rti.dds.infrastructure.Time_t;
com.rti.dds.infrastructure.WriteParams_t;
com.rti.dds.infrastructure.InstanceHandle_t;
com.rti.dds.publication.DataWriterImpl;
com.rti.dds.publication.DataWriterListener;
// ===========================================================================
public
//
//
//
class HelloWorldDataWriter extends DataWriterImpl {

----------------------------------------------------------------------Public Methods
-----------------------------------------------------------------------
public InstanceHandle_t register_instance(HelloWorld instance_data) {

return register_instance_untyped(instance_data);
}
public InstanceHandle_t register_instance_w_timestamp(HelloWorld instance_data,

Time_t source_timestamp) {
return register_instance_w_timestamp_untyped(
instance_data, source_timestamp);
}
public InstanceHandle_t register_instance_w_params(HelloWorld instance_data,

WriteParams_t params) {
return register_instance_w_params_untyped(
instance_data, params);
}
public void unregister_instance(HelloWorld instance_data,

InstanceHandle_t handle) {
unregister_instance_untyped(instance_data, handle);
}
public void unregister_instance_w_timestamp(HelloWorld instance_data,

InstanceHandle_t handle, Time_t source_timestamp) {
unregister_instance_w_timestamp_untyped(
instance_data, handle, source_timestamp);
}
public void unregister_instance_w_params(HelloWorld instance_data,

1756
unregister_instance_w_params_untyped(
instance_data, params);
}
public void write(HelloWorld instance_data, InstanceHandle_t handle) {

write_untyped(instance_data, handle);
}
public void write_w_timestamp(HelloWorld instance_data,

InstanceHandle_t handle, Time_t source_timestamp) {
write_w_timestamp_untyped(instance_data, handle, source_timestamp);
}
public void write_w_params(HelloWorld instance_data,

write_w_params_untyped(instance_data, params);
}
public void dispose(HelloWorld instance_data, InstanceHandle_t instance_handle){

dispose_untyped(instance_data, instance_handle);
}
public void dispose_w_timestamp(HelloWorld instance_data,

InstanceHandle_t instance_handle, Time_t source_timestamp) {
dispose_w_timestamp_untyped(
instance_data, instance_handle, source_timestamp);
}
public void dispose_w_params(HelloWorld instance_data,

dispose_w_params_untyped(instance_data, params);
}
public void get_key_value(HelloWorld key_holder, InstanceHandle_t handle) {

get_key_value_untyped(key_holder, handle);
}
public InstanceHandle_t lookup_instance(HelloWorld key_holder) {

return lookup_instance_untyped(key_holder);
}
// ----------------------------------------------------------------------// Package Methods
// -----------------------------------------------------------------------
1757
// --- Constructors: ----------------------------------------------------/*package*/ HelloWorldDataWriter(long native_writer, DataWriterListener listener,

int mask, TypeSupportImpl type) {
super(native_writer, listener, mask, type);
}
}
9.2.1.3
[ (NDDSHOME)/example/JAVA/helloWorld/HelloWorldDataReader.java]
/*
*/
import
import
import
import
import
import
import
com.rti.dds.infrastructure.InstanceHandle_t;
com.rti.dds.subscription.DataReaderImpl;
com.rti.dds.subscription.DataReaderListener;
com.rti.dds.subscription.ReadCondition;
com.rti.dds.subscription.SampleInfo;
com.rti.dds.subscription.SampleInfoSeq;
// ===========================================================================
public
//
//
//
class HelloWorldDataReader extends DataReaderImpl {

----------------------------------------------------------------------Public Methods
-----------------------------------------------------------------------
public void read(HelloWorldSeq received_data, SampleInfoSeq info_seq,

int max_samples,
int sample_states, int view_states, int instance_states) {
read_untyped(received_data, info_seq, max_samples, sample_states,
view_states, instance_states);
}
public void take(HelloWorldSeq received_data, SampleInfoSeq info_seq,

int max_samples,
int sample_states, int view_states, int instance_states) {
take_untyped(received_data, info_seq, max_samples, sample_states,
view_states, instance_states);
}
public void read_w_condition(HelloWorldSeq received_data,

1758
SampleInfoSeq info_seq,
int max_samples,
ReadCondition condition) {
read_w_condition_untyped(received_data, info_seq, max_samples,
condition);
public void take_w_condition(HelloWorldSeq received_data,

SampleInfoSeq info_seq,
int max_samples,
ReadCondition condition) {
take_w_condition_untyped(received_data, info_seq, max_samples,
condition);
}
public void read_next_sample(HelloWorld received_data, SampleInfo sample_info) {

read_next_sample_untyped(received_data, sample_info);
}
public void take_next_sample(HelloWorld received_data, SampleInfo sample_info) {

take_next_sample_untyped(received_data, sample_info);
}
public void read_instance(HelloWorldSeq received_data, SampleInfoSeq info_seq,

int max_samples, InstanceHandle_t a_handle, int sample_states,
int view_states, int instance_states) {
read_instance_untyped(received_data, info_seq, max_samples, a_handle,
sample_states, view_states, instance_states);
}
public void take_instance(HelloWorldSeq received_data, SampleInfoSeq info_seq,

int max_samples, InstanceHandle_t a_handle, int sample_states,
int view_states, int instance_states) {
take_instance_untyped(received_data, info_seq, max_samples, a_handle,
sample_states, view_states, instance_states);
}
public void read_instance_w_condition(HelloWorldSeq received_data,

SampleInfoSeq info_seq, int max_samples,
InstanceHandle_t a_handle, ReadCondition condition) {
read_instance_w_condition_untyped(received_data, info_seq,
max_samples, a_handle, condition);
}
public void take_instance_w_condition(HelloWorldSeq received_data,

1759
take_instance_w_condition_untyped(received_data, info_seq,
}
public void read_next_instance(HelloWorldSeq received_data,

InstanceHandle_t a_handle, int sample_states, int view_states,
int instance_states) {
read_next_instance_untyped(received_data, info_seq, max_samples,
a_handle, sample_states, view_states, instance_states);
}
public void take_next_instance(HelloWorldSeq received_data,

InstanceHandle_t a_handle, int sample_states, int view_states,
int instance_states) {
take_next_instance_untyped(received_data, info_seq, max_samples,
a_handle, sample_states, view_states, instance_states);
}
public void read_next_instance_w_condition(HelloWorldSeq received_data,

read_next_instance_w_condition_untyped(received_data, info_seq,
}
public void take_next_instance_w_condition(HelloWorldSeq received_data,

take_next_instance_w_condition_untyped(received_data, info_seq,
}
public void return_loan(HelloWorldSeq received_data, SampleInfoSeq info_seq) {

return_loan_untyped(received_data, info_seq);
}
public void get_key_value(HelloWorld key_holder, InstanceHandle_t handle){

get_key_value_untyped(key_holder, handle);
}
public InstanceHandle_t lookup_instance(HelloWorld key_holder) {

return lookup_instance_untyped(key_holder);
}
1760
// ----------------------------------------------------------------------// Package Methods

// ----------------------------------------------------------------------// --- Constructors: ----------------------------------------------------/*package*/ HelloWorldDataReader(long native_reader, DataReaderListener listener,
int mask, TypeSupportImpl data_type) {
super(native_reader, listener, mask, data_type);
}
}
9.3 HelloWorldPublisher.java
9.3
1761
HelloWorldPublisher.java
9.3.1
RTI Connext Publication Example
The publication example generated by rtiddsgen (p. 298). The example has
been modified slightly to update the sample value.
9.3.1.1
[ (NDDSHOME)/example/JAVA/helloWorld/HelloWorldPublisher.java]
/* HelloWorldPublisher.java
A publication of data of type HelloWorld
This file is derived from code automatically generated by the rtiddsgen
command:
rtiddsgen -language java -example <arch> HelloWorld.idl
Example publication of type HelloWorld automatically generated by
rtiddsgen. To test them follow these steps:
(1) Compile this file and the example subscription.
(2) Start the subscription on the same domain used for RTI Connext with the command
java HelloWorldSubscriber <domain_id> <sample_count>
(3) Start the publication on the same domain used for RTI Connext with the command
java HelloWorldPublisher <domain_id> <sample_count>
(4) [Optional] Specify the list of discovery initial peers and
multicast receive addresses via an environment variable or a file
(in the current working directory) called NDDS_DISCOVERY_PEERS.
You can run any number of publishers and subscribers programs, and can
add and remove them dynamically from the domain.
Example:
To run the example application on domain <domain_id>:
Ensure that $(NDDSHOME)/lib/<arch> is on the dynamic library path for
Java.
On Unix:
add $(NDDSHOME)/lib/<arch> to the LD_LIBRARY_PATH environment
variable
On Windows:
add $(NDDSHOME)\lib\<arch> to the Path environment variable
1762
Run the Java applications:

java -Djava.ext.dirs=$(NDDSHOME)/class HelloWorldPublisher <domain_id>
java -Djava.ext.dirs=$(NDDSHOME)/class HelloWorldSubscriber <domain_id>
modification history
------------ ------*/
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.Arrays;
import
import
import
import
import
com.rti.dds.domain.*;
com.rti.dds.infrastructure.*;
com.rti.dds.publication.*;
com.rti.dds.topic.*;
com.rti.ndds.config.*;
// ===========================================================================
public
//
//
//
class HelloWorldPublisher {
----------------------------------------------------------------------Public Methods
-----------------------------------------------------------------------
public static void main(String[] args) {

// --- Get domain ID --- //
int domainId = 0;
if (args.length >= 1) {
domainId = Integer.valueOf(args[0]).intValue();
}
// -- Get max loop count; 0 means infinite loop --- //
int sampleCount = 0;
sampleCount = Integer.valueOf(args[1]).intValue();
}
/* Uncomment this to turn on additional logging
Logger.get_instance().set_verbosity_by_category(
LogCategory.NDDS_CONFIG_LOG_CATEGORY_API,
LogVerbosity.NDDS_CONFIG_LOG_VERBOSITY_STATUS_ALL);
*/
// --- Run --- //
publisherMain(domainId, sampleCount);
}
// ----------------------------------------------------------------------// Private Methods

// -----------------------------------------------------------------------
9.3 HelloWorldPublisher.java
1763
// --- Constructors: ----------------------------------------------------private HelloWorldPublisher() {

super();
}
// ----------------------------------------------------------------------private static void publisherMain(int domainId, int sampleCount) {

Publisher publisher = null;
Topic topic = null;
HelloWorldDataWriter writer = null;
try {
// --- Create participant --- //
/* To create participant with default QoS,
use DomainParticipantFactory.DomainParticipantFactory.
participant.get_default_publisher_qos() instead */
participant = DomainParticipantFactory.TheParticipantFactory.
create_participant(
domainId, DomainParticipantFactory.PARTICIPANT_QOS_DEFAULT,
null /* listener */, StatusKind.STATUS_MASK_NONE);
// --- Create publisher --- //
/* To customize publisher QoS, use
participant.get_default_publisher_qos() instead */
publisher = participant.create_publisher(
DomainParticipant.PUBLISHER_QOS_DEFAULT, null /* listener */,
StatusKind.STATUS_MASK_NONE);
// --- Create topic --- //
/* Register type before creating topic */
String typeName = HelloWorldTypeSupport.get_type_name();
HelloWorldTypeSupport.register_type(participant, typeName);
/* To customize topic QoS, use
participant.get_default_topic_qos() instead */
topic = participant.create_topic(
"Example HelloWorld",
typeName, DomainParticipant.TOPIC_QOS_DEFAULT,
// --- Create writer --- //
/* To customize data writer QoS, use
publisher.get_default_datawriter_qos() instead */
writer = (HelloWorldDataWriter)
publisher.create_datawriter(
topic, Publisher.DATAWRITER_QOS_DEFAULT,
1764
// --- Write --- //

/* Create data sample for writing */
HelloWorld instance = new HelloWorld();
InstanceHandle_t instance_handle = InstanceHandle_t.HANDLE_NIL;
/* For data type that has key, if the same instance is going to be
written multiple times, initialize the key here
and register the keyed instance prior to writing */
//instance_handle = writer.register_instance(instance);
final long sendPeriodMillis = 4 * 1000; // 4 seconds
for (int count = 0;
(sampleCount == 0) || (count < sampleCount);
++count) {
System.out.println("Writing HelloWorld, count " + count);
/* Modify the instance to be written here */
instance.msg = "Hello World! (" + count + ")";
/* Write data */
writer.write(instance, InstanceHandle_t.HANDLE_NIL);
try {
Thread.sleep(sendPeriodMillis);
} catch (InterruptedException ix) {
System.err.println("INTERRUPTED");
break;
}
}
//writer.unregister_instance(instance, instance_handle);
} finally {
// --- Shutdown --- //
if(participant != null) {
participant.delete_contained_entities();
delete_participant(participant);
}
/* RTI Connext provides finalize_instance()
method for people who want to release memory used by the
participant factory singleton. Uncomment the following block of
code for clean destruction of the participant factory
singleton. */
//DomainParticipantFactory.finalize_instance();
}
}
}
9.4 HelloWorldSeq.java
9.4
1765
HelloWorldSeq.java
9.4.1
Programming Language Type Description
The following programming language specific type representation is generated

by rtiddsgen (p. 298) for use in application code, where:
Foo = HelloWorld
FooSeq = HelloWorldSeq
9.4.1.1
HelloWorld.java
[ (NDDSHOME)/example/JAVA/helloWorld/HelloWorld.java]
/*
*/
import com.rti.dds.infrastructure.*;
import com.rti.dds.infrastructure.Copyable;
import java.io.Serializable;
import com.rti.dds.cdr.CdrHelper;
public class HelloWorld implements Copyable, Serializable

{
public String msg = ""; /* maximum length = (128) */
public HelloWorld() {
}
public HelloWorld(HelloWorld other) {

this();
copy_from(other);
}
public static Object create() {

1766
}
public boolean equals(Object o) {
if (o == null) {
return false;
}
if(getClass() != o.getClass()) {
return false;
}
HelloWorld otherObj = (HelloWorld)o;
if(!msg.equals(otherObj.msg)) {
return false;
}
return true;
}
public int hashCode() {
int __result = 0;
__result += msg.hashCode();
return __result;
}
public Object copy_from(Object src) {

HelloWorld typedDst = this;
typedDst.msg = typedSrc.msg;
return this;
}
public String toString(){

return toString("", 0);
}
public String toString(String desc, int indent) {

StringBuffer strBuffer = new StringBuffer();
if (desc != null) {
1767
CdrHelper.printIndent(strBuffer, indent);
strBuffer.append(desc).append(":\n");
}
CdrHelper.printIndent(strBuffer, indent+1);
strBuffer.append("msg: ").append(msg).append("\n");
return strBuffer.toString();
}
}
9.4.1.2
HelloWorldSeq.java
[ (NDDSHOME)/example/JAVA/helloWorld/HelloWorldSeq.java]
/*
*/
import java.util.Collection;
import
import
import
import
com.rti.dds.infrastructure.Copyable;
com.rti.dds.util.Enum;
com.rti.dds.util.Sequence;
com.rti.dds.util.LoanableSequence;
public
//
//
//
final class HelloWorldSeq extends LoanableSequence implements Copyable {

----------------------------------------------------------------------Package Fields
-----------------------------------------------------------------------
/*package*/ transient Sequence _loanedInfoSequence = null;

// ----------------------------------------------------------------------// Public Fields
// ----------------------------------------------------------------------// --- Constructors: ----------------------------------------------------public HelloWorldSeq() {
super(HelloWorld.class);
}
1768
public HelloWorldSeq(int initialMaximum) {

super(HelloWorld.class, initialMaximum);
}
public HelloWorldSeq(Collection elements) {

super(HelloWorld.class, elements);
}
// --- From Copyable: ---------------------------------------------------public Object copy_from(Object src) {

Sequence typedSrc = (Sequence) src;
final int srcSize = typedSrc.size();
final int origSize = size();
// if this objects size is less than the source, ensure we have
// enough room to store all of the objects
if (getMaximum() < srcSize) {
setMaximum(srcSize);
}
//
//
//
//
if
trying to avoid clear() method here since it allocates memory

(an Iterator)
if the source object has fewer items than the current object,
remove from the end until the sizes are equal
(srcSize < origSize){
removeRange(srcSize, origSize);
}
// copy the data from source into this (into positions that already
// existed)
for(int i = 0; (i < origSize) && (i < srcSize); i++){
if (typedSrc.get(i) == null){
set(i, null);
} else {
// check to see if our entry is null, if it is, a new instance has to be allocated
if (get(i) == null){
set(i, HelloWorld.create());
}
set(i, ((Copyable) get(i)).copy_from(typedSrc.get(i)));
}
}
// copy new HelloWorld objects (beyond the original size of this object)
for(int i = origSize; i < srcSize; i++){
if (typedSrc.get(i) == null) {
add(null);
} else {
// NOTE: we need to create a new object here to hold the copy
add(HelloWorld.create());
// we need to do a set here since enums arent truely Copyable
set(i, ((Copyable) get(i)).copy_from(typedSrc.get(i)));
}
}
1769
return this;
}
}
1770
9.5
HelloWorldSubscriber.java
9.5.1
RTI Connext Subscription Example
The unmodified subscription example generated by rtiddsgen (p. 298).

9.5.1.1
[ (NDDSHOME)/example/JAVA/helloWorld/HelloWorldSubscriber.java]
/* HelloWorldSubscriber.java
A publication of data of type HelloWorld
This file is derived from code automatically generated by the rtiddsgen
command:
rtiddsgen -language java -example <arch> .idl
Example publication of type HelloWorld automatically generated by
rtiddsgen To test them follow these steps:
(1) Compile this file and the example subscription.
(2) Start the subscription on the same domain used for with the command
java HelloWorldSubscriber <domain_id> <sample_count>
(3) Start the publication with the command
java HelloWorldPublisher <domain_id> <sample_count>
(4) [Optional] Specify the list of discovery initial peers and
multicast receive addresses via an environment variable or a file
(in the current working directory) called NDDS_DISCOVERY_PEERS.
You can run any number of publishers and subscribers programs, and can
add and remove them dynamically from the domain.
Example:
To run the example application on domain <domain_id>:
Ensure that $(NDDSHOME)/lib/<arch> is on the dynamic library path for
Java.
On UNIX systems:
add $(NDDSHOME)/lib/<arch> to the LD_LIBRARY_PATH environment
variable
On Windows systems:
add %NDDSHOME%\lib\<arch> to the Path environment variable
Run the Java applications:

9.5 HelloWorldSubscriber.java
1771
java -Djava.ext.dirs=$NDDSHOME/class HelloWorldPublisher <domain_id>

java -Djava.ext.dirs=$NDDSHOME/class HelloWorldSubscriber <domain_id>
modification history
------------ ------*/
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.Arrays;
import
import
import
import
import
com.rti.dds.domain.*;
com.rti.dds.infrastructure.*;
com.rti.dds.subscription.*;
com.rti.dds.topic.*;
com.rti.ndds.config.*;
// ===========================================================================
public
//
//
//
class HelloWorldSubscriber {
----------------------------------------------------------------------Public Methods
-----------------------------------------------------------------------
public static void main(String[] args) {

// --- Get domain ID --- //
int domainId = 0;
domainId = Integer.valueOf(args[0]).intValue();
}
// -- Get max loop count; 0 means infinite loop --- //
int sampleCount = 0;
sampleCount = Integer.valueOf(args[1]).intValue();
}
/* Uncomment this to turn on additional logging

Logger.get_instance().set_verbosity_by_category(
LogCategory.NDDS_CONFIG_LOG_CATEGORY_API,
LogVerbosity.NDDS_CONFIG_LOG_VERBOSITY_STATUS_ALL);
*/
// --- Run --- //
subscriberMain(domainId, sampleCount);
}
// ----------------------------------------------------------------------// Private Methods

// -----------------------------------------------------------------------
1772
// --- Constructors: ----------------------------------------------------private HelloWorldSubscriber() {

super();
}
// ----------------------------------------------------------------------private static void subscriberMain(int domainId, int sampleCount) {

Subscriber subscriber = null;
Topic topic = null;
DataReaderListener listener = null;
HelloWorldDataReader reader = null;
try {
// --- Create participant --- //
/* To customize participant QoS, use
get_default_participant_qos() */
participant = DomainParticipantFactory.TheParticipantFactory.
create_participant(
domainId, DomainParticipantFactory.PARTICIPANT_QOS_DEFAULT,
if (participant == null) {
System.err.println("create_participant error\n");
return;
}
// --- Create subscriber --- //
/* To customize subscriber QoS, use
participant.get_default_subscriber_qos() */
subscriber = participant.create_subscriber(
DomainParticipant.SUBSCRIBER_QOS_DEFAULT, null /* listener */,
StatusKind.STATUS_MASK_NONE);
if (subscriber == null) {
System.err.println("create_subscriber error\n");
return;
}
// --- Create topic --- //
/* Register type before creating topic */
String typeName = HelloWorldTypeSupport.get_type_name();
HelloWorldTypeSupport.register_type(participant, typeName);
/* To customize topic QoS, use
participant.get_default_topic_qos() */
topic = participant.create_topic(
9.5 HelloWorldSubscriber.java
1773
"Example HelloWorld",
typeName, DomainParticipant.TOPIC_QOS_DEFAULT,
if (topic == null) {
System.err.println("create_topic error\n");
return;
}
// --- Create reader --- //
listener = new HelloWorldListener();
/* To customize data reader QoS, use
subscriber.get_default_datareader_qos() */
reader = (HelloWorldDataReader)
subscriber.create_datareader(
topic, Subscriber.DATAREADER_QOS_DEFAULT, listener,
if (reader == null) {
System.err.println("create_datareader error\n");
return;
}
// --- Wait for data --- //
final long receivePeriodSec = 4;
for (int count = 0;
(sampleCount == 0) || (count < sampleCount);
++count) {
System.out.println("HelloWorld subscriber sleeping for "
+ receivePeriodSec + " sec...");
try {
Thread.sleep(receivePeriodSec * 1000); // in millisec
} catch (InterruptedException ix) {
System.err.println("INTERRUPTED");
break;
}
}
} finally {
// --- Shutdown --- //
if(participant != null) {
participant.delete_contained_entities();
delete_participant(participant);
}
/* RTI Connext provides the finalize_instance()
method for users who want to release memory used by the
participant factory singleton. Uncomment the following block of
code for clean destruction of the participant factory
singleton. */
//DomainParticipantFactory.finalize_instance();
}
1774
}
// ----------------------------------------------------------------------// Private Types
// ----------------------------------------------------------------------// =======================================================================
private static class HelloWorldListener extends DataReaderAdapter {
HelloWorldSeq _dataSeq = new HelloWorldSeq();
SampleInfoSeq _infoSeq = new SampleInfoSeq();
public void on_data_available(DataReader reader) {
HelloWorldDataReader HelloWorldReader =
(HelloWorldDataReader)reader;
try {
HelloWorldReader.take(
_dataSeq, _infoSeq,
ResourceLimitsQosPolicy.LENGTH_UNLIMITED,
SampleStateKind.ANY_SAMPLE_STATE,
InstanceStateKind.ANY_INSTANCE_STATE);
for(int i = 0; i < _dataSeq.size(); ++i) {
SampleInfo info = (SampleInfo)_infoSeq.get(i);
if (info.valid_data) {
System.out.println(
((HelloWorld)_dataSeq.get(i)).toString("Received",0));
}
}
} catch (RETCODE_NO_DATA noData) {
// No data to process
} finally {
HelloWorldReader.return_loan(_dataSeq, _infoSeq);
}
}
}
}

RTI Connext Java API v5.0.0

Uploaded by

RTI Connext Java API v5.0.0

Uploaded by

RTI Connext Java API

Feedback and Support for this Release. . . . . . . . . . . . . . . .

Conditions and WaitSets . . . . . . . . . . . . . . . . . . . . . . .

DATA READER PROTOCOL . . . . . . . . . . . . . . . . . . .

DATA READER RESOURCE LIMITS . . . . . . . . . . . . . .

DATA WRITER PROTOCOL . . . . . . . . . . . . . . . . . . .

DATA WRITER RESOURCE LIMITS . . . . . . . . . . . . . .

6.11 DESTINATION ORDER . . . . . . . . . . . . . . . . . . . . . .

6.12 DISCOVERY CONFIG . . . . . . . . . . . . . . . . . . . . . . .

6.14 NDDS DISCOVERY PEERS . . . . . . . . . . . . . . . . . . . .

6.15 DOMAIN PARTICIPANT RESOURCE LIMITS . . . . . . . . .

6.17 DURABILITY SERVICE . . . . . . . . . . . . . . . . . . . . . .

6.18 Time Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.19 Entity Support . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.20 ENTITY FACTORY . . . . . . . . . . . . . . . . . . . . . . . . .

6.21 ENTITY NAME . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.23 EXCLUSIVE AREA . . . . . . . . . . . . . . . . . . . . . . . . .

6.24 GROUP DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.25 GUID Support . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.27 LATENCY BUDGET . . . . . . . . . . . . . . . . . . . . . . . .

6.33 Object Support . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.35 OWNERSHIP STRENGTH . . . . . . . . . . . . . . . . . . . . .

6.40 PUBLISH MODE . . . . . . . . . . . . . . . . . . . . . . . . . .

6.41 QoS Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

6.42 READER DATA LIFECYCLE . . . . . . . . . . . . . . . . . . . 103

6.96 Pluggable Transports . . . . . . . . . . . . . . . . . . . . . . . . . 213

6.102Configuring QoS Profiles with XML . . . . . . . . . . . . . . . . 233

Package com.rti . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

Package com.rti.dds . . . . . . . . . . . . . . . . . . . . . . . . . 326

Package com.rti.dds.domain . . . . . . . . . . . . . . . . . . . . . 328

Package com.rti.dds.domain.builtin . . . . . . . . . . . . . . . . . 330

Package com.rti.dds.dynamicdata . . . . . . . . . . . . . . . . . . 331

Package com.rti.dds.infrastructure . . . . . . . . . . . . . . . . . 334

Package com.rti.dds.publication . . . . . . . . . . . . . . . . . . . 349

Package com.rti.dds.publication.builtin . . . . . . . . . . . . . . . 352

Package com.rti.dds.subscription . . . . . . . . . . . . . . . . . . 353

7.10 Package com.rti.dds.subscription.builtin . . . . . . . . . . . . . . 358

AbstractBuiltinTopicDataTypeSupport Class Reference . . . . . 383

AbstractPrimitiveSequence Class Reference . . . . . . . . . . . . 385

AbstractSequence Class Reference . . . . . . . . . . . . . . . . . 390

AcknowledgmentInfo Class Reference . . . . . . . . . . . . . . . . 393

AckResponseData t Class Reference . . . . . . . . . . . . . . . . 394

AllocationSettings t Class Reference . . . . . . . . . . . . . . . . 395

AsynchronousPublisherQosPolicy Class Reference . . . . . . . . . 397

AvailabilityQosPolicy Class Reference . . . . . . . . . . . . . . . 402

BAD PARAM Class Reference . . . . . . . . . . . . . . . . . . . 407

8.10 BAD TYPECODE Class Reference . . . . . . . . . . . . . . . . . 408

8.15 BooleanSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 417

8.45 DataReaderSeq Class Reference . . . . . . . . . . . . . . . . . . . 555

8.50 DataWriterProtocolQosPolicy Class Reference . . . . . . . . . . . 592

8.64 DomainParticipant Interface Reference . . . . . . . . . . . . . . . 654

8.75 Duration t Class Reference . . . . . . . . . . . . . . . . . . . . . 813

8.98 FilterSampleInfo Class Reference . . . . . . . . . . . . . . . . . . 957

8.103FlowControllerTokenBucketProperty t Class Reference . . . . . . 973

8.126KeyedStringDataReader Class Reference . . . . . . . . . . . . . . 1101

8.137LivelinessQosPolicyKind Class Reference . . . . . . . . . . . . . . 1144

8.185PublisherListener Interface Reference . . . . . . . . . . . . . . . . 1289

8.199RefilterQosPolicyKind Class Reference . . . . . . . . . . . . . . . 1322

8.225RtpsWellKnownPorts t Class Reference . . . . . . . . . . . . . . 1390

8.230SampleLostStatusKind Class Reference . . . . . . . . . . . . . . . 1412

8.261ThreadSettingsKind Class Reference . . . . . . . . . . . . . . . . 1535

8.292TypeCode Class Reference . . . . . . . . . . . . . . . . . . . . . . 1611

8.305UserException Class Reference . . . . . . . . . . . . . . . . . . . 1696

Feedback and Support for this Release.

For more information, visit our knowledge base (accessible from

(see http://www.rti.com/company/contact.html), send an email request to

Whats New. An overview of the new features in this release.

1.2 Available Documentation.

XML-Based Application Creation Getting Started Guide. Details

The HTML API Reference documentation contains:

DDS API Reference (p. 280) - The DDS API reference.

Here is a list of all modules:

Here are the packages with brief descriptions (if available):

3.1 Package List

com.rti.ndds.config (Utility APIs independent of the DDS standard )374

This inheritance list is sorted roughly, but not completely, alphabetically: