rti connext java api v5.0.0

1794
RTI Connext Java API Version 5.0.0 Generated by Doxygen 1.5.5 Mon Aug 13 09:02:20 2012

Upload: fcaballerog

Post on 10-Sep-2015

67 views

Category:

Documents


1 download

DESCRIPTION

Api de Java

TRANSCRIPT

  • 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.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 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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • CONTENTS v

    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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • CONTENTS vii

    8.14 BatchQosPolicy Class Reference . . . . . . . . . . . . . . . . . . 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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 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 Ref-erence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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 ClassReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • x 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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • CONTENTS xvii

    9 Example Documentation 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

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • Chapter 1

    RTI Connext

    Core Libraries and Utilities

    Real-Time Innovations, Inc.

    RTI Connext is network middleware for real-time distributed applications. Itprovides the communications services that programmers need to distribute time-critical data between embedded and/or enterprise devices or nodes. RTI Con-next uses the publish-subscribe communications model to make data distribu-tion efficient and robust.

    The RTI Connext Application Programming Interface (API) is based on theOMGs Data Distribution Service (DDS) specification. The most recent publica-tion of this specification can be found in the Catalog of OMG Specificationsunder Middleware Specifications.

    1.1 Feedback and Support for this Release.

    For more information, visit our knowledge base (accessible fromhttps://support.rti.com/) to see sample code, general information onRTI Connext, performance information, troubleshooting tips, and technicaldetails.

    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

  • 2 RTI Connext

    (see http://www.rti.com/company/contact.html), send an email request [email protected], or call +1 (408) 990-7400.

    Please do not hesitate to contact RTI with questions or comments about thisrelease. We welcome any input on how to improve RTI Connext to suit yourneeds.

    1.2 Available Documentation.

    The documentation for this release is provided in two forms: the HTML APIreference documentation and PDF documents. If you are new to RTI Connext,the Documentation Roadmap (p. 277) will provide direction on how to learnabout this product.

    1.2.1 The PDF documents for the Core Libraries and Util-ities 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 Connext, product tour and concep-tual presentation of the functionality of RTI Connext.

    Platform Notes. Specific details, such as compilation setting and li-braries, related to building and using RTI Connext on the various sup-ported platforms.

    QoS Reference Guide. A compact summary of supported Quality of Ser-vice (QoS) policies.

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 1.2 Available Documentation. 3

    XML-Based Application Creation Getting Started Guide. Detailson how to use XML-Based Application Creation, an experimental featurein this release.

    C API Reference Manual. A consolidated PDF version of the HTML CAPI reference documentation.

    C++ API Reference Manual. A consolidated PDF version of the HTMLC++ API reference documentation.

    Java API Reference Manual. A consolidate PDF version of the HTMLJava 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 indepen-dent of the DDS standard.

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

    Programming Tools (p. 297) - RTI Connext helper tools.

    The HTML API Reference documentation can be accessed through the tree viewin the left frame of the web browser window. The bulk of the documentation isfound under the entry labeled Modules.

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 4 RTI Connext

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • Chapter 2

    Module Index

    2.1 Modules

    Here is a list of all modules:

    Thread Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Documentation Roadmap . . . . . . . . . . . . . . . . . . . . . . . . . 277Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278DDS API Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

    Domain Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . 149DomainParticipants . . . . . . . . . . . . . . . . . . . . . . . . 151Built-in Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

    Topic Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162User Data Type Support . . . . . . . . . . . . . . . . . . . . . 164Type Code Support . . . . . . . . . . . . . . . . . . . . . . . . 165Built-in Types . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

    KeyedString Built-in Type . . . . . . . . . . . . . . . . . . . 141Octets Built-in Type . . . . . . . . . . . . . . . . . . . . . . . 142KeyedOctets Built-in Type . . . . . . . . . . . . . . . . . . . 143

    Dynamic Data . . . . . . . . . . . . . . . . . . . . . . . . . . . 175Publication Module . . . . . . . . . . . . . . . . . . . . . . . . . . 180

    Publishers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181Data Writers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184Flow Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . 186

    Subscription Module . . . . . . . . . . . . . . . . . . . . . . . . . . 192Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195DataReaders . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

    Read Conditions . . . . . . . . . . . . . . . . . . . . . . . . . 200

  • 6 Module Index

    Query Conditions . . . . . . . . . . . . . . . . . . . . . . . . . 201Data Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

    Sample States . . . . . . . . . . . . . . . . . . . . . . . . . . . 203View States . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204Instance States . . . . . . . . . . . . . . . . . . . . . . . . . . 205

    Infrastructure Module . . . . . . . . . . . . . . . . . . . . . . . . . 206Conditions and WaitSets . . . . . . . . . . . . . . . . . . . . . 45Time Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Entity Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 72GUID Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 78Object Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 86QoS Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

    ASYNCHRONOUS PUBLISHER . . . . . . . . . . . . . . . 41AVAILABILITY . . . . . . . . . . . . . . . . . . . . . . . . . 43BATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44DATABASE . . . . . . . . . . . . . . . . . . . . . . . . . . . 46DATA READER PROTOCOL . . . . . . . . . . . . . . . . . 47DATA READER RESOURCE LIMITS . . . . . . . . . . . . 48DATA WRITER PROTOCOL . . . . . . . . . . . . . . . . . 50DATA WRITER RESOURCE LIMITS . . . . . . . . . . . . 51DEADLINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52DESTINATION ORDER . . . . . . . . . . . . . . . . . . . . 53DISCOVERY CONFIG . . . . . . . . . . . . . . . . . . . . . 54DISCOVERY . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

    NDDS DISCOVERY PEERS . . . . . . . . . . . . . . . . 57DOMAIN PARTICIPANT RESOURCE LIMITS . . . . . . . 66DURABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . 68DURABILITY SERVICE . . . . . . . . . . . . . . . . . . . . 69ENTITY FACTORY . . . . . . . . . . . . . . . . . . . . . . . 73ENTITY NAME . . . . . . . . . . . . . . . . . . . . . . . . . 74EVENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75EXCLUSIVE AREA . . . . . . . . . . . . . . . . . . . . . . . 76GROUP DATA . . . . . . . . . . . . . . . . . . . . . . . . . . 77HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79LATENCY BUDGET . . . . . . . . . . . . . . . . . . . . . . 80LIFESPAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81LIVELINESS . . . . . . . . . . . . . . . . . . . . . . . . . . . 82LOCATORFILTER . . . . . . . . . . . . . . . . . . . . . . . 83LOGGING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84MULTICHANNEL . . . . . . . . . . . . . . . . . . . . . . . . 85OWNERSHIP . . . . . . . . . . . . . . . . . . . . . . . . . . 87OWNERSHIP STRENGTH . . . . . . . . . . . . . . . . . . . 88PARTITION . . . . . . . . . . . . . . . . . . . . . . . . . . . 89PRESENTATION . . . . . . . . . . . . . . . . . . . . . . . . 90PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 2.1 Modules 7

    PROPERTY . . . . . . . . . . . . . . . . . . . . . . . . . . . 92PUBLISH MODE . . . . . . . . . . . . . . . . . . . . . . . . 93READER DATA LIFECYCLE . . . . . . . . . . . . . . . . . 103RECEIVER POOL . . . . . . . . . . . . . . . . . . . . . . . 104RELIABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . 105RESOURCE LIMITS . . . . . . . . . . . . . . . . . . . . . . 106SYSTEM RESOURCE LIMITS . . . . . . . . . . . . . . . . 115TIME BASED FILTER . . . . . . . . . . . . . . . . . . . . . 117TOPIC DATA . . . . . . . . . . . . . . . . . . . . . . . . . . 118TRANSPORT BUILTIN . . . . . . . . . . . . . . . . . . . . 119TRANSPORT MULTICAST MAPPING . . . . . . . . . . . 122TRANSPORT MULTICAST . . . . . . . . . . . . . . . . . . 123TRANSPORT PRIORITY . . . . . . . . . . . . . . . . . . . 126TRANSPORT SELECTION . . . . . . . . . . . . . . . . . . 127TRANSPORT UNICAST . . . . . . . . . . . . . . . . . . . . 128TYPE CONSISTENCY ENFORCEMENT . . . . . . . . . . 129TYPESUPPORT . . . . . . . . . . . . . . . . . . . . . . . . . 130USER DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . 132WIRE PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . 134WRITER DATA LIFECYCLE . . . . . . . . . . . . . . . . . 140

    Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Sequence Number Support . . . . . . . . . . . . . . . . . . . . 109Status Kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Exception Codes . . . . . . . . . . . . . . . . . . . . . . . . . . 133Sequence Support . . . . . . . . . . . . . . . . . . . . . . . . . 144

    Built-in Sequences . . . . . . . . . . . . . . . . . . . . . . . . 208Queries and Filters Syntax . . . . . . . . . . . . . . . . . . . . . . 286

    RTI Connext API Reference . . . . . . . . . . . . . . . . . . . . . . . . 294Clock Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Multi-channel DataWriters . . . . . . . . . . . . . . . . . . . . . . 210Pluggable Transports . . . . . . . . . . . . . . . . . . . . . . . . . 213

    Using Transport Plugins . . . . . . . . . . . . . . . . . . . . . . 219Built-in Transport Plugins . . . . . . . . . . . . . . . . . . . . . 222

    Configuration Utilities . . . . . . . . . . . . . . . . . . . . . . . . . 224Durability and Persistence . . . . . . . . . . . . . . . . . . . . . . . 225System Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 231Configuring QoS Profiles with XML . . . . . . . . . . . . . . . . . 233

    Programming How-Tos . . . . . . . . . . . . . . . . . . . . . . . . . . 295Publication Example . . . . . . . . . . . . . . . . . . . . . . . . . . 237Subscription Example . . . . . . . . . . . . . . . . . . . . . . . . . 238Participant Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 239Topic Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241FlowController Use Cases . . . . . . . . . . . . . . . . . . . . . . . 243Publisher Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 247DataWriter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 248

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 8 Module Index

    Subscriber Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 250DataReader Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 253Entity Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257Waitset Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 261Transport Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 263Filter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265Creating Custom Content Filters . . . . . . . . . . . . . . . . . . . 271Large Data Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 275

    Programming Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297rtiddsgen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298rtiddsping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311rtiddsspy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 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 Connextand acts as a factory for many of the classes. Thecom.rti.dds.domain.DomainParticipant (p. 654) alsoacts as a container for the other objects that make up RTIConnext ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

    com.rti.dds.domain.builtin (Builtin topic (p. 359) for accessing in-formation about the DomainParticipants discovered by RTIConnext ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

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

    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 ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334

  • 10 Namespace Index

    com.rti.dds.publication (Contains thecom.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 thecom.rti.dds.publication.PublisherListener (p. 1289)and com.rti.dds.publication.DataWriterListener(p. 586) interfaces, and more generally, all that is needed onthe publication (p. 349) side ) . . . . . . . . . . . . . . . . . 349

    com.rti.dds.publication.builtin (Builtin topic (p. 359) for access-ing information about the Publications discovered by RTIConnext ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352

    com.rti.dds.subscription (Contains thecom.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 thecom.rti.dds.subscription.SubscriberListener (p. 1503)and com.rti.dds.subscription.DataReaderListener(p. 518) interfaces, and more generally, all that is needed onthe subscription (p. 353) side ) . . . . . . . . . . . . . . . . 353

    com.rti.dds.subscription.builtin (Builtin topic (p. 359) for access-ing information about the Subscriptions discovered by RTIConnext ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

    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 anapplication to define com.rti.dds.topic.Topic (p. 1545)objects and attach QoS policies to them ) . . . . . . . . . . . 359

    com.rti.dds.topic.builtin (Builtin topic (p. 359) for accessing infor-mation about the Topics discovered by RTI Connext ) . . . . 361

    com.rti.dds.type.builtin ( (p. 278) RTI Connextprovides a set of very simple data types for you to use withthe topics in your application ) . . . . . . . . . . . . . . . . . 362

    com.rti.dds.typecode ( (p. 278) Acom.rti.dds.typecode.TypeCode (p. 1611) is a mech-anism for representing a type at runtime. RTI Connextcan use type codes to send type definitions on the network.You will need to understand this API in order to use theDynamic Data (p. 175) capability or to inspect the typeinformation you receive from remote readers and writers ) . . 368

    com.rti.dds.util (Utility types that support the DDS API ) . . . . . 372com.rti.ndds (DDS extensions ) . . . . . . . . . . . . . . . . . . . . . 373

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 3.1 Package List 11

    com.rti.ndds.config (Utility APIs independent of the DDS standard )374com.rti.ndds.example (Programming HowTos: Code templates for

    common use cases ) . . . . . . . . . . . . . . . . . . . . . . . . 375com.rti.ndds.transport (APIs related to RTI Connext pluggable

    transports ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 12 Namespace Index

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • Chapter 4

    Class Index

    4.1 Class Hierarchy

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

    AbstractBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . . . . 383ParticipantBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . 1216PublicationBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . 1258SubscriptionBuiltinTopicDataTypeSupport . . . . . . . . . . . . . 1518TopicBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . . . . 1558

    AcknowledgmentInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393AckResponseData t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394AllocationSettings t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395BuiltinTopicReaderResourceLimits t . . . . . . . . . . . . . . . . . . . 426ChannelSettings t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454ChannelSettingsSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464

    StatusCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1448ReadCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1313

    QueryCondition . . . . . . . . . . . . . . . . . . . . . . . . . . 1311ConditionSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465ContentFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467

    WriterContentFilter . . . . . . . . . . . . . . . . . . . . . . . . . . 1737ContentFilterProperty t . . . . . . . . . . . . . . . . . . . . . . . . . . 476Cookie t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478CookieSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479Copyable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

    DynamicData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817InstanceHandle t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055

  • 14 Class Index

    StringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1467WstringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1741

    Time t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1537WriteParams t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1733SampleInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1398BuiltinTopicKey t . . . . . . . . . . . . . . . . . . . . . . . . . . . 424Bytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430BytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447KeyedBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1070KeyedBytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091KeyedString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1098KeyedStringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1117AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . . . 385

    BooleanSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417ByteSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441CharSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458

    WcharSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1721DoubleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 796

    LongDoubleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1179FloatSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958IntSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1064LongSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1181ShortSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1442

    Enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 944DataWriterResourceLimitsInstanceReplacementKind . . . . . . 617DestinationOrderQosPolicyKind . . . . . . . . . . . . . . . . . 634DiscoveryPluginPromiscuityKind . . . . . . . . . . . . . . . . . 648DurabilityQosPolicyKind . . . . . . . . . . . . . . . . . . . . . 807HistoryQosPolicyKind . . . . . . . . . . . . . . . . . . . . . . . 1050LivelinessQosPolicyKind . . . . . . . . . . . . . . . . . . . . . . 1144OwnershipQosPolicyKind . . . . . . . . . . . . . . . . . . . . . 1207PresentationQosPolicyAccessScopeKind . . . . . . . . . . . . . 1226PublishModeQosPolicyKind . . . . . . . . . . . . . . . . . . . . 1298QosPolicyId t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1305RefilterQosPolicyKind . . . . . . . . . . . . . . . . . . . . . . . 1322ReliabilityQosPolicyAcknowledgmentModeKind . . . . . . . . . 1329ReliabilityQosPolicyKind . . . . . . . . . . . . . . . . . . . . . 1331RemoteParticipantPurgeKind . . . . . . . . . . . . . . . . . . . 1341ThreadSettingsCpuRotationKind . . . . . . . . . . . . . . . . . 1533TransportMulticastQosPolicyKind . . . . . . . . . . . . . . . . 1593TypeConsistencyKind . . . . . . . . . . . . . . . . . . . . . . . 1663WireProtocolQosPolicyAutoKind . . . . . . . . . . . . . . . . . 1732FlowControllerSchedulingPolicy . . . . . . . . . . . . . . . . . . 970SampleLostStatusKind . . . . . . . . . . . . . . . . . . . . . . . 1412SampleRejectedStatusKind . . . . . . . . . . . . . . . . . . . . 1420

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 4.1 Class Hierarchy 15

    ExtensibilityKind . . . . . . . . . . . . . . . . . . . . . . . . . . 956TCKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1525LogCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1161LogLevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1171LogPrintFormat . . . . . . . . . . . . . . . . . . . . . . . . . . 1174LogVerbosity . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1177

    Foo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 977FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034

    DataReaderCacheStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 517DataReaderProtocolStatus . . . . . . . . . . . . . . . . . . . . . . . . 526DataReaderSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555DataWriterCacheStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 585DataWriterProtocolStatus . . . . . . . . . . . . . . . . . . . . . . . . . 598DiscoveryBuiltinReaderFragmentationResourceLimits t . . . . . . . . 636DiscoveryConfigBuiltinPluginKind . . . . . . . . . . . . . . . . . . . . 638DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . . . . . 742Duration t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813DynamicDataInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885DynamicDataMemberInfo . . . . . . . . . . . . . . . . . . . . . . . . . 887DynamicDataProperty t . . . . . . . . . . . . . . . . . . . . . . . . . . 890DynamicDataTypeProperty t . . . . . . . . . . . . . . . . . . . . . . . 897DynamicDataTypeSerializationProperty t . . . . . . . . . . . . . . . . 899EndpointGroup t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928EndpointGroupSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931

    DomainParticipant . . . . . . . . . . . . . . . . . . . . . . . . . . . 654DomainEntity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653

    DataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 557DynamicDataWriter . . . . . . . . . . . . . . . . . . . . . . . 907BytesDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . 437KeyedBytesDataWriter . . . . . . . . . . . . . . . . . . . . . 1081KeyedStringDataWriter . . . . . . . . . . . . . . . . . . . . . 1109StringDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . 1465FooDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . 1012

    Publisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1262DataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487

    DynamicDataReader . . . . . . . . . . . . . . . . . . . . . . . 892BytesDataReader . . . . . . . . . . . . . . . . . . . . . . . . . 433KeyedBytesDataReader . . . . . . . . . . . . . . . . . . . . . 1073KeyedStringDataReader . . . . . . . . . . . . . . . . . . . . . 1101StringDataReader . . . . . . . . . . . . . . . . . . . . . . . . 1462FooDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . 979

    Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1476Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1545

    EnumMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 16 Class Index

    ExpressionProperty . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955FilterSampleInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957FlowController . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 964FlowControllerProperty t . . . . . . . . . . . . . . . . . . . . . . . . . 968FlowControllerTokenBucketProperty t . . . . . . . . . . . . . . . . . . 973FooTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1036GuardCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1041GUID t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1044InconsistentTopicStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 1052InetAddressSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1054InstanceHandleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1058InstanceStateKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061LibraryVersion t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1126Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1130

    DataWriterListener . . . . . . . . . . . . . . . . . . . . . . . . . . . 586DataWriterAdapter . . . . . . . . . . . . . . . . . . . . . . . . 580

    PublisherAdapter . . . . . . . . . . . . . . . . . . . . . . . . . 1288PublisherListener . . . . . . . . . . . . . . . . . . . . . . . . . . 1289

    DomainParticipantListener . . . . . . . . . . . . . . . . . . . 771DomainParticipantAdapter . . . . . . . . . . . . . . . . . 736

    PublisherAdapter . . . . . . . . . . . . . . . . . . . . . . . . . 1288DataReaderListener . . . . . . . . . . . . . . . . . . . . . . . . . . 518

    DataReaderAdapter . . . . . . . . . . . . . . . . . . . . . . . . 514SubscriberAdapter . . . . . . . . . . . . . . . . . . . . . . . . 1502

    DomainParticipantAdapter . . . . . . . . . . . . . . . . . 736SubscriberListener . . . . . . . . . . . . . . . . . . . . . . . . . 1503

    DomainParticipantListener . . . . . . . . . . . . . . . . . . . 771SubscriberAdapter . . . . . . . . . . . . . . . . . . . . . . . . 1502

    TopicListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1564DomainParticipantListener . . . . . . . . . . . . . . . . . . . . 771TopicAdapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550

    EntityHowTo.MyEntityListener . . . . . . . . . . . . . . . . . . . . 941LivelinessChangedStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 1135LivelinessLostStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1138Locator t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1150LocatorFilter t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1154LocatorFilterSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1159LocatorSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1160Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1163LoggerDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1167LogMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1173ObjectHolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1194OfferedDeadlineMissedStatus . . . . . . . . . . . . . . . . . . . . . . . 1195OfferedIncompatibleQosStatus . . . . . . . . . . . . . . . . . . . . . . 1197ParticipantBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . 1211

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 4.1 Class Hierarchy 17

    ParticipantBuiltinTopicDataDataReader . . . . . . . . . . . . . . . . . 1214ParticipantBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . 1215PRIVATE MEMBER . . . . . . . . . . . . . . . . . . . . . . . . . . . 1228ProductVersion t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1229Property t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1234PropertyQosPolicyHelper . . . . . . . . . . . . . . . . . . . . . . . . . 1239PropertySeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1244ProtocolVersion t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1245PUBLIC MEMBER . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1248PublicationBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . 1249PublicationBuiltinTopicDataDataReader . . . . . . . . . . . . . . . . . 1256PublicationBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . 1257PublicationMatchedStatus . . . . . . . . . . . . . . . . . . . . . . . . . 1259PublisherSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1293Qos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1300

    DomainParticipantFactoryQos . . . . . . . . . . . . . . . . . . . . 769DomainParticipantQos . . . . . . . . . . . . . . . . . . . . . . . . . 773DataWriterQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610PublisherQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1290DataReaderQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536SubscriberQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1505TopicQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1566

    QosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1301AsynchronousPublisherQosPolicy . . . . . . . . . . . . . . . . . . . 397AvailabilityQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 402BatchQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412DatabaseQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 482DataReaderProtocolQosPolicy . . . . . . . . . . . . . . . . . . . . 521DataReaderResourceLimitsQosPolicy . . . . . . . . . . . . . . . . . 542DataWriterProtocolQosPolicy . . . . . . . . . . . . . . . . . . . . . 592DataWriterResourceLimitsQosPolicy . . . . . . . . . . . . . . . . . 621DeadlineQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 628DestinationOrderQosPolicy . . . . . . . . . . . . . . . . . . . . . . 631DiscoveryConfigQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 639DiscoveryQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 649DomainParticipantResourceLimitsQosPolicy . . . . . . . . . . . . . 778DurabilityQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 802DurabilityServiceQosPolicy . . . . . . . . . . . . . . . . . . . . . . 810EntityFactoryQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 938EntityNameQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 942EventQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 949ExclusiveAreaQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 952GroupDataQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 1039HistoryQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1046LatencyBudgetQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 1124

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 18 Class Index

    LifespanQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1128LivelinessQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1140LocatorFilterQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 1157LoggingQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1169MultiChannelQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 1187OwnershipQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 1199OwnershipStrengthQosPolicy . . . . . . . . . . . . . . . . . . . . . 1209PartitionQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1217PresentationQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 1221ProfileQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1231PropertyQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1236PublishModeQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 1295ReaderDataLifecycleQosPolicy . . . . . . . . . . . . . . . . . . . . 1315ReceiverPoolQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 1318ReliabilityQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 1324ResourceLimitsQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 1348SystemResourceLimitsQosPolicy . . . . . . . . . . . . . . . . . . . 1523TimeBasedFilterQosPolicy . . . . . . . . . . . . . . . . . . . . . . 1541TopicDataQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 1559TransportBuiltinQosPolicy . . . . . . . . . . . . . . . . . . . . . . 1580TransportMulticastMappingQosPolicy . . . . . . . . . . . . . . . . 1587TransportMulticastQosPolicy . . . . . . . . . . . . . . . . . . . . . 1590TransportPriorityQosPolicy . . . . . . . . . . . . . . . . . . . . . . 1598TransportSelectionQosPolicy . . . . . . . . . . . . . . . . . . . . . 1600TransportUnicastQosPolicy . . . . . . . . . . . . . . . . . . . . . . 1605TypeConsistencyEnforcementQosPolicy . . . . . . . . . . . . . . . 1661TypeSupportQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 1666UserDataQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1694WireProtocolQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 1723WriterDataLifecycleQosPolicy . . . . . . . . . . . . . . . . . . . . . 1738

    QosPolicyCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1302QosPolicyCountSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1304ReliableReaderActivityChangedStatus . . . . . . . . . . . . . . . . . . 1333ReliableWriterCacheChangedStatus . . . . . . . . . . . . . . . . . . . 1336ReliableWriterCacheEventCount . . . . . . . . . . . . . . . . . . . . . 1340RequestedDeadlineMissedStatus . . . . . . . . . . . . . . . . . . . . . 1344RequestedIncompatibleQosStatus . . . . . . . . . . . . . . . . . . . . . 1346RETCODE ERROR . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1356

    RETCODE ALREADY DELETED . . . . . . . . . . . . . . . . . 1354RETCODE BAD PARAMETER . . . . . . . . . . . . . . . . . . . 1355RETCODE ILLEGAL OPERATION . . . . . . . . . . . . . . . . 1357RETCODE IMMUTABLE POLICY . . . . . . . . . . . . . . . . . 1358RETCODE INCONSISTENT POLICY . . . . . . . . . . . . . . . 1359RETCODE NO DATA . . . . . . . . . . . . . . . . . . . . . . . . 1360RETCODE NOT ENABLED . . . . . . . . . . . . . . . . . . . . . 1361

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 4.1 Class Hierarchy 19

    RETCODE OUT OF RESOURCES . . . . . . . . . . . . . . . . . 1362RETCODE PRECONDITION NOT MET . . . . . . . . . . . . . 1363RETCODE TIMEOUT . . . . . . . . . . . . . . . . . . . . . . . . 1364RETCODE UNSUPPORTED . . . . . . . . . . . . . . . . . . . . . 1365

    RtpsReliableReaderProtocol t . . . . . . . . . . . . . . . . . . . . . . . 1366RtpsReliableWriterProtocol t . . . . . . . . . . . . . . . . . . . . . . . 1372RtpsReservedPortKind . . . . . . . . . . . . . . . . . . . . . . . . . . . 1388RtpsWellKnownPorts t . . . . . . . . . . . . . . . . . . . . . . . . . . 1390SampleIdentity t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1396SampleLostStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1410SampleRejectedStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . 1418SampleStateKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1426Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1428

    DynamicDataSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895SampleInfoSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1409BytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447KeyedBytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091KeyedStringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1117AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . . . 385AbstractSequence . . . . . . . . . . . . . . . . . . . . . . . . . . . 390

    AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . 385LoanableSequence . . . . . . . . . . . . . . . . . . . . . . . . . 1146

    SampleInfoSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1409BytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447KeyedBytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1091KeyedStringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1117FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034

    FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034SequenceNumber t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1431StatusKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1451StructMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1474SubscriberSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1507SubscriptionBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . 1509SubscriptionBuiltinTopicDataDataReader . . . . . . . . . . . . . . . . 1516SubscriptionBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . 1517SubscriptionMatchedStatus . . . . . . . . . . . . . . . . . . . . . . . . 1519SystemException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1522

    BAD PARAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407BAD TYPECODE . . . . . . . . . . . . . . . . . . . . . . . . . . . 408

    ThreadSettings t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1530ThreadSettingsKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1535TopicBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . . . . . 1552TopicBuiltinTopicDataDataReader . . . . . . . . . . . . . . . . . . . . 1556TopicBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . . . . . 1557TopicDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1561

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • 20 Class Index

    ContentFilteredTopic . . . . . . . . . . . . . . . . . . . . . . . . . 471MultiTopic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1190Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1545

    Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1569ShmemTransport . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1435UDPv4Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1668UDPv6Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1680

    Transport.Property t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1570ShmemTransport.Property t . . . . . . . . . . . . . . . . . . . . . 1439UDPv4Transport.Property t . . . . . . . . . . . . . . . . . . . . . 1672UDPv6Transport.Property t . . . . . . . . . . . . . . . . . . . . . 1684

    TransportBuiltinKind . . . . . . . . . . . . . . . . . . . . . . . . . . . 1578TransportMulticastMapping t . . . . . . . . . . . . . . . . . . . . . . . 1582TransportMulticastMappingFunction t . . . . . . . . . . . . . . . . . . 1585TransportMulticastMappingSeq . . . . . . . . . . . . . . . . . . . . . . 1589TransportMulticastSettings t . . . . . . . . . . . . . . . . . . . . . . . 1594TransportMulticastSettingsSeq . . . . . . . . . . . . . . . . . . . . . . 1597TransportSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1602TransportUnicastSettings t . . . . . . . . . . . . . . . . . . . . . . . . 1608TransportUnicastSettingsSeq . . . . . . . . . . . . . . . . . . . . . . . 1610TypeCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1611TypeCodeFactory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1647TypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1665

    DynamicDataTypeSupport . . . . . . . . . . . . . . . . . . . . . . 901BytesTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . 450KeyedBytesTypeSupport . . . . . . . . . . . . . . . . . . . . . . . 1094KeyedStringTypeSupport . . . . . . . . . . . . . . . . . . . . . . . 1120StringTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . 1470

    Union . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1691UnionMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1692UserException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1696

    BadKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409BadMemberId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410BadMemberName . . . . . . . . . . . . . . . . . . . . . . . . . . . 411Bounds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

    ValueMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1697VendorId t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1699Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1701ViewStateKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1703VM ABSTRACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1705VM CUSTOM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1706VM NONE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1707VM TRUNCATABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . 1708WaitSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1709WaitSetProperty t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1719

    Generated on Mon Aug 13 09:02:20 2012 for RTI Connext Java API by Doxygen

  • Chapter 5

    Class Index

    5.1 Class List

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

    AbstractBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . 383AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . . 385AbstractSequence (Abstract sequence ) . . . . . . . . . . . . . . . . 390AcknowledgmentInfo (Information about an application-level ac-

    knowledged sample ) . . . . . . . . . . . . . . . . . . . . . . . 393AckResponseData t (Data payload of an application-level acknowl-

    edgment ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394AllocationSettings t (Resource allocation settings ) . . . . . . . . . 395AsynchronousPublisherQosPolicy (Configures the mechanism

    that sends user data in an external middleware thread ) . . . 397AvailabilityQosPolicy (Configures the availability of data ) . . . . . 402BAD PARAM (The exception BadKind (p. 409) is thrown when

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

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

    BadKind (The exception BadKind (p. 409) is thrown when an inap-propriate 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 intoa single network packet in order to increase throughput forsmall 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 thelegal bounds ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 423

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

    readers resource limits ) . . . . . . . . . . . . . . . . . . . . . 426Bytes (Built-in type consisting of a variable-length array of opaque

    bytes ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430BytesDataReader (

    (p. 279) Instantiates DataReader ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433

    BytesDataWriter ((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.ty