rti connext c++ api - data distribution service (dds ... · rti connext c++ api version 5.0.0...

1628
RTI Connext C++ API Version 5.0.0 Generated by Doxygen 1.5.5 Mon Aug 13 09:00:30 2012

Upload: truongtu

Post on 30-Aug-2018

324 views

Category:

Documents


1 download

TRANSCRIPT

  • RTI Connext C++ API

    Version 5.0.0

    Generated by Doxygen 1.5.5

    Mon Aug 13 09:00:30 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 Class Index 9

    3.1 Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

    4 Class Index 15

    4.1 Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

    5 Module Documentation 29

    5.1 Clock Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

    5.2 Domain Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

    5.3 DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . . 34

    5.4 DomainParticipants . . . . . . . . . . . . . . . . . . . . . . . . . 37

    5.5 Built-in Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

    5.6 Topic Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

    5.7 Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

    5.8 User Data Type Support . . . . . . . . . . . . . . . . . . . . . . . 51

    5.9 Type Code Support . . . . . . . . . . . . . . . . . . . . . . . . . 56

    5.10 Built-in Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

  • ii CONTENTS

    5.11 Dynamic Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

    5.12 Publication Module . . . . . . . . . . . . . . . . . . . . . . . . . . 82

    5.13 Publishers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

    5.14 Data Writers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

    5.15 Flow Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

    5.16 Subscription Module . . . . . . . . . . . . . . . . . . . . . . . . . 95

    5.17 Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

    5.18 DataReaders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

    5.19 Read Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

    5.20 Query Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

    5.21 Data Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

    5.22 Sample States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

    5.23 View States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

    5.24 Instance States . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

    5.25 Infrastructure Module . . . . . . . . . . . . . . . . . . . . . . . . 118

    5.26 Built-in Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . 120

    5.27 Multi-channel DataWriters . . . . . . . . . . . . . . . . . . . . . 122

    5.28 Pluggable Transports . . . . . . . . . . . . . . . . . . . . . . . . . 124

    5.29 Using Transport Plugins . . . . . . . . . . . . . . . . . . . . . . . 130

    5.30 Built-in Transport Plugins . . . . . . . . . . . . . . . . . . . . . . 136

    5.31 Configuration Utilities . . . . . . . . . . . . . . . . . . . . . . . . 138

    5.32 Unsupported Utilities . . . . . . . . . . . . . . . . . . . . . . . . 143

    5.33 Durability and Persistence . . . . . . . . . . . . . . . . . . . . . . 144

    5.34 System Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 150

    5.35 Configuring QoS Profiles with XML . . . . . . . . . . . . . . . . 151

    5.36 Publication Example . . . . . . . . . . . . . . . . . . . . . . . . . 154

    5.37 Subscription Example . . . . . . . . . . . . . . . . . . . . . . . . 155

    5.38 Participant Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 156

    5.39 Topic Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 159

    5.40 FlowController Use Cases . . . . . . . . . . . . . . . . . . . . . . 161

    5.41 Publisher Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 165

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • CONTENTS iii

    5.42 DataWriter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 166

    5.43 Subscriber Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 168

    5.44 DataReader Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 172

    5.45 Entity Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 176

    5.46 Waitset Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 179

    5.47 Transport Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 181

    5.48 Filter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

    5.49 Creating Custom Content Filters . . . . . . . . . . . . . . . . . . 191

    5.50 Large Data Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 195

    5.51 Documentation Roadmap . . . . . . . . . . . . . . . . . . . . . . 197

    5.52 Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

    5.53 Using DDS:: Namespace . . . . . . . . . . . . . . . . . . . . . . . 201

    5.54 DDS API Reference . . . . . . . . . . . . . . . . . . . . . . . . . 203

    5.55 Queries and Filters Syntax . . . . . . . . . . . . . . . . . . . . . . 208

    5.56 RTI Connext API Reference . . . . . . . . . . . . . . . . . . . . . 216

    5.57 Programming How-Tos . . . . . . . . . . . . . . . . . . . . . . . 217

    5.58 Programming Tools . . . . . . . . . . . . . . . . . . . . . . . . . . 219

    5.59 rtiddsgen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

    5.60 rtiddsping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

    5.61 rtiddsspy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

    5.62 Class Id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

    5.63 Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

    5.64 Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

    5.65 Shared Memory Transport . . . . . . . . . . . . . . . . . . . . . . 257

    5.66 UDPv4 Transport . . . . . . . . . . . . . . . . . . . . . . . . . . 265

    5.67 UDPv6 Transport . . . . . . . . . . . . . . . . . . . . . . . . . . 275

    5.68 Participant Built-in Topics . . . . . . . . . . . . . . . . . . . . . 285

    5.69 Topic Built-in Topics . . . . . . . . . . . . . . . . . . . . . . . . . 287

    5.70 Publication Built-in Topics . . . . . . . . . . . . . . . . . . . . . 289

    5.71 Subscription Built-in Topics . . . . . . . . . . . . . . . . . . . . . 291

    5.72 String Built-in Type . . . . . . . . . . . . . . . . . . . . . . . . . 293

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • iv CONTENTS

    5.73 KeyedString Built-in Type . . . . . . . . . . . . . . . . . . . . . . 294

    5.74 Octets Built-in Type . . . . . . . . . . . . . . . . . . . . . . . . . 295

    5.75 KeyedOctets Built-in Type . . . . . . . . . . . . . . . . . . . . . 296

    5.76 DDS-Specific Primitive Types . . . . . . . . . . . . . . . . . . . . 297

    5.77 Time Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

    5.78 GUID Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

    5.79 Sequence Number Support . . . . . . . . . . . . . . . . . . . . . . 310

    5.80 Exception Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

    5.81 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314

    5.82 Status Kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317

    5.83 Thread Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328

    5.84 QoS Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

    5.85 USER DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345

    5.86 TOPIC DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

    5.87 GROUP DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347

    5.88 DURABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

    5.89 PRESENTATION . . . . . . . . . . . . . . . . . . . . . . . . . . 351

    5.90 DEADLINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353

    5.91 LATENCY BUDGET . . . . . . . . . . . . . . . . . . . . . . . . 354

    5.92 OWNERSHIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355

    5.93 OWNERSHIP STRENGTH . . . . . . . . . . . . . . . . . . . . . 357

    5.94 LIVELINESS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

    5.95 TIME BASED FILTER . . . . . . . . . . . . . . . . . . . . . . . 360

    5.96 PARTITION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

    5.97 RELIABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362

    5.98 DESTINATION ORDER . . . . . . . . . . . . . . . . . . . . . . 365

    5.99 HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367

    5.100DURABILITY SERVICE . . . . . . . . . . . . . . . . . . . . . . 370

    5.101RESOURCE LIMITS . . . . . . . . . . . . . . . . . . . . . . . . 371

    5.102TRANSPORT PRIORITY . . . . . . . . . . . . . . . . . . . . . 373

    5.103LIFESPAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • CONTENTS v

    5.104WRITER DATA LIFECYCLE . . . . . . . . . . . . . . . . . . . 375

    5.105READER DATA LIFECYCLE . . . . . . . . . . . . . . . . . . . 376

    5.106ENTITY FACTORY . . . . . . . . . . . . . . . . . . . . . . . . . 377

    5.107Extended Qos Support . . . . . . . . . . . . . . . . . . . . . . . . 378

    5.108Unicast Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

    5.109Multicast Settings . . . . . . . . . . . . . . . . . . . . . . . . . . 380

    5.110Multicast Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . 381

    5.111TRANSPORT SELECTION . . . . . . . . . . . . . . . . . . . . 382

    5.112TRANSPORT UNICAST . . . . . . . . . . . . . . . . . . . . . . 383

    5.113TRANSPORT MULTICAST . . . . . . . . . . . . . . . . . . . . 384

    5.114TRANSPORT MULTICAST MAPPING . . . . . . . . . . . . . 386

    5.115DISCOVERY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

    5.116NDDS DISCOVERY PEERS . . . . . . . . . . . . . . . . . . . . 388

    5.117TRANSPORT BUILTIN . . . . . . . . . . . . . . . . . . . . . . . 396

    5.118WIRE PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . . . 400

    5.119DATA READER RESOURCE LIMITS . . . . . . . . . . . . . . 407

    5.120DATA WRITER RESOURCE LIMITS . . . . . . . . . . . . . . 409

    5.121DATA READER PROTOCOL . . . . . . . . . . . . . . . . . . . 413

    5.122DATA WRITER PROTOCOL . . . . . . . . . . . . . . . . . . . 414

    5.123SYSTEM RESOURCE LIMITS . . . . . . . . . . . . . . . . . . . 415

    5.124DOMAIN PARTICIPANT RESOURCE LIMITS . . . . . . . . . 416

    5.125EVENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417

    5.126DATABASE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

    5.127RECEIVER POOL . . . . . . . . . . . . . . . . . . . . . . . . . . 419

    5.128PUBLISH MODE . . . . . . . . . . . . . . . . . . . . . . . . . . 420

    5.129DISCOVERY CONFIG . . . . . . . . . . . . . . . . . . . . . . . 423

    5.130ASYNCHRONOUS PUBLISHER . . . . . . . . . . . . . . . . . . 428

    5.131TYPESUPPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . 429

    5.132EXCLUSIVE AREA . . . . . . . . . . . . . . . . . . . . . . . . . 430

    5.133BATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431

    5.134TYPE CONSISTENCY ENFORCEMENT . . . . . . . . . . . . 432

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • vi CONTENTS

    5.135LOCATORFILTER . . . . . . . . . . . . . . . . . . . . . . . . . 434

    5.136MULTICHANNEL . . . . . . . . . . . . . . . . . . . . . . . . . . 435

    5.137PROPERTY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436

    5.138AVAILABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . 442

    5.139Entity Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443

    5.140Conditions and WaitSets . . . . . . . . . . . . . . . . . . . . . . . 444

    5.141ENTITY NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . 445

    5.142PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446

    5.143WriteParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447

    5.144LOGGING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

    5.145Octet Buffer Support . . . . . . . . . . . . . . . . . . . . . . . . . 451

    5.146Sequence Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 455

    5.147String Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

    6 Class Documentation 463

    6.1 DDS AckResponseData t Struct Reference . . . . . . . . . . . . . 463

    6.2 DDS AllocationSettings t Struct Reference . . . . . . . . . . . . 464

    6.3 DDS AsynchronousPublisherQosPolicy Struct Reference . . . . . 466

    6.4 DDS AvailabilityQosPolicy Struct Reference . . . . . . . . . . . . 471

    6.5 DDS BatchQosPolicy Struct Reference . . . . . . . . . . . . . . . 476

    6.6 DDS BooleanSeq Struct Reference . . . . . . . . . . . . . . . . . 480

    6.7 DDS BuiltinTopicKey t Struct Reference . . . . . . . . . . . . . 481

    6.8 DDS BuiltinTopicReaderResourceLimits t Struct Reference . . . 482

    6.9 DDS ChannelSettings t Struct Reference . . . . . . . . . . . . . . 486

    6.10 DDS ChannelSettingsSeq Struct Reference . . . . . . . . . . . . . 489

    6.11 DDS CharSeq Struct Reference . . . . . . . . . . . . . . . . . . . 490

    6.12 DDS ContentFilterProperty t Struct Reference . . . . . . . . . . 491

    6.13 DDS Cookie t Struct Reference . . . . . . . . . . . . . . . . . . . 493

    6.14 DDS CookieSeq Struct Reference . . . . . . . . . . . . . . . . . . 494

    6.15 DDS DatabaseQosPolicy Struct Reference . . . . . . . . . . . . . 495

    6.16 DDS DataReaderCacheStatus Struct Reference . . . . . . . . . . 500

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • CONTENTS vii

    6.17 DDS DataReaderProtocolQosPolicy Struct Reference . . . . . . . 501

    6.18 DDS DataReaderProtocolStatus Struct Reference . . . . . . . . . 505

    6.19 DDS DataReaderQos Struct Reference . . . . . . . . . . . . . . . 515

    6.20 DDS DataReaderResourceLimitsQosPolicy Struct Reference . . . 521

    6.21 DDS DataWriterCacheStatus Struct Reference . . . . . . . . . . 534

    6.22 DDS DataWriterProtocolQosPolicy Struct Reference . . . . . . . 535

    6.23 DDS DataWriterProtocolStatus Struct Reference . . . . . . . . . 540

    6.24 DDS DataWriterQos Struct Reference . . . . . . . . . . . . . . . 553

    6.25 DDS DataWriterResourceLimitsQosPolicy Struct Reference . . . 560

    6.26 DDS DeadlineQosPolicy Struct Reference . . . . . . . . . . . . . 567

    6.27 DDS DestinationOrderQosPolicy Struct Reference . . . . . . . . 570

    6.28 DDS DiscoveryConfigQosPolicy Struct Reference . . . . . . . . . 573

    6.29 DDS DiscoveryQosPolicy Struct Reference . . . . . . . . . . . . . 582

    6.30 DDS DomainParticipantFactoryQos Struct Reference . . . . . . . 586

    6.31 DDS DomainParticipantQos Struct Reference . . . . . . . . . . . 588

    6.32 DDS DomainParticipantResourceLimitsQosPolicy Struct Refer-ence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593

    6.33 DDS DoubleSeq Struct Reference . . . . . . . . . . . . . . . . . . 613

    6.34 DDS DurabilityQosPolicy Struct Reference . . . . . . . . . . . . 614

    6.35 DDS DurabilityServiceQosPolicy Struct Reference . . . . . . . . 618

    6.36 DDS Duration t Struct Reference . . . . . . . . . . . . . . . . . . 621

    6.37 DDS DynamicData Struct Reference . . . . . . . . . . . . . . . . 622

    6.38 DDS DynamicDataInfo Struct Reference . . . . . . . . . . . . . . 721

    6.39 DDS DynamicDataMemberInfo Struct Reference . . . . . . . . . 722

    6.40 DDS DynamicDataProperty t Struct Reference . . . . . . . . . . 725

    6.41 DDS DynamicDataSeq Struct Reference . . . . . . . . . . . . . . 727

    6.42 DDS DynamicDataTypeProperty t Struct Reference . . . . . . . 728

    6.43 DDS DynamicDataTypeSerializationProperty t Struct Reference 729

    6.44 DDS EndpointGroup t Struct Reference . . . . . . . . . . . . . . 731

    6.45 DDS EndpointGroupSeq Struct Reference . . . . . . . . . . . . . 732

    6.46 DDS EntityFactoryQosPolicy Struct Reference . . . . . . . . . . 733

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • viii CONTENTS

    6.47 DDS EntityNameQosPolicy Struct Reference . . . . . . . . . . . 735

    6.48 DDS EnumMember Struct Reference . . . . . . . . . . . . . . . . 737

    6.49 DDS EnumMemberSeq Struct Reference . . . . . . . . . . . . . . 738

    6.50 DDS EventQosPolicy Struct Reference . . . . . . . . . . . . . . . 739

    6.51 DDS ExclusiveAreaQosPolicy Struct Reference . . . . . . . . . . 742

    6.52 DDS ExpressionProperty Struct Reference . . . . . . . . . . . . . 745

    6.53 DDS FactoryPluginSupport Struct Reference . . . . . . . . . . . 746

    6.54 DDS FilterSampleInfo Struct Reference . . . . . . . . . . . . . . 747

    6.55 DDS FloatSeq Struct Reference . . . . . . . . . . . . . . . . . . . 748

    6.56 DDS FlowControllerProperty t Struct Reference . . . . . . . . . 749

    6.57 DDS FlowControllerTokenBucketProperty t Struct Reference . . 751

    6.58 DDS GroupDataQosPolicy Struct Reference . . . . . . . . . . . . 755

    6.59 DDS GUID t Struct Reference . . . . . . . . . . . . . . . . . . . 757

    6.60 DDS HistoryQosPolicy Struct Reference . . . . . . . . . . . . . . 758

    6.61 DDS InconsistentTopicStatus Struct Reference . . . . . . . . . . 762

    6.62 DDS InstanceHandleSeq Struct Reference . . . . . . . . . . . . . 764

    6.63 DDS KeyedOctets Struct Reference . . . . . . . . . . . . . . . . . 765

    6.64 DDS KeyedOctetsSeq Struct Reference . . . . . . . . . . . . . . . 767

    6.65 DDS KeyedString Struct Reference . . . . . . . . . . . . . . . . . 768

    6.66 DDS KeyedStringSeq Struct Reference . . . . . . . . . . . . . . . 770

    6.67 DDS LatencyBudgetQosPolicy Struct Reference . . . . . . . . . . 771

    6.68 DDS LifespanQosPolicy Struct Reference . . . . . . . . . . . . . 773

    6.69 DDS LivelinessChangedStatus Struct Reference . . . . . . . . . . 775

    6.70 DDS LivelinessLostStatus Struct Reference . . . . . . . . . . . . 777

    6.71 DDS LivelinessQosPolicy Struct Reference . . . . . . . . . . . . . 779

    6.72 DDS Locator t Struct Reference . . . . . . . . . . . . . . . . . . 783

    6.73 DDS LocatorFilter t Struct Reference . . . . . . . . . . . . . . . 785

    6.74 DDS LocatorFilterQosPolicy Struct Reference . . . . . . . . . . . 787

    6.75 DDS LocatorFilterSeq Struct Reference . . . . . . . . . . . . . . 789

    6.76 DDS LocatorSeq Struct Reference . . . . . . . . . . . . . . . . . 790

    6.77 DDS LoggingQosPolicy Struct Reference . . . . . . . . . . . . . . 791

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • CONTENTS ix

    6.78 DDS LongDoubleSeq Struct Reference . . . . . . . . . . . . . . . 793

    6.79 DDS LongLongSeq Struct Reference . . . . . . . . . . . . . . . . 794

    6.80 DDS LongSeq Struct Reference . . . . . . . . . . . . . . . . . . . 795

    6.81 DDS MultiChannelQosPolicy Struct Reference . . . . . . . . . . 796

    6.82 DDS Octets Struct Reference . . . . . . . . . . . . . . . . . . . . 799

    6.83 DDS OctetSeq Struct Reference . . . . . . . . . . . . . . . . . . . 801

    6.84 DDS OctetsSeq Struct Reference . . . . . . . . . . . . . . . . . . 802

    6.85 DDS OfferedDeadlineMissedStatus Struct Reference . . . . . . . 803

    6.86 DDS OfferedIncompatibleQosStatus Struct Reference . . . . . . . 805

    6.87 DDS OwnershipQosPolicy Struct Reference . . . . . . . . . . . . 807

    6.88 DDS OwnershipStrengthQosPolicy Struct Reference . . . . . . . 814

    6.89 DDS ParticipantBuiltinTopicData Struct Reference . . . . . . . . 816

    6.90 DDS ParticipantBuiltinTopicDataSeq Struct Reference . . . . . . 819

    6.91 DDS PartitionQosPolicy Struct Reference . . . . . . . . . . . . . 820

    6.92 DDS PresentationQosPolicy Struct Reference . . . . . . . . . . . 823

    6.93 DDS ProductVersion t Struct Reference . . . . . . . . . . . . . . 828

    6.94 DDS ProfileQosPolicy Struct Reference . . . . . . . . . . . . . . 830

    6.95 DDS Property t Struct Reference . . . . . . . . . . . . . . . . . . 833

    6.96 DDS PropertyQosPolicy Struct Reference . . . . . . . . . . . . . 834

    6.97 DDS PropertySeq Struct Reference . . . . . . . . . . . . . . . . . 837

    6.98 DDS ProtocolVersion t Struct Reference . . . . . . . . . . . . . . 838

    6.99 DDS PublicationBuiltinTopicData Struct Reference . . . . . . . 839

    6.100DDS PublicationBuiltinTopicDataSeq Struct Reference . . . . . . 847

    6.101DDS PublicationMatchedStatus Struct Reference . . . . . . . . . 848

    6.102DDS PublisherQos Struct Reference . . . . . . . . . . . . . . . . 851

    6.103DDS PublishModeQosPolicy Struct Reference . . . . . . . . . . . 853

    6.104DDS QosPolicyCount Struct Reference . . . . . . . . . . . . . . . 857

    6.105DDS QosPolicyCountSeq Struct Reference . . . . . . . . . . . . . 858

    6.106DDS ReaderDataLifecycleQosPolicy Struct Reference . . . . . . . 859

    6.107DDS ReceiverPoolQosPolicy Struct Reference . . . . . . . . . . . 862

    6.108DDS ReliabilityQosPolicy Struct Reference . . . . . . . . . . . . 865

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • x CONTENTS

    6.109DDS ReliableReaderActivityChangedStatus Struct Reference . . 869

    6.110DDS ReliableWriterCacheChangedStatus Struct Reference . . . . 871

    6.111DDS ReliableWriterCacheEventCount Struct Reference . . . . . 874

    6.112DDS RequestedDeadlineMissedStatus Struct Reference . . . . . . 875

    6.113DDS RequestedIncompatibleQosStatus Struct Reference . . . . . 877

    6.114DDS ResourceLimitsQosPolicy Struct Reference . . . . . . . . . 879

    6.115DDS RtpsReliableReaderProtocol t Struct Reference . . . . . . . 884

    6.116DDS RtpsReliableWriterProtocol t Struct Reference . . . . . . . 889

    6.117DDS RtpsWellKnownPorts t Struct Reference . . . . . . . . . . . 905

    6.118DDS SampleIdentity t Struct Reference . . . . . . . . . . . . . . 911

    6.119DDS SampleInfo Struct Reference . . . . . . . . . . . . . . . . . 912

    6.120DDS SampleInfoSeq Struct Reference . . . . . . . . . . . . . . . 922

    6.121DDS SampleLostStatus Struct Reference . . . . . . . . . . . . . . 923

    6.122DDS SampleRejectedStatus Struct Reference . . . . . . . . . . . 925

    6.123DDS SequenceNumber t Struct Reference . . . . . . . . . . . . . 927

    6.124DDS ShortSeq Struct Reference . . . . . . . . . . . . . . . . . . . 928

    6.125DDS StringSeq Struct Reference . . . . . . . . . . . . . . . . . . 929

    6.126DDS StructMember Struct Reference . . . . . . . . . . . . . . . . 931

    6.127DDS StructMemberSeq Struct Reference . . . . . . . . . . . . . . 933

    6.128DDS SubscriberQos Struct Reference . . . . . . . . . . . . . . . . 934

    6.129DDS SubscriptionBuiltinTopicData Struct Reference . . . . . . . 936

    6.130DDS SubscriptionBuiltinTopicDataSeq Struct Reference . . . . . 944

    6.131DDS SubscriptionMatchedStatus Struct Reference . . . . . . . . 945

    6.132DDS SystemResourceLimitsQosPolicy Struct Reference . . . . . 948

    6.133DDS ThreadSettings t Struct Reference . . . . . . . . . . . . . . 950

    6.134DDS Time t Struct Reference . . . . . . . . . . . . . . . . . . . . 953

    6.135DDS TimeBasedFilterQosPolicy Struct Reference . . . . . . . . . 954

    6.136DDS TopicBuiltinTopicData Struct Reference . . . . . . . . . . . 958

    6.137DDS TopicBuiltinTopicDataSeq Struct Reference . . . . . . . . . 962

    6.138DDS TopicDataQosPolicy Struct Reference . . . . . . . . . . . . 963

    6.139DDS TopicQos Struct Reference . . . . . . . . . . . . . . . . . . 965

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • CONTENTS xi

    6.140DDS TransportBuiltinQosPolicy Struct Reference . . . . . . . . . 969

    6.141DDS TransportMulticastMapping t Struct Reference . . . . . . . 971

    6.142DDS TransportMulticastMappingFunction t Struct Reference . . 973

    6.143DDS TransportMulticastMappingQosPolicy Struct Reference . . 975

    6.144DDS TransportMulticastMappingSeq Struct Reference . . . . . . 977

    6.145DDS TransportMulticastQosPolicy Struct Reference . . . . . . . 978

    6.146DDS TransportMulticastSettings t Struct Reference . . . . . . . 980

    6.147DDS TransportMulticastSettingsSeq Struct Reference . . . . . . 982

    6.148DDS TransportPriorityQosPolicy Struct Reference . . . . . . . . 983

    6.149DDS TransportSelectionQosPolicy Struct Reference . . . . . . . . 985

    6.150DDS TransportUnicastQosPolicy Struct Reference . . . . . . . . 987

    6.151DDS TransportUnicastSettings t Struct Reference . . . . . . . . 989

    6.152DDS TransportUnicastSettingsSeq Struct Reference . . . . . . . 991

    6.153DDS TypeCode Struct Reference . . . . . . . . . . . . . . . . . . 992

    6.154DDS TypeCodeFactory Struct Reference . . . . . . . . . . . . . . 1022

    6.155DDS TypeConsistencyEnforcementQosPolicy Struct Reference . 1038

    6.156DDS TypeSupportQosPolicy Struct Reference . . . . . . . . . . . 1040

    6.157DDS UnionMember Struct Reference . . . . . . . . . . . . . . . . 1042

    6.158DDS UnionMemberSeq Struct Reference . . . . . . . . . . . . . . 1044

    6.159DDS UnsignedLongLongSeq Struct Reference . . . . . . . . . . . 1045

    6.160DDS UnsignedLongSeq Struct Reference . . . . . . . . . . . . . . 1046

    6.161DDS UnsignedShortSeq Struct Reference . . . . . . . . . . . . . 1047

    6.162DDS UserDataQosPolicy Struct Reference . . . . . . . . . . . . . 1048

    6.163DDS ValueMember Struct Reference . . . . . . . . . . . . . . . . 1050

    6.164DDS ValueMemberSeq Struct Reference . . . . . . . . . . . . . . 1052

    6.165DDS VendorId t Struct Reference . . . . . . . . . . . . . . . . . . 1053

    6.166DDS VirtualSubscriptionBuiltinTopicData Struct Reference . . . 1054

    6.167DDS VirtualSubscriptionBuiltinTopicDataSeq Struct Reference . 1055

    6.168DDS WaitSetProperty t Struct Reference . . . . . . . . . . . . . 1056

    6.169DDS WcharSeq Struct Reference . . . . . . . . . . . . . . . . . . 1058

    6.170DDS WireProtocolQosPolicy Struct Reference . . . . . . . . . . . 1059

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • xii CONTENTS

    6.171DDS WriteParams t Struct Reference . . . . . . . . . . . . . . . 1067

    6.172DDS WriterDataLifecycleQosPolicy Struct Reference . . . . . . . 1071

    6.173DDS WstringSeq Struct Reference . . . . . . . . . . . . . . . . . 1074

    6.174DDSCondition Class Reference . . . . . . . . . . . . . . . . . . . 1075

    6.175DDSConditionSeq Struct Reference . . . . . . . . . . . . . . . . . 1076

    6.176DDSContentFilter Class Reference . . . . . . . . . . . . . . . . . 1077

    6.177DDSContentFilteredTopic Class Reference . . . . . . . . . . . . . 1081

    6.178DDSDataReader Class Reference . . . . . . . . . . . . . . . . . . 1087

    6.179DDSDataReaderListener Class Reference . . . . . . . . . . . . . 1108

    6.180DDSDataReaderSeq Class Reference . . . . . . . . . . . . . . . . 1112

    6.181DDSDataWriter Class Reference . . . . . . . . . . . . . . . . . . 1113

    6.182DDSDataWriterListener Class Reference . . . . . . . . . . . . . . 1133

    6.183DDSDomainEntity Class Reference . . . . . . . . . . . . . . . . . 1138

    6.184DDSDomainParticipant Class Reference . . . . . . . . . . . . . . 1139

    6.185DDSDomainParticipantFactory Class Reference . . . . . . . . . . 1216

    6.186DDSDomainParticipantListener Class Reference . . . . . . . . . 1243

    6.187DDSDynamicDataReader Class Reference . . . . . . . . . . . . . 1245

    6.188DDSDynamicDataTypeSupport Class Reference . . . . . . . . . . 1246

    6.189DDSDynamicDataWriter Class Reference . . . . . . . . . . . . . 1252

    6.190DDSEntity Class Reference . . . . . . . . . . . . . . . . . . . . . 1253

    6.191DDSFlowController Class Reference . . . . . . . . . . . . . . . . 1259

    6.192DDSGuardCondition Class Reference . . . . . . . . . . . . . . . . 1263

    6.193DDSKeyedOctetsDataReader Class Reference . . . . . . . . . . . 1265

    6.194DDSKeyedOctetsDataWriter Class Reference . . . . . . . . . . . 1276

    6.195DDSKeyedOctetsTypeSupport Class Reference . . . . . . . . . . 1289

    6.196DDSKeyedStringDataReader Class Reference . . . . . . . . . . . 1293

    6.197DDSKeyedStringDataWriter Class Reference . . . . . . . . . . . 1304

    6.198DDSKeyedStringTypeSupport Class Reference . . . . . . . . . . 1314

    6.199DDSListener Class Reference . . . . . . . . . . . . . . . . . . . . 1318

    6.200DDSMultiTopic Class Reference . . . . . . . . . . . . . . . . . . . 1322

    6.201DDSOctetsDataReader Class Reference . . . . . . . . . . . . . . 1326

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • CONTENTS xiii

    6.202DDSOctetsDataWriter Class Reference . . . . . . . . . . . . . . . 1331

    6.203DDSOctetsTypeSupport Class Reference . . . . . . . . . . . . . . 1337

    6.204DDSParticipantBuiltinTopicDataDataReader Class Reference . . 1341

    6.205DDSParticipantBuiltinTopicDataTypeSupport Class Reference . 1342

    6.206DDSPropertyQosPolicyHelper Class Reference . . . . . . . . . . 1343

    6.207DDSPublicationBuiltinTopicDataDataReader Class Reference . . 1344

    6.208DDSPublicationBuiltinTopicDataTypeSupport Class Reference . 1345

    6.209DDSPublisher Class Reference . . . . . . . . . . . . . . . . . . . 1346

    6.210DDSPublisherListener Class Reference . . . . . . . . . . . . . . . 1370

    6.211DDSPublisherSeq Class Reference . . . . . . . . . . . . . . . . . 1371

    6.212DDSQueryCondition Class Reference . . . . . . . . . . . . . . . . 1372

    6.213DDSReadCondition Class Reference . . . . . . . . . . . . . . . . 1374

    6.214DDSStatusCondition Class Reference . . . . . . . . . . . . . . . . 1376

    6.215DDSStringDataReader Class Reference . . . . . . . . . . . . . . . 1379

    6.216DDSStringDataWriter Class Reference . . . . . . . . . . . . . . . 1383

    6.217DDSStringTypeSupport Class Reference . . . . . . . . . . . . . . 1386

    6.218DDSSubscriber Class Reference . . . . . . . . . . . . . . . . . . . 1390

    6.219DDSSubscriberListener Class Reference . . . . . . . . . . . . . . 1414

    6.220DDSSubscriberSeq Class Reference . . . . . . . . . . . . . . . . . 1416

    6.221DDSSubscriptionBuiltinTopicDataDataReader Class Reference . 1417

    6.222DDSSubscriptionBuiltinTopicDataTypeSupport Class Reference 1418

    6.223DDSTopic Class Reference . . . . . . . . . . . . . . . . . . . . . . 1419

    6.224DDSTopicBuiltinTopicDataDataReader Class Reference . . . . . 1425

    6.225DDSTopicBuiltinTopicDataTypeSupport Class Reference . . . . 1426

    6.226DDSTopicDescription Class Reference . . . . . . . . . . . . . . . 1427

    6.227DDSTopicListener Class Reference . . . . . . . . . . . . . . . . . 1430

    6.228DDSTypeSupport Class Reference . . . . . . . . . . . . . . . . . 1432

    6.229DDSWaitSet Class Reference . . . . . . . . . . . . . . . . . . . . 1433

    6.230DDSWriterContentFilter Class Reference . . . . . . . . . . . . . 1441

    6.231Foo Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . 1443

    6.232FooDataReader Struct Reference . . . . . . . . . . . . . . . . . . 1444

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • xiv CONTENTS

    6.233FooDataWriter Struct Reference . . . . . . . . . . . . . . . . . . 1475

    6.234FooSeq Struct Reference . . . . . . . . . . . . . . . . . . . . . . . 1494

    6.235FooTypeSupport Struct Reference . . . . . . . . . . . . . . . . . 1509

    6.236NDDS Config LibraryVersion t Struct Reference . . . . . . . . . 1518

    6.237NDDS Config LogMessage Struct Reference . . . . . . . . . . . . 1520

    6.238NDDS Transport Address t Struct Reference . . . . . . . . . . . 1521

    6.239NDDS Transport Property t Struct Reference . . . . . . . . . . . 1522

    6.240NDDS Transport Shmem Property t Struct Reference . . . . . . 1530

    6.241NDDS Transport UDPv4 Property t Struct Reference . . . . . . 1533

    6.242NDDS Transport UDPv6 Property t Struct Reference . . . . . . 1542

    6.243NDDSConfigLogger Class Reference . . . . . . . . . . . . . . . . 1550

    6.244NDDSConfigLoggerDevice Class Reference . . . . . . . . . . . . . 1555

    6.245NDDSConfigVersion Class Reference . . . . . . . . . . . . . . . . 1557

    6.246NDDSTransportSupport Class Reference . . . . . . . . . . . . . . 1559

    6.247NDDSUtility Class Reference . . . . . . . . . . . . . . . . . . . . 1567

    6.248TransportAllocationSettings t Struct Reference . . . . . . . . . . 1568

    7 Example Documentation 1569

    7.1 HelloWorld.cxx . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1569

    7.2 HelloWorld.idl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1576

    7.3 HelloWorld publisher.cxx . . . . . . . . . . . . . . . . . . . . . . 1577

    7.4 HelloWorld subscriber.cxx . . . . . . . . . . . . . . . . . . . . . . 1582

    7.5 HelloWorldPlugin.cxx . . . . . . . . . . . . . . . . . . . . . . . . 1588

    7.6 HelloWorldSupport.cxx . . . . . . . . . . . . . . . . . . . . . . . 1609

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ 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. 197) 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:00:30 2012 for RTI Connext C++ 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. 203) - The DDS API reference.

    RTI Connext API Reference (p. 216) - RTI Connext APIs indepen-dent of the DDS standard.

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

    Programming Tools (p. 219) - 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:00:30 2012 for RTI Connext C++ API by Doxygen

  • 4 RTI Connext

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • Chapter 2

    Module Index

    2.1 Modules

    Here is a list of all modules:

    Documentation Roadmap . . . . . . . . . . . . . . . . . . . . . . . . . 197Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198Using DDS:: Namespace . . . . . . . . . . . . . . . . . . . . . . . . . . 201DDS API Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

    Domain Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . 34DomainParticipants . . . . . . . . . . . . . . . . . . . . . . . . 37Built-in Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

    Participant Built-in Topics . . . . . . . . . . . . . . . . . . . 285Topic Built-in Topics . . . . . . . . . . . . . . . . . . . . . . . 287Publication Built-in Topics . . . . . . . . . . . . . . . . . . . 289Subscription Built-in Topics . . . . . . . . . . . . . . . . . . . 291

    Topic Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50User Data Type Support . . . . . . . . . . . . . . . . . . . . . 51Type Code Support . . . . . . . . . . . . . . . . . . . . . . . . 56Built-in Types . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

    String Built-in Type . . . . . . . . . . . . . . . . . . . . . . . 293KeyedString Built-in Type . . . . . . . . . . . . . . . . . . . 294Octets Built-in Type . . . . . . . . . . . . . . . . . . . . . . . 295KeyedOctets Built-in Type . . . . . . . . . . . . . . . . . . . 296

    Dynamic Data . . . . . . . . . . . . . . . . . . . . . . . . . . . 77DDS-Specific Primitive Types . . . . . . . . . . . . . . . . . . . 297

    Publication Module . . . . . . . . . . . . . . . . . . . . . . . . . . 82Publishers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

  • 6 Module Index

    Data Writers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Flow Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . 88

    Subscription Module . . . . . . . . . . . . . . . . . . . . . . . . . . 95Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98DataReaders . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

    Read Conditions . . . . . . . . . . . . . . . . . . . . . . . . . 107Query Conditions . . . . . . . . . . . . . . . . . . . . . . . . . 108

    Data Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Sample States . . . . . . . . . . . . . . . . . . . . . . . . . . . 111View States . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113Instance States . . . . . . . . . . . . . . . . . . . . . . . . . . 115

    Infrastructure Module . . . . . . . . . . . . . . . . . . . . . . . . . 118Time Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302GUID Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 307Sequence Number Support . . . . . . . . . . . . . . . . . . . . 310Exception Codes . . . . . . . . . . . . . . . . . . . . . . . . . . 312Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314Status Kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317QoS Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331

    USER DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . 345TOPIC DATA . . . . . . . . . . . . . . . . . . . . . . . . . . 346GROUP DATA . . . . . . . . . . . . . . . . . . . . . . . . . . 347DURABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . 348PRESENTATION . . . . . . . . . . . . . . . . . . . . . . . . 351DEADLINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353LATENCY BUDGET . . . . . . . . . . . . . . . . . . . . . . 354OWNERSHIP . . . . . . . . . . . . . . . . . . . . . . . . . . 355OWNERSHIP STRENGTH . . . . . . . . . . . . . . . . . . . 357LIVELINESS . . . . . . . . . . . . . . . . . . . . . . . . . . . 358TIME BASED FILTER . . . . . . . . . . . . . . . . . . . . . 360PARTITION . . . . . . . . . . . . . . . . . . . . . . . . . . . 361RELIABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . 362DESTINATION ORDER . . . . . . . . . . . . . . . . . . . . 365HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367DURABILITY SERVICE . . . . . . . . . . . . . . . . . . . . 370RESOURCE LIMITS . . . . . . . . . . . . . . . . . . . . . . 371TRANSPORT PRIORITY . . . . . . . . . . . . . . . . . . . 373LIFESPAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374WRITER DATA LIFECYCLE . . . . . . . . . . . . . . . . . 375READER DATA LIFECYCLE . . . . . . . . . . . . . . . . . 376ENTITY FACTORY . . . . . . . . . . . . . . . . . . . . . . . 377Extended Qos Support . . . . . . . . . . . . . . . . . . . . . . 378

    Thread Settings . . . . . . . . . . . . . . . . . . . . . . . 328TRANSPORT SELECTION . . . . . . . . . . . . . . . . . . 382TRANSPORT UNICAST . . . . . . . . . . . . . . . . . . . . 383

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • 2.1 Modules 7

    Unicast Settings . . . . . . . . . . . . . . . . . . . . . . . 379TRANSPORT MULTICAST . . . . . . . . . . . . . . . . . . 384

    Multicast Settings . . . . . . . . . . . . . . . . . . . . . . 380Multicast Mapping . . . . . . . . . . . . . . . . . . . . . . 381

    TRANSPORT MULTICAST MAPPING . . . . . . . . . . . 386DISCOVERY . . . . . . . . . . . . . . . . . . . . . . . . . . . 387

    NDDS DISCOVERY PEERS . . . . . . . . . . . . . . . . 388TRANSPORT BUILTIN . . . . . . . . . . . . . . . . . . . . 396WIRE PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . 400DATA READER RESOURCE LIMITS . . . . . . . . . . . . 407DATA WRITER RESOURCE LIMITS . . . . . . . . . . . . 409DATA READER PROTOCOL . . . . . . . . . . . . . . . . . 413DATA WRITER PROTOCOL . . . . . . . . . . . . . . . . . 414SYSTEM RESOURCE LIMITS . . . . . . . . . . . . . . . . 415DOMAIN PARTICIPANT RESOURCE LIMITS . . . . . . . 416EVENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417DATABASE . . . . . . . . . . . . . . . . . . . . . . . . . . . 418RECEIVER POOL . . . . . . . . . . . . . . . . . . . . . . . 419PUBLISH MODE . . . . . . . . . . . . . . . . . . . . . . . . 420DISCOVERY CONFIG . . . . . . . . . . . . . . . . . . . . . 423ASYNCHRONOUS PUBLISHER . . . . . . . . . . . . . . . 428TYPESUPPORT . . . . . . . . . . . . . . . . . . . . . . . . . 429EXCLUSIVE AREA . . . . . . . . . . . . . . . . . . . . . . . 430BATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431TYPE CONSISTENCY ENFORCEMENT . . . . . . . . . . 432LOCATORFILTER . . . . . . . . . . . . . . . . . . . . . . . 434MULTICHANNEL . . . . . . . . . . . . . . . . . . . . . . . . 435PROPERTY . . . . . . . . . . . . . . . . . . . . . . . . . . . 436AVAILABILITY . . . . . . . . . . . . . . . . . . . . . . . . . 442ENTITY NAME . . . . . . . . . . . . . . . . . . . . . . . . . 445PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 446LOGGING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450

    Entity Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 443Conditions and WaitSets . . . . . . . . . . . . . . . . . . . . . 444WriteParams . . . . . . . . . . . . . . . . . . . . . . . . . . . . 447Octet Buffer Support . . . . . . . . . . . . . . . . . . . . . . . . 451Sequence Support . . . . . . . . . . . . . . . . . . . . . . . . . 455

    Built-in Sequences . . . . . . . . . . . . . . . . . . . . . . . . 120String Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 456

    Queries and Filters Syntax . . . . . . . . . . . . . . . . . . . . . . 208RTI Connext API Reference . . . . . . . . . . . . . . . . . . . . . . . . 216

    Clock Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Multi-channel DataWriters . . . . . . . . . . . . . . . . . . . . . . 122Pluggable Transports . . . . . . . . . . . . . . . . . . . . . . . . . 124

    Using Transport Plugins . . . . . . . . . . . . . . . . . . . . . . 130

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • 8 Module Index

    Built-in Transport Plugins . . . . . . . . . . . . . . . . . . . . . 136Shared Memory Transport . . . . . . . . . . . . . . . . . . . . 257UDPv4 Transport . . . . . . . . . . . . . . . . . . . . . . . . 265UDPv6 Transport . . . . . . . . . . . . . . . . . . . . . . . . 275

    Configuration Utilities . . . . . . . . . . . . . . . . . . . . . . . . . 138Unsupported Utilities . . . . . . . . . . . . . . . . . . . . . . . . . 143Durability and Persistence . . . . . . . . . . . . . . . . . . . . . . . 144System Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 150Configuring QoS Profiles with XML . . . . . . . . . . . . . . . . . 151

    Programming How-Tos . . . . . . . . . . . . . . . . . . . . . . . . . . 217Publication Example . . . . . . . . . . . . . . . . . . . . . . . . . . 154Subscription Example . . . . . . . . . . . . . . . . . . . . . . . . . 155Participant Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 156Topic Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159FlowController Use Cases . . . . . . . . . . . . . . . . . . . . . . . 161Publisher Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 165DataWriter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 166Subscriber Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 168DataReader Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 172Entity Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Waitset Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Transport Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 181Filter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186Creating Custom Content Filters . . . . . . . . . . . . . . . . . . . 191Large Data Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 195

    Programming Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219rtiddsgen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220rtiddsping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233rtiddsspy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

    Class Id . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • Chapter 3

    Class Index

    3.1 Class Hierarchy

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

    DDS AckResponseData t . . . . . . . . . . . . . . . . . . . . . . . . . 463DDS AllocationSettings t . . . . . . . . . . . . . . . . . . . . . . . . . 464DDS AsynchronousPublisherQosPolicy . . . . . . . . . . . . . . . . . . 466DDS AvailabilityQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 471DDS BatchQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 476DDS BooleanSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480DDS BuiltinTopicKey t . . . . . . . . . . . . . . . . . . . . . . . . . . 481DDS BuiltinTopicReaderResourceLimits t . . . . . . . . . . . . . . . . 482DDS ChannelSettings t . . . . . . . . . . . . . . . . . . . . . . . . . . 486DDS ChannelSettingsSeq . . . . . . . . . . . . . . . . . . . . . . . . . 489DDS CharSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490DDS ContentFilterProperty t . . . . . . . . . . . . . . . . . . . . . . . 491DDS Cookie t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493DDS CookieSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494DDS DatabaseQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 495DDS DataReaderCacheStatus . . . . . . . . . . . . . . . . . . . . . . . 500DDS DataReaderProtocolQosPolicy . . . . . . . . . . . . . . . . . . . 501DDS DataReaderProtocolStatus . . . . . . . . . . . . . . . . . . . . . 505DDS DataReaderQos . . . . . . . . . . . . . . . . . . . . . . . . . . . 515DDS DataReaderResourceLimitsQosPolicy . . . . . . . . . . . . . . . 521DDS DataWriterCacheStatus . . . . . . . . . . . . . . . . . . . . . . . 534DDS DataWriterProtocolQosPolicy . . . . . . . . . . . . . . . . . . . . 535DDS DataWriterProtocolStatus . . . . . . . . . . . . . . . . . . . . . . 540DDS DataWriterQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553DDS DataWriterResourceLimitsQosPolicy . . . . . . . . . . . . . . . . 560

  • 10 Class Index

    DDS DeadlineQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 567DDS DestinationOrderQosPolicy . . . . . . . . . . . . . . . . . . . . . 570DDS DiscoveryConfigQosPolicy . . . . . . . . . . . . . . . . . . . . . . 573DDS DiscoveryQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 582DDS DomainParticipantFactoryQos . . . . . . . . . . . . . . . . . . . 586DDS DomainParticipantQos . . . . . . . . . . . . . . . . . . . . . . . 588DDS DomainParticipantResourceLimitsQosPolicy . . . . . . . . . . . 593DDS DoubleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613DDS DurabilityQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 614DDS DurabilityServiceQosPolicy . . . . . . . . . . . . . . . . . . . . . 618DDS Duration t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621DDS DynamicData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622DDS DynamicDataInfo . . . . . . . . . . . . . . . . . . . . . . . . . . 721DDS DynamicDataMemberInfo . . . . . . . . . . . . . . . . . . . . . . 722DDS DynamicDataProperty t . . . . . . . . . . . . . . . . . . . . . . . 725DDS DynamicDataSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . 727DDS DynamicDataTypeProperty t . . . . . . . . . . . . . . . . . . . . 728DDS DynamicDataTypeSerializationProperty t . . . . . . . . . . . . . 729DDS EndpointGroup t . . . . . . . . . . . . . . . . . . . . . . . . . . . 731DDS EndpointGroupSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 732DDS EntityFactoryQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 733DDS EntityNameQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 735DDS EnumMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . 737DDS EnumMemberSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 738DDS EventQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 739DDS ExclusiveAreaQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 742DDS ExpressionProperty . . . . . . . . . . . . . . . . . . . . . . . . . 745DDS FactoryPluginSupport . . . . . . . . . . . . . . . . . . . . . . . . 746DDS FilterSampleInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . 747DDS FloatSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748DDS FlowControllerProperty t . . . . . . . . . . . . . . . . . . . . . . 749DDS FlowControllerTokenBucketProperty t . . . . . . . . . . . . . . . 751DDS GroupDataQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 755DDS GUID t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757DDS HistoryQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 758DDS InconsistentTopicStatus . . . . . . . . . . . . . . . . . . . . . . . 762DDS InstanceHandleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 764DDS KeyedOctets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765DDS KeyedOctetsSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . 767DDS KeyedString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 768DDS KeyedStringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . 770DDS LatencyBudgetQosPolicy . . . . . . . . . . . . . . . . . . . . . . 771DDS LifespanQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 773DDS LivelinessChangedStatus . . . . . . . . . . . . . . . . . . . . . . 775DDS LivelinessLostStatus . . . . . . . . . . . . . . . . . . . . . . . . . 777DDS LivelinessQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 779

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • 3.1 Class Hierarchy 11

    DDS Locator t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783DDS LocatorFilter t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785DDS LocatorFilterQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 787DDS LocatorFilterSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . 789DDS LocatorSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790DDS LoggingQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 791DDS LongDoubleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793DDS LongLongSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794DDS LongSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795DDS MultiChannelQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 796DDS Octets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799DDS OctetSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801DDS OctetsSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802DDS OfferedDeadlineMissedStatus . . . . . . . . . . . . . . . . . . . . 803DDS OfferedIncompatibleQosStatus . . . . . . . . . . . . . . . . . . . 805DDS OwnershipQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 807DDS OwnershipStrengthQosPolicy . . . . . . . . . . . . . . . . . . . . 814DDS ParticipantBuiltinTopicData . . . . . . . . . . . . . . . . . . . . 816DDS ParticipantBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . 819DDS PartitionQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 820DDS PresentationQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 823DDS ProductVersion t . . . . . . . . . . . . . . . . . . . . . . . . . . . 828DDS ProfileQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 830DDS Property t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833DDS PropertyQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 834DDS PropertySeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837DDS ProtocolVersion t . . . . . . . . . . . . . . . . . . . . . . . . . . 838DDS PublicationBuiltinTopicData . . . . . . . . . . . . . . . . . . . . 839DDS PublicationBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . 847DDS PublicationMatchedStatus . . . . . . . . . . . . . . . . . . . . . 848DDS PublisherQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 851DDS PublishModeQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 853DDS QosPolicyCount . . . . . . . . . . . . . . . . . . . . . . . . . . . 857DDS QosPolicyCountSeq . . . . . . . . . . . . . . . . . . . . . . . . . 858DDS ReaderDataLifecycleQosPolicy . . . . . . . . . . . . . . . . . . . 859DDS ReceiverPoolQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 862DDS ReliabilityQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 865DDS ReliableReaderActivityChangedStatus . . . . . . . . . . . . . . . 869DDS ReliableWriterCacheChangedStatus . . . . . . . . . . . . . . . . 871DDS ReliableWriterCacheEventCount . . . . . . . . . . . . . . . . . . 874DDS RequestedDeadlineMissedStatus . . . . . . . . . . . . . . . . . . 875DDS RequestedIncompatibleQosStatus . . . . . . . . . . . . . . . . . . 877DDS ResourceLimitsQosPolicy . . . . . . . . . . . . . . . . . . . . . . 879DDS RtpsReliableReaderProtocol t . . . . . . . . . . . . . . . . . . . . 884DDS RtpsReliableWriterProtocol t . . . . . . . . . . . . . . . . . . . . 889DDS RtpsWellKnownPorts t . . . . . . . . . . . . . . . . . . . . . . . 905

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • 12 Class Index

    DDS SampleIdentity t . . . . . . . . . . . . . . . . . . . . . . . . . . . 911DDS SampleInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912DDS SampleInfoSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . 922DDS SampleLostStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 923DDS SampleRejectedStatus . . . . . . . . . . . . . . . . . . . . . . . . 925DDS SequenceNumber t . . . . . . . . . . . . . . . . . . . . . . . . . . 927DDS ShortSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928DDS StringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929DDS StructMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931DDS StructMemberSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 933DDS SubscriberQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934DDS SubscriptionBuiltinTopicData . . . . . . . . . . . . . . . . . . . . 936DDS SubscriptionBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . 944DDS SubscriptionMatchedStatus . . . . . . . . . . . . . . . . . . . . . 945DDS SystemResourceLimitsQosPolicy . . . . . . . . . . . . . . . . . . 948DDS ThreadSettings t . . . . . . . . . . . . . . . . . . . . . . . . . . . 950DDS Time t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 953DDS TimeBasedFilterQosPolicy . . . . . . . . . . . . . . . . . . . . . 954DDS TopicBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . 958DDS TopicBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . . 962DDS TopicDataQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 963DDS TopicQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965DDS TransportBuiltinQosPolicy . . . . . . . . . . . . . . . . . . . . . 969DDS TransportMulticastMapping t . . . . . . . . . . . . . . . . . . . . 971DDS TransportMulticastMappingFunction t . . . . . . . . . . . . . . . 973DDS TransportMulticastMappingQosPolicy . . . . . . . . . . . . . . . 975DDS TransportMulticastMappingSeq . . . . . . . . . . . . . . . . . . . 977DDS TransportMulticastQosPolicy . . . . . . . . . . . . . . . . . . . . 978DDS TransportMulticastSettings t . . . . . . . . . . . . . . . . . . . . 980DDS TransportMulticastSettingsSeq . . . . . . . . . . . . . . . . . . . 982DDS TransportPriorityQosPolicy . . . . . . . . . . . . . . . . . . . . . 983DDS TransportSelectionQosPolicy . . . . . . . . . . . . . . . . . . . . 985DDS TransportUnicastQosPolicy . . . . . . . . . . . . . . . . . . . . . 987DDS TransportUnicastSettings t . . . . . . . . . . . . . . . . . . . . . 989DDS TransportUnicastSettingsSeq . . . . . . . . . . . . . . . . . . . . 991DDS TypeCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992DDS TypeCodeFactory . . . . . . . . . . . . . . . . . . . . . . . . . . 1022DDS TypeConsistencyEnforcementQosPolicy . . . . . . . . . . . . . . 1038DDS TypeSupportQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 1040DDS UnionMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1042DDS UnionMemberSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1044DDS UnsignedLongLongSeq . . . . . . . . . . . . . . . . . . . . . . . . 1045DDS UnsignedLongSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1046DDS UnsignedShortSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1047DDS UserDataQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 1048DDS ValueMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1050

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • 3.1 Class Hierarchy 13

    DDS ValueMemberSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . 1052DDS VendorId t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1053DDS VirtualSubscriptionBuiltinTopicData . . . . . . . . . . . . . . . . 1054DDS VirtualSubscriptionBuiltinTopicDataSeq . . . . . . . . . . . . . . 1055DDS WaitSetProperty t . . . . . . . . . . . . . . . . . . . . . . . . . . 1056DDS WcharSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1058DDS WireProtocolQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 1059DDS WriteParams t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1067DDS WriterDataLifecycleQosPolicy . . . . . . . . . . . . . . . . . . . 1071DDS WstringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1074DDSCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1075

    DDSGuardCondition . . . . . . . . . . . . . . . . . . . . . . . . . . 1263DDSReadCondition . . . . . . . . . . . . . . . . . . . . . . . . . . 1374

    DDSQueryCondition . . . . . . . . . . . . . . . . . . . . . . . . 1372DDSStatusCondition . . . . . . . . . . . . . . . . . . . . . . . . . . 1376

    DDSConditionSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1076DDSContentFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1077

    DDSWriterContentFilter . . . . . . . . . . . . . . . . . . . . . . . . 1441DDSDataReaderSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1112DDSDomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . . 1216DDSEntity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1253

    DDSDomainEntity . . . . . . . . . . . . . . . . . . . . . . . . . . . 1138DDSDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . 1087

    DDSDynamicDataReader . . . . . . . . . . . . . . . . . . . . 1245DDSDynamicDataReader . . . . . . . . . . . . . . . . . . . . 1245DDSKeyedOctetsDataReader . . . . . . . . . . . . . . . . . . 1265DDSKeyedStringDataReader . . . . . . . . . . . . . . . . . . 1293DDSOctetsDataReader . . . . . . . . . . . . . . . . . . . . . 1326DDSParticipantBuiltinTopicDataDataReader . . . . . . . . . 1341DDSPublicationBuiltinTopicDataDataReader . . . . . . . . . 1344DDSStringDataReader . . . . . . . . . . . . . . . . . . . . . . 1379DDSSubscriptionBuiltinTopicDataDataReader . . . . . . . . 1417DDSTopicBuiltinTopicDataDataReader . . . . . . . . . . . . 1425FooDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . 1444

    DDSDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . 1113DDSDynamicDataWriter . . . . . . . . . . . . . . . . . . . . 1252DDSDynamicDataWriter . . . . . . . . . . . . . . . . . . . . 1252DDSKeyedOctetsDataWriter . . . . . . . . . . . . . . . . . . 1276DDSKeyedStringDataWriter . . . . . . . . . . . . . . . . . . 1304DDSOctetsDataWriter . . . . . . . . . . . . . . . . . . . . . . 1331DDSStringDataWriter . . . . . . . . . . . . . . . . . . . . . . 1383FooDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . 1475

    DDSPublisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1346DDSSubscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . 1390DDSTopic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1419

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • 14 Class Index

    DDSDomainParticipant . . . . . . . . . . . . . . . . . . . . . . . . 1139DDSFlowController . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259DDSListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1318

    DDSDataReaderListener . . . . . . . . . . . . . . . . . . . . . . . . 1108DDSSubscriberListener . . . . . . . . . . . . . . . . . . . . . . 1414

    DDSDomainParticipantListener . . . . . . . . . . . . . . . . . 1243DDSDataWriterListener . . . . . . . . . . . . . . . . . . . . . . . . 1133

    DDSPublisherListener . . . . . . . . . . . . . . . . . . . . . . . 1370DDSDomainParticipantListener . . . . . . . . . . . . . . . . . 1243

    DDSTopicListener . . . . . . . . . . . . . . . . . . . . . . . . . . . 1430DDSDomainParticipantListener . . . . . . . . . . . . . . . . . . 1243

    DDSParticipantBuiltinTopicDataTypeSupport . . . . . . . . . . . . . 1342DDSPropertyQosPolicyHelper . . . . . . . . . . . . . . . . . . . . . . . 1343DDSPublicationBuiltinTopicDataTypeSupport . . . . . . . . . . . . . 1345DDSPublisherSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1371DDSSubscriberSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1416DDSSubscriptionBuiltinTopicDataTypeSupport . . . . . . . . . . . . . 1418DDSTopicBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . . . 1426DDSTopicDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . 1427

    DDSContentFilteredTopic . . . . . . . . . . . . . . . . . . . . . . . 1081DDSMultiTopic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1322DDSTopic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1419

    DDSTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1432DDSDynamicDataTypeSupport . . . . . . . . . . . . . . . . . . . . 1246DDSKeyedOctetsTypeSupport . . . . . . . . . . . . . . . . . . . . 1289DDSKeyedStringTypeSupport . . . . . . . . . . . . . . . . . . . . 1314DDSOctetsTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . 1337DDSStringTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . 1386FooTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1509

    DDSWaitSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1433Foo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1443FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1494NDDS Config LibraryVersion t . . . . . . . . . . . . . . . . . . . . . . 1518NDDS Config LogMessage . . . . . . . . . . . . . . . . . . . . . . . . . 1520NDDS Transport Address t . . . . . . . . . . . . . . . . . . . . . . . . 1521NDDS Transport Property t . . . . . . . . . . . . . . . . . . . . . . . 1522NDDS Transport Shmem Property t . . . . . . . . . . . . . . . . . . . 1530NDDS Transport UDPv4 Property t . . . . . . . . . . . . . . . . . . . 1533NDDS Transport UDPv6 Property t . . . . . . . . . . . . . . . . . . . 1542NDDSConfigLogger . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550NDDSConfigLoggerDevice . . . . . . . . . . . . . . . . . . . . . . . . . 1555NDDSConfigVersion . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1557NDDSTransportSupport . . . . . . . . . . . . . . . . . . . . . . . . . . 1559NDDSUtility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1567TransportAllocationSettings t . . . . . . . . . . . . . . . . . . . . . . . 1568

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • Chapter 4

    Class Index

    4.1 Class List

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

    DDS AckResponseData t (Data payload of an application-level ac-knowledgment ) . . . . . . . . . . . . . . . . . . . . . . . . . . 463

    DDS AllocationSettings t (Resource allocation settings ) . . . . . 464DDS AsynchronousPublisherQosPolicy (Configures the mecha-

    nism that sends user data in an external middleware thread) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466

    DDS AvailabilityQosPolicy (Configures the availability of data ) . 471DDS BatchQosPolicy (Used to configure batching of multiple sam-

    ples into a single network packet in order to increase through-put for small samples ) . . . . . . . . . . . . . . . . . . . . . . 476

    DDS BooleanSeq (Instantiates FooSeq (p. 1494) < DDS Boolean(p. 301) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

    DDS BuiltinTopicKey t (The key type of the built-in topic types ) 481DDS BuiltinTopicReaderResourceLimits t (Built-in topic

    readers resource limits ) . . . . . . . . . . . . . . . . . . . . . 482DDS ChannelSettings t (Type used to configure the properties of

    a channel ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486DDS ChannelSettingsSeq (Declares IDL sequence< DDS -

    ChannelSettings t (p. 486) > ) . . . . . . . . . . . . . . . . 489DDS CharSeq (Instantiates FooSeq (p. 1494) < DDS Char

    (p. 299) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490DDS ContentFilterProperty t ( (p. 199) Type

    used to provide all the required information to enable contentfiltering ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 491

  • 16 Class Index

    DDS Cookie t ( (p. 199) Sequence of bytes iden-tifying a written data sample, used when writing with param-eters ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493

    DDS CookieSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494DDS DatabaseQosPolicy (Various threads and resource limits set-

    tings used by RTI Connext to control its internal database) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

    DDS DataReaderCacheStatus ( (p. 199) Thestatus of the readers cache ) . . . . . . . . . . . . . . . . . . 500

    DDS DataReaderProtocolQosPolicy (Along with DDS -WireProtocolQosPolicy (p. 1059) and DDS -DataWriterProtocolQosPolicy (p. 535), this QoS policyconfigures the DDS on-the-network protocol (RTPS) ) . . . . 501

    DDS DataReaderProtocolStatus ( (p. 199)The status of a readers internal protocol related metrics, likethe number of samples received, filtered, rejected; and statusof wire protocol traffic ) . . . . . . . . . . . . . . . . . . . . . 505

    DDS DataReaderQos (QoS policies supported by a DDS-DataReader (p. 1087) entity ) . . . . . . . . . . . . . . . . . 515

    DDS DataReaderResourceLimitsQosPolicy (Various settingsthat configure how a DDSDataReader (p. 1087) allocatesand uses physical memory for internal resources ) . . . . . . . 521

    DDS DataWriterCacheStatus ( (p. 199) Thestatus of the writers cache ) . . . . . . . . . . . . . . . . . . . 534

    DDS DataWriterProtocolQosPolicy (Protocol that applies onlyto DDSDataWriter (p. 1113) instances ) . . . . . . . . . . . 535

    DDS DataWriterProtocolStatus ( (p. 199)The status of a writers internal protocol related metrics, likethe number of samples pushed, pulled, filtered; and status ofwire protocol traffic ) . . . . . . . . . . . . . . . . . . . . . . . 540

    DDS DataWriterQos (QoS policies supported by a DDS-DataWriter (p. 1113) entity ) . . . . . . . . . . . . . . . . . 553

    DDS DataWriterResourceLimitsQosPolicy (Various settingsthat configure how a DDSDataWriter (p. 1113) allocatesand uses physical memory for internal resources ) . . . . . . . 560

    DDS DeadlineQosPolicy (Expresses the maximum duration (dead-line) within which an instance is expected to be updated ) . . 567

    DDS DestinationOrderQosPolicy (Controls how the middlewarewill deal with data sent by multiple DDSDataWriter(p. 1113) entities for the same instance of data (i.e., sameDDSTopic (p. 1419) and key) ) . . . . . . . . . . . . . . . . 570

    DDS DiscoveryConfigQosPolicy (Settings for discovery configura-tion ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573

    DDS DiscoveryQosPolicy (Configures the mechanism used by themiddleware to automatically discover and connect with newremote applications ) . . . . . . . . . . . . . . . . . . . . . . . 582

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • 4.1 Class List 17

    DDS DomainParticipantFactoryQos (QoS policies supported bya DDSDomainParticipantFactory (p. 1216) ) . . . . . . . 586

    DDS DomainParticipantQos (QoS policies supported by a DDS-DomainParticipant (p. 1139) entity ) . . . . . . . . . . . . 588

    DDS DomainParticipantResourceLimitsQosPolicy (Varioussettings that configure how a DDSDomainParticipant(p. 1139) allocates and uses physical memory for internalresources, including the maximum sizes of various properties ) 593

    DDS DoubleSeq (Instantiates FooSeq (p. 1494) < DDS Double(p. 300) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613

    DDS DurabilityQosPolicy (This QoS policy specifies whether ornot RTI Connext will store and deliver previously publisheddata samples to new DDSDataReader (p. 1087) entities thatjoin the network later ) . . . . . . . . . . . . . . . . . . . . . 614

    DDS DurabilityServiceQosPolicy (Various settings to configurethe external RTI Persistence Service used by RTI Connextfor DataWriters with a DDS DurabilityQosPolicy (p. 614)setting of DDS PERSISTENT DURABILITY QOS(p. 349) or DDS TRANSIENT DURABILITY QOS(p. 349) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618

    DDS Duration t (Type for duration representation ) . . . . . . . . . 621DDS DynamicData (A sample of any complex data type, which can

    be inspected and manipulated reflectively ) . . . . . . . . . . 622DDS DynamicDataInfo (A descriptor for a DDS DynamicData

    (p. 622) object ) . . . . . . . . . . . . . . . . . . . . . . . . . . 721DDS DynamicDataMemberInfo (A descriptor for a single member

    (i.e. field) of dynamically defined data type ) . . . . . . . . . 722DDS DynamicDataProperty t (A collection of attributes used to

    configure DDS DynamicData (p. 622) objects ) . . . . . . . 725DDS DynamicDataSeq (An ordered collection of DDS -

    DynamicData (p. 622) elements ) . . . . . . . . . . . . . . . 727DDS DynamicDataTypeProperty t (A collection of attributes

    used to configure DDSDynamicDataTypeSupport(p. 1246) objects ) . . . . . . . . . . . . . . . . . . . . . . . . 728

    DDS DynamicDataTypeSerializationProperty t (Propertiesthat govern how data of a certain type will be serialized onthe network ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 729

    DDS EndpointGroup t (Specifies a group of endpoints that can becollectively identified by a name and satisfied by a quorum ) . 731

    DDS EndpointGroupSeq (A sequence of DDS -EndpointGroup t (p. 731) ) . . . . . . . . . . . . . . . . . . 732

    DDS EntityFactoryQosPolicy (A QoS policy for all DDSEntity(p. 1253) types that can act as factories for one or more otherDDSEntity (p. 1253) types ) . . . . . . . . . . . . . . . . . . 733

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • 18 Class Index

    DDS EntityNameQosPolicy (Assigns a name and a role nameto a DDSDomainParticipant (p. 1139), DDSDataWriter(p. 1113) or DDSDataReader (p. 1087). These names willbe visible during the discovery process and in RTI tools tohelp you visualize and debug your system ) . . . . . . . . . . 735

    DDS EnumMember (A description of a member of an enumeration ) 737DDS EnumMemberSeq (Defines a sequence of enumerator mem-

    bers ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 738DDS EventQosPolicy (Settings for event ) . . . . . . . . . . . . . . 739DDS ExclusiveAreaQosPolicy (Configures multi-thread concur-

    rency and deadlock prevention capabilities ) . . . . . . . . . . 742DDS ExpressionProperty . . . . . . . . . . . . . . . . . . . . . . . 745DDS FactoryPluginSupport (Interface for creating and manipulat-

    ing DDS entities ) . . . . . . . . . . . . . . . . . . . . . . . . 746DDS FilterSampleInfo . . . . . . . . . . . . . . . . . . . . . . . . . 747DDS FloatSeq (Instantiates FooSeq (p. 1494) < DDS Float

    (p. 300) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 748DDS FlowControllerProperty t (Determines the flow control

    characteristics of the DDSFlowController (p. 1259) ) . . . 749DDS FlowControllerTokenBucketProperty t

    (DDSFlowController (p. 1259) uses the popular tokenbucket approach for open loop network flow control. The flowcontrol characteristics are determined by the token bucketproperties ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751

    DDS GroupDataQosPolicy (Attaches a buffer of opaque data thatis distributed by means of Built-in Topics (p. 42) duringdiscovery ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 755

    DDS GUID t (Type for GUID (Global Unique Identifier) represen-tation ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 757

    DDS HistoryQosPolicy (Specifies the behavior of RTI Connext inthe case where the value of a sample changes (one or moretimes) before it can be successfully communicated to one ormore existing subscribers ) . . . . . . . . . . . . . . . . . . . . 758

    DDS InconsistentTopicStatus (DDS INCONSISTENT -TOPIC STATUS (p. 322) ) . . . . . . . . . . . . . . . . . . 762

    DDS InstanceHandleSeq (Instantiates FooSeq (p. 1494) ) . . . . . . . . . . . . . . 764

    DDS KeyedOctets (Built-in type consisting of a variable-length ar-ray of opaque bytes and a string that is the key ) . . . . . . . 765

    DDS KeyedOctetsSeq (Instantiates FooSeq (p. 1494) < DDS -KeyedOctets (p. 765) > ) . . . . . . . . . . . . . . . . . . . 767

    DDS KeyedString (Keyed string built-in type ) . . . . . . . . . . . 768DDS KeyedStringSeq (Instantiates FooSeq (p. 1494) < DDS -

    KeyedString (p. 768) > ) . . . . . . . . . . . . . . . . . . . . 770

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • 4.1 Class List 19

    DDS LatencyBudgetQosPolicy (Provides a hint as to the maxi-mum acceptable delay from the time the data is written tothe time it is received by the subscribing applications ) . . . . 771

    DDS LifespanQosPolicy (Specifies how long the data written by theDDSDataWriter (p. 1113) is considered valid ) . . . . . . . 773

    DDS LivelinessChangedStatus (DDS LIVELINESS -CHANGED STATUS (p. 325) ) . . . . . . . . . . . . . . . 775

    DDS LivelinessLostStatus (DDS LIVELINESS LOST -STATUS (p. 325) ) . . . . . . . . . . . . . . . . . . . . . . . 777

    DDS LivelinessQosPolicy (Specifies and configures the mechanismthat allows DDSDataReader (p. 1087) entities to detectwhen DDSDataWriter (p. 1113) entities become discon-nected or dead. ) . . . . . . . . . . . . . . . . . . . . . . . . 779

    DDS Locator t ( (p. 199) Type used to representthe addressing information needed to send a message to anRTPS Endpoint using one of the supported transports ) . . . 783

    DDS LocatorFilter t (Specifies the configuration of an individualchannel within a MultiChannel DataWriter ) . . . . . . . . . 785

    DDS LocatorFilterQosPolicy (The QoS policy used to report theconfiguration of a MultiChannel DataWriter as part of DDS -PublicationBuiltinTopicData (p. 839) ) . . . . . . . . . . 787

    DDS LocatorFilterSeq (Declares IDL sequence< DDS -LocatorFilter t (p. 785) > ) . . . . . . . . . . . . . . . . . . 789

    DDS LocatorSeq (Declares IDL sequence < DDS Locator t(p. 783) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790

    DDS LoggingQosPolicy (Configures the RTI Connext logging facil-ity ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 791

    DDS LongDoubleSeq (Instantiates FooSeq (p. 1494) < DDS -LongDouble (p. 300) > ) . . . . . . . . . . . . . . . . . . . . 793

    DDS LongLongSeq (Instantiates FooSeq (p. 1494) < DDS -LongLong (p. 300) > ) . . . . . . . . . . . . . . . . . . . . . 794

    DDS LongSeq (Instantiates FooSeq (p. 1494) < DDS Long(p. 300) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795

    DDS MultiChannelQosPolicy (Configures the ability of aDataWriter to send data on different multicast groups (ad-dresses) based on the value of the data ) . . . . . . . . . . . . 796

    DDS Octets (Built-in type consisting of a variable-length array ofopaque bytes ) . . . . . . . . . . . . . . . . . . . . . . . . . . 799

    DDS OctetSeq (Instantiates FooSeq (p. 1494) < DDS Octet(p. 299) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801

    DDS OctetsSeq (Instantiates FooSeq (p. 1494) < DDS Octets(p. 799) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802

    DDS OfferedDeadlineMissedStatus (DDS OFFERED -DEADLINE MISSED STATUS (p. 323) ) . . . . . . . . . 803

    DDS OfferedIncompatibleQosStatus (DDS OFFERED -INCOMPATIBLE QOS STATUS (p. 323) ) . . . . . . . . 805

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • 20 Class Index

    DDS OwnershipQosPolicy (Specifies whether it is allowed for mul-tiple DDSDataWriter (p. 1113) (s) to write the same in-stance of the data and if so, how these modifications shouldbe arbitrated ) . . . . . . . . . . . . . . . . . . . . . . . . . . 807

    DDS OwnershipStrengthQosPolicy (Specifies the value of thestrength used to arbitrate among multiple DDSDataWriter(p. 1113) objects that attempt to modify the same instance ofa data type (identified by DDSTopic (p. 1419) + key) ) . . . 814

    DDS ParticipantBuiltinTopicData (Entry created when a Do-mainParticipant object is discovered ) . . . . . . . . . . . . . 816

    DDS ParticipantBuiltinTopicDataSeq (Instantiates FooSeq(p. 1494) < DDS ParticipantBuiltinTopicData (p. 816)> ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819

    DDS PartitionQosPolicy (Set of strings that introduces a logi-cal partition among the topics visible by a DDSPublisher(p. 1346) and a DDSSubscriber (p. 1390) ) . . . . . . . . . . 820

    DDS PresentationQosPolicy (Specifies how the samples represent-ing changes to data instances are presented to a subscribingapplication ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 823

    DDS ProductVersion t ( (p. 199) Type used torepresent the current version of RTI Connext ) . . . . . . . . 828

    DDS ProfileQosPolicy (Configures the way that XML documentscontaining QoS profiles are loaded by RTI Connext ) . . . . . 830

    DDS Property t (Properties are name/value pairs objects ) . . . . . 833DDS PropertyQosPolicy (Stores name/value(string) pairs that can

    be used to configure certain parameters of RTI Connext thatare not exposed through formal QoS policies. Can also beused to store and propagate application-specific name/valuepairs that can be retrieved by user code during discovery ) . . 834

    DDS PropertySeq (Declares IDL sequence < DDS Property t(p. 833) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837

    DDS ProtocolVersion t ( (p. 199) Type used torepresent the version of the RTPS protocol ) . . . . . . . . . 838

    DDS PublicationBuiltinTopicData (Entry created when a DDS-DataWriter (p. 1113) is discovered in association with itsPublisher ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839

    DDS PublicationBuiltinTopicDataSeq (Instantiates FooSeq(p. 1494) < DDS PublicationBuiltinTopicData (p. 839)> ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 847

    DDS PublicationMatchedStatus (DDS PUBLICATION -MATCHED STATUS (p. 325) ) . . . . . . . . . . . . . . . 848

    DDS PublisherQos (QoS policies supported by a DDSPublisher(p. 1346) entity ) . . . . . . . . . . . . . . . . . . . . . . . . . 851

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • 4.1 Class List 21

    DDS PublishModeQosPolicy (Specifies how RTI Connext sendsapplication data on the network. This QoS policy can beused to tell RTI Connext to use its own thread to send data,instead of the user thread ) . . . . . . . . . . . . . . . . . . . 853

    DDS QosPolicyCount (Type to hold a counter for a DDS -QosPolicyId t (p. 341) ) . . . . . . . . . . . . . . . . . . . . 857

    DDS QosPolicyCountSeq (Declares IDL sequence < DDS -QosPolicyCount (p. 857) > ) . . . . . . . . . . . . . . . . . 858

    DDS ReaderDataLifecycleQosPolicy (Controls how aDataReader manages the lifecycle of the data that ithas received ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 859

    DDS ReceiverPoolQosPolicy (Configures threads used by RTIConnext to receive and process data from transports (for ex-ample, UDP sockets) ) . . . . . . . . . . . . . . . . . . . . . . 862

    DDS ReliabilityQosPolicy (Indicates the level of reliability of-fered/requested by RTI Connext ) . . . . . . . . . . . . . . . 865

    DDS ReliableReaderActivityChangedStatus( (p. 199) Describes the activity (i.e.are acknowledgements forthcoming) of reliable readersmatched to a reliable writer ) . . . . . . . . . . . . . . . . . . 869

    DDS ReliableWriterCacheChangedStatus ((p. 199) A summary of the state of a data writers cache ofunacknowledged samples written ) . . . . . . . . . . . . . . . 871

    DDS ReliableWriterCacheEventCount ((p. 199) The number of times the number of unacknowl-edged samples in the cache of a reliable writer hit a certainwell-defined threshold ) . . . . . . . . . . . . . . . . . . . . . 874

    DDS RequestedDeadlineMissedStatus (DDS -REQUESTED DEADLINE MISSED STATUS(p. 323) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 875

    DDS RequestedIncompatibleQosStatus (DDS -REQUESTED INCOMPATIBLE QOS STATUS(p. 323) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877

    DDS ResourceLimitsQosPolicy (Controls the amount of physicalmemory allocated for DDS entities, if dynamic allocations areallowed, and how they occur. Also controls memory usageamong different instance values for keyed topics ) . . . . . . . 879

    DDS RtpsReliableReaderProtocol t (Qos related to reliablereader protocol defined in RTPS ) . . . . . . . . . . . . . . . 884

    DDS RtpsReliableWriterProtocol t (QoS related to the reliablewriter protocol defined in RTPS ) . . . . . . . . . . . . . . . . 889

    DDS RtpsWellKnownPorts t (RTPS well-known port mappingconfiguration ) . . . . . . . . . . . . . . . . . . . . . . . . . . 905

    DDS SampleIdentity t (Type definition for an Sample Identity ) . 911DDS SampleInfo (Information that accompanies each sample that

    is read or taken ) . . . . . . . . . . . . . . . . . . . . . . . . 912

    Generated on Mon Aug 13 09:00:30 2012 for RTI Connext C++ API by Doxygen

  • 22 Class Index

    DDS SampleInfoSeq (Declares IDL sequence < DDS -SampleInfo (p. 912) > ) . . . . . . . . . . . . . . . . . . . . 922

    DDS SampleLostStatus (DDS SAMPLE LOST STATUS(p. 324) ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923

    DDS SampleRejectedStatus (DDS SAMPLE REJECTED -STATUS (p. 324) ) . . . . . . . . . . . . . . . . . . . . . . . 925

    DDS SequenceNumber t (Type for sequence number representa-tion ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927

    DDS ShortSeq (Instantiates FooSeq (p. 1494) < DDS Short(p. 299) > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928

    DDS StringSeq