RTI Connext Java API...Contents 1 RTI Connext 1 1.1 Feedback and Support for this Release. . . . . ....
Transcript of RTI Connext Java API...Contents 1 RTI Connext 1 1.1 Feedback and Support for this Release. . . . . ....
-
RTI Connext Java API
Version 4.5f
Generated by Doxygen 1.5.5
Sat Mar 17 21:18:59 2012
-
Contents
1 RTI Connext 1
1.1 Feedback and Support for this Release. . . . . . . . . . . . . . . . 1
1.2 Available Documentation. . . . . . . . . . . . . . . . . . . . . . . 2
2 Module Index 5
2.1 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3 Namespace Index 9
3.1 Package List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4 Class Index 13
4.1 Class Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5 Class Index 21
5.1 Class List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
6 Module Documentation 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 Sat Mar 17 21:18:59 2012 for RTI Connext 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 . . . . . . . . . . . . . . . . . . . . . 121
6.56 TRANSPORT SELECTION . . . . . . . . . . . . . . . . . . . . 122
6.57 TRANSPORT UNICAST . . . . . . . . . . . . . . . . . . . . . . 123
6.58 TYPESUPPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
6.59 USER DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
6.60 Exception Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
6.61 WIRE PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . . . 128
6.62 WRITER DATA LIFECYCLE . . . . . . . . . . . . . . . . . . . 134
6.63 String Built-in Type . . . . . . . . . . . . . . . . . . . . . . . . . 135
6.64 KeyedString Built-in Type . . . . . . . . . . . . . . . . . . . . . . 136
6.65 Octets Built-in Type . . . . . . . . . . . . . . . . . . . . . . . . . 137
6.66 KeyedOctets Built-in Type . . . . . . . . . . . . . . . . . . . . . 138
6.67 Sequence Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
6.68 Clock Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
6.69 Domain Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
6.70 DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . . 145
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
iv CONTENTS
6.71 DomainParticipants . . . . . . . . . . . . . . . . . . . . . . . . . 147
6.72 Built-in Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
6.73 Topic Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
6.74 Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
6.75 User Data Type Support . . . . . . . . . . . . . . . . . . . . . . . 160
6.76 Type Code Support . . . . . . . . . . . . . . . . . . . . . . . . . 162
6.77 Built-in Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
6.78 Dynamic Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
6.79 Publication Module . . . . . . . . . . . . . . . . . . . . . . . . . . 175
6.80 Publishers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
6.81 Data Writers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
6.82 Flow Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
6.83 Subscription Module . . . . . . . . . . . . . . . . . . . . . . . . . 186
6.84 Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
6.85 DataReaders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
6.86 Read Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
6.87 Query Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
6.88 Data Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
6.89 Sample States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
6.90 View States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
6.91 Instance States . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
6.92 Infrastructure Module . . . . . . . . . . . . . . . . . . . . . . . . 200
6.93 Built-in Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . 202
6.94 Multi-channel DataWriters . . . . . . . . . . . . . . . . . . . . . 204
6.95 Pluggable Transports . . . . . . . . . . . . . . . . . . . . . . . . . 207
6.96 Using Transport Plugins . . . . . . . . . . . . . . . . . . . . . . . 213
6.97 Built-in Transport Plugins . . . . . . . . . . . . . . . . . . . . . . 216
6.98 Configuration Utilities . . . . . . . . . . . . . . . . . . . . . . . . 218
6.99 Durability and Persistence . . . . . . . . . . . . . . . . . . . . . . 219
6.100Configuring QoS Profiles with XML . . . . . . . . . . . . . . . . 225
6.101Publication Example . . . . . . . . . . . . . . . . . . . . . . . . . 229
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
CONTENTS v
6.102Subscription Example . . . . . . . . . . . . . . . . . . . . . . . . 230
6.103Participant Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 231
6.104Topic Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
6.105FlowController Use Cases . . . . . . . . . . . . . . . . . . . . . . 235
6.106Publisher Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 239
6.107DataWriter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 240
6.108Subscriber Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 242
6.109DataReader Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 245
6.110Entity Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
6.111Waitset Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 253
6.112Transport Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 255
6.113Filter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
6.114Creating Custom Content Filters . . . . . . . . . . . . . . . . . . 263
6.115Large Data Use Cases . . . . . . . . . . . . . . . . . . . . . . . . 267
6.116Documentation Roadmap . . . . . . . . . . . . . . . . . . . . . . 269
6.117Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
6.118DDS API Reference . . . . . . . . . . . . . . . . . . . . . . . . . 272
6.119Queries and Filters Syntax . . . . . . . . . . . . . . . . . . . . . . 278
6.120RTI Connext API Reference . . . . . . . . . . . . . . . . . . . . . 286
6.121Programming How-To’s . . . . . . . . . . . . . . . . . . . . . . . 287
6.122Programming Tools . . . . . . . . . . . . . . . . . . . . . . . . . . 289
6.123rtiddsgen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
6.124rtiddsping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
6.125rtiddsspy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
7 Namespace Documentation 317
7.1 Package com.rti.dds.domain . . . . . . . . . . . . . . . . . . . . . 317
7.2 Package com.rti.dds.domain.builtin . . . . . . . . . . . . . . . . . 319
7.3 Package com.rti.dds.dynamicdata . . . . . . . . . . . . . . . . . . 320
7.4 Package com.rti.dds.infrastructure . . . . . . . . . . . . . . . . . 323
7.5 Package com.rti.dds.publication . . . . . . . . . . . . . . . . . . . 338
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
vi CONTENTS
7.6 Package com.rti.dds.publication.builtin . . . . . . . . . . . . . . . 341
7.7 Package com.rti.dds.publication.example . . . . . . . . . . . . . . 342
7.8 Package com.rti.dds.subscription . . . . . . . . . . . . . . . . . . 343
7.9 Package com.rti.dds.subscription.builtin . . . . . . . . . . . . . . 348
7.10 Package com.rti.dds.subscription.example . . . . . . . . . . . . . 349
7.11 Package com.rti.dds.topic . . . . . . . . . . . . . . . . . . . . . . 350
7.12 Package com.rti.dds.topic.builtin . . . . . . . . . . . . . . . . . . 352
7.13 Package com.rti.dds.topic.example . . . . . . . . . . . . . . . . . 353
7.14 Package com.rti.dds.type.builtin . . . . . . . . . . . . . . . . . . . 354
7.15 Package com.rti.dds.typecode . . . . . . . . . . . . . . . . . . . . 360
7.16 Package com.rti.dds.util . . . . . . . . . . . . . . . . . . . . . . . 364
7.17 Package com.rti.ndds.config . . . . . . . . . . . . . . . . . . . . . 365
7.18 Package com.rti.ndds.example . . . . . . . . . . . . . . . . . . . . 366
7.19 Package com.rti.ndds.transport . . . . . . . . . . . . . . . . . . . 367
8 Class Documentation 375
8.1 AbstractBuiltinTopicDataTypeSupport Class Reference . . . . . 375
8.2 AbstractPrimitiveSequence Class Reference . . . . . . . . . . . . 377
8.3 AbstractSequence Class Reference . . . . . . . . . . . . . . . . . 382
8.4 AllocationSettings t Class Reference . . . . . . . . . . . . . . . . 385
8.5 AsynchronousPublisherQosPolicy Class Reference . . . . . . . . . 387
8.6 AvailabilityQosPolicy Class Reference . . . . . . . . . . . . . . . 392
8.7 BAD PARAM Class Reference . . . . . . . . . . . . . . . . . . . 396
8.8 BAD TYPECODE Class Reference . . . . . . . . . . . . . . . . . 397
8.9 BadKind Class Reference . . . . . . . . . . . . . . . . . . . . . . 398
8.10 BadMemberId Class Reference . . . . . . . . . . . . . . . . . . . 399
8.11 BadMemberName Class Reference . . . . . . . . . . . . . . . . . 400
8.12 BatchQosPolicy Class Reference . . . . . . . . . . . . . . . . . . 401
8.13 BooleanSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 405
8.14 Bounds Class Reference . . . . . . . . . . . . . . . . . . . . . . . 411
8.15 BuiltinTopicKey t Class Reference . . . . . . . . . . . . . . . . . 412
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
CONTENTS vii
8.16 BuiltinTopicReaderResourceLimits t Class Reference . . . . . . . 414
8.17 Bytes Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 417
8.18 BytesDataReader Class Reference . . . . . . . . . . . . . . . . . . 420
8.19 BytesDataWriter Class Reference . . . . . . . . . . . . . . . . . . 424
8.20 ByteSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 428
8.21 BytesSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 434
8.22 BytesTypeSupport Class Reference . . . . . . . . . . . . . . . . . 437
8.23 ChannelSettings t Class Reference . . . . . . . . . . . . . . . . . 441
8.24 ChannelSettingsSeq Class Reference . . . . . . . . . . . . . . . . 444
8.25 CharSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 445
8.26 Condition Interface Reference . . . . . . . . . . . . . . . . . . . . 451
8.27 ConditionSeq Class Reference . . . . . . . . . . . . . . . . . . . . 452
8.28 ContentFilter Interface Reference . . . . . . . . . . . . . . . . . . 454
8.29 ContentFilteredTopic Interface Reference . . . . . . . . . . . . . 458
8.30 ContentFilterProperty t Class Reference . . . . . . . . . . . . . . 463
8.31 Cookie t Class Reference . . . . . . . . . . . . . . . . . . . . . . . 465
8.32 Copyable Interface Reference . . . . . . . . . . . . . . . . . . . . 466
8.33 DatabaseQosPolicy Class Reference . . . . . . . . . . . . . . . . . 468
8.34 DataReader Interface Reference . . . . . . . . . . . . . . . . . . . 473
8.35 DataReaderAdapter Class Reference . . . . . . . . . . . . . . . . 497
8.36 DataReaderCacheStatus Class Reference . . . . . . . . . . . . . . 500
8.37 DataReaderListener Interface Reference . . . . . . . . . . . . . . 501
8.38 DataReaderProtocolQosPolicy Class Reference . . . . . . . . . . 504
8.39 DataReaderProtocolStatus Class Reference . . . . . . . . . . . . 508
8.40 DataReaderQos Class Reference . . . . . . . . . . . . . . . . . . . 518
8.41 DataReaderResourceLimitsQosPolicy Class Reference . . . . . . 524
8.42 DataReaderSeq Class Reference . . . . . . . . . . . . . . . . . . . 536
8.43 DataWriter Interface Reference . . . . . . . . . . . . . . . . . . . 538
8.44 DataWriterAdapter Class Reference . . . . . . . . . . . . . . . . 560
8.45 DataWriterCacheStatus Class Reference . . . . . . . . . . . . . . 565
8.46 DataWriterListener Interface Reference . . . . . . . . . . . . . . 566
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
viii CONTENTS
8.47 DataWriterProtocolQosPolicy Class Reference . . . . . . . . . . . 571
8.48 DataWriterProtocolStatus Class Reference . . . . . . . . . . . . . 576
8.49 DataWriterQos Class Reference . . . . . . . . . . . . . . . . . . . 588
8.50 DataWriterResourceLimitsInstanceReplacementKind Class Ref-erence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
8.51 DataWriterResourceLimitsQosPolicy Class Reference . . . . . . . 598
8.52 DeadlineQosPolicy Class Reference . . . . . . . . . . . . . . . . . 604
8.53 DestinationOrderQosPolicy Class Reference . . . . . . . . . . . . 607
8.54 DestinationOrderQosPolicyKind Class Reference . . . . . . . . . 610
8.55 DiscoveryBuiltinReaderFragmentationResourceLimits t ClassReference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
8.56 DiscoveryConfigBuiltinPluginKind Class Reference . . . . . . . . 614
8.57 DiscoveryConfigQosPolicy Class Reference . . . . . . . . . . . . . 615
8.58 DiscoveryPluginPromiscuityKind Class Reference . . . . . . . . . 623
8.59 DiscoveryQosPolicy Class Reference . . . . . . . . . . . . . . . . 624
8.60 DomainEntity Interface Reference . . . . . . . . . . . . . . . . . 628
8.61 DomainParticipant Interface Reference . . . . . . . . . . . . . . . 629
8.62 DomainParticipantAdapter Class Reference . . . . . . . . . . . . 703
8.63 DomainParticipantFactory Class Reference . . . . . . . . . . . . 708
8.64 DomainParticipantFactoryQos Class Reference . . . . . . . . . . 732
8.65 DomainParticipantListener Interface Reference . . . . . . . . . . 734
8.66 DomainParticipantQos Class Reference . . . . . . . . . . . . . . . 736
8.67 DomainParticipantResourceLimitsQosPolicy Class Reference . . 741
8.68 DoubleSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 759
8.69 DurabilityQosPolicy Class Reference . . . . . . . . . . . . . . . . 765
8.70 DurabilityQosPolicyKind Class Reference . . . . . . . . . . . . . 770
8.71 DurabilityServiceQosPolicy Class Reference . . . . . . . . . . . . 773
8.72 Duration t Class Reference . . . . . . . . . . . . . . . . . . . . . 776
8.73 DynamicData Class Reference . . . . . . . . . . . . . . . . . . . . 780
8.74 DynamicDataInfo Class Reference . . . . . . . . . . . . . . . . . 844
8.75 DynamicDataMemberInfo Class Reference . . . . . . . . . . . . . 846
8.76 DynamicDataProperty t Class Reference . . . . . . . . . . . . . . 849
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
CONTENTS ix
8.77 DynamicDataReader Class Reference . . . . . . . . . . . . . . . . 851
8.78 DynamicDataSeq Class Reference . . . . . . . . . . . . . . . . . . 881
8.79 DynamicDataTypeProperty t Class Reference . . . . . . . . . . . 883
8.80 DynamicDataTypeSerializationProperty t Class Reference . . . . 885
8.81 DynamicDataTypeSupport Class Reference . . . . . . . . . . . . 887
8.82 DynamicDataWriter Class Reference . . . . . . . . . . . . . . . . 893
8.83 EndpointGroup t Class Reference . . . . . . . . . . . . . . . . . . 909
8.84 EndpointGroupSeq Class Reference . . . . . . . . . . . . . . . . . 911
8.85 Entity Interface Reference . . . . . . . . . . . . . . . . . . . . . . 912
8.86 EntityFactoryQosPolicy Class Reference . . . . . . . . . . . . . . 919
8.87 EntityHowTo.MyEntityListener Class Reference . . . . . . . . . . 922
8.88 EntityNameQosPolicy Class Reference . . . . . . . . . . . . . . . 923
8.89 Enum Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 925
8.90 EnumMember Class Reference . . . . . . . . . . . . . . . . . . . 928
8.91 EventQosPolicy Class Reference . . . . . . . . . . . . . . . . . . . 930
8.92 ExclusiveAreaQosPolicy Class Reference . . . . . . . . . . . . . . 933
8.93 FloatSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 936
8.94 FlowController Interface Reference . . . . . . . . . . . . . . . . . 942
8.95 FlowControllerProperty t Class Reference . . . . . . . . . . . . . 946
8.96 FlowControllerSchedulingPolicy Class Reference . . . . . . . . . 948
8.97 FlowControllerTokenBucketProperty t Class Reference . . . . . . 951
8.98 Foo Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . 955
8.99 Foo Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . 956
8.100FooDataReader Class Reference . . . . . . . . . . . . . . . . . . . 958
8.101FooDataReader Interface Reference . . . . . . . . . . . . . . . . . 988
8.102FooDataWriter Class Reference . . . . . . . . . . . . . . . . . . . 1021
8.103FooDataWriter Interface Reference . . . . . . . . . . . . . . . . . 1040
8.104FooSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1056
8.105FooSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1058
8.106FooTypeSupport Class Reference . . . . . . . . . . . . . . . . . . 1060
8.107FooTypeSupport Class Reference . . . . . . . . . . . . . . . . . . 1063
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
x CONTENTS
8.108GroupDataQosPolicy Class Reference . . . . . . . . . . . . . . . 1064
8.109GuardCondition Class Reference . . . . . . . . . . . . . . . . . . 1066
8.110GUID t Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1069
8.111HistoryQosPolicy Class Reference . . . . . . . . . . . . . . . . . . 1071
8.112HistoryQosPolicyKind Class Reference . . . . . . . . . . . . . . . 1075
8.113InconsistentTopicStatus Class Reference . . . . . . . . . . . . . . 1077
8.114InetAddressSeq Class Reference . . . . . . . . . . . . . . . . . . . 1079
8.115InstanceHandle t Class Reference . . . . . . . . . . . . . . . . . . 1080
8.116InstanceHandleSeq Class Reference . . . . . . . . . . . . . . . . . 1083
8.117InstanceStateKind Class Reference . . . . . . . . . . . . . . . . . 1086
8.118IntSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 1089
8.119KeyedBytes Class Reference . . . . . . . . . . . . . . . . . . . . . 1095
8.120KeyedBytesDataReader Class Reference . . . . . . . . . . . . . . 1098
8.121KeyedBytesDataWriter Class Reference . . . . . . . . . . . . . . 1106
8.122KeyedBytesSeq Class Reference . . . . . . . . . . . . . . . . . . . 1116
8.123KeyedBytesTypeSupport Class Reference . . . . . . . . . . . . . 1119
8.124KeyedString Class Reference . . . . . . . . . . . . . . . . . . . . 1123
8.125KeyedStringDataReader Class Reference . . . . . . . . . . . . . . 1125
8.126KeyedStringDataWriter Class Reference . . . . . . . . . . . . . . 1133
8.127KeyedStringSeq Class Reference . . . . . . . . . . . . . . . . . . . 1141
8.128KeyedStringTypeSupport Class Reference . . . . . . . . . . . . . 1144
8.129LatencyBudgetQosPolicy Class Reference . . . . . . . . . . . . . 1148
8.130LibraryVersion t Class Reference . . . . . . . . . . . . . . . . . . 1150
8.131LifespanQosPolicy Class Reference . . . . . . . . . . . . . . . . . 1152
8.132Listener Interface Reference . . . . . . . . . . . . . . . . . . . . . 1154
8.133LivelinessChangedStatus Class Reference . . . . . . . . . . . . . . 1159
8.134LivelinessLostStatus Class Reference . . . . . . . . . . . . . . . . 1162
8.135LivelinessQosPolicy Class Reference . . . . . . . . . . . . . . . . 1164
8.136LivelinessQosPolicyKind Class Reference . . . . . . . . . . . . . . 1168
8.137LoanableSequence Class Reference . . . . . . . . . . . . . . . . . 1170
8.138Locator t Class Reference . . . . . . . . . . . . . . . . . . . . . . 1174
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
CONTENTS xi
8.139LocatorFilter t Class Reference . . . . . . . . . . . . . . . . . . . 1178
8.140LocatorFilterQosPolicy Class Reference . . . . . . . . . . . . . . 1181
8.141LocatorFilterSeq Class Reference . . . . . . . . . . . . . . . . . . 1183
8.142LocatorSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 1184
8.143LogCategory Class Reference . . . . . . . . . . . . . . . . . . . . 1185
8.144Logger Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 1187
8.145LoggingQosPolicy Class Reference . . . . . . . . . . . . . . . . . 1190
8.146LogPrintFormat Class Reference . . . . . . . . . . . . . . . . . . 1192
8.147LogVerbosity Class Reference . . . . . . . . . . . . . . . . . . . . 1195
8.148LongDoubleSeq Class Reference . . . . . . . . . . . . . . . . . . . 1197
8.149LongSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1199
8.150MultiChannelQosPolicy Class Reference . . . . . . . . . . . . . . 1205
8.151MultiTopic Interface Reference . . . . . . . . . . . . . . . . . . . 1208
8.152ObjectHolder Class Reference . . . . . . . . . . . . . . . . . . . . 1211
8.153OfferedDeadlineMissedStatus Class Reference . . . . . . . . . . . 1212
8.154OfferedIncompatibleQosStatus Class Reference . . . . . . . . . . 1214
8.155OwnershipQosPolicy Class Reference . . . . . . . . . . . . . . . . 1216
8.156OwnershipQosPolicyKind Class Reference . . . . . . . . . . . . . 1223
8.157OwnershipStrengthQosPolicy Class Reference . . . . . . . . . . . 1225
8.158ParticipantBuiltinTopicData Class Reference . . . . . . . . . . . 1227
8.159ParticipantBuiltinTopicDataDataReader Class Reference . . . . . 1230
8.160ParticipantBuiltinTopicDataSeq Class Reference . . . . . . . . . 1231
8.161ParticipantBuiltinTopicDataTypeSupport Class Reference . . . . 1232
8.162PartitionQosPolicy Class Reference . . . . . . . . . . . . . . . . . 1233
8.163PresentationQosPolicy Class Reference . . . . . . . . . . . . . . . 1237
8.164PresentationQosPolicyAccessScopeKind Class Reference . . . . . 1242
8.165PRIVATE MEMBER Class Reference . . . . . . . . . . . . . . . 1244
8.166ProductVersion t Class Reference . . . . . . . . . . . . . . . . . . 1245
8.167ProfileQosPolicy Class Reference . . . . . . . . . . . . . . . . . . 1247
8.168Property t Class Reference . . . . . . . . . . . . . . . . . . . . . 1250
8.169PropertyQosPolicy Class Reference . . . . . . . . . . . . . . . . . 1252
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
xii CONTENTS
8.170PropertyQosPolicyHelper Class Reference . . . . . . . . . . . . . 1255
8.171PropertySeq Class Reference . . . . . . . . . . . . . . . . . . . . 1259
8.172ProtocolVersion t Class Reference . . . . . . . . . . . . . . . . . . 1260
8.173PUBLIC MEMBER Class Reference . . . . . . . . . . . . . . . . 1263
8.174PublicationBuiltinTopicData Class Reference . . . . . . . . . . . 1264
8.175PublicationBuiltinTopicDataDataReader Class Reference . . . . 1271
8.176PublicationBuiltinTopicDataSeq Class Reference . . . . . . . . . 1272
8.177PublicationBuiltinTopicDataTypeSupport Class Reference . . . . 1273
8.178PublicationMatchedStatus Class Reference . . . . . . . . . . . . . 1274
8.179Publisher Interface Reference . . . . . . . . . . . . . . . . . . . . 1277
8.180PublisherAdapter Class Reference . . . . . . . . . . . . . . . . . 1301
8.181PublisherListener Interface Reference . . . . . . . . . . . . . . . . 1302
8.182PublisherQos Class Reference . . . . . . . . . . . . . . . . . . . . 1303
8.183PublisherSeq Class Reference . . . . . . . . . . . . . . . . . . . . 1306
8.184PublishModeQosPolicy Class Reference . . . . . . . . . . . . . . 1308
8.185PublishModeQosPolicyKind Class Reference . . . . . . . . . . . . 1311
8.186Qos Class Reference . . . . . . . . . . . . . . . . . . . . . . . . . 1313
8.187QosPolicy Class Reference . . . . . . . . . . . . . . . . . . . . . . 1314
8.188QosPolicyCount Class Reference . . . . . . . . . . . . . . . . . . 1315
8.189QosPolicyCountSeq Class Reference . . . . . . . . . . . . . . . . 1317
8.190QosPolicyId t Class Reference . . . . . . . . . . . . . . . . . . . . 1318
8.191QueryCondition Interface Reference . . . . . . . . . . . . . . . . 1324
8.192ReadCondition Interface Reference . . . . . . . . . . . . . . . . . 1326
8.193ReaderDataLifecycleQosPolicy Class Reference . . . . . . . . . . 1328
8.194ReceiverPoolQosPolicy Class Reference . . . . . . . . . . . . . . . 1331
8.195RefilterQosPolicyKind Class Reference . . . . . . . . . . . . . . . 1334
8.196ReliabilityQosPolicy Class Reference . . . . . . . . . . . . . . . . 1336
8.197ReliabilityQosPolicyKind Class Reference . . . . . . . . . . . . . 1340
8.198ReliableReaderActivityChangedStatus Class Reference . . . . . . 1342
8.199ReliableWriterCacheChangedStatus Class Reference . . . . . . . 1345
8.200ReliableWriterCacheEventCount Class Reference . . . . . . . . . 1349
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
CONTENTS xiii
8.201RemoteParticipantPurgeKind Class Reference . . . . . . . . . . . 1350
8.202RequestedDeadlineMissedStatus Class Reference . . . . . . . . . 1353
8.203RequestedIncompatibleQosStatus Class Reference . . . . . . . . . 1354
8.204ResourceLimitsQosPolicy Class Reference . . . . . . . . . . . . . 1356
8.205RETCODE ALREADY DELETED Class Reference . . . . . . . 1362
8.206RETCODE BAD PARAMETER Class Reference . . . . . . . . . 1363
8.207RETCODE ERROR Class Reference . . . . . . . . . . . . . . . . 1364
8.208RETCODE ILLEGAL OPERATION Class Reference . . . . . . 1365
8.209RETCODE IMMUTABLE POLICY Class Reference . . . . . . . 1366
8.210RETCODE INCONSISTENT POLICY Class Reference . . . . . 1367
8.211RETCODE NO DATA Class Reference . . . . . . . . . . . . . . 1368
8.212RETCODE NOT ENABLED Class Reference . . . . . . . . . . . 1369
8.213RETCODE OUT OF RESOURCES Class Reference . . . . . . . 1370
8.214RETCODE PRECONDITION NOT MET Class Reference . . . 1371
8.215RETCODE TIMEOUT Class Reference . . . . . . . . . . . . . . 1372
8.216RETCODE UNSUPPORTED Class Reference . . . . . . . . . . 1373
8.217RtpsReliableReaderProtocol t Class Reference . . . . . . . . . . . 1374
8.218RtpsReliableWriterProtocol t Class Reference . . . . . . . . . . . 1378
8.219RtpsReservedPortKind Class Reference . . . . . . . . . . . . . . 1394
8.220RtpsWellKnownPorts t Class Reference . . . . . . . . . . . . . . 1396
8.221SampleIdentity t Class Reference . . . . . . . . . . . . . . . . . . 1402
8.222SampleInfo Class Reference . . . . . . . . . . . . . . . . . . . . . 1404
8.223SampleInfoSeq Class Reference . . . . . . . . . . . . . . . . . . . 1414
8.224SampleLostStatus Class Reference . . . . . . . . . . . . . . . . . 1415
8.225SampleLostStatusKind Class Reference . . . . . . . . . . . . . . . 1416
8.226SampleRejectedStatus Class Reference . . . . . . . . . . . . . . . 1422
8.227SampleRejectedStatusKind Class Reference . . . . . . . . . . . . 1424
8.228SampleStateKind Class Reference . . . . . . . . . . . . . . . . . . 1430
8.229Sequence Interface Reference . . . . . . . . . . . . . . . . . . . . 1432
8.230SequenceNumber t Class Reference . . . . . . . . . . . . . . . . . 1435
8.231ShmemTransport Interface Reference . . . . . . . . . . . . . . . . 1439
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
xiv CONTENTS
8.232ShmemTransport.Property t Class Reference . . . . . . . . . . . 1443
8.233ShortSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 1446
8.234StatusCondition Interface Reference . . . . . . . . . . . . . . . . 1452
8.235StatusKind Class Reference . . . . . . . . . . . . . . . . . . . . . 1455
8.236StringDataReader Class Reference . . . . . . . . . . . . . . . . . 1465
8.237StringDataWriter Class Reference . . . . . . . . . . . . . . . . . . 1468
8.238StringSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 1470
8.239StringTypeSupport Class Reference . . . . . . . . . . . . . . . . . 1473
8.240StructMember Class Reference . . . . . . . . . . . . . . . . . . . 1476
8.241Subscriber Interface Reference . . . . . . . . . . . . . . . . . . . . 1478
8.242SubscriberAdapter Class Reference . . . . . . . . . . . . . . . . . 1503
8.243SubscriberListener Interface Reference . . . . . . . . . . . . . . . 1504
8.244SubscriberQos Class Reference . . . . . . . . . . . . . . . . . . . 1506
8.245SubscriberSeq Class Reference . . . . . . . . . . . . . . . . . . . . 1508
8.246SubscriptionBuiltinTopicData Class Reference . . . . . . . . . . . 1510
8.247SubscriptionBuiltinTopicDataDataReader Class Reference . . . . 1517
8.248SubscriptionBuiltinTopicDataSeq Class Reference . . . . . . . . . 1518
8.249SubscriptionBuiltinTopicDataTypeSupport Class Reference . . . 1519
8.250SubscriptionMatchedStatus Class Reference . . . . . . . . . . . . 1520
8.251SystemException Class Reference . . . . . . . . . . . . . . . . . . 1523
8.252SystemResourceLimitsQosPolicy Class Reference . . . . . . . . . 1524
8.253TCKind Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1526
8.254ThreadSettings t Class Reference . . . . . . . . . . . . . . . . . . 1531
8.255ThreadSettingsCpuRotationKind Class Reference . . . . . . . . . 1534
8.256ThreadSettingsKind Class Reference . . . . . . . . . . . . . . . . 1536
8.257Time t Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 1538
8.258TimeBasedFilterQosPolicy Class Reference . . . . . . . . . . . . 1541
8.259Topic Interface Reference . . . . . . . . . . . . . . . . . . . . . . 1545
8.260TopicAdapter Class Reference . . . . . . . . . . . . . . . . . . . . 1550
8.261TopicBuiltinTopicData Class Reference . . . . . . . . . . . . . . . 1552
8.262TopicBuiltinTopicDataDataReader Class Reference . . . . . . . . 1556
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
CONTENTS xv
8.263TopicBuiltinTopicDataSeq Class Reference . . . . . . . . . . . . . 1557
8.264TopicBuiltinTopicDataTypeSupport Class Reference . . . . . . . 1558
8.265TopicDataQosPolicy Class Reference . . . . . . . . . . . . . . . . 1559
8.266TopicDescription Interface Reference . . . . . . . . . . . . . . . . 1561
8.267TopicListener Interface Reference . . . . . . . . . . . . . . . . . . 1564
8.268TopicQos Class Reference . . . . . . . . . . . . . . . . . . . . . . 1566
8.269Transport Interface Reference . . . . . . . . . . . . . . . . . . . . 1569
8.270Transport.Property t Class Reference . . . . . . . . . . . . . . . . 1570
8.271TransportBuiltinKind Class Reference . . . . . . . . . . . . . . . 1578
8.272TransportBuiltinQosPolicy Class Reference . . . . . . . . . . . . 1580
8.273TransportMulticastMapping t Class Reference . . . . . . . . . . . 1582
8.274TransportMulticastMappingFunction t Class Reference . . . . . . 1585
8.275TransportMulticastMappingQosPolicy Class Reference . . . . . . 1587
8.276TransportMulticastMappingSeq Class Reference . . . . . . . . . . 1589
8.277TransportMulticastQosPolicy Class Reference . . . . . . . . . . . 1590
8.278TransportMulticastQosPolicyKind Class Reference . . . . . . . . 1593
8.279TransportMulticastSettings t Class Reference . . . . . . . . . . . 1594
8.280TransportMulticastSettingsSeq Class Reference . . . . . . . . . . 1597
8.281TransportPriorityQosPolicy Class Reference . . . . . . . . . . . . 1598
8.282TransportSelectionQosPolicy Class Reference . . . . . . . . . . . 1600
8.283TransportSupport Class Reference . . . . . . . . . . . . . . . . . 1602
8.284TransportUnicastQosPolicy Class Reference . . . . . . . . . . . . 1605
8.285TransportUnicastSettings t Class Reference . . . . . . . . . . . . 1608
8.286TransportUnicastSettingsSeq Class Reference . . . . . . . . . . . 1610
8.287TypeCode Class Reference . . . . . . . . . . . . . . . . . . . . . . 1611
8.288TypeCodeFactory Class Reference . . . . . . . . . . . . . . . . . 1641
8.289TypeSupport Interface Reference . . . . . . . . . . . . . . . . . . 1651
8.290TypeSupportQosPolicy Class Reference . . . . . . . . . . . . . . 1652
8.291UDPv4Transport Interface Reference . . . . . . . . . . . . . . . . 1654
8.292UDPv4Transport.Property t Class Reference . . . . . . . . . . . 1658
8.293UDPv6Transport Interface Reference . . . . . . . . . . . . . . . . 1666
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
xvi CONTENTS
8.294UDPv6Transport.Property t Class Reference . . . . . . . . . . . 1670
8.295Union Class Reference . . . . . . . . . . . . . . . . . . . . . . . . 1677
8.296UnionMember Class Reference . . . . . . . . . . . . . . . . . . . 1678
8.297UserDataQosPolicy Class Reference . . . . . . . . . . . . . . . . 1680
8.298UserException Class Reference . . . . . . . . . . . . . . . . . . . 1682
8.299ValueMember Class Reference . . . . . . . . . . . . . . . . . . . . 1683
8.300VendorId t Class Reference . . . . . . . . . . . . . . . . . . . . . 1685
8.301Version Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1687
8.302ViewStateKind Class Reference . . . . . . . . . . . . . . . . . . . 1689
8.303VM ABSTRACT Class Reference . . . . . . . . . . . . . . . . . . 1691
8.304VM CUSTOM Class Reference . . . . . . . . . . . . . . . . . . . 1692
8.305VM NONE Class Reference . . . . . . . . . . . . . . . . . . . . . 1693
8.306VM TRUNCATABLE Class Reference . . . . . . . . . . . . . . . 1694
8.307WaitSet Class Reference . . . . . . . . . . . . . . . . . . . . . . . 1695
8.308WaitSetProperty t Class Reference . . . . . . . . . . . . . . . . . 1705
8.309WcharSeq Class Reference . . . . . . . . . . . . . . . . . . . . . . 1707
8.310WireProtocolQosPolicy Class Reference . . . . . . . . . . . . . . 1709
8.311WireProtocolQosPolicyAutoKind Class Reference . . . . . . . . . 1718
8.312WriteParams t Class Reference . . . . . . . . . . . . . . . . . . . 1719
8.313WriterDataLifecycleQosPolicy Class Reference . . . . . . . . . . . 1722
8.314WstringSeq Class Reference . . . . . . . . . . . . . . . . . . . . . 1725
9 Example Documentation 1727
9.1 HelloWorld.idl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1727
9.2 HelloWorldDataReader.java . . . . . . . . . . . . . . . . . . . . . 1729
9.3 HelloWorldPublisher.java . . . . . . . . . . . . . . . . . . . . . . 1744
9.4 HelloWorldSeq.java . . . . . . . . . . . . . . . . . . . . . . . . . . 1748
9.5 HelloWorldSubscriber.java . . . . . . . . . . . . . . . . . . . . . . 1753
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
Chapter 1
RTI Connext
Core Libraries and Utilities
Real-Time Innovations, Inc.
RTI Connext is network middleware for real-time distributed applications. Itprovides the communications services that programmers need to distribute time-critical data between embedded and/or enterprise devices or nodes. RTI Con-next uses the publish-subscribe communications model to make data distribu-tion efficient and robust.
The RTI Connext Application Programming Interface (API) is based on theOMG’s 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. 269) will provide direction on how to learnabout this product.
1.2.1 The PDF documents are:
What’s New. An overview of the new features in this release.
Release Notes. System requirements, compatibility, what’s 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.
User’s 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 Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
1.2 Available Documentation. 3
XML-Based Application Creation Getting Started Guide. Detailson how to use XML-Based Application Creation, an experimental featurein this release.
C API Reference Manual. A consolidated PDF version of the HTML CAPI reference documentation.
C++ API Reference Manual. A consolidated PDF version of the HTMLC++ API reference documentation.
Java API Reference Manual. A consolidate PDF version of the HTMLJava API reference documentation.
.NET API Reference Manual. A consolidated PDF version of the HTML.Net API reference documentation.
1.2.2 The HTML API Reference documentation contains:
DDS API Reference (p. 272) - The DDS API reference.
RTI Connext API Reference (p. 286) - RTI Connext API’s indepen-dent of the DDS standard.
Programming How-To’s (p. 287) - Describes and shows the commontasks done using the API.
Programming Tools (p. 289) - 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 Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
4 RTI Connext
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
Chapter 2
Module Index
2.1 Modules
Here is a list of all modules:
Thread Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Documentation Roadmap . . . . . . . . . . . . . . . . . . . . . . . . . 269Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270DDS API Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Domain Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . 145DomainParticipants . . . . . . . . . . . . . . . . . . . . . . . . 147Built-in Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Topic Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157Topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158User Data Type Support . . . . . . . . . . . . . . . . . . . . . 160Type Code Support . . . . . . . . . . . . . . . . . . . . . . . . 162Built-in Types . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
String Built-in Type . . . . . . . . . . . . . . . . . . . . . . . 135KeyedString Built-in Type . . . . . . . . . . . . . . . . . . . 136Octets Built-in Type . . . . . . . . . . . . . . . . . . . . . . . 137KeyedOctets Built-in Type . . . . . . . . . . . . . . . . . . . 138
Dynamic Data . . . . . . . . . . . . . . . . . . . . . . . . . . . 170Publication Module . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Publishers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176Data Writers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179Flow Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Subscription Module . . . . . . . . . . . . . . . . . . . . . . . . . . 186Subscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189DataReaders . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
-
6 Module Index
Read Conditions . . . . . . . . . . . . . . . . . . . . . . . . . 194Query Conditions . . . . . . . . . . . . . . . . . . . . . . . . . 195
Data Samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196Sample States . . . . . . . . . . . . . . . . . . . . . . . . . . . 197View States . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198Instance States . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Infrastructure Module . . . . . . . . . . . . . . . . . . . . . . . . . 200Conditions and WaitSets . . . . . . . . . . . . . . . . . . . . . 43Time Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Entity Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 68GUID Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Object Support . . . . . . . . . . . . . . . . . . . . . . . . . . . 82QoS Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
ASYNCHRONOUS PUBLISHER . . . . . . . . . . . . . . . 39AVAILABILITY . . . . . . . . . . . . . . . . . . . . . . . . . 41BATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42DATABASE . . . . . . . . . . . . . . . . . . . . . . . . . . . 44DATA READER PROTOCOL . . . . . . . . . . . . . . . . . 45DATA READER RESOURCE LIMITS . . . . . . . . . . . . 46DATA WRITER PROTOCOL . . . . . . . . . . . . . . . . . 48DATA WRITER RESOURCE LIMITS . . . . . . . . . . . . 49DEADLINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50DESTINATION ORDER . . . . . . . . . . . . . . . . . . . . 51DISCOVERY CONFIG . . . . . . . . . . . . . . . . . . . . . 52DISCOVERY . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
NDDS DISCOVERY PEERS . . . . . . . . . . . . . . . . 55DOMAIN PARTICIPANT RESOURCE LIMITS . . . . . . . 63DURABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . 65DURABILITY SERVICE . . . . . . . . . . . . . . . . . . . . 66ENTITY FACTORY . . . . . . . . . . . . . . . . . . . . . . . 69ENTITY NAME . . . . . . . . . . . . . . . . . . . . . . . . . 70EVENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71EXCLUSIVE AREA . . . . . . . . . . . . . . . . . . . . . . . 72GROUP DATA . . . . . . . . . . . . . . . . . . . . . . . . . . 73HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75LATENCY BUDGET . . . . . . . . . . . . . . . . . . . . . . 76LIFESPAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77LIVELINESS . . . . . . . . . . . . . . . . . . . . . . . . . . . 78LOCATORFILTER . . . . . . . . . . . . . . . . . . . . . . . 79LOGGING . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80MULTICHANNEL . . . . . . . . . . . . . . . . . . . . . . . . 81OWNERSHIP . . . . . . . . . . . . . . . . . . . . . . . . . . 83OWNERSHIP STRENGTH . . . . . . . . . . . . . . . . . . . 84PARTITION . . . . . . . . . . . . . . . . . . . . . . . . . . . 85PRESENTATION . . . . . . . . . . . . . . . . . . . . . . . . 86
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
2.1 Modules 7
PROFILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87PROPERTY . . . . . . . . . . . . . . . . . . . . . . . . . . . 88PUBLISH MODE . . . . . . . . . . . . . . . . . . . . . . . . 89READER DATA LIFECYCLE . . . . . . . . . . . . . . . . . 99RECEIVER POOL . . . . . . . . . . . . . . . . . . . . . . . 100RELIABILITY . . . . . . . . . . . . . . . . . . . . . . . . . . 101RESOURCE LIMITS . . . . . . . . . . . . . . . . . . . . . . 102SYSTEM RESOURCE LIMITS . . . . . . . . . . . . . . . . 111TIME BASED FILTER . . . . . . . . . . . . . . . . . . . . . 113TOPIC DATA . . . . . . . . . . . . . . . . . . . . . . . . . . 114TRANSPORT BUILTIN . . . . . . . . . . . . . . . . . . . . 115TRANSPORT MULTICAST . . . . . . . . . . . . . . . . . . 118TRANSPORT PRIORITY . . . . . . . . . . . . . . . . . . . 121TRANSPORT SELECTION . . . . . . . . . . . . . . . . . . 122TRANSPORT UNICAST . . . . . . . . . . . . . . . . . . . . 123TYPESUPPORT . . . . . . . . . . . . . . . . . . . . . . . . . 124USER DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . 126WIRE PROTOCOL . . . . . . . . . . . . . . . . . . . . . . . 128WRITER DATA LIFECYCLE . . . . . . . . . . . . . . . . . 134
Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103Sequence Number Support . . . . . . . . . . . . . . . . . . . . 105Status Kinds . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Exception Codes . . . . . . . . . . . . . . . . . . . . . . . . . . 127Sequence Support . . . . . . . . . . . . . . . . . . . . . . . . . 139
Built-in Sequences . . . . . . . . . . . . . . . . . . . . . . . . 202Queries and Filters Syntax . . . . . . . . . . . . . . . . . . . . . . 278
RTI Connext API Reference . . . . . . . . . . . . . . . . . . . . . . . . 286Clock Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Multi-channel DataWriters . . . . . . . . . . . . . . . . . . . . . . 204Pluggable Transports . . . . . . . . . . . . . . . . . . . . . . . . . 207
Using Transport Plugins . . . . . . . . . . . . . . . . . . . . . . 213Built-in Transport Plugins . . . . . . . . . . . . . . . . . . . . . 216
Configuration Utilities . . . . . . . . . . . . . . . . . . . . . . . . . 218Durability and Persistence . . . . . . . . . . . . . . . . . . . . . . . 219Configuring QoS Profiles with XML . . . . . . . . . . . . . . . . . 225
Programming How-To’s . . . . . . . . . . . . . . . . . . . . . . . . . . 287Publication Example . . . . . . . . . . . . . . . . . . . . . . . . . . 229Subscription Example . . . . . . . . . . . . . . . . . . . . . . . . . 230Participant Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 231Topic Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233FlowController Use Cases . . . . . . . . . . . . . . . . . . . . . . . 235Publisher Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 239DataWriter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 240Subscriber Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 242DataReader Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 245
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
8 Module Index
Entity Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249Waitset Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 253Transport Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . 255Filter Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257Creating Custom Content Filters . . . . . . . . . . . . . . . . . . . 263Large Data Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . 267
Programming Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289rtiddsgen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290rtiddsping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303rtiddsspy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
Chapter 3
Namespace Index
3.1 Package List
Here are the packages with brief descriptions (if available):
com.rti.dds.domain (Contains the com.rti.dds.domain.DomainParticipant(p. 629) class that acts as an entrypoint of RTI Connextand acts as a factory for many of the classes. Thecom.rti.dds.domain.DomainParticipant (p. 629) alsoacts as a container for the other objects that make up RTIConnext ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
com.rti.dds.domain.builtin (Builtin topic (p. 350) for accessing in-formation about the DomainParticipants discovered by RTIConnext ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
com.rti.dds.dynamicdata ( (p. 270) The Dy-namic Data API provides a way to interact with arbitrarilycomplex data types at runtime without the need for code gen-eration ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
com.rti.dds.infrastructure (Defines the abstract classes and the in-terfaces that are refined by the other modules. Contains com-mon definitions such as return codes, status values, and QoSpolicies ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
-
10 Namespace Index
com.rti.dds.publication (Contains thecom.rti.dds.publication.FlowController (p. 942),com.rti.dds.publication.Publisher (p. 1277),and com.rti.dds.publication.DataWriter(p. 538) classes as well as thecom.rti.dds.publication.PublisherListener (p. 1302)and com.rti.dds.publication.DataWriterListener(p. 566) interfaces, and more generally, all that is needed onthe publication (p. 338) side ) . . . . . . . . . . . . . . . . . 338
com.rti.dds.publication.builtin (Builtin topic (p. 350) for access-ing information about the Publications discovered by RTIConnext ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
com.rti.dds.publication.example . . . . . . . . . . . . . . . . . . 342
com.rti.dds.subscription (Contains thecom.rti.dds.subscription.Subscriber (p. 1478),com.rti.dds.subscription.DataReader (p. 473),com.rti.dds.subscription.ReadCondition (p. 1326),and com.rti.dds.subscription.QueryCondition(p. 1324) classes, as well as thecom.rti.dds.subscription.SubscriberListener (p. 1504)and com.rti.dds.subscription.DataReaderListener(p. 501) interfaces, and more generally, all that is needed onthe subscription (p. 343) side ) . . . . . . . . . . . . . . . . 343
com.rti.dds.subscription.builtin (Builtin topic (p. 350) for access-ing information about the Subscriptions discovered by RTIConnext ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
com.rti.dds.subscription.example . . . . . . . . . . . . . . . . . . 349
com.rti.dds.topic (Contains the com.rti.dds.topic.Topic(p. 1545), com.rti.dds.topic.ContentFilteredTopic(p. 458), and com.rti.dds.topic.MultiTopic (p. 1208)classes, the com.rti.dds.topic.TopicListener (p. 1564)interface, and more generally, all that is needed by anapplication to define com.rti.dds.topic.Topic (p. 1545)objects and attach QoS policies to them ) . . . . . . . . . . . 350
com.rti.dds.topic.builtin (Builtin topic (p. 350) for accessing infor-mation about the Topics discovered by RTI Connext ) . . . . 352
com.rti.dds.topic.example (Descriptions of Foo (p. 955), FooSeq(p. 1056), and FooTypeSupport (p. 1060), where Foo(p. 955) represents a user-defined data-type intended to bedistributed using DDS ) . . . . . . . . . . . . . . . . . . . . . 353
com.rti.dds.type.builtin ( (p. 270) RTI Connextprovides a set of very simple data types for you to use withthe topics in your application ) . . . . . . . . . . . . . . . . . 354
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
3.1 Package List 11
com.rti.dds.typecode ( (p. 270) A TypeCode(p. 1611) is a mechanism for representing a type at runtime.RTI Connext can use type codes to send type definitions onthe network. You will need to understand this API in order touse the Dynamic Data (p. 170) capability or to inspect thetype information you receive from remote readers and writers )360
com.rti.dds.util (Utility types that support the DDS API ) . . . . . 364com.rti.ndds.config (Utility API’s independent of the DDS standard )365com.rti.ndds.example (Programming HowTos: Code templates for
common use cases ) . . . . . . . . . . . . . . . . . . . . . . . . 366com.rti.ndds.transport (APIs related to RTI Connext pluggable
transports ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
12 Namespace Index
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
Chapter 4
Class Index
4.1 Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
AbstractBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . . . . 375ParticipantBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . 1232PublicationBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . 1273SubscriptionBuiltinTopicDataTypeSupport . . . . . . . . . . . . . 1519TopicBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . . . . 1558
AllocationSettings t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385BuiltinTopicReaderResourceLimits t . . . . . . . . . . . . . . . . . . . 414ChannelSettings t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441ChannelSettingsSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
StatusCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1452ReadCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1326
QueryCondition . . . . . . . . . . . . . . . . . . . . . . . . . . 1324ConditionSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452ContentFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454ContentFilterProperty t . . . . . . . . . . . . . . . . . . . . . . . . . . 463Cookie t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465Copyable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
DynamicData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 780InstanceHandle t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1080StringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1470
WstringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1725SampleInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1404BuiltinTopicKey t . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
-
14 Class Index
Bytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417BytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434KeyedBytes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1095KeyedBytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1116KeyedString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1123KeyedStringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1141AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . . . 377
BooleanSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405ByteSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428CharSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
WcharSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1707DoubleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 759
LongDoubleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1197FloatSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936IntSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1089LongSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1199ShortSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1446
Enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925DataWriterResourceLimitsInstanceReplacementKind . . . . . . 594DestinationOrderQosPolicyKind . . . . . . . . . . . . . . . . . 610DiscoveryPluginPromiscuityKind . . . . . . . . . . . . . . . . . 623DurabilityQosPolicyKind . . . . . . . . . . . . . . . . . . . . . 770HistoryQosPolicyKind . . . . . . . . . . . . . . . . . . . . . . . 1075LivelinessQosPolicyKind . . . . . . . . . . . . . . . . . . . . . . 1168OwnershipQosPolicyKind . . . . . . . . . . . . . . . . . . . . . 1223PresentationQosPolicyAccessScopeKind . . . . . . . . . . . . . 1242PublishModeQosPolicyKind . . . . . . . . . . . . . . . . . . . . 1311QosPolicyId t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1318RefilterQosPolicyKind . . . . . . . . . . . . . . . . . . . . . . . 1334ReliabilityQosPolicyKind . . . . . . . . . . . . . . . . . . . . . 1340RemoteParticipantPurgeKind . . . . . . . . . . . . . . . . . . . 1350ThreadSettingsCpuRotationKind . . . . . . . . . . . . . . . . . 1534TransportMulticastQosPolicyKind . . . . . . . . . . . . . . . . 1593WireProtocolQosPolicyAutoKind . . . . . . . . . . . . . . . . . 1718FlowControllerSchedulingPolicy . . . . . . . . . . . . . . . . . . 948SampleLostStatusKind . . . . . . . . . . . . . . . . . . . . . . . 1416SampleRejectedStatusKind . . . . . . . . . . . . . . . . . . . . 1424TCKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1526LogCategory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1185LogPrintFormat . . . . . . . . . . . . . . . . . . . . . . . . . . 1192LogVerbosity . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1195
Foo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 956FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1058
DataReaderCacheStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 500DataReaderProtocolStatus . . . . . . . . . . . . . . . . . . . . . . . . 508
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
4.1 Class Hierarchy 15
DataReaderSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536DataWriterCacheStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 565DataWriterProtocolStatus . . . . . . . . . . . . . . . . . . . . . . . . . 576DiscoveryBuiltinReaderFragmentationResourceLimits t . . . . . . . . 612DiscoveryConfigBuiltinPluginKind . . . . . . . . . . . . . . . . . . . . 614DomainParticipantFactory . . . . . . . . . . . . . . . . . . . . . . . . . 708Duration t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776DynamicDataInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 844DynamicDataMemberInfo . . . . . . . . . . . . . . . . . . . . . . . . . 846DynamicDataProperty t . . . . . . . . . . . . . . . . . . . . . . . . . . 849DynamicDataTypeProperty t . . . . . . . . . . . . . . . . . . . . . . . 883DynamicDataTypeSerializationProperty t . . . . . . . . . . . . . . . . 885EndpointGroup t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 909EndpointGroupSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 912
DomainParticipant . . . . . . . . . . . . . . . . . . . . . . . . . . . 629DomainEntity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
DataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538DynamicDataWriter . . . . . . . . . . . . . . . . . . . . . . . 893BytesDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . 424KeyedBytesDataWriter . . . . . . . . . . . . . . . . . . . . . 1106KeyedStringDataWriter . . . . . . . . . . . . . . . . . . . . . 1133StringDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . 1468FooDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . 1021
Publisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1277DataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
DynamicDataReader . . . . . . . . . . . . . . . . . . . . . . . 851BytesDataReader . . . . . . . . . . . . . . . . . . . . . . . . . 420KeyedBytesDataReader . . . . . . . . . . . . . . . . . . . . . 1098KeyedStringDataReader . . . . . . . . . . . . . . . . . . . . . 1125StringDataReader . . . . . . . . . . . . . . . . . . . . . . . . 1465FooDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . 958
Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1478Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1545
EnumMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928FlowController . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942FlowControllerProperty t . . . . . . . . . . . . . . . . . . . . . . . . . 946FlowControllerTokenBucketProperty t . . . . . . . . . . . . . . . . . . 951Foo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955FooDataReader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988FooDataWriter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1040FooTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1060FooTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1063GuardCondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1066GUID t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1069
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
16 Class Index
InconsistentTopicStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 1077InetAddressSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1079InstanceHandleSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1083InstanceStateKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1086LibraryVersion t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1150Listener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1154
DataWriterListener . . . . . . . . . . . . . . . . . . . . . . . . . . . 566DataWriterAdapter . . . . . . . . . . . . . . . . . . . . . . . . 560
PublisherAdapter . . . . . . . . . . . . . . . . . . . . . . . . . 1301PublisherListener . . . . . . . . . . . . . . . . . . . . . . . . . . 1302
DomainParticipantListener . . . . . . . . . . . . . . . . . . . 734DomainParticipantAdapter . . . . . . . . . . . . . . . . . 703
PublisherAdapter . . . . . . . . . . . . . . . . . . . . . . . . . 1301DataReaderListener . . . . . . . . . . . . . . . . . . . . . . . . . . 501
DataReaderAdapter . . . . . . . . . . . . . . . . . . . . . . . . 497SubscriberAdapter . . . . . . . . . . . . . . . . . . . . . . . . 1503
DomainParticipantAdapter . . . . . . . . . . . . . . . . . 703SubscriberListener . . . . . . . . . . . . . . . . . . . . . . . . . 1504
DomainParticipantListener . . . . . . . . . . . . . . . . . . . 734SubscriberAdapter . . . . . . . . . . . . . . . . . . . . . . . . 1503
TopicListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1564DomainParticipantListener . . . . . . . . . . . . . . . . . . . . 734TopicAdapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1550
EntityHowTo.MyEntityListener . . . . . . . . . . . . . . . . . . . . 922LivelinessChangedStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 1159LivelinessLostStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1162Locator t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1174LocatorFilter t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1178LocatorFilterSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1183LocatorSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1184Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1187ObjectHolder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1211OfferedDeadlineMissedStatus . . . . . . . . . . . . . . . . . . . . . . . 1212OfferedIncompatibleQosStatus . . . . . . . . . . . . . . . . . . . . . . 1214ParticipantBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . 1227ParticipantBuiltinTopicDataDataReader . . . . . . . . . . . . . . . . . 1230ParticipantBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . 1231PRIVATE MEMBER . . . . . . . . . . . . . . . . . . . . . . . . . . . 1244ProductVersion t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1245Property t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1250PropertyQosPolicyHelper . . . . . . . . . . . . . . . . . . . . . . . . . 1255PropertySeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1259ProtocolVersion t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1260PUBLIC MEMBER . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1263PublicationBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . 1264
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
4.1 Class Hierarchy 17
PublicationBuiltinTopicDataDataReader . . . . . . . . . . . . . . . . . 1271PublicationBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . 1272PublicationMatchedStatus . . . . . . . . . . . . . . . . . . . . . . . . . 1274PublisherSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1306Qos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1313
DomainParticipantFactoryQos . . . . . . . . . . . . . . . . . . . . 732DomainParticipantQos . . . . . . . . . . . . . . . . . . . . . . . . . 736DataWriterQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588PublisherQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1303DataReaderQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518SubscriberQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1506TopicQos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1566
QosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1314AsynchronousPublisherQosPolicy . . . . . . . . . . . . . . . . . . . 387AvailabilityQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 392BatchQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401DatabaseQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 468DataReaderProtocolQosPolicy . . . . . . . . . . . . . . . . . . . . 504DataReaderResourceLimitsQosPolicy . . . . . . . . . . . . . . . . . 524DataWriterProtocolQosPolicy . . . . . . . . . . . . . . . . . . . . . 571DataWriterResourceLimitsQosPolicy . . . . . . . . . . . . . . . . . 598DeadlineQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 604DestinationOrderQosPolicy . . . . . . . . . . . . . . . . . . . . . . 607DiscoveryConfigQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 615DiscoveryQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 624DomainParticipantResourceLimitsQosPolicy . . . . . . . . . . . . . 741DurabilityQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 765DurabilityServiceQosPolicy . . . . . . . . . . . . . . . . . . . . . . 773EntityFactoryQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 919EntityNameQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 923EventQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 930ExclusiveAreaQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 933GroupDataQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 1064HistoryQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1071LatencyBudgetQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 1148LifespanQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1152LivelinessQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1164LocatorFilterQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 1181LoggingQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1190MultiChannelQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 1205OwnershipQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 1216OwnershipStrengthQosPolicy . . . . . . . . . . . . . . . . . . . . . 1225PartitionQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1233PresentationQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 1237ProfileQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1247
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
18 Class Index
PropertyQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1252PublishModeQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 1308ReaderDataLifecycleQosPolicy . . . . . . . . . . . . . . . . . . . . 1328ReceiverPoolQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . 1331ReliabilityQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 1336ResourceLimitsQosPolicy . . . . . . . . . . . . . . . . . . . . . . . 1356SystemResourceLimitsQosPolicy . . . . . . . . . . . . . . . . . . . 1524TimeBasedFilterQosPolicy . . . . . . . . . . . . . . . . . . . . . . 1541TopicDataQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . 1559TransportBuiltinQosPolicy . . . . . . . . . . . . . . . . . . . . . . 1580TransportMulticastMappingQosPolicy . . . . . . . . . . . . . . . . 1587TransportMulticastQosPolicy . . . . . . . . . . . . . . . . . . . . . 1590TransportPriorityQosPolicy . . . . . . . . . . . . . . . . . . . . . . 1598TransportSelectionQosPolicy . . . . . . . . . . . . . . . . . . . . . 1600TransportUnicastQosPolicy . . . . . . . . . . . . . . . . . . . . . . 1605TypeSupportQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 1652UserDataQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . . . . 1680WireProtocolQosPolicy . . . . . . . . . . . . . . . . . . . . . . . . 1709WriterDataLifecycleQosPolicy . . . . . . . . . . . . . . . . . . . . . 1722
QosPolicyCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1315QosPolicyCountSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1317ReliableReaderActivityChangedStatus . . . . . . . . . . . . . . . . . . 1342ReliableWriterCacheChangedStatus . . . . . . . . . . . . . . . . . . . 1345ReliableWriterCacheEventCount . . . . . . . . . . . . . . . . . . . . . 1349RequestedDeadlineMissedStatus . . . . . . . . . . . . . . . . . . . . . 1353RequestedIncompatibleQosStatus . . . . . . . . . . . . . . . . . . . . . 1354RETCODE ERROR . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1364
RETCODE ALREADY DELETED . . . . . . . . . . . . . . . . . 1362RETCODE BAD PARAMETER . . . . . . . . . . . . . . . . . . . 1363RETCODE ILLEGAL OPERATION . . . . . . . . . . . . . . . . 1365RETCODE IMMUTABLE POLICY . . . . . . . . . . . . . . . . . 1366RETCODE INCONSISTENT POLICY . . . . . . . . . . . . . . . 1367RETCODE NO DATA . . . . . . . . . . . . . . . . . . . . . . . . 1368RETCODE NOT ENABLED . . . . . . . . . . . . . . . . . . . . . 1369RETCODE OUT OF RESOURCES . . . . . . . . . . . . . . . . . 1370RETCODE PRECONDITION NOT MET . . . . . . . . . . . . . 1371RETCODE TIMEOUT . . . . . . . . . . . . . . . . . . . . . . . . 1372RETCODE UNSUPPORTED . . . . . . . . . . . . . . . . . . . . . 1373
RtpsReliableReaderProtocol t . . . . . . . . . . . . . . . . . . . . . . . 1374RtpsReliableWriterProtocol t . . . . . . . . . . . . . . . . . . . . . . . 1378RtpsReservedPortKind . . . . . . . . . . . . . . . . . . . . . . . . . . . 1394RtpsWellKnownPorts t . . . . . . . . . . . . . . . . . . . . . . . . . . 1396SampleIdentity t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1402SampleLostStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1415SampleRejectedStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . 1422
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
4.1 Class Hierarchy 19
SampleStateKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1430Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1432
DynamicDataSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . 881SampleInfoSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1414FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056BytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434KeyedBytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1116KeyedStringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1141AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . . . 377AbstractSequence . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . 377LoanableSequence . . . . . . . . . . . . . . . . . . . . . . . . . 1170
SampleInfoSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1414FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056BytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434KeyedBytesSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1116KeyedStringSeq . . . . . . . . . . . . . . . . . . . . . . . . . . 1141FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1058
FooSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1058SequenceNumber t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1435StatusKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1455StructMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1476SubscriberSeq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1508SubscriptionBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . 1510SubscriptionBuiltinTopicDataDataReader . . . . . . . . . . . . . . . . 1517SubscriptionBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . 1518SubscriptionMatchedStatus . . . . . . . . . . . . . . . . . . . . . . . . 1520SystemException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1523
BAD PARAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396BAD TYPECODE . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
ThreadSettings t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1531ThreadSettingsKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1536Time t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1538TopicBuiltinTopicData . . . . . . . . . . . . . . . . . . . . . . . . . . . 1552TopicBuiltinTopicDataDataReader . . . . . . . . . . . . . . . . . . . . 1556TopicBuiltinTopicDataSeq . . . . . . . . . . . . . . . . . . . . . . . . . 1557TopicDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1561
ContentFilteredTopic . . . . . . . . . . . . . . . . . . . . . . . . . 458MultiTopic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1208Topic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1545
Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1569ShmemTransport . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1439UDPv4Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1654UDPv6Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1666
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
20 Class Index
Transport.Property t . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1570ShmemTransport.Property t . . . . . . . . . . . . . . . . . . . . . 1443UDPv4Transport.Property t . . . . . . . . . . . . . . . . . . . . . 1658UDPv6Transport.Property t . . . . . . . . . . . . . . . . . . . . . 1670
TransportBuiltinKind . . . . . . . . . . . . . . . . . . . . . . . . . . . 1578TransportMulticastMapping t . . . . . . . . . . . . . . . . . . . . . . . 1582TransportMulticastMappingFunction t . . . . . . . . . . . . . . . . . . 1585TransportMulticastMappingSeq . . . . . . . . . . . . . . . . . . . . . . 1589TransportMulticastSettings t . . . . . . . . . . . . . . . . . . . . . . . 1594TransportMulticastSettingsSeq . . . . . . . . . . . . . . . . . . . . . . 1597TransportSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1602TransportUnicastSettings t . . . . . . . . . . . . . . . . . . . . . . . . 1608TransportUnicastSettingsSeq . . . . . . . . . . . . . . . . . . . . . . . 1610TypeCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1611TypeCodeFactory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1641TypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1651
DynamicDataTypeSupport . . . . . . . . . . . . . . . . . . . . . . 887BytesTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . 437KeyedBytesTypeSupport . . . . . . . . . . . . . . . . . . . . . . . 1119KeyedStringTypeSupport . . . . . . . . . . . . . . . . . . . . . . . 1144StringTypeSupport . . . . . . . . . . . . . . . . . . . . . . . . . . . 1473
Union . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1677UnionMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1678UserException . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1682
BadKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398BadMemberId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399BadMemberName . . . . . . . . . . . . . . . . . . . . . . . . . . . 400Bounds . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
ValueMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1683VendorId t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1685Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1687ViewStateKind . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1689VM ABSTRACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1691VM CUSTOM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1692VM NONE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1693VM TRUNCATABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . 1694WaitSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1695WaitSetProperty t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1705WriteParams t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1719
Generated on Sat Mar 17 21:18:59 2012 for RTI Connext Java API by Doxygen
-
Chapter 5
Class Index
5.1 Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
AbstractBuiltinTopicDataTypeSupport . . . . . . . . . . . . . . 375AbstractPrimitiveSequence . . . . . . . . . . . . . . . . . . . . . 377AbstractSequence (Abstract sequence ) . . . . . . . . . . . . . . . . 382AllocationSettings t (Resource allocation settings ) . . . . . . . . . 385AsynchronousPublisherQosPolicy (Configures the mechanism
that sends user data in an external middleware thread ) . . . 387AvailabilityQosPolicy (Configures the availability of data ) . . . . . 392BAD PARAM (The exception BadKind (p. 398) is thrown when
an inappropriate operation is invoked on a TypeCode object ) 396BAD TYPECODE (The exception BadKind (p. 398) is thrown
when an inappropriate operation is invoked on a TypeCodeobject ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
BadKind (The exception BadKind (p. 398) is thrown when an inap-propriate operation is invoked on a TypeCode object ) . . . . 398
BadMemberId (The specified TypeCode member ID is invalid ) . . 399BadMemberName (The specified TypeCode member name is invalid )400BatchQosPolicy (Used to configure batching of multiple samples into
a single network packet in order to increase throughput forsmall samples ) . . . . . . . . . . . . . . . . . . . . . . . . . . 401
BooleanSeq (Instantiates com.rti.dds.util.Sequence (p. 1432)< boolean > ) . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Bounds (A user exception thrown when a parameter is not within thelegal bounds ) . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
BuiltinTopicKey t (The key type of the built-in topic (p. 350) types )412
-
22 Class Index
BuiltinTopicReaderResourceLimits t (Built-in topic (p. 350)reader’s resource limits ) . . . . . . . . . . . . . . . . . . . . . 414
Bytes (Built-in type consisting of a variable-length array of opaquebytes ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
BytesDataReader ( (p. 271) InstantiatesDataReader < com.rti.dds.type.builtin.Bytes (p. 417) > ) 420
BytesDataWriter ( (p. 271) InstantiatesDataWriter < com.rti.dds.type.builtin.Bytes (p. 417) > ) 424
ByteSeq (Instantiates com.rti.dds.util.Sequence (p. 1432) <byte > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
BytesSeq (Instantiates com.rti.dds.util.Sequence (p. 1432) <com.rti.dds.type.builtin.Bytes (p. 417) > ) . . . . . . . . 434
BytesTypeSupport ( (p. 271)com.rti.dds.type.builtin.Bytes (p. 417) type support) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
ChannelSettings t (Type used to configure the properties of a chan-nel ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
ChannelSettingsSeq (Declares IDL sequence<com.rti.dds.infrastructure.ChannelSettings t (p. 441)> ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
CharSeq (Instantiates com.rti.dds.util.Sequence (p. 1432) <char > ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
Condition ( (p. 271) Root class forall the conditions that may be attached to acom.rti.dds.infrastructure.WaitSet (p. 1695) ) . . . . . . 451
ConditionSeq (Instantiates com.rti.dds.util.Sequence (p. 1432)< com.rti.dds.infrastructure.Condition (p. 451) > ) . . . 452
ContentFilter ( (p. 271) Inter-face to be used by a custom filter of acom.rti.dds.topic.ContentFilteredTopic (p. 458) ) . . . . 454
ContentFilteredTopic ( (p. 271) Specialization ofcom.rti.dds.topic.TopicDescription (p. 1561) that allowsfor content-based subscriptions ) . . . . . . . . . . . . . . . . 458
ContentFilterProperty t ( (p. 270) Type usedto provide all the required information to enable content fil-tering ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Cookie t ( (p. 270) Sequence of bytes identifyinga written data sample, used when writing with parameters ) . 465
Copyable ( (p. 270) (p. 271) In-terface for all the user-defined da