RTI Data Distribution Service Java API · RTI Data Distribution Service Java API Version 4.5d...

RTI Data Distribution Service Java API

Version 4.5d

Generated by Doxygen 1.5.5

Thu Jan 13 04:42:04 2011

Contents

1 RTI Data Distribution Service 1

1.1 Feedback and Support for this Release. . . . . . . . . . . . . . . . 1

1.2 Available Documentation. . . . . . . . . . . . . . . . . . . . . . . 2

2 Module Index 5

2.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

3 Namespace Index 9

3.1 Package List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4 Class Index 13

4.1 Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

5 Class Index 21

5.1 Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

6 Module Documentation 39

6.1 ASYNCHRONOUS PUBLISHER . . . . . . . . . . . . . . . . . . 39

6.2 BATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

6.3 Conditions and WaitSets . . . . . . . . . . . . . . . . . . . . . . . 42

6.4 DATABASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

6.5 DATA READER PROTOCOL . . . . . . . . . . . . . . . . . . . 44

6.6 DATA READER RESOURCE LIMITS . . . . . . . . . . . . . . 45

6.7 DATA WRITER PROTOCOL . . . . . . . . . . . . . . . . . . . 47

6.8 DATA WRITER RESOURCE LIMITS . . . . . . . . . . . . . . 48

ii CONTENTS

6.9 DEADLINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

6.10 DESTINATION ORDER . . . . . . . . . . . . . . . . . . . . . . 50

6.11 DISCOVERY CONFIG . . . . . . . . . . . . . . . . . . . . . . . 51

6.12 DISCOVERY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

6.13 NDDS DISCOVERY PEERS . . . . . . . . . . . . . . . . . . . . 54

6.14 DOMAIN PARTICIPANT RESOURCE LIMITS . . . . . . . . . 62

6.15 DURABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

6.16 DURABILITY SERVICE . . . . . . . . . . . . . . . . . . . . . . 65

6.17 Time Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

6.18 Entity Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

6.19 ENTITY FACTORY . . . . . . . . . . . . . . . . . . . . . . . . . 68

6.20 ENTITY NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

6.21 EVENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

6.22 EXCLUSIVE AREA . . . . . . . . . . . . . . . . . . . . . . . . . 71

6.23 GROUP DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

6.24 GUID Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

6.25 HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

6.26 LATENCY BUDGET . . . . . . . . . . . . . . . . . . . . . . . . 75

6.27 LIFESPAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

6.28 LIVELINESS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

6.29 LOCATORFILTER . . . . . . . . . . . . . . . . . . . . . . . . . 78

6.30 MULTICHANNEL . . . . . . . . . . . . . . . . . . . . . . . . . . 79

6.31 Object Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

6.32 OWNERSHIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

6.33 OWNERSHIP STRENGTH . . . . . . . . . . . . . . . . . . . . . 82

6.34 PARTITION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

6.35 PRESENTATION . . . . . . . . . . . . . . . . . . . . . . . . . . 84

6.36 PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

6.37 PROPERTY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

6.38 PUBLISH MODE . . . . . . . . . . . . . . . . . . . . . . . . . . 87

6.39 QoS Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Generated on Thu Jan 13 04:42:04 2011 for RTI Data Distribution Service Java APIby Doxygen

CONTENTS iii

6.40 READER DATA LIFECYCLE . . . . . . . . . . . . . . . . . . . 97

6.41 RECEIVER POOL . . . . . . . . . . . . . . . . . . . . . . . . . . 98

6.42 RELIABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

6.43 RESOURCE LIMITS . . . . . . . . . . . . . . . . . . . . . . . . 100

6.44 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

6.45 Sequence Number Support . . . . . . . . . . . . . . . . . . . . . . 103

6.46 Status Kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

6.47 SYSTEM RESOURCE LIMITS . . . . . . . . . . . . . . . . . . . 109

6.48 Thread Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

6.49 TIME BASED FILTER . . . . . . . . . . . . . . . . . . . . . . . 111

6.50 TOPIC DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

6.51 TRANSPORT BUILTIN . . . . . . . . . . . . . . . . . . . . . . . 113

6.52 TRANSPORT MULTICAST . . . . . . . . . . . . . . . . . . . . 116

6.53 TRANSPORT PRIORITY . . . . . . . . . . . . . . . . . . . . . 117

6.54 TRANSPORT SELECTION . . . . . . . . . . . . . . . . . . . . 118

6.55 TRANSPORT UNICAST . . . . . . . . . . . . . . . . . . . . . . 119

6.56 TYPESUPPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

6.57 USER DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

6.58 Exception Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

6.59 WIRE PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . . . 124

6.60 WRITER DATA LIFECYCLE . . . . . . . . . . . . . . . . . . . 130

6.61 KeyedString Built-in Type . . . . . . . . . . . . . . . . . . . . . . 131

6.62 Octets Built-in Type . . . . . . . . . . . . . . . . . . . . . . . . . 132

6.63 KeyedOctets Built-in Type . . . . . . . . . . . . . . . . . . . . . 133

6.64 Sequence Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

6.65 Clock Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

6.66 Domain Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

6.67 DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . . 140

6.68 DomainParticipants . . . . . . . . . . . . . . . . . . . . . . . . . 142

6.69 Built-in Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

6.70 Topic Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151


iv CONTENTS

6.71 Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

6.72 User Data Type Support . . . . . . . . . . . . . . . . . . . . . . . 154

6.73 Type Code Support . . . . . . . . . . . . . . . . . . . . . . . . . 156

6.74 Built-in Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

6.75 Dynamic Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

6.76 Publication Module . . . . . . . . . . . . . . . . . . . . . . . . . . 169

6.77 Publishers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

6.78 Data Writers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

6.79 Flow Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

6.80 Subscription Module . . . . . . . . . . . . . . . . . . . . . . . . . 180

6.81 Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

6.82 DataReaders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

6.83 Read Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

6.84 Query Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

6.85 Data Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

6.86 Sample States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

6.87 View States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

6.88 Instance States . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

6.89 Infrastructure Module . . . . . . . . . . . . . . . . . . . . . . . . 194

6.90 Built-in Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . 196

6.91 Multi-channel DataWriters . . . . . . . . . . . . . . . . . . . . . 198

6.92 Pluggable Transports . . . . . . . . . . . . . . . . . . . . . . . . . 201

6.93 Using Transport Plugins . . . . . . . . . . . . . . . . . . . . . . . 207

6.94 Built-in Transport Plugins . . . . . . . . . . . . . . . . . . . . . . 210

6.95 Configuration Utilities . . . . . . . . . . . . . . . . . . . . . . . . 212

6.96 Durability and Persistence . . . . . . . . . . . . . . . . . . . . . . 213

6.97 Configuring QoS Profiles with XML . . . . . . . . . . . . . . . . 219

6.98 Publication Example . . . . . . . . . . . . . . . . . . . . . . . . . 223

6.99 Subscription Example . . . . . . . . . . . . . . . . . . . . . . . . 224

6.100Participant Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 225

6.101Topic Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 227


CONTENTS v

6.102FlowController Use Cases . . . . . . . . . . . . . . . . . . . . . . 229

6.103Publisher Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 233

6.104DataWriter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 234

6.105Subscriber Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 236

6.106DataReader Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 239

6.107Entity Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

6.108Waitset Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 247

6.109Transport Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 249

6.110Filter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

6.111Creating Custom Content Filters . . . . . . . . . . . . . . . . . . 257

6.112Large Data Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 261

6.113Documentation Roadmap . . . . . . . . . . . . . . . . . . . . . . 263

6.114Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

6.115DDS API Reference . . . . . . . . . . . . . . . . . . . . . . . . . 266

6.116Queries and Filters Syntax . . . . . . . . . . . . . . . . . . . . . . 272

6.117RTI Data Distribution Service API Reference . . . . . . . . . . . 280

6.118Programming How-Tos . . . . . . . . . . . . . . . . . . . . . . . 281

6.119Programming Tools . . . . . . . . . . . . . . . . . . . . . . . . . . 283

6.120rtiddsgen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

6.121rtiddsping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

6.122rtiddsspy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

7 Namespace Documentation 311

7.1 Package com.rti.dds.domain . . . . . . . . . . . . . . . . . . . . . 311

7.2 Package com.rti.dds.domain.builtin . . . . . . . . . . . . . . . . . 313

7.3 Package com.rti.dds.dynamicdata . . . . . . . . . . . . . . . . . . 314

7.4 Package com.rti.dds.infrastructure . . . . . . . . . . . . . . . . . 317

7.5 Package com.rti.dds.publication . . . . . . . . . . . . . . . . . . . 331

7.6 Package com.rti.dds.publication.builtin . . . . . . . . . . . . . . . 334

7.7 Package com.rti.dds.publication.example . . . . . . . . . . . . . . 335

7.8 Package com.rti.dds.subscription . . . . . . . . . . . . . . . . . . 336


vi CONTENTS

7.9 Package com.rti.dds.subscription.builtin . . . . . . . . . . . . . . 341

7.10 Package com.rti.dds.subscription.example . . . . . . . . . . . . . 342

