NET API Reference Manual

1583 Pages·2012·8.16 MB·English

RTI Connext .Net APIs
Version 5.0.0
Generated by Doxygen 1.5.5
Mon Aug 13 09:03:22 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 19
4.1 Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
5 Module Documentation 35
5.1 Clock Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
5.2 Domain Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
5.3 DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . . 39
5.4 DomainParticipants . . . . . . . . . . . . . . . . . . . . . . . . . 41
5.5 Built-in Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
5.6 Topic Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
5.7 Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
5.8 User Data Type Support . . . . . . . . . . . . . . . . . . . . . . . 56
5.9 Type Code Support . . . . . . . . . . . . . . . . . . . . . . . . . 59
5.10 Built-in Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
ii CONTENTS
5.11 Dynamic Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
5.12 Publication Module. . . . . . . . . . . . . . . . . . . . . . . . . . 83
5.13 Publishers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
5.14 Data Writers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
5.15 Flow Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
5.16 Subscription Module . . . . . . . . . . . . . . . . . . . . . . . . . 96
5.17 Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
5.18 DataReaders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
5.19 Read Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
5.20 Query Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
5.21 Data Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
5.22 Sample States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
5.23 View States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
5.24 Instance States . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
5.25 Infrastructure Module . . . . . . . . . . . . . . . . . . . . . . . . 115
5.26 Built-in Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . 117
5.27 Multi-channel DataWriters . . . . . . . . . . . . . . . . . . . . . 119
5.28 Pluggable Transports . . . . . . . . . . . . . . . . . . . . . . . . . 121
5.29 Using Transport Plugins . . . . . . . . . . . . . . . . . . . . . . . 127
5.30 Built-in Transport Plugins . . . . . . . . . . . . . . . . . . . . . . 130
5.31 Configuration Utilities . . . . . . . . . . . . . . . . . . . . . . . . 132
5.32 Unsupported Utilities . . . . . . . . . . . . . . . . . . . . . . . . 137
5.33 Durability and Persistence . . . . . . . . . . . . . . . . . . . . . . 138
5.34 System Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 144
5.35 Configuring QoS Profiles with XML . . . . . . . . . . . . . . . . 145
5.36 Publication Example . . . . . . . . . . . . . . . . . . . . . . . . . 148
5.37 Subscription Example . . . . . . . . . . . . . . . . . . . . . . . . 149
5.38 Participant Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 150
5.39 Topic Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
5.40 FlowController Use Cases . . . . . . . . . . . . . . . . . . . . . . 155
5.41 Publisher Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 159
Generated on Mon Aug 13 09:03:22 2012 for RTI Connext .Net APIs by Doxygen
CONTENTS iii
5.42 DataWriter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 160
5.43 Subscriber Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 162
5.44 DataReader Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 165
5.45 Entity Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
5.46 Waitset Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 173
5.47 Transport Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 175
5.48 Filter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
5.49 Large Data Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 181
5.50 Documentation Roadmap . . . . . . . . . . . . . . . . . . . . . . 183
5.51 Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
5.52 .Net Language Support . . . . . . . . . . . . . . . . . . . . . . . 187
5.53 DDS API Reference . . . . . . . . . . . . . . . . . . . . . . . . . 189
5.54 Queries and Filters Syntax. . . . . . . . . . . . . . . . . . . . . . 194
5.55 RTI Connext API Reference . . . . . . . . . . . . . . . . . . . . . 202
5.56 Programming How-To’s . . . . . . . . . . . . . . . . . . . . . . . 203
5.57 Programming Tools. . . . . . . . . . . . . . . . . . . . . . . . . . 205
5.58 rtiddsgen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
5.59 rtiddsping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
5.60 rtiddsspy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
5.61 Octets Built-in Type . . . . . . . . . . . . . . . . . . . . . . . . . 233
5.62 KeyedOctets Built-in Type . . . . . . . . . . . . . . . . . . . . . 234
5.63 KeyedString Built-in Type . . . . . . . . . . . . . . . . . . . . . . 235
5.64 String Built-in Type . . . . . . . . . . . . . . . . . . . . . . . . . 236
5.65 Participant Built-in Topics . . . . . . . . . . . . . . . . . . . . . 237
5.66 Topic Built-in Topics . . . . . . . . . . . . . . . . . . . . . . . . . 239
5.67 Publication Built-in Topics . . . . . . . . . . . . . . . . . . . . . 241
5.68 Subscription Built-in Topics . . . . . . . . . . . . . . . . . . . . . 243
5.69 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
5.70 Status Kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
5.71 Exception Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
5.72 Time Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Generated on Mon Aug 13 09:03:22 2012 for RTI Connext .Net APIs by Doxygen
iv CONTENTS
5.73 GUID Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
5.74 Sequence Number Support . . . . . . . . . . . . . . . . . . . . . . 268
5.75 Thread Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
5.76 QoS Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
5.77 USER DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
5.78 TOPIC DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
5.79 GROUP DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
5.80 DURABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
5.81 PRESENTATION . . . . . . . . . . . . . . . . . . . . . . . . . . 292
5.82 DEADLINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
5.83 LATENCY BUDGET . . . . . . . . . . . . . . . . . . . . . . . . 295
5.84 OWNERSHIP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
5.85 OWNERSHIP STRENGTH . . . . . . . . . . . . . . . . . . . . . 298
5.86 LIVELINESS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
5.87 TIME BASED FILTER . . . . . . . . . . . . . . . . . . . . . . . 302
5.88 PARTITION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
5.89 RELIABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
5.90 DESTINATION ORDER . . . . . . . . . . . . . . . . . . . . . . 306
5.91 HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
5.92 DURABILITY SERVICE . . . . . . . . . . . . . . . . . . . . . . 311
5.93 RESOURCE LIMITS . . . . . . . . . . . . . . . . . . . . . . . . 312
5.94 TRANSPORT PRIORITY . . . . . . . . . . . . . . . . . . . . . 314
5.95 LIFESPAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
5.96 WRITER DATA LIFECYCLE . . . . . . . . . . . . . . . . . . . 316
5.97 READER DATA LIFECYCLE . . . . . . . . . . . . . . . . . . . 317
5.98 ENTITY FACTORY . . . . . . . . . . . . . . . . . . . . . . . . . 318
5.99 Extended Qos Support . . . . . . . . . . . . . . . . . . . . . . . . 319
5.100Unicast Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
5.101Multicast Settings . . . . . . . . . . . . . . . . . . . . . . . . . . 321
5.102Multicast Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . 322
5.103TRANSPORT SELECTION . . . . . . . . . . . . . . . . . . . . 323
Generated on Mon Aug 13 09:03:22 2012 for RTI Connext .Net APIs by Doxygen
CONTENTS v
5.104TRANSPORT UNICAST . . . . . . . . . . . . . . . . . . . . . . 324
5.105TRANSPORT MULTICAST . . . . . . . . . . . . . . . . . . . . 325
5.106TRANSPORT MULTICAST MAPPING . . . . . . . . . . . . . 327
5.107NDDS DISCOVERY PEERS . . . . . . . . . . . . . . . . . . . . 328
5.108DISCOVERY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
5.109TRANSPORT BUILTIN . . . . . . . . . . . . . . . . . . . . . . . 337
5.110WIRE PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . . . 341
5.111DATA READER RESOURCE LIMITS . . . . . . . . . . . . . . 347
5.112DATA WRITER RESOURCE LIMITS . . . . . . . . . . . . . . 349
5.113DATA READER PROTOCOL . . . . . . . . . . . . . . . . . . . 353
5.114DATA WRITER PROTOCOL . . . . . . . . . . . . . . . . . . . 354
5.115SYSTEM RESOURCE LIMITS. . . . . . . . . . . . . . . . . . . 355
5.116DOMAIN PARTICIPANT RESOURCE LIMITS . . . . . . . . . 356
5.117EVENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
5.118DATABASE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
5.119RECEIVER POOL . . . . . . . . . . . . . . . . . . . . . . . . . . 359
5.120PUBLISH MODE . . . . . . . . . . . . . . . . . . . . . . . . . . 360
5.121DISCOVERY CONFIG . . . . . . . . . . . . . . . . . . . . . . . 363
5.122ASYNCHRONOUS PUBLISHER . . . . . . . . . . . . . . . . . . 366
5.123TYPESUPPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
5.124EXCLUSIVE AREA . . . . . . . . . . . . . . . . . . . . . . . . . 368
5.125BATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
5.126LOCATORFILTER . . . . . . . . . . . . . . . . . . . . . . . . . 370
5.127MULTICHANNEL . . . . . . . . . . . . . . . . . . . . . . . . . . 372
5.128PROPERTY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
5.129AVAILABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
5.130Entity Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
5.131ENTITY NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . 381
5.132PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
5.133LOGGING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
5.134Conditions and WaitSets . . . . . . . . . . . . . . . . . . . . . . . 384
Generated on Mon Aug 13 09:03:22 2012 for RTI Connext .Net APIs by Doxygen
vi CONTENTS
5.135Sequence Support. . . . . . . . . . . . . . . . . . . . . . . . . . . 385
6 Class Documentation 387
6.1 DDS::AckResponseData t Class Reference . . . . . . . . . . . . . 387
6.2 DDS::AllocationSettings t Struct Reference . . . . . . . . . . . . 388
6.3 DDS::AsynchronousPublisherQosPolicy Class Reference . . . . . 390
6.4 DDS::AvailabilityQosPolicy Class Reference . . . . . . . . . . . . 395
6.5 DDS::BatchQosPolicy Struct Reference. . . . . . . . . . . . . . . 400
6.6 DDS::BooleanSeq Class Reference. . . . . . . . . . . . . . . . . . 405
6.7 DDS::BuiltinTopicKey t Struct Reference . . . . . . . . . . . . . 407
6.8 DDS::BuiltinTopicReaderResourceLimits t Struct Reference . . . 409
6.9 DDS::Bytes Struct Reference . . . . . . . . . . . . . . . . . . . . 413
6.10 DDS::BytesDataReader Class Reference . . . . . . . . . . . . . . 416
6.11 DDS::BytesDataWriter Class Reference . . . . . . . . . . . . . . 417
6.12 DDS::ByteSeq Class Reference . . . . . . . . . . . . . . . . . . . 420
6.13 DDS::BytesSeq Class Reference . . . . . . . . . . . . . . . . . . . 422
6.14 DDS::BytesTypeSupport Class Reference . . . . . . . . . . . . . 424
6.15 DDS::ChannelSettings t Class Reference . . . . . . . . . . . . . . 428
6.16 DDS::ChannelSettingsSeq Class Reference . . . . . . . . . . . . . 430
6.17 DDS::CharSeq Class Reference . . . . . . . . . . . . . . . . . . . 431
6.18 DDS::Condition Class Reference . . . . . . . . . . . . . . . . . . 433
6.19 DDS::ConditionSeq Class Reference . . . . . . . . . . . . . . . . 435
6.20 NDDS::Config LibraryVersion t Struct Reference . . . . . . . . . 436
6.21 NDDS::ConfigLogger Class Reference . . . . . . . . . . . . . . . . 438
6.22 NDDS::ConfigVersion Class Reference . . . . . . . . . . . . . . . 442
6.23 DDS::ContentFilteredTopic Class Reference . . . . . . . . . . . . 444
6.24 DDS::ContentFilterProperty t Class Reference . . . . . . . . . . 451
6.25 DDS::Cookie t Class Reference . . . . . . . . . . . . . . . . . . . 453
6.26 DDS::DatabaseQosPolicy Class Reference . . . . . . . . . . . . . 454
6.27 DDS::DataReader Class Reference . . . . . . . . . . . . . . . . . 459
6.28 DDS::DataReaderCacheStatus Struct Reference . . . . . . . . . . 488
Generated on Mon Aug 13 09:03:22 2012 for RTI Connext .Net APIs by Doxygen
CONTENTS vii
6.29 DDS::DataReaderListener Class Reference . . . . . . . . . . . . . 489
6.30 DDS::DataReaderProtocolQosPolicy Struct Reference . . . . . . 493
6.31 DDS::DataReaderProtocolStatus Struct Reference . . . . . . . . 498
6.32 DDS::DataReaderQos Class Reference . . . . . . . . . . . . . . . 509
6.33 DDS::DataReaderResourceLimitsQosPolicy Struct Reference. . . 515
6.34 DDS::DataReaderSeq Class Reference . . . . . . . . . . . . . . . 529
6.35 DDS::DataWriter Class Reference . . . . . . . . . . . . . . . . . . 530
6.36 DDS::DataWriterCacheStatus Struct Reference . . . . . . . . . . 554
6.37 DDS::DataWriterListener Class Reference . . . . . . . . . . . . . 555
6.38 DDS::DataWriterProtocolQosPolicy Struct Reference . . . . . . . 560
6.39 DDS::DataWriterProtocolStatus Struct Reference . . . . . . . . . 566
6.40 DDS::DataWriterQos Class Reference . . . . . . . . . . . . . . . 579
6.41 DDS::DataWriterResourceLimitsQosPolicy Struct Reference . . . 586
6.42 DDS::DeadlineQosPolicy Struct Reference . . . . . . . . . . . . . 593
6.43 DDS::DestinationOrderQosPolicy Struct Reference . . . . . . . . 596
6.44 DDS::DiscoveryConfigQosPolicy Class Reference . . . . . . . . . 599
6.45 DDS::DiscoveryQosPolicy Class Reference . . . . . . . . . . . . . 607
6.46 DDS::DomainEntity Class Reference . . . . . . . . . . . . . . . . 611
6.47 DDS::DomainParticipant Class Reference . . . . . . . . . . . . . 612
6.48 DDS::DomainParticipantFactory Class Reference . . . . . . . . . 690
6.49 DDS::DomainParticipantFactoryQos Class Reference . . . . . . . 717
6.50 DDS::DomainParticipantListener Class Reference . . . . . . . . . 719
6.51 DDS::DomainParticipantQos Class Reference . . . . . . . . . . . 727
6.52 DDS::DomainParticipantResourceLimitsQosPolicy Struct Refer-
ence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
6.53 DDS::DoubleSeq Class Reference . . . . . . . . . . . . . . . . . . 753
6.54 DDS::DurabilityQosPolicy Struct Reference . . . . . . . . . . . . 755
6.55 DDS::DurabilityServiceQosPolicy Struct Reference . . . . . . . . 760
6.56 DDS::Duration t Struct Reference . . . . . . . . . . . . . . . . . 763
6.57 DDS::DynamicData Class Reference . . . . . . . . . . . . . . . . 765
6.58 DDS::DynamicDataInfo Class Reference . . . . . . . . . . . . . . 856
Generated on Mon Aug 13 09:03:22 2012 for RTI Connext .Net APIs by Doxygen
viii CONTENTS
6.59 DDS::DynamicDataMemberInfo Class Reference . . . . . . . . . 857
6.60 DDS::DynamicDataProperty t Class Reference . . . . . . . . . . 860
6.61 DDS::DynamicDataReader Class Reference . . . . . . . . . . . . 862
6.62 DDS::DynamicDataSeq Class Reference . . . . . . . . . . . . . . 863
6.63 DDS::DynamicDataTypeProperty t Class Reference . . . . . . . 865
6.64 DDS::DynamicDataTypeSerializationProperty t Class Reference 867
6.65 DDS::DynamicDataTypeSupport Class Reference . . . . . . . . . 869
6.66 DDS::DynamicDataWriter Class Reference . . . . . . . . . . . . . 875
6.67 DDS::EndpointGroup t Class Reference . . . . . . . . . . . . . . 892
6.68 DDS::EndpointGroupSeq Class Reference . . . . . . . . . . . . . 893
6.69 DDS::Entity Class Reference . . . . . . . . . . . . . . . . . . . . 894
6.70 DDS::EntityFactoryQosPolicy Struct Reference . . . . . . . . . . 900
6.71 DDS::EntityNameQosPolicy Class Reference . . . . . . . . . . . . 903
6.72 DDS::EnumMember Class Reference . . . . . . . . . . . . . . . . 905
6.73 DDS::EnumMemberSeq Class Reference . . . . . . . . . . . . . . 906
6.74 DDS::EventQosPolicy Class Reference . . . . . . . . . . . . . . . 907
6.75 DDS::Exception Class Reference . . . . . . . . . . . . . . . . . . 910
6.76 DDS::ExclusiveAreaQosPolicy Struct Reference . . . . . . . . . . 911
6.77 DDS::FloatSeq Class Reference . . . . . . . . . . . . . . . . . . . 914
6.78 DDS::FlowController Class Reference . . . . . . . . . . . . . . . . 916
6.79 DDS::FlowControllerProperty t Class Reference . . . . . . . . . . 920
6.80 DDS::FlowControllerTokenBucketProperty t Struct Reference . . 922
6.81 Foo Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . 926
6.82 FooDataReader Class Reference . . . . . . . . . . . . . . . . . . . 927
6.83 FooDataWriter Class Reference . . . . . . . . . . . . . . . . . . . 928
6.84 FooSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 929
6.85 FooTypeSupport Class Reference . . . . . . . . . . . . . . . . . . 933
6.86 DDS::GroupDataQosPolicy Class Reference . . . . . . . . . . . . 939
6.87 DDS::GuardCondition Class Reference . . . . . . . . . . . . . . . 941
6.88 DDS::GUID t Struct Reference . . . . . . . . . . . . . . . . . . . 943
6.89 DDS::HistoryQosPolicy Struct Reference . . . . . . . . . . . . . . 947
Generated on Mon Aug 13 09:03:22 2012 for RTI Connext .Net APIs by Doxygen