Java API Reference Manual

1771 Pages·2011·8.81 MB·English

RTI Data Distribution Service Java API
Version 4.5e
Generated by Doxygen 1.5.5
Sun Oct 23 23:16:30 2011

Contents
1 RTI Data Distribution Service 1
1.1 Feedback and Support for this Release.. . . . . . . . . . . . . . . 1
1.2 Available Documentation. . . . . . . . . . . . . . . . . . . . . . . 2
2 Module Index 5
2.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3 Namespace Index 9
3.1 Package List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4 Class Index 13
4.1 Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5 Class Index 21
5.1 Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6 Module Documentation 39
6.1 ASYNCHRONOUS PUBLISHER . . . . . . . . . . . . . . . . . . 39
6.2 AVAILABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
6.3 BATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
6.4 Conditions and WaitSets . . . . . . . . . . . . . . . . . . . . . . . 43
6.5 DATABASE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
6.6 DATA READER PROTOCOL . . . . . . . . . . . . . . . . . . . 45
6.7 DATA READER RESOURCE LIMITS . . . . . . . . . . . . . . 46
6.8 DATA WRITER PROTOCOL . . . . . . . . . . . . . . . . . . . 48
ii CONTENTS
6.9 DATA WRITER RESOURCE LIMITS . . . . . . . . . . . . . . 49
6.10 DEADLINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
6.11 DESTINATION ORDER . . . . . . . . . . . . . . . . . . . . . . 51
6.12 DISCOVERY CONFIG . . . . . . . . . . . . . . . . . . . . . . . 52
6.13 DISCOVERY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
6.14 NDDS DISCOVERY PEERS . . . . . . . . . . . . . . . . . . . . 55
6.15 DOMAIN PARTICIPANT RESOURCE LIMITS . . . . . . . . . 63
6.16 DURABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
6.17 DURABILITY SERVICE . . . . . . . . . . . . . . . . . . . . . . 66
6.18 Time Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
6.19 Entity Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
6.20 ENTITY FACTORY . . . . . . . . . . . . . . . . . . . . . . . . . 69
6.21 ENTITY NAME . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
6.22 EVENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
6.23 EXCLUSIVE AREA . . . . . . . . . . . . . . . . . . . . . . . . . 72
6.24 GROUP DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
6.25 GUID Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
6.26 HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
6.27 LATENCY BUDGET . . . . . . . . . . . . . . . . . . . . . . . . 76
6.28 LIFESPAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
6.29 LIVELINESS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
6.30 LOCATORFILTER . . . . . . . . . . . . . . . . . . . . . . . . . 79
6.31 LOGGING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
6.32 MULTICHANNEL . . . . . . . . . . . . . . . . . . . . . . . . . . 81
6.33 Object Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
6.34 OWNERSHIP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
6.35 OWNERSHIP STRENGTH . . . . . . . . . . . . . . . . . . . . . 84
6.36 PARTITION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
6.37 PRESENTATION . . . . . . . . . . . . . . . . . . . . . . . . . . 86
6.38 PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
6.39 PROPERTY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Generated on Sun Oct 23 23:16:30 2011 for RTI Data Distribution Service Java API
by Doxygen
CONTENTS iii
6.40 PUBLISH MODE . . . . . . . . . . . . . . . . . . . . . . . . . . 89
6.41 QoS Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
6.42 READER DATA LIFECYCLE . . . . . . . . . . . . . . . . . . . 99
6.43 RECEIVER POOL . . . . . . . . . . . . . . . . . . . . . . . . . . 100
6.44 RELIABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
6.45 RESOURCE LIMITS . . . . . . . . . . . . . . . . . . . . . . . . 102
6.46 Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
6.47 Sequence Number Support . . . . . . . . . . . . . . . . . . . . . . 105
6.48 Status Kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
6.49 SYSTEM RESOURCE LIMITS. . . . . . . . . . . . . . . . . . . 111
6.50 Thread Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
6.51 TIME BASED FILTER . . . . . . . . . . . . . . . . . . . . . . . 113
6.52 TOPIC DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
6.53 TRANSPORT BUILTIN . . . . . . . . . . . . . . . . . . . . . . . 115
6.54 TRANSPORT MULTICAST . . . . . . . . . . . . . . . . . . . . 118
6.55 TRANSPORT PRIORITY . . . . . . . . . . . . . . . . . . . . . 120
6.56 TRANSPORT SELECTION . . . . . . . . . . . . . . . . . . . . 121
6.57 TRANSPORT UNICAST . . . . . . . . . . . . . . . . . . . . . . 122
6.58 TYPESUPPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
6.59 USER DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
6.60 Exception Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
6.61 WIRE PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . . . 127
6.62 WRITER DATA LIFECYCLE . . . . . . . . . . . . . . . . . . . 133
6.63 KeyedString Built-in Type . . . . . . . . . . . . . . . . . . . . . . 134
6.64 Octets Built-in Type . . . . . . . . . . . . . . . . . . . . . . . . . 135
6.65 KeyedOctets Built-in Type . . . . . . . . . . . . . . . . . . . . . 136
6.66 Sequence Support. . . . . . . . . . . . . . . . . . . . . . . . . . . 137
6.67 Clock Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
6.68 Domain Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
6.69 DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . . 143
6.70 DomainParticipants . . . . . . . . . . . . . . . . . . . . . . . . . 145
Generated on Sun Oct 23 23:16:30 2011 for RTI Data Distribution Service Java API
by Doxygen
iv CONTENTS
6.71 Built-in Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
6.72 Topic Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
6.73 Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
6.74 User Data Type Support . . . . . . . . . . . . . . . . . . . . . . . 158
6.75 Type Code Support . . . . . . . . . . . . . . . . . . . . . . . . . 160
6.76 Built-in Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
6.77 Dynamic Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
6.78 Publication Module. . . . . . . . . . . . . . . . . . . . . . . . . . 173
6.79 Publishers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
6.80 Data Writers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
6.81 Flow Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
6.82 Subscription Module . . . . . . . . . . . . . . . . . . . . . . . . . 184
6.83 Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
6.84 DataReaders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
6.85 Read Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
6.86 Query Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
6.87 Data Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
6.88 Sample States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
6.89 View States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
6.90 Instance States . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
6.91 Infrastructure Module . . . . . . . . . . . . . . . . . . . . . . . . 198
6.92 Built-in Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . 200
6.93 Multi-channel DataWriters . . . . . . . . . . . . . . . . . . . . . 202
6.94 Pluggable Transports . . . . . . . . . . . . . . . . . . . . . . . . . 205
6.95 Using Transport Plugins . . . . . . . . . . . . . . . . . . . . . . . 211
6.96 Built-in Transport Plugins . . . . . . . . . . . . . . . . . . . . . . 214
6.97 Configuration Utilities . . . . . . . . . . . . . . . . . . . . . . . . 216
6.98 Durability and Persistence . . . . . . . . . . . . . . . . . . . . . . 217
6.99 Configuring QoS Profiles with XML . . . . . . . . . . . . . . . . 223
6.100Publication Example . . . . . . . . . . . . . . . . . . . . . . . . . 227
6.101Subscription Example . . . . . . . . . . . . . . . . . . . . . . . . 228
Generated on Sun Oct 23 23:16:30 2011 for RTI Data Distribution Service Java API
by Doxygen
CONTENTS v
6.102Participant Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 229
6.103Topic Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
6.104FlowController Use Cases . . . . . . . . . . . . . . . . . . . . . . 233
6.105Publisher Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 237
6.106DataWriter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 238
6.107Subscriber Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 240
6.108DataReader Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 243
6.109Entity Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
6.110Waitset Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 251
6.111Transport Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 253
6.112Filter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
6.113Creating Custom Content Filters . . . . . . . . . . . . . . . . . . 260
6.114Large Data Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 264
6.115Documentation Roadmap . . . . . . . . . . . . . . . . . . . . . . 266
6.116Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
6.117DDS API Reference . . . . . . . . . . . . . . . . . . . . . . . . . 269
6.118Queries and Filters Syntax. . . . . . . . . . . . . . . . . . . . . . 275
6.119RTI Data Distribution Service API Reference . . . . . . . . . . . 283
6.120Programming How-To’s . . . . . . . . . . . . . . . . . . . . . . . 284
6.121Programming Tools. . . . . . . . . . . . . . . . . . . . . . . . . . 286
6.122rtiddsgen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
6.123rtiddsping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
6.124rtiddsspy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
7 Namespace Documentation 315
7.1 Package com.rti.dds.domain . . . . . . . . . . . . . . . . . . . . . 315
7.2 Package com.rti.dds.domain.builtin . . . . . . . . . . . . . . . . . 317
7.3 Package com.rti.dds.dynamicdata . . . . . . . . . . . . . . . . . . 318
7.4 Package com.rti.dds.infrastructure . . . . . . . . . . . . . . . . . 321
7.5 Package com.rti.dds.publication . . . . . . . . . . . . . . . . . . . 336
7.6 Package com.rti.dds.publication.builtin . . . . . . . . . . . . . . . 339
Generated on Sun Oct 23 23:16:30 2011 for RTI Data Distribution Service Java API
by Doxygen
vi CONTENTS
7.7 Package com.rti.dds.publication.example . . . . . . . . . . . . . . 340
7.8 Package com.rti.dds.subscription . . . . . . . . . . . . . . . . . . 341
7.9 Package com.rti.dds.subscription.builtin . . . . . . . . . . . . . . 346
7.10 Package com.rti.dds.subscription.example . . . . . . . . . . . . . 347
7.11 Package com.rti.dds.topic . . . . . . . . . . . . . . . . . . . . . . 348
7.12 Package com.rti.dds.topic.builtin . . . . . . . . . . . . . . . . . . 350
7.13 Package com.rti.dds.topic.example . . . . . . . . . . . . . . . . . 351
7.14 Package com.rti.dds.type.builtin. . . . . . . . . . . . . . . . . . . 352
7.15 Package com.rti.dds.typecode . . . . . . . . . . . . . . . . . . . . 358
7.16 Package com.rti.dds.util . . . . . . . . . . . . . . . . . . . . . . . 362
7.17 Package com.rti.ndds.config . . . . . . . . . . . . . . . . . . . . . 363
7.18 Package com.rti.ndds.example . . . . . . . . . . . . . . . . . . . . 364
7.19 Package com.rti.ndds.transport . . . . . . . . . . . . . . . . . . . 365
8 Class Documentation 373
8.1 AbstractBuiltinTopicDataTypeSupport Class Reference . . . . . 373
8.2 AbstractPrimitiveSequence Class Reference . . . . . . . . . . . . 375
8.3 AbstractSequence Class Reference . . . . . . . . . . . . . . . . . 380
8.4 AllocationSettings t Class Reference . . . . . . . . . . . . . . . . 383
8.5 AsynchronousPublisherQosPolicy Class Reference . . . . . . . . . 385
8.6 AvailabilityQosPolicy Class Reference . . . . . . . . . . . . . . . 390
8.7 BAD PARAM Class Reference . . . . . . . . . . . . . . . . . . . 394
8.8 BAD TYPECODE Class Reference . . . . . . . . . . . . . . . . . 395
8.9 BadKind Class Reference . . . . . . . . . . . . . . . . . . . . . . 396
8.10 BadMemberId Class Reference . . . . . . . . . . . . . . . . . . . 397
8.11 BadMemberName Class Reference . . . . . . . . . . . . . . . . . 398
8.12 BatchQosPolicy Class Reference . . . . . . . . . . . . . . . . . . 399
8.13 BooleanSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 403
8.14 Bounds Class Reference . . . . . . . . . . . . . . . . . . . . . . . 409
8.15 BuiltinTopicKey t Class Reference . . . . . . . . . . . . . . . . . 410
8.16 BuiltinTopicReaderResourceLimits t Class Reference . . . . . . . 412
Generated on Sun Oct 23 23:16:30 2011 for RTI Data Distribution Service Java API
by Doxygen
CONTENTS vii
8.17 Bytes Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 415
8.18 BytesDataReader Class Reference. . . . . . . . . . . . . . . . . . 418
8.19 BytesDataWriter Class Reference . . . . . . . . . . . . . . . . . . 422
8.20 ByteSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 426
8.21 BytesSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 432
8.22 BytesTypeSupport Class Reference . . . . . . . . . . . . . . . . . 435
8.23 ChannelSettings t Class Reference . . . . . . . . . . . . . . . . . 439
8.24 ChannelSettingsSeq Class Reference . . . . . . . . . . . . . . . . 442
8.25 CharSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 443
8.26 Condition Interface Reference . . . . . . . . . . . . . . . . . . . . 449
8.27 ConditionSeq Class Reference . . . . . . . . . . . . . . . . . . . . 450
8.28 ContentFilter Interface Reference . . . . . . . . . . . . . . . . . . 452
8.29 ContentFilteredTopic Interface Reference . . . . . . . . . . . . . 456
8.30 ContentFilterProperty t Class Reference . . . . . . . . . . . . . . 461
8.31 Cookie t Class Reference . . . . . . . . . . . . . . . . . . . . . . . 463
8.32 Copyable Interface Reference . . . . . . . . . . . . . . . . . . . . 464
8.33 DatabaseQosPolicy Class Reference . . . . . . . . . . . . . . . . . 466
8.34 DataReader Interface Reference . . . . . . . . . . . . . . . . . . . 471
8.35 DataReaderAdapter Class Reference . . . . . . . . . . . . . . . . 495
8.36 DataReaderCacheStatus Class Reference . . . . . . . . . . . . . . 498
8.37 DataReaderListener Interface Reference . . . . . . . . . . . . . . 499
8.38 DataReaderProtocolQosPolicy Class Reference . . . . . . . . . . 502
8.39 DataReaderProtocolStatus Class Reference . . . . . . . . . . . . 507
8.40 DataReaderQos Class Reference. . . . . . . . . . . . . . . . . . . 517
8.41 DataReaderResourceLimitsQosPolicy Class Reference . . . . . . 523
8.42 DataReaderSeq Class Reference . . . . . . . . . . . . . . . . . . . 535
8.43 DataWriter Interface Reference . . . . . . . . . . . . . . . . . . . 537
8.44 DataWriterAdapter Class Reference . . . . . . . . . . . . . . . . 559
8.45 DataWriterCacheStatus Class Reference . . . . . . . . . . . . . . 564
8.46 DataWriterListener Interface Reference . . . . . . . . . . . . . . 565
8.47 DataWriterProtocolQosPolicy Class Reference . . . . . . . . . . . 570
Generated on Sun Oct 23 23:16:30 2011 for RTI Data Distribution Service Java API
by Doxygen
viii CONTENTS
8.48 DataWriterProtocolStatus Class Reference . . . . . . . . . . . . . 575
8.49 DataWriterQos Class Reference . . . . . . . . . . . . . . . . . . . 587
8.50 DataWriterResourceLimitsInstanceReplacementKind Class Ref-
erence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
8.51 DataWriterResourceLimitsQosPolicy Class Reference . . . . . . . 597
8.52 DeadlineQosPolicy Class Reference . . . . . . . . . . . . . . . . . 603
8.53 DestinationOrderQosPolicy Class Reference . . . . . . . . . . . . 606
8.54 DestinationOrderQosPolicyKind Class Reference . . . . . . . . . 609
8.55 DiscoveryBuiltinReaderFragmentationResourceLimits t Class
Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
8.56 DiscoveryConfigBuiltinPluginKind Class Reference . . . . . . . . 613
8.57 DiscoveryConfigQosPolicy Class Reference . . . . . . . . . . . . . 614
8.58 DiscoveryPluginPromiscuityKind Class Reference . . . . . . . . . 622
8.59 DiscoveryQosPolicy Class Reference . . . . . . . . . . . . . . . . 623
8.60 DomainEntity Interface Reference . . . . . . . . . . . . . . . . . 627
8.61 DomainParticipant Interface Reference . . . . . . . . . . . . . . . 628
8.62 DomainParticipantAdapter Class Reference . . . . . . . . . . . . 702
8.63 DomainParticipantFactory Class Reference . . . . . . . . . . . . 707
8.64 DomainParticipantFactoryQos Class Reference . . . . . . . . . . 731
8.65 DomainParticipantListener Interface Reference . . . . . . . . . . 733
8.66 DomainParticipantQos Class Reference. . . . . . . . . . . . . . . 735
8.67 DomainParticipantResourceLimitsQosPolicy Class Reference . . 740
8.68 DoubleSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 757
8.69 DurabilityQosPolicy Class Reference . . . . . . . . . . . . . . . . 763
8.70 DurabilityQosPolicyKind Class Reference . . . . . . . . . . . . . 768
8.71 DurabilityServiceQosPolicy Class Reference . . . . . . . . . . . . 771
8.72 Duration t Class Reference . . . . . . . . . . . . . . . . . . . . . 774
8.73 DynamicData Class Reference . . . . . . . . . . . . . . . . . . . . 777
8.74 DynamicDataInfo Class Reference . . . . . . . . . . . . . . . . . 841
8.75 DynamicDataMemberInfo Class Reference . . . . . . . . . . . . . 843
8.76 DynamicDataProperty t Class Reference . . . . . . . . . . . . . . 846
8.77 DynamicDataReader Class Reference . . . . . . . . . . . . . . . . 848
Generated on Sun Oct 23 23:16:30 2011 for RTI Data Distribution Service Java API
by Doxygen