7.11 Package com.rti.dds.topic . . . . . . . . . . . . . . . . . . . . . . 343

7.12 Package com.rti.dds.topic.builtin . . . . . . . . . . . . . . . . . . 345

7.13 Package com.rti.dds.topic.example . . . . . . . . . . . . . . . . . 346

7.14 Package com.rti.dds.type.builtin . . . . . . . . . . . . . . . . . . . 347

7.15 Package com.rti.dds.typecode . . . . . . . . . . . . . . . . . . . . 353

7.16 Package com.rti.dds.util . . . . . . . . . . . . . . . . . . . . . . . 357

7.17 Package com.rti.ndds.config . . . . . . . . . . . . . . . . . . . . . 358

7.18 Package com.rti.ndds.example . . . . . . . . . . . . . . . . . . . . 359

7.19 Package com.rti.ndds.transport . . . . . . . . . . . . . . . . . . . 360

8 Class Documentation 367

8.1 AbstractBuiltinTopicDataTypeSupport Class Reference . . . . . 367

8.2 AbstractPrimitiveSequence Class Reference . . . . . . . . . . . . 369

8.3 AbstractSequence Class Reference . . . . . . . . . . . . . . . . . 374

8.4 AllocationSettings t Class Reference . . . . . . . . . . . . . . . . 377

8.5 AsynchronousPublisherQosPolicy Class Reference . . . . . . . . . 379

8.6 BAD PARAM Class Reference . . . . . . . . . . . . . . . . . . . 384

8.7 BAD TYPECODE Class Reference . . . . . . . . . . . . . . . . . 385

8.8 BadKind Class Reference . . . . . . . . . . . . . . . . . . . . . . 386

8.9 BadMemberId Class Reference . . . . . . . . . . . . . . . . . . . 387

8.10 BadMemberName Class Reference . . . . . . . . . . . . . . . . . 388

8.11 BatchQosPolicy Class Reference . . . . . . . . . . . . . . . . . . 389

8.12 BooleanSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 393

8.13 Bounds Class Reference . . . . . . . . . . . . . . . . . . . . . . . 399

8.14 BuiltinTopicKey t Class Reference . . . . . . . . . . . . . . . . . 400

8.15 BuiltinTopicReaderResourceLimits t Class Reference . . . . . . . 402

8.16 Bytes Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 405

8.17 BytesDataReader Class Reference . . . . . . . . . . . . . . . . . . 408

8.18 BytesDataWriter Class Reference . . . . . . . . . . . . . . . . . . 412


CONTENTS vii

8.19 ByteSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 416

8.20 BytesSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 422

8.21 BytesTypeSupport Class Reference . . . . . . . . . . . . . . . . . 425

8.22 ChannelSettings t Class Reference . . . . . . . . . . . . . . . . . 429

8.23 ChannelSettingsSeq Class Reference . . . . . . . . . . . . . . . . 432

8.24 CharSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 433

8.25 Condition Interface Reference . . . . . . . . . . . . . . . . . . . . 439

8.26 ConditionSeq Class Reference . . . . . . . . . . . . . . . . . . . . 440

8.27 ContentFilter Interface Reference . . . . . . . . . . . . . . . . . . 442

8.28 ContentFilteredTopic Interface Reference . . . . . . . . . . . . . 446

8.29 ContentFilterProperty t Class Reference . . . . . . . . . . . . . . 451

8.30 Copyable Interface Reference . . . . . . . . . . . . . . . . . . . . 453

8.31 DatabaseQosPolicy Class Reference . . . . . . . . . . . . . . . . . 455

8.32 DataReader Interface Reference . . . . . . . . . . . . . . . . . . . 460

8.33 DataReaderAdapter Class Reference . . . . . . . . . . . . . . . . 483

8.34 DataReaderCacheStatus Class Reference . . . . . . . . . . . . . . 486

8.35 DataReaderListener Interface Reference . . . . . . . . . . . . . . 487

8.36 DataReaderProtocolQosPolicy Class Reference . . . . . . . . . . 490

8.37 DataReaderProtocolStatus Class Reference . . . . . . . . . . . . 495

8.38 DataReaderQos Class Reference . . . . . . . . . . . . . . . . . . . 505

8.39 DataReaderResourceLimitsQosPolicy Class Reference . . . . . . 511

8.40 DataReaderSeq Class Reference . . . . . . . . . . . . . . . . . . . 522

8.41 DataWriter Interface Reference . . . . . . . . . . . . . . . . . . . 524

8.42 DataWriterAdapter Class Reference . . . . . . . . . . . . . . . . 546

8.43 DataWriterCacheStatus Class Reference . . . . . . . . . . . . . . 551

8.44 DataWriterListener Interface Reference . . . . . . . . . . . . . . 552

8.45 DataWriterProtocolQosPolicy Class Reference . . . . . . . . . . . 557

8.46 DataWriterProtocolStatus Class Reference . . . . . . . . . . . . . 562

8.47 DataWriterQos Class Reference . . . . . . . . . . . . . . . . . . . 574

8.48 DataWriterResourceLimitsInstanceReplacementKind Class Ref-erence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580


viii CONTENTS

8.49 DataWriterResourceLimitsQosPolicy Class Reference . . . . . . . 584

8.50 DeadlineQosPolicy Class Reference . . . . . . . . . . . . . . . . . 589

8.51 DestinationOrderQosPolicy Class Reference . . . . . . . . . . . . 592

8.52 DestinationOrderQosPolicyKind Class Reference . . . . . . . . . 595

8.53 DiscoveryBuiltinReaderFragmentationResourceLimits t ClassReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597

8.54 DiscoveryConfigBuiltinPluginKind Class Reference . . . . . . . . 599

8.55 DiscoveryConfigQosPolicy Class Reference . . . . . . . . . . . . . 600

8.56 DiscoveryPluginPromiscuityKind Class Reference . . . . . . . . . 608

8.57 DiscoveryQosPolicy Class Reference . . . . . . . . . . . . . . . . 609

8.58 DomainEntity Interface Reference . . . . . . . . . . . . . . . . . 613

8.59 DomainParticipant Interface Reference . . . . . . . . . . . . . . . 614

8.60 DomainParticipantAdapter Class Reference . . . . . . . . . . . . 687

8.61 DomainParticipantFactory Class Reference . . . . . . . . . . . . 692

8.62 DomainParticipantFactoryQos Class Reference . . . . . . . . . . 717

8.63 DomainParticipantListener Interface Reference . . . . . . . . . . 719

8.64 DomainParticipantQos Class Reference . . . . . . . . . . . . . . . 721

8.65 DomainParticipantResourceLimitsQosPolicy Class Reference . . 725

8.66 DoubleSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 742

8.67 DurabilityQosPolicy Class Reference . . . . . . . . . . . . . . . . 748

8.68 DurabilityQosPolicyKind Class Reference . . . . . . . . . . . . . 753

8.69 DurabilityServiceQosPolicy Class Reference . . . . . . . . . . . . 756

8.70 Duration t Class Reference . . . . . . . . . . . . . . . . . . . . . 759

8.71 DynamicData Class Reference . . . . . . . . . . . . . . . . . . . . 762

8.72 DynamicDataInfo Class Reference . . . . . . . . . . . . . . . . . 826

8.73 DynamicDataMemberInfo Class Reference . . . . . . . . . . . . . 828

8.74 DynamicDataProperty t Class Reference . . . . . . . . . . . . . . 831

8.75 DynamicDataReader Class Reference . . . . . . . . . . . . . . . . 833

8.76 DynamicDataSeq Class Reference . . . . . . . . . . . . . . . . . . 863

8.77 DynamicDataTypeProperty t Class Reference . . . . . . . . . . . 865

8.78 DynamicDataTypeSerializationProperty t Class Reference . . . . 867


CONTENTS ix

8.79 DynamicDataTypeSupport Class Reference . . . . . . . . . . . . 869

8.80 DynamicDataWriter Class Reference . . . . . . . . . . . . . . . . 875

8.81 Entity Interface Reference . . . . . . . . . . . . . . . . . . . . . . 891

8.82 EntityFactoryQosPolicy Class Reference . . . . . . . . . . . . . . 898

8.83 EntityHowTo.MyEntityListener Class Reference . . . . . . . . . . 901

8.84 EntityNameQosPolicy Class Reference . . . . . . . . . . . . . . . 902

8.85 Enum Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 903

8.86 EnumMember Class Reference . . . . . . . . . . . . . . . . . . . 906

8.87 EventQosPolicy Class Reference . . . . . . . . . . . . . . . . . . . 908

8.88 ExclusiveAreaQosPolicy Class Reference . . . . . . . . . . . . . . 911

8.89 FloatSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 914

8.90 FlowController Interface Reference . . . . . . . . . . . . . . . . . 920

8.91 FlowControllerProperty t Class Reference . . . . . . . . . . . . . 924

8.92 FlowControllerSchedulingPolicy Class Reference . . . . . . . . . 926

8.93 FlowControllerTokenBucketProperty t Class Reference . . . . . . 929

8.94 Foo Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . 933

8.95 Foo Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . 934

