C++ API Reference Manual

1628 Pages·2012·8.74 MB·English

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-To’s . . . . . . . . . . . . . . . . . . . . . . . 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