8.96 FooDataReader Class Reference . . . . . . . . . . . . . . . . . . . 936

8.97 FooDataReader Interface Reference . . . . . . . . . . . . . . . . . 966

8.98 FooDataWriter Interface Reference . . . . . . . . . . . . . . . . . 995

8.99 FooDataWriter Class Reference . . . . . . . . . . . . . . . . . . . 1011

8.100FooSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1027

8.101FooSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1029

8.102FooTypeSupport Class Reference . . . . . . . . . . . . . . . . . . 1031

8.103FooTypeSupport Class Reference . . . . . . . . . . . . . . . . . . 1034

8.104GroupDataQosPolicy Class Reference . . . . . . . . . . . . . . . 1035

8.105GuardCondition Class Reference . . . . . . . . . . . . . . . . . . 1037

8.106GUID t Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1040

8.107HistoryQosPolicy Class Reference . . . . . . . . . . . . . . . . . . 1042

8.108HistoryQosPolicyKind Class Reference . . . . . . . . . . . . . . . 1046

8.109InconsistentTopicStatus Class Reference . . . . . . . . . . . . . . 1048


x CONTENTS

8.110InetAddressSeq Class Reference . . . . . . . . . . . . . . . . . . . 1050

8.111InstanceHandle t Class Reference . . . . . . . . . . . . . . . . . . 1051

8.112InstanceHandleSeq Class Reference . . . . . . . . . . . . . . . . . 1054

8.113InstanceStateKind Class Reference . . . . . . . . . . . . . . . . . 1057

8.114IntSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 1060

8.115KeyedBytes Class Reference . . . . . . . . . . . . . . . . . . . . . 1066

8.116KeyedBytesDataReader Class Reference . . . . . . . . . . . . . . 1069

8.117KeyedBytesDataWriter Class Reference . . . . . . . . . . . . . . 1076

8.118KeyedBytesSeq Class Reference . . . . . . . . . . . . . . . . . . . 1086

8.119KeyedBytesTypeSupport Class Reference . . . . . . . . . . . . . 1089

8.120KeyedString Class Reference . . . . . . . . . . . . . . . . . . . . 1093

8.121KeyedStringDataReader Class Reference . . . . . . . . . . . . . . 1095

8.122KeyedStringDataWriter Class Reference . . . . . . . . . . . . . . 1102

8.123KeyedStringSeq Class Reference . . . . . . . . . . . . . . . . . . . 1110

8.124KeyedStringTypeSupport Class Reference . . . . . . . . . . . . . 1113

8.125LatencyBudgetQosPolicy Class Reference . . . . . . . . . . . . . 1117

8.126LibraryVersion t Class Reference . . . . . . . . . . . . . . . . . . 1119

8.127LifespanQosPolicy Class Reference . . . . . . . . . . . . . . . . . 1121

8.128Listener Interface Reference . . . . . . . . . . . . . . . . . . . . . 1123

8.129LivelinessChangedStatus Class Reference . . . . . . . . . . . . . . 1128

8.130LivelinessLostStatus Class Reference . . . . . . . . . . . . . . . . 1131

8.131LivelinessQosPolicy Class Reference . . . . . . . . . . . . . . . . 1133

8.132LivelinessQosPolicyKind Class Reference . . . . . . . . . . . . . . 1137

8.133LoanableSequence Class Reference . . . . . . . . . . . . . . . . . 1139

8.134Locator t Class Reference . . . . . . . . . . . . . . . . . . . . . . 1143

8.135LocatorFilter t Class Reference . . . . . . . . . . . . . . . . . . . 1147

8.136LocatorFilterQosPolicy Class Reference . . . . . . . . . . . . . . 1150

8.137LocatorFilterSeq Class Reference . . . . . . . . . . . . . . . . . . 1152

8.138LocatorSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 1153

8.139LogCategory Class Reference . . . . . . . . . . . . . . . . . . . . 1154

8.140Logger Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 1156


CONTENTS xi

8.141LogPrintFormat Class Reference . . . . . . . . . . . . . . . . . . 1159

8.142LogVerbosity Class Reference . . . . . . . . . . . . . . . . . . . . 1162

8.143LongDoubleSeq Class Reference . . . . . . . . . . . . . . . . . . . 1164

8.144LongSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1166

8.145MultiChannelQosPolicy Class Reference . . . . . . . . . . . . . . 1172

8.146MultiTopic Interface Reference . . . . . . . . . . . . . . . . . . . 1175

8.147ObjectHolder Class Reference . . . . . . . . . . . . . . . . . . . . 1178

8.148OfferedDeadlineMissedStatus Class Reference . . . . . . . . . . . 1179

8.149OfferedIncompatibleQosStatus Class Reference . . . . . . . . . . 1181

8.150OwnershipQosPolicy Class Reference . . . . . . . . . . . . . . . . 1183

8.151OwnershipQosPolicyKind Class Reference . . . . . . . . . . . . . 1190

8.152OwnershipStrengthQosPolicy Class Reference . . . . . . . . . . . 1192

8.153ParticipantBuiltinTopicData Class Reference . . . . . . . . . . . 1194

8.154ParticipantBuiltinTopicDataDataReader Class Reference . . . . . 1197

8.155ParticipantBuiltinTopicDataSeq Class Reference . . . . . . . . . 1198

8.156ParticipantBuiltinTopicDataTypeSupport Class Reference . . . . 1199

8.157PartitionQosPolicy Class Reference . . . . . . . . . . . . . . . . . 1200

8.158PresentationQosPolicy Class Reference . . . . . . . . . . . . . . . 1204

8.159PresentationQosPolicyAccessScopeKind Class Reference . . . . . 1209

8.160PRIVATE MEMBER Class Reference . . . . . . . . . . . . . . . 1211

8.161ProductVersion t Class Reference . . . . . . . . . . . . . . . . . . 1212

8.162ProfileQosPolicy Class Reference . . . . . . . . . . . . . . . . . . 1214

8.163Property t Class Reference . . . . . . . . . . . . . . . . . . . . . 1217

8.164PropertyQosPolicy Class Reference . . . . . . . . . . . . . . . . . 1219

8.165PropertyQosPolicyHelper Class Reference . . . . . . . . . . . . . 1222

8.166PropertySeq Class Reference . . . . . . . . . . . . . . . . . . . . 1226

8.167ProtocolVersion t Class Reference . . . . . . . . . . . . . . . . . . 1227

8.168PUBLIC MEMBER Class Reference . . . . . . . . . . . . . . . . 1230

8.169PublicationBuiltinTopicData Class Reference . . . . . . . . . . . 1231

8.170PublicationBuiltinTopicDataDataReader Class Reference . . . . 1238

8.171PublicationBuiltinTopicDataSeq Class Reference . . . . . . . . . 1239


xii CONTENTS

8.172PublicationBuiltinTopicDataTypeSupport Class Reference . . . . 1240

8.173PublicationMatchedStatus Class Reference . . . . . . . . . . . . . 1241

8.174Publisher Interface Reference . . . . . . . . . . . . . . . . . . . . 1244

8.175PublisherAdapter Class Reference . . . . . . . . . . . . . . . . . 1268

8.176PublisherListener Interface Reference . . . . . . . . . . . . . . . . 1269

8.177PublisherQos Class Reference . . . . . . . . . . . . . . . . . . . . 1270

8.178PublisherSeq Class Reference . . . . . . . . . . . . . . . . . . . . 1273

8.179PublishModeQosPolicy Class Reference . . . . . . . . . . . . . . 1275

8.180PublishModeQosPolicyKind Class Reference . . . . . . . . . . . . 1278

8.181Qos Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . 1280

8.182QosPolicy Class Reference . . . . . . . . . . . . . . . . . . . . . . 1281

8.183QosPolicyCount Class Reference . . . . . . . . . . . . . . . . . . 1282

8.184QosPolicyCountSeq Class Reference . . . . . . . . . . . . . . . . 1284

8.185QosPolicyId t Class Reference . . . . . . . . . . . . . . . . . . . . 1285

8.186QueryCondition Interface Reference . . . . . . . . . . . . . . . . 1291

8.187ReadCondition Interface Reference . . . . . . . . . . . . . . . . . 1293

8.188ReaderDataLifecycleQosPolicy Class Reference . . . . . . . . . . 1295

8.189ReceiverPoolQosPolicy Class Reference . . . . . . . . . . . . . . . 1298

8.190RefilterQosPolicyKind Class Reference . . . . . . . . . . . . . . . 1301

8.191ReliabilityQosPolicy Class Reference . . . . . . . . . . . . . . . . 1303

8.192ReliabilityQosPolicyKind Class Reference . . . . . . . . . . . . . 1307

8.193ReliableReaderActivityChangedStatus Class Reference . . . . . . 1309

8.194ReliableWriterCacheChangedStatus Class Reference . . . . . . . 1312

8.195ReliableWriterCacheEventCount Class Reference . . . . . . . . . 1316

8.196RemoteParticipantPurgeKind Class Reference . . . . . . . . . . . 1317

8.197RequestedDeadlineMissedStatus Class Reference . . . . . . . . . 1320

8.198RequestedIncompatibleQosStatus Class Reference . . . . . . . . . 1321

8.199ResourceLimitsQosPolicy Class Reference . . . . . . . . . . . . . 1323

8.200RETCODE ALREADY DELETED Class Reference . . . . . . . 1329

8.201RETCODE BAD PARAMETER Class Reference . . . . . . . . . 1330

8.202RETCODE ERROR Class Reference . . . . . . . . . . . . . . . . 1331


CONTENTS xiii

8.203RETCODE ILLEGAL OPERATION Class Reference . . . . . . 1332

8.204RETCODE IMMUTABLE POLICY Class Reference . . . . . . . 1333

8.205RETCODE INCONSISTENT POLICY Class Reference . . . . . 1334

8.206RETCODE NO DATA Class Reference . . . . . . . . . . . . . . 1335

8.207RETCODE NOT ENABLED Class Reference . . . . . . . . . . . 1336

8.208RETCODE OUT OF RESOURCES Class Reference . . . . . . . 1337

8.209RETCODE PRECONDITION NOT MET Class Reference . . . 1338

8.210RETCODE TIMEOUT Class Reference . . . . . . . . . . . . . . 1339

8.211RETCODE UNSUPPORTED Class Reference . . . . . . . . . . 1340

8.212RtpsReliableReaderProtocol t Class Reference . . . . . . . . . . . 1341

8.213RtpsReliableWriterProtocol t Class Reference . . . . . . . . . . . 1344

8.214RtpsReservedPortKind Class Reference . . . . . . . . . . . . . . 1358

8.215RtpsWellKnownPorts t Class Reference . . . . . . . . . . . . . . 1360

8.216SampleInfo Class Reference . . . . . . . . . . . . . . . . . . . . . 1366

8.217SampleInfoSeq Class Reference . . . . . . . . . . . . . . . . . . . 1376

8.218SampleLostStatus Class Reference . . . . . . . . . . . . . . . . . 1377

8.219SampleRejectedStatus Class Reference . . . . . . . . . . . . . . . 1378

8.220SampleRejectedStatusKind Class Reference . . . . . . . . . . . . 1380

8.221SampleStateKind Class Reference . . . . . . . . . . . . . . . . . . 1384

8.222Sequence Interface Reference . . . . . . . . . . . . . . . . . . . . 1386

8.223SequenceNumber t Class Reference . . . . . . . . . . . . . . . . . 1389

8.224ShmemTransport Interface Reference . . . . . . . . . . . . . . . . 1392

8.225ShmemTransport.Property t Class Reference . . . . . . . . . . . 1396

8.226ShortSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 1399

8.227StatusCondition Interface Reference . . . . . . . . . . . . . . . . 1405

8.228StatusKind Class Reference . . . . . . . . . . . . . . . . . . . . . 1408

8.229StringDataReader Class Reference . . . . . . . . . . . . . . . . . 1418

8.230StringDataWriter Class Reference . . . . . . . . . . . . . . . . . . 1421

8.231StringSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 1423

8.232StringTypeSupport Class Reference . . . . . . . . . . . . . . . . . 1426

8.233StructMember Class Reference . . . . . . . . . . . . . . . . . . . 1429


xiv CONTENTS

8.234Subscriber Interface Reference . . . . . . . . . . . . . . . . . . . . 1431

8.235SubscriberAdapter Class Reference . . . . . . . . . . . . . . . . . 1455

8.236SubscriberListener Interface Reference . . . . . . . . . . . . . . . 1456

8.237SubscriberQos Class Reference . . . . . . . . . . . . . . . . . . . 1458

8.238SubscriberSeq Class Reference . . . . . . . . . . . . . . . . . . . . 1460

8.239SubscriptionBuiltinTopicData Class Reference . . . . . . . . . . . 1462

8.240SubscriptionBuiltinTopicDataDataReader Class Reference . . . . 1469

8.241SubscriptionBuiltinTopicDataSeq Class Reference . . . . . . . . . 1470

8.242SubscriptionBuiltinTopicDataTypeSupport Class Reference . . . 1471

8.243SubscriptionMatchedStatus Class Reference . . . . . . . . . . . . 1472

8.244SystemException Class Reference . . . . . . . . . . . . . . . . . . 1475

8.245SystemResourceLimitsQosPolicy Class Reference . . . . . . . . . 1476

8.246TCKind Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1478

8.247ThreadSettings t Class Reference . . . . . . . . . . . . . . . . . . 1483

8.248ThreadSettingsCpuRotationKind Class Reference . . . . . . . . . 1486

8.249ThreadSettingsKind Class Reference . . . . . . . . . . . . . . . . 1488

8.250Time t Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 1490

8.251TimeBasedFilterQosPolicy Class Reference . . . . . . . . . . . . 1493

8.252Topic Interface Reference . . . . . . . . . . . . . . . . . . . . . . 1497

8.253TopicAdapter Class Reference . . . . . . . . . . . . . . . . . . . . 1502

8.254TopicBuiltinTopicData Class Reference . . . . . . . . . . . . . . . 1504

8.255TopicBuiltinTopicDataDataReader Class Reference . . . . . . . . 1508

8.256TopicBuiltinTopicDataSeq Class Reference . . . . . . . . . . . . . 1509

8.257TopicBuiltinTopicDataTypeSupport Class Reference . . . . . . . 1510

8.258TopicDataQosPolicy Class Reference . . . . . . . . . . . . . . . . 1511

8.259TopicDescription Interface Reference . . . . . . . . . . . . . . . . 1513

8.260TopicListener Interface Reference . . . . . . . . . . . . . . . . . . 1516

8.261TopicQos Class Reference . . . . . . . . . . . . . . . . . . . . . . 1518

8.262Transport Interface Reference . . . . . . . . . . . . . . . . . . . . 1521

8.263Transport.Property t Class Reference . . . . . . . . . . . . . . . . 1522

8.264TransportBuiltinKind Class Reference . . . . . . . . . . . . . . . 1530


CONTENTS xv

8.265TransportBuiltinQosPolicy Class Reference . . . . . . . . . . . . 1532

8.266TransportMulticastQosPolicy Class Reference . . . . . . . . . . . 1534

8.267TransportMulticastSettings t Class Reference . . . . . . . . . . . 1536

8.268TransportMulticastSettingsSeq Class Reference . . . . . . . . . . 1539

8.269TransportPriorityQosPolicy Class Reference . . . . . . . . . . . . 1540

8.270TransportSelectionQosPolicy Class Reference . . . . . . . . . . . 1542

8.271TransportSupport Class Reference . . . . . . . . . . . . . . . . . 1544

8.272TransportUnicastQosPolicy Class Reference . . . . . . . . . . . . 1547

8.273TransportUnicastSettings t Class Reference . . . . . . . . . . . . 1550

8.274TransportUnicastSettingsSeq Class Reference . . . . . . . . . . . 1552

8.275TypeCode Class Reference . . . . . . . . . . . . . . . . . . . . . . 1553

8.276TypeCodeFactory Class Reference . . . . . . . . . . . . . . . . . 1583

8.277TypeSupport Interface Reference . . . . . . . . . . . . . . . . . . 1593

8.278TypeSupportQosPolicy Class Reference . . . . . . . . . . . . . . 1594

8.279UDPv4Transport Interface Reference . . . . . . . . . . . . . . . . 1596

8.280UDPv4Transport.Property t Class Reference . . . . . . . . . . . 1600

8.281UDPv6Transport Interface Reference . . . . . . . . . . . . . . . . 1607

8.282UDPv6Transport.Property t Class Reference . . . . . . . . . . . 1611

8.283Union Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 1618

8.284UnionMember Class Reference . . . . . . . . . . . . . . . . . . . 1619

8.285UserDataQosPolicy Class Reference . . . . . . . . . . . . . . . . 1621

8.286UserException Class Reference . . . . . . . . . . . . . . . . . . . 1623

8.287ValueMember Class Reference . . . . . . . . . . . . . . . . . . . . 1624

8.288VendorId t Class Reference . . . . . . . . . . . . . . . . . . . . . 1626

8.289Version Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1628

8.290ViewStateKind Class Reference . . . . . . . . . . . . . . . . . . . 1630

8.291VM ABSTRACT Class Reference . . . . . . . . . . . . . . . . . . 1632

8.292VM CUSTOM Class Reference . . . . . . . . . . . . . . . . . . . 1633

8.293VM NONE Class Reference . . . . . . . . . . . . . . . . . . . . . 1634

8.294VM TRUNCATABLE Class Reference . . . . . . . . . . . . . . . 1635

8.295WaitSet Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1636


xvi CONTENTS

8.296WaitSetProperty t Class Reference . . . . . . . . . . . . . . . . . 1646

8.297WcharSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 1648

8.298WireProtocolQosPolicy Class Reference . . . . . . . . . . . . . . 1650

8.299WireProtocolQosPolicyAutoKind Class Reference . . . . . . . . . 1659

8.300WriterDataLifecycleQosPolicy Class Reference . . . . . . . . . . . 1660

8.301WstringSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 1662

9 Example Documentation 1665

9.1 HelloWorld.idl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1665

9.2 HelloWorldDataReader.java . . . . . . . . . . . . . . . . . . . . . 1667

9.3 HelloWorldPublisher.java . . . . . . . . . . . . . . . . . . . . . . 1682

9.4 HelloWorldSeq.java . . . . . . . . . . . . . . . . . . . . . . . . . . 1686

9.5 HelloWorldSubscriber.java . . . . . . . . . . . . . . . . . . . . . . 1691


Chapter 1

RTI Data DistributionService

Real-Time Innovations, Inc.

RTI Data Distribution Service is a data-centric communications middlewarethat allows developers to build high-performance distributed communicationsin a heterogeneous computer environment.

The Application Programming Interface (API) of RTI Data Distribution Service4 is based on the OMGs Data Distribution Service (DDS) specification. Themost recent publication of this specification can be found in the Catalog ofOMG Specifications under Middleware Specifications.

1.1 Feedback and Support for this Release.

For more information, visit our knowledge base, accessible fromhttp://www.rti.com/support, to see sample code, general informationon RTI Data Distribution Service, performance information, troubleshootingtips, and technical details.

By its very nature, the knowledge base is continuously evolving and improv-ing. We hope that you will find it helpful. If there are questions thatyou would like to see addressed or comments you would like to share, pleasesend e-mail to [email protected]. We can only guarantee a response for cus-tomers with a current maintenance contract or subscription. To purchase amaintenance contract or subscription, contact your local RTI representative(see http://www.rti.com/company/contact.html), send an email request [email protected], or call +1 (408) 990-7400.

2 RTI Data Distribution Service

Please do not hesitate to contact RTI with questions or comments about thisrelease. We welcome any input on how to improve RTI Data Distribution Serviceto suit your needs.

1.2 Available Documentation.

The documentation of this release is provided in two forms: the HTML APIreference and PDF documents. If you are new to RTI Data Distribution Service4, the Documentation Roadmap (p. 263) will provide direction on how tolearn about this product.

1.2.1 The PDF documents are:

Whats New. An overview of the new features in this release.

Release Notes. System requirements, compatibility, whats fixed in thisrelease, and known issues.

Getting Started Guide. Download and installation instructions. It alsolays out the core value and concepts behind the product and takes youstep-by-step through the creation of a simple example application. Devel-opers should read this document first.

Getting Started Guide, Database Addendum. Additional installationand setup information for database usage.

Getting Started Guide, Embedded Systems Addendum. Additional in-stallation and setup information for embedded systems.

Users Manual. Introduction to RTI Data Distribution Service, producttour and conceptual presentation of the functionality of RTI Data Distri-bution Service.

Platform Notes. Specific details, such as compilation setting and li-braries, related to building and using RTI Data Distribution Service onthe various supported platforms.

C API Reference Manual. PDF version of the online HTML documen-tation for the C API.

C++ API Reference Manual. PDF version of the online HTML docu-mentation for the C++ API.


1.2 Available Documentation. 3

Java API Reference Manual. PDF version of the online HTML docu-mentation for the Java API.

.NET API Reference Manual. PDF version of the online HTML docu-mentation for the .NET API.

1.2.2 The HTML API reference contains:

DDS API Reference (p. 266) - The DDS API reference.

RTI Data Distribution Service API Reference (p. 280) - RTI DataDistribution Service APIs independent of the DDS standard.

Programming How-Tos (p. 281) - Describes and shows the commontasks done using the API.

Programming Tools (p. 283) - RTI Data Distribution Service helpertools.

The HTML API documentation can be accessed through the tree view in theleft frame of the web browser window. The bulk of the documentation is foundunder the entry labeled Modules.


4 RTI Data Distribution Service


Chapter 2

Module Index

2.1 Modules

Here is a list of all modules:

Thread Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Documentation Roadmap . . . . . . . . . . . . . . . . . . . . . . . . . 263Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264DDS API Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

Domain Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . 140DomainParticipants . . . . . . . . . . . . . . . . . . . . . . . . 142Built-in Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Topic Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152User Data Type Support . . . . . . . . . . . . . . . . . . . . . 154Type Code Support . . . . . . . . . . . . . . . . . . . . . . . . 156Built-in Types . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

KeyedString Built-in Type . . . . . . . . . . . . . . . . . . . 131Octets Built-in Type . . . . . . . . . . . . . . . . . . . . . . . 132KeyedOctets Built-in Type . . . . . . . . . . . . . . . . . . . 133

Dynamic Data . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Publication Module . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Publishers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Data Writers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173Flow Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Subscription Module . . . . . . . . . . . . . . . . . . . . . . . . . . 180Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183DataReaders . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

Read Conditions . . . . . . . . . . . . . . . . . . . . . . . . . 188

6 Module Index

Query Conditions . . . . . . . . . . . . . . . . . . . . . . . . . 189Data Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Sample States . . . . . . . . . . . . . . . . . . . . . . . . . . . 191View States . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192Instance States . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Infrastructure Module . . . . . . . . . . . . . . . . . . . . . . . . . 194Conditions and WaitSets . . . . . . . . . . . . . . . . . . . . . 42Time Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Entity Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 67GUID Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Object Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 80QoS Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

ASYNCHRONOUS PUBLISHER . . . . . . . . . . . . . . . 39BATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41DATABASE . . . . . . . . . . . . . . . . . . . . . . . . . . . 43DATA READER PROTOCOL . . . . . . . . . . . . . . . . . 44DATA READER RESOURCE LIMITS . . . . . . . . . . . . 45DATA WRITER PROTOCOL . . . . . . . . . . . . . . . . . 47DATA WRITER RESOURCE LIMITS . . . . . . . . . . . . 48DEADLINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49DESTINATION ORDER . . . . . . . . . . . . . . . . . . . . 50DISCOVERY CONFIG . . . . . . . . . . . . . . . . . . . . . 51DISCOVERY . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

NDDS DISCOVERY PEERS . . . . . . . . . . . . . . . . 54DOMAIN PARTICIPANT RESOURCE LIMITS . . . . . . . 62DURABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . 64DURABILITY SERVICE . . . . . . . . . . . . . . . . . . . . 65ENTITY FACTORY . . . . . . . . . . . . . . . . . . . . . . . 68ENTITY NAME . . . . . . . . . . . . . . . . . . . . . . . . . 69EVENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70EXCLUSIVE AREA . . . . . . . . . . . . . . . . . . . . . . . 71GROUP DATA . . . . . . . . . . . . . . . . . . . . . . . . . . 72HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74LATENCY BUDGET . . . . . . . . . . . . . . . . . . . . . . 75LIFESPAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76LIVELINESS . . . . . . . . . . . . . . . . . . . . . . . . . . . 77LOCATORFILTER . . . . . . . . . . . . . . . . . . . . . . . 78MULTICHANNEL . . . . . . . . . . . . . . . . . . . . . . . . 79OWNERSHIP . . . . . . . . . . . . . . . . . . . . . . . . . . 81OWNERSHIP STRENGTH . . . . . . . . . . . . . . . . . . . 82PARTITION . . . . . . . . . . . . . . . . . . . . . . . . . . . 83PRESENTATION . . . . . . . . . . . . . . . . . . . . . . . . 84PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85PROPERTY . . . . . . . . . . . . . . . . . . . . . . . . . . . 86PUBLISH MODE . . . . . . . . . . . . . . . . . . . . . . . . 87


2.1 Modules 7

READER DATA LIFECYCLE . . . . . . . . . . . . . . . . . 97RECEIVER POOL . . . . . . . . . . . . . . . . . . . . . . . 98RELIABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . 99RESOURCE LIMITS . . . . . . . . . . . . . . . . . . . . . . 100SYSTEM RESOURCE LIMITS . . . . . . . . . . . . . . . . 109TIME BASED FILTER . . . . . . . . . . . . . . . . . . . . . 111TOPIC DATA . . . . . . . . . . . . . . . . . . . . . . . . . . 112TRANSPORT BUILTIN . . . . . . . . . . . . . . . . . . . . 113TRANSPORT MULTICAST . . . . . . . . . . . . . . . . . . 116TRANSPORT PRIORITY . . . . . . . . . . . . . . . . . . . 117TRANSPORT SELECTION . . . . . . . . . . . . . . . . . . 118TRANSPORT UNICAST . . . . . . . . . . . . . . . . . . . . 119TYPESUPPORT . . . . . . . . . . . . . . . . . . . . . . . . . 120USER DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . 122WIRE PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . 124WRITER DATA LIFECYCLE . . . . . . . . . . . . . . . . . 130

Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Sequence Number Support . . . . . . . . . . . . . . . . . . . . 103Status Kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Exception Codes . . . . . . . . . . . . . . . . . . . . . . . . . . 123Sequence Support . . . . . . . . . . . . . . . . . . . . . . . . . 134

Built-in Sequences . . . . . . . . . . . . . . . . . . . . . . . . 196Queries and Filters Syntax . . . . . . . . . . . . . . . . . . . . . . 272

RTI Data Distribution Service API Reference . . . . . . . . . . . . . . 280Clock Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136Multi-channel DataWriters . . . . . . . . . . . . . . . . . . . . . . 198Pluggable Transports . . . . . . . . . . . . . . . . . . . . . . . . . 201

Using Transport Plugins . . . . . . . . . . . . . . . . . . . . . . 207Built-in Transport Plugins . . . . . . . . . . . . . . . . . . . . . 210

Configuration Utilities . . . . . . . . . . . . . . . . . . . . . . . . . 212Durability and Persistence . . . . . . . . . . . . . . . . . . . . . . . 213Configuring QoS Profiles with XML . . . . . . . . . . . . . . . . . 219

Programming How-Tos . . . . . . . . . . . . . . . . . . . . . . . . . . 281Publication Example . . . . . . . . . . . . . . . . . . . . . . . . . . 223Subscription Example . . . . . . . . . . . . . . . . . . . . . . . . . 224Participant Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 225Topic Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227FlowController Use Cases . . . . . . . . . . . . . . . . . . . . . . . 229Publisher Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 233DataWriter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 234Subscriber Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 236DataReader Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 239Entity Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243Waitset Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 247Transport Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 249


8 Module Index

Filter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251Creating Custom Content Filters . . . . . . . . . . . . . . . . . . . 257Large Data Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 261

Programming Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283rtiddsgen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284rtiddsping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297rtiddsspy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304


Chapter 3

Namespace Index

3.1 Package List

Here are the packages with brief descriptions (if available):

com.rti.dds.domain (Contains the com.rti.dds.domain.DomainParticipant(p. 614) class that acts as an entrypoint of RTI Data Distri-bution Service and acts as a factory for many of the classes.The com.rti.dds.domain.DomainParticipant (p. 614)also acts as a container for the other objects that make upRTI Data Distribution Service ) . . . . . . . . . . . . . . . . . 311

com.rti.dds.domain.builtin (Builtin topic (p. 343) for accessing in-formation about the DomainParticipants discovered by RTIData Distribution Service ) . . . . . . . . . . . . . . . . . . . 313

com.rti.dds.dynamicdata ( (p. 264) The Dy-namic Data API provides a way to interact with arbitrarilycomplex data types at runtime without the need for code gen-eration ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

com.rti.dds.infrastructure (Defines the abstract classes and the in-terfaces that are refined by the other modules. Contains com-mon definitions such as return codes, status values, and QoSpolicies ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

10 Namespace Index

com.rti.dds.publication (Contains thecom.rti.dds.publication.FlowController (p. 920),com.rti.dds.publication.Publisher (p. 1244),and com.rti.dds.publication.DataWriter(p. 524) classes as well as thecom.rti.dds.publication.PublisherListener (p. 1269)and com.rti.dds.publication.DataWriterListener(p. 552) interfaces, and more generally, all that is needed onthe publication (p. 331) side ) . . . . . . . . . . . . . . . . . 331

com.rti.dds.publication.builtin (Builtin topic (p. 343) for access-ing information about the Publications discovered by RTIData Distribution Service ) . . . . . . . . . . . . . . . . . . . 334

com.rti.dds.publication.example . . . . . . . . . . . . . . . . . . 335com.rti.dds.subscription (Contains the

com.rti.dds.subscription.Subscriber (p. 1431),com.rti.dds.subscription.DataReader (p. 460),com.rti.dds.subscription.ReadCondition (p. 1293),and com.rti.dds.subscription.QueryCondition(p. 1291) classes, as well as thecom.rti.dds.subscription.SubscriberListener (p. 1456)and com.rti.dds.subscription.DataReaderListener(p. 487) interfaces, and more generally, all that is needed onthe subscription (p. 336) side ) . . . . . . . . . . . . . . . . 336

com.rti.dds.subscription.builtin (Builtin topic (p. 343) for access-ing information about the Subscriptions discovered by RTIData Distribution Service ) . . . . . . . . . . . . . . . . . . . 341

com.rti.dds.subscription.example . . . . . . . . . . . . . . . . . . 342com.rti.dds.topic (Contains the com.rti.dds.topic.Topic

(p. 1497), com.rti.dds.topic.ContentFilteredTopic(p. 446), and com.rti.dds.topic.MultiTopic (p. 1175)classes, the com.rti.dds.topic.TopicListener (p. 1516)interface, and more generally, all that is needed by anapplication to define com.rti.dds.topic.Topic (p. 1497)objects and attach QoS policies to them ) . . . . . . . . . . . 343

com.rti.dds.topic.builtin (Builtin topic (p. 343) for accessing infor-mation about the Topics discovered by RTI Data DistributionService ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

com.rti.dds.topic.example (Descriptions of Foo (p. 933), FooSeq(p. 1027), and FooTypeSupport (p. 1031), where Foo(p. 933) represents a user-defined data-type intended to bedistributed using DDS ) . . . . . . . . . . . . . . . . . . . . . 346

com.rti.dds.type.builtin ( (p. 264) RTI DataDistribution Service provides a set of very simple data typesfor you to use with the topics in your application ) . . . . . . 347


3.1 Package List 11

com.rti.dds.typecode ( (p. 264) A TypeCode(p. 1553) is a mechanism for representing a type at runtime.RTI Data Distribution Service can use type codes to send typedefinitions on the network. You will need to understand thisAPI in order to use the Dynamic Data (p. 164) capabilityor to inspect the type information you receive from remotereaders and writers ) . . . . . . . . . . . . . . . . . . . . . . . 353

com.rti.dds.util (Utility types that support the DDS API ) . . . . . 357com.rti.ndds.config (Utility APIs independent of the DDS standard )358com.rti.ndds.example (Programming HowTos: Code templates for

common use cases ) . . . . . . . . . . . . . . . . . . . . . . . . 359com.rti.ndds.transport (APIs related to RTI Data Distribution Ser-

vice pluggable transports ) . . . . . . . . . . . . . . . . . . . . 360


12 Namespace Index


Chapter 4

Class Index

4.1 Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:

AbstractBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . . . . 367ParticipantBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . 1199PublicationBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . 1240SubscriptionBuiltinTopicDataTypeSupport . . . . . . . . . . . . . 1471TopicBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . . . . 1510

AllocationSettings t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377BuiltinTopicReaderResourceLimits t . . . . . . . . . . . . . . . . . . . 402ChannelSettings t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429ChannelSettingsSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

StatusCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1405ReadCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1293

QueryCondition . . . . . . . . . . . . . . . . . . . . . . . . . . 1291ConditionSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440ContentFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442ContentFilterProperty t . . . . . . . . . . . . . . . . . . . . . . . . . . 451Copyable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453

DynamicData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 762InstanceHandle t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1051StringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1423

WstringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1662SampleInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1366BuiltinTopicKey t . . . . . . . . . . . . . . . . . . . . . . . . . . . 400Bytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

14 Class Index

BytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422KeyedBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1066KeyedBytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1086KeyedString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1093KeyedStringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1110AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . . . 369

BooleanSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393ByteSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416CharSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

WcharSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1648DoubleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 742

LongDoubleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1164FloatSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 914IntSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1060LongSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1166ShortSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1399

Enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903DataWriterResourceLimitsInstanceReplacementKind . . . . . . 580DestinationOrderQosPolicyKind . . . . . . . . . . . . . . . . . 595DiscoveryPluginPromiscuityKind . . . . . . . . . . . . . . . . . 608DurabilityQosPolicyKind . . . . . . . . . . . . . . . . . . . . . 753HistoryQosPolicyKind . . . . . . . . . . . . . . . . . . . . . . . 1046LivelinessQosPolicyKind . . . . . . . . . . . . . . . . . . . . . . 1137OwnershipQosPolicyKind . . . . . . . . . . . . . . . . . . . . . 1190PresentationQosPolicyAccessScopeKind . . . . . . . . . . . . . 1209PublishModeQosPolicyKind . . . . . . . . . . . . . . . . . . . . 1278QosPolicyId t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1285RefilterQosPolicyKind . . . . . . . . . . . . . . . . . . . . . . . 1301ReliabilityQosPolicyKind . . . . . . . . . . . . . . . . . . . . . 1307RemoteParticipantPurgeKind . . . . . . . . . . . . . . . . . . . 1317ThreadSettingsCpuRotationKind . . . . . . . . . . . . . . . . . 1486WireProtocolQosPolicyAutoKind . . . . . . . . . . . . . . . . . 1659FlowControllerSchedulingPolicy . . . . . . . . . . . . . . . . . . 926SampleRejectedStatusKind . . . . . . . . . . . . . . . . . . . . 1380TCKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1478LogCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1154LogPrintFormat . . . . . . . . . . . . . . . . . . . . . . . . . . 1159LogVerbosity . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1162

Foo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029

DataReaderCacheStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 486DataReaderProtocolStatus . . . . . . . . . . . . . . . . . . . . . . . . 495DataReaderSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522DataWriterCacheStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 551DataWriterProtocolStatus . . . . . . . . . . . . . . . . . . . . . . . . . 562


4.1 Class Hierarchy 15

DiscoveryBuiltinReaderFragmentationResourceLimits t . . . . . . . . 597DiscoveryConfigBuiltinPluginKind . . . . . . . . . . . . . . . . . . . . 599DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . . . . . 692Duration t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759DynamicDataInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 826DynamicDataMemberInfo . . . . . . . . . . . . . . . . . . . . . . . . . 828DynamicDataProperty t . . . . . . . . . . . . . . . . . . . . . . . . . . 831DynamicDataTypeProperty t . . . . . . . . . . . . . . . . . . . . . . . 865DynamicDataTypeSerializationProperty t . . . . . . . . . . . . . . . . 867Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891

DomainParticipant . . . . . . . . . . . . . . . . . . . . . . . . . . . 614DomainEntity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613

DataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524DynamicDataWriter . . . . . . . . . . . . . . . . . . . . . . . 875BytesDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . 412KeyedBytesDataWriter . . . . . . . . . . . . . . . . . . . . . 1076KeyedStringDataWriter . . . . . . . . . . . . . . . . . . . . . 1102StringDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . 1421FooDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . 1011

Publisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1244DataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460

DynamicDataReader . . . . . . . . . . . . . . . . . . . . . . . 833BytesDataReader . . . . . . . . . . . . . . . . . . . . . . . . . 408KeyedBytesDataReader . . . . . . . . . . . . . . . . . . . . . 1069KeyedStringDataReader . . . . . . . . . . . . . . . . . . . . . 1095StringDataReader . . . . . . . . . . . . . . . . . . . . . . . . 1418FooDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . 936

Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1431Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1497

EnumMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906FlowController . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920FlowControllerProperty t . . . . . . . . . . . . . . . . . . . . . . . . . 924FlowControllerTokenBucketProperty t . . . . . . . . . . . . . . . . . . 929Foo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 933FooDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 966FooDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 995FooTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1031FooTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034GuardCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1037GUID t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1040InconsistentTopicStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 1048InetAddressSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1050InstanceHandleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1054InstanceStateKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1057LibraryVersion t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1119


16 Class Index

Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1123DataWriterListener . . . . . . . . . . . . . . . . . . . . . . . . . . . 552

DataWriterAdapter . . . . . . . . . . . . . . . . . . . . . . . . 546PublisherAdapter . . . . . . . . . . . . . . . . . . . . . . . . . 1268

PublisherListener . . . . . . . . . . . . . . . . . . . . . . . . . . 1269DomainParticipantListener . . . . . . . . . . . . . . . . . . . 719

DomainParticipantAdapter . . . . . . . . . . . . . . . . . 687PublisherAdapter . . . . . . . . . . . . . . . . . . . . . . . . . 1268

DataReaderListener . . . . . . . . . . . . . . . . . . . . . . . . . . 487DataReaderAdapter . . . . . . . . . . . . . . . . . . . . . . . . 483

SubscriberAdapter . . . . . . . . . . . . . . . . . . . . . . . . 1455DomainParticipantAdapter . . . . . . . . . . . . . . . . . 687

SubscriberListener . . . . . . . . . . . . . . . . . . . . . . . . . 1456DomainParticipantListener . . . . . . . . . . . . . . . . . . . 719SubscriberAdapter . . . . . . . . . . . . . . . . . . . . . . . . 1455

TopicListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1516DomainParticipantListener . . . . . . . . . . . . . . . . . . . . 719TopicAdapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1502

EntityHowTo.MyEntityListener . . . . . . . . . . . . . . . . . . . . 901LivelinessChangedStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 1128LivelinessLostStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1131Locator t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1143LocatorFilter t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1147LocatorFilterSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1152LocatorSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1153Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1156ObjectHolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1178OfferedDeadlineMissedStatus . . . . . . . . . . . . . . . . . . . . . . . 1179OfferedIncompatibleQosStatus . . . . . . . . . . . . . . . . . . . . . . 1181ParticipantBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . 1194ParticipantBuiltinTopicDataDataReader . . . . . . . . . . . . . . . . . 1197ParticipantBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . 1198PRIVATE MEMBER . . . . . . . . . . . . . . . . . . . . . . . . . . . 1211ProductVersion t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1212Property t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1217PropertyQosPolicyHelper . . . . . . . . . . . . . . . . . . . . . . . . . 1222PropertySeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1226ProtocolVersion t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1227PUBLIC MEMBER . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1230PublicationBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . 1231PublicationBuiltinTopicDataDataReader . . . . . . . . . . . . . . . . . 1238PublicationBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . 1239PublicationMatchedStatus . . . . . . . . . . . . . . . . . . . . . . . . . 1241PublisherSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1273Qos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1280



DomainParticipantFactoryQos . . . . . . . . . . . . . . . . . . . . 717DomainParticipantQos . . . . . . . . . . . . . . . . . . . . . . . . . 721DataWriterQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574PublisherQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1270DataReaderQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505SubscriberQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1458TopicQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1518

QosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1281AsynchronousPublisherQosPolicy . . . . . . . . . . . . . . . . . . . 379BatchQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389DatabaseQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 455DataReaderProtocolQosPolicy . . . . . . . . . . . . . . . . . . . . 490DataReaderResourceLimitsQosPolicy . . . . . . . . . . . . . . . . . 511DataWriterProtocolQosPolicy . . . . . . . . . . . . . . . . . . . . . 557DataWriterResourceLimitsQosPolicy . . . . . . . . . . . . . . . . . 584DeadlineQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 589DestinationOrderQosPolicy . . . . . . . . . . . . . . . . . . . . . . 592DiscoveryConfigQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 600DiscoveryQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 609DomainParticipantResourceLimitsQosPolicy . . . . . . . . . . . . . 725DurabilityQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 748DurabilityServiceQosPolicy . . . . . . . . . . . . . . . . . . . . . . 756EntityFactoryQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 898EntityNameQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 902EventQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 908ExclusiveAreaQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 911GroupDataQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 1035HistoryQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1042LatencyBudgetQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 1117LifespanQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1121LivelinessQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1133LocatorFilterQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 1150MultiChannelQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 1172OwnershipQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 1183OwnershipStrengthQosPolicy . . . . . . . . . . . . . . . . . . . . . 1192PartitionQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1200PresentationQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 1204ProfileQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1214PropertyQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1219PublishModeQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 1275ReaderDataLifecycleQosPolicy . . . . . . . . . . . . . . . . . . . . 1295ReceiverPoolQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 1298ReliabilityQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 1303ResourceLimitsQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 1323SystemResourceLimitsQosPolicy . . . . . . . . . . . . . . . . . . . 1476


18 Class Index

TimeBasedFilterQosPolicy . . . . . . . . . . . . . . . . . . . . . . 1493TopicDataQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 1511TransportBuiltinQosPolicy . . . . . . . . . . . . . . . . . . . . . . 1532TransportMulticastQosPolicy . . . . . . . . . . . . . . . . . . . . . 1534TransportPriorityQosPolicy . . . . . . . . . . . . . . . . . . . . . . 1540TransportSelectionQosPolicy . . . . . . . . . . . . . . . . . . . . . 1542TransportUnicastQosPolicy . . . . . . . . . . . . . . . . . . . . . . 1547TypeSupportQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 1594UserDataQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1621WireProtocolQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 1650WriterDataLifecycleQosPolicy . . . . . . . . . . . . . . . . . . . . . 1660

QosPolicyCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1282QosPolicyCountSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1284ReliableReaderActivityChangedStatus . . . . . . . . . . . . . . . . . . 1309ReliableWriterCacheChangedStatus . . . . . . . . . . . . . . . . . . . 1312ReliableWriterCacheEventCount . . . . . . . . . . . . . . . . . . . . . 1316RequestedDeadlineMissedStatus . . . . . . . . . . . . . . . . . . . . . 1320RequestedIncompatibleQosStatus . . . . . . . . . . . . . . . . . . . . . 1321RETCODE ERROR . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1331

RETCODE ALREADY DELETED . . . . . . . . . . . . . . . . . 1329RETCODE BAD PARAMETER . . . . . . . . . . . . . . . . . . . 1330RETCODE ILLEGAL OPERATION . . . . . . . . . . . . . . . . 1332RETCODE IMMUTABLE POLICY . . . . . . . . . . . . . . . . . 1333RETCODE INCONSISTENT POLICY . . . . . . . . . . . . . . . 1334RETCODE NO DATA . . . . . . . . . . . . . . . . . . . . . . . . 1335RETCODE NOT ENABLED . . . . . . . . . . . . . . . . . . . . . 1336RETCODE OUT OF RESOURCES . . . . . . . . . . . . . . . . . 1337RETCODE PRECONDITION NOT MET . . . . . . . . . . . . . 1338RETCODE TIMEOUT . . . . . . . . . . . . . . . . . . . . . . . . 1339RETCODE UNSUPPORTED . . . . . . . . . . . . . . . . . . . . . 1340

RtpsReliableReaderProtocol t . . . . . . . . . . . . . . . . . . . . . . . 1341RtpsReliableWriterProtocol t . . . . . . . . . . . . . . . . . . . . . . . 1344RtpsReservedPortKind . . . . . . . . . . . . . . . . . . . . . . . . . . . 1358RtpsWellKnownPorts t . . . . . . . . . . . . . . . . . . . . . . . . . . 1360SampleLostStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1377SampleRejectedStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . 1378SampleStateKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1384Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1386

DynamicDataSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . 863SampleInfoSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1376FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027BytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422KeyedBytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1086KeyedStringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1110AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . . . 369



AbstractSequence . . . . . . . . . . . . . . . . . . . . . . . . . . . 374AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . 369LoanableSequence . . . . . . . . . . . . . . . . . . . . . . . . . 1139

SampleInfoSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1376FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027BytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422KeyedBytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1086KeyedStringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1110FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029

FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029SequenceNumber t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1389StatusKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1408StructMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1429SubscriberSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1460SubscriptionBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . 1462SubscriptionBuiltinTopicDataDataReader . . . . . . . . . . . . . . . . 1469SubscriptionBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . 1470SubscriptionMatchedStatus . . . . . . . . . . . . . . . . . . . . . . . . 1472SystemException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1475

BAD PARAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384BAD TYPECODE . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

ThreadSettings t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1483ThreadSettingsKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1488Time t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1490TopicBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . . . . . 1504TopicBuiltinTopicDataDataReader . . . . . . . . . . . . . . . . . . . . 1508TopicBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . . . . . 1509TopicDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1513

ContentFilteredTopic . . . . . . . . . . . . . . . . . . . . . . . . . 446MultiTopic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1175Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1497

Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1521ShmemTransport . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1392UDPv4Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1596UDPv6Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1607

Transport.Property t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1522ShmemTransport.Property t . . . . . . . . . . . . . . . . . . . . . 1396UDPv4Transport.Property t . . . . . . . . . . . . . . . . . . . . . 1600UDPv6Transport.Property t . . . . . . . . . . . . . . . . . . . . . 1611

TransportBuiltinKind . . . . . . . . . . . . . . . . . . . . . . . . . . . 1530TransportMulticastSettings t . . . . . . . . . . . . . . . . . . . . . . . 1536TransportMulticastSettingsSeq . . . . . . . . . . . . . . . . . . . . . . 1539TransportSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1544TransportUnicastSettings t . . . . . . . . . . . . . . . . . . . . . . . . 1550


20 Class Index

TransportUnicastSettingsSeq . . . . . . . . . . . . . . . . . . . . . . . 1552TypeCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1553TypeCodeFactory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1583TypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1593

DynamicDataTypeSupport . . . . . . . . . . . . . . . . . . . . . . 869BytesTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . 425KeyedBytesTypeSupport . . . . . . . . . . . . . . . . . . . . . . . 1089KeyedStringTypeSupport . . . . . . . . . . . . . . . . . . . . . . . 1113StringTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . 1426

Union . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1618UnionMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1619UserException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1623

BadKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386BadMemberId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387BadMemberName . . . . . . . . . . . . . . . . . . . . . . . . . . . 388Bounds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

ValueMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1624VendorId t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1626Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1628ViewStateKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1630VM ABSTRACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1632VM CUSTOM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1633VM NONE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1634VM TRUNCATABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . 1635WaitSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1636WaitSetProperty t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1646


Chapter 5

Class Index

5.1 Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

AbstractBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . 367AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . . 369AbstractSequence (Abstract sequence ) . . . . . . . . . . . . . . . . 374AllocationSettings t (Resource allocation settings ) . . . . . . . . . 377AsynchronousPublisherQosPolicy (Configures the mechanism

that sends user data in an external middleware thread ) . . . 379BAD PARAM (The exception BadKind (p. 386) is thrown when

an inappropriate operation is invoked on a TypeCode object ) 384BAD TYPECODE (The exception BadKind (p. 386) is thrown

when an inappropriate operation is invoked on a TypeCodeobject ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

BadKind (The exception BadKind (p. 386) is thrown when an inap-propriate operation is invoked on a TypeCode object ) . . . . 386

BadMemberId (The specified TypeCode member ID is invalid ) . . 387BadMemberName (The specified TypeCode member name is invalid )388BatchQosPolicy (Used to configure batching of multiple samples into

a single network packet in order to increase throughput forsmall samples ) . . . . . . . . . . . . . . . . . . . . . . . . . . 389

BooleanSeq (Instantiates com.rti.dds.util.Sequence (p. 1386)< boolean > ) . . . . . . . . . . . . . . . . . . . . . . . . . . 393

Bounds (A user exception thrown when a parameter is not within thelegal bounds ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 399

BuiltinTopicKey t (The key type of the built-in topic (p. 343) types )400BuiltinTopicReaderResourceLimits t (Built-in topic (p. 343)

readers resource limits ) . . . . . . . . . . . . . . . . . . . . . 402

22 Class Index

Bytes (Built-in type consisting of a variable-length array of opaquebytes ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405

BytesDataReader ( (p. 264) InstantiatesDataReader < com.rti.dds.type.builtin.Bytes (p. 405) > ) 408

BytesDataWriter ( (p. 264) InstantiatesDataWriter < com.rti.dds.type.builtin.Bytes (p. 405) > ) 412

ByteSeq (Instantiates com.rti.dds.util.Sequence (p. 1386) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

BytesSeq (Instantiates com.rti.dds.util.Sequence (p. 1386) ) . . . . . . . . 422

BytesTypeSupport ( (p. 264)com.rti.dds.type.builtin.Bytes (p. 405) type support) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425

ChannelSettings t (Type used to configure the properties of a chan-nel ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429

ChannelSettingsSeq (Declares IDL sequence ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432

CharSeq (Instantiates com.rti.dds.util.Sequence (p. 1386) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

Condition ( (p. 264) Root class forall the conditions that may be attached to acom.rti.dds.infrastructure.WaitSet (p. 1636) ) . . . . . . 439

ConditionSeq (Instantiates com.rti.dds.util.Sequence (p. 1386)< com.rti.dds.infrastructure.Condition (p. 439) > ) . . . 440

ContentFilter ( (p. 264) Inter-face to be used by a custom filter of acom.rti.dds.topic.ContentFilteredTopic (p. 446) ) . . . . 442

ContentFilteredTopic ( (p. 264) Specialization ofcom.rti.dds.topic.TopicDescription (p. 1513) that allowsfor content-based subscriptions ) . . . . . . . . . . . . . . . . 446

ContentFilterProperty t ( (p. 264) Type usedto provide all the required information to enable content fil-tering ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451

Copyable ( (p. 264) (p. 264) In-terface for all the user-defined data type classes that supportcopy ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453

DatabaseQosPolicy (Various threads and resource limits settingsused by RTI Data Distribution Service to control its inter-nal database ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

DataReader ( (p. 264) Allows the application to:(1) declare the data it wishes to receive (i.e. make a sub-scription (p. 336)) and (2) access the data received by theattached com.rti.dds.subscription.Subscriber (p. 1431) ) 460


5.1 Class List 23

DataReaderAdapter ( (p. 264) A listeneradapter in the spirit of the Java AWT listener adapters. (TheAdapter provides empty implementations for the listenermethods) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483

DataReaderCacheStatus ( (p. 264) The statusof the readers cache ) . . . . . . . . . . . . . . . . . . . . . . 486

DataReaderListener ( (p. 264)com.rti.dds.infrastructure.Listener (p. 1123) for readerstatus ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487

DataReaderProtocolQosPolicy (Along withcom.rti.dds.infrastructure.WireProtocolQosPolicy(p. 1650) and com.rti.dds.infrastructure.DataWriterProtocolQosPolicy(p. 557), this QoS policy configures the DDS on-the-networkprotocol (RTPS) ) . . . . . . . . . . . . . . . . . . . . . . . . 490

DataReaderProtocolStatus ( (p. 264) The sta-tus of a readers internal protocol related metrics, like thenumber of samples received, filtered, rejected; and status ofwire protocol traffic ) . . . . . . . . . . . . . . . . . . . . . . . 495

DataReaderQos (QoS policies supported by acom.rti.dds.subscription.DataReader (p. 460) entity) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505

DataReaderResourceLimitsQosPolicy (Various settings thatconfigure how a com.rti.dds.subscription.DataReader(p. 460) allocates and uses physical memory for internal re-sources ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511

DataReaderSeq (Declares IDL sequence ) . . . . 522

DataWriter ( (p. 264) Allows an application toset the value of the data to be published under a givencom.rti.dds.topic.Topic (p. 1497) ) . . . . . . . . . . . . . . 524

DataWriterAdapter ( (p. 264) A listener adapterin the spirit of the Java AWT listener adapters. (The Adapterprovides empty implementations for the listener methods orfunctions.) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 546

DataWriterCacheStatus ( (p. 264) The status ofthe writers cache ) . . . . . . . . . . . . . . . . . . . . . .

RTI Data Distribution Service Java API · RTI Data Distribution Service Java API Version 4.5d...

Documents

Transcript of RTI Data Distribution Service Java API · RTI Data Distribution Service Java API Version 4.5d...