CoreDX DDS for Java
from Twin Oaks Computing, Inc.

Package com.toc.coredx.DDS

Welcome to the CoreDX DDS for Java API documentation from Twin Oaks Computing, Inc.

See:
          Description

Interface Summary
DataReaderListener The DDS_DataReaderListener provides asynchronous notification of DDS_DataReader events.
DataWriterListener The DDS_DataWriterListener provides asynchronous notification of DDS_DataWriter events.
DomainParticipantListener The DDS_DomainParticipantListener provides asynchronous notification of DDS_DomainParticipant events.
PublisherListener The DDS_PublisherListener provides asynchronous notification of DDS_Publisher events.
SubscriberListener The DDS_SubscriberListener provides asynchronous notification of DDS_Subscriber events.
TopicDescription TopicDescription is an abstract that provides the foundation for Topic, ContentFilteredTopic, and MultiTopic.
TopicListener The DDS_TopicListener provides asynchronous notification of DDS_Topic events.
TypeSupport The TypeSupport interface is implemented by an application defined data type specific TypeSupport class.
 

Class Summary
Condition A DDS_Condition can be added to a DDS_WaitSet to provide synchronous event notification.
ContentFilteredTopic MultiTopic provides a topic that may include data from multiple Topics.
DataReader The DataReader entity allows the application to subscribe to and read data.
DataReaderQos Structure that holds DDS_DataReader Quality of Service policies.
DataWriter The DataWriter entity provides an interface for the application to publish (write) data.
DataWriterQos Structure that holds DDS_DataWriter Quality of Service policies.
DDS Provides various constants and utility routines used throughout CoreDX DDS.
DeadlineQosPolicy This QoS policy establishes a minimum update period for data instances.
Debug  
DestinationOrderQosPolicy This QoS policy controls how each Subscriber orders received data samples.
DomainEntity Base class for all DDS Domain Entities.
DomainId_t Identifies a DDS Domain.
DomainParticipant The DomainParticipant is used to configure, create and destroy Publisher, Subscriber and Topic objects.
DomainParticipantFactory DomainParticipantFactory constructs DomainParticipants.
DomainParticipantFactoryQos Structure that holds DDS_DomainParticipantFactory Quality of Service policies.
DomainParticipantQos Structure that holds DDS_DomainParticipant Quality of Service policies.
DurabilityQosPolicy The DurablityQosPolicy controls the durablity of data.
DurabilityServiceQosPolicy The DurablityServiceQosPolicy supports the durablity of data.
Duration_t Represents a time duration with nanosecond resolution.
Entity Base class for all DDS Entities.
EntityFactoryQosPolicy Controls the behavior of entity factories.
EntityNameQosPolicy Assigns a name to an Entity.
FooDataReader The FooDataReader is an example specialized DataReader (generated by the coredx_ddl compiler) for reading data samples of type 'Foo'.
FooDataWriter The FooDataWriter is an example specialized DataWriter (generated by the coredx_ddl compiler) for writing data samples of type 'Foo'.
FooTypeSupport The FooTypeSupport class impliments the TypeSupport inteface for the Data Type 'Foo'.
GroupDataQosPolicy Allows the application to attach arbitrary information to a Publisher or Subscriber.
GuardCondition A GuardCondition is a Condition where the trigger_value is under application control.
HistoryQosPolicy Controls the ammount of historical data maintained by a DataReader or DataWriter.
InconsistentTopicStatus InconsistentTopicStatus provides status related to the on_inconsistent_topic listener methods of the TopicListener structure.
InstanceHandle_t Used to identify a DDS Entity or data instance.
KeyMap Used internally by CoreDX DDS.
LatencyBudgetQosPolicy Specifies allowable latency.
LifespanQosPolicy Specifies the maximum duration of validity of the data written by the DataWriter.
LivelinessChangedStatus Status related to the on_liveliness_changed listener methods of the DDS_DataReader, DDS_Subscriber, and DDS_DomainParticipant structures.
LivelinessLostStatus Status related to the on_liveliness_lost listener methods of the DDS_DataWriter, DDS_Publisher, and DDS_DomainParticipant structures.
LivelinessQosPolicy Determines the mechanism and parameters used by the application to determine whether an Entity is alive.
Locator  
LoggingQosPolicy  
MultiTopic MultiTopic is not currently implemented.
OfferedDeadlineMissedStatus Status related to the on_offered_deadline_missed listener methods of the DDS_DataWriter, DDS_Publisher, and DDS_DomainParticipant structures.
OfferedIncompatibleQosStatus Status related to the on_offered_incompatible_qos listener methods of the DDS_DataWriter, DDS_Publisher, and DDS_DomainParticipant structures.
OwnershipQosPolicy CoreDX DDS supports SHARED_OWNERSHIP_QOS.
OwnershipStrengthQosPolicy CoreDX DDS currently does not support the OwnershipStrength QoS.
ParticipantBuiltinTopicData  
ParticipantLocator  
PartitionQosPolicy Defines a logical data partition.
PeerParticipantQosPolicy  
PresentationQosPolicy Controls the presentation of received data samples to the application.
PublicationBuiltinTopicData  
PublicationMatchedStatus Status related to the on_publication_matched listener methods of the DDS_DataWriter, DDS_Publisher, and DDS_DomainParticipant structures.
Publisher The Publisher configures, creates, manages and destroys DataWriters.
PublisherQos Structure that holds DDS_Publisher Quality of Service policies.
QosPolicyCount  
QueryCondition The trigger_value is driven by the data available, after applying the filter, in the associated DataReader.
ReadCondition A DDS_ReadCondition is a specialized DDS_Condition associated with a DDS_DataReader.
ReaderDataLifecycleQosPolicy Specifies the lifecycle behavior of data instances managed by the DataReader.
ReliabilityQosPolicy Indicates the level of reliability offered/provided by the Entity.
RequestedDeadlineMissedStatus Status related to the on_requested_deadline_missed listener methods of the DDS_DataReader, DDS_Subscriber, and DDS_DomainParticipant structures.
RequestedIncompatibleQosStatus Status related to the on_requested_incompatible_qos listener methods of the DDS_DataReader, DDS_Subscriber, and DDS_DomainParticipant structures.
ResourceLimitsQosPolicy Specifies the resources that the Service can use to maintain data samples and instances.
SampleInfo The SampleInfo structure contains information associated with each Sample.
SampleInfoSeq  
SampleLostStatus Status related to the on_sample_lost listener methods of the DDS_DataReader, DDS_Subscriber, and DDS_DomainParticipant structures.
SampleRejectedStatus Status related to the on_sample_rejected listener methods of the DDS_DataReader, DDS_Subscriber, and DDS_DomainParticipant structures.
SampleSeq  
StatusCondition A StatusCondition is a condition associated with an Entity.
Subscriber The Subscriber configures, creates, manages and destroys DataReaders.
SubscriberQos Structure that holds DDS_Subscriber Quality of Service policies.
SubscriptionBuiltinTopicData  
SubscriptionMatchedStatus Status related to the on_subscription_matched listener methods of the DDS_DataReader, DDS_Subscriber, and DDS_DomainParticipant structures.
Time_t Represents time with nanosecond resolution.
TimeBasedFilterQosPolicy Defines a filter based on time between samples.
Topic Topic is the basic description of data to be published or subscribed.
TopicBuiltinTopicData  
TopicDataQosPolicy Allows the application to attach arbitrary information to a Topic.
TopicQos Structure that holds DDS_Topic Quality of Service policies.
TransportPriorityQosPolicy A hint to the middleware to help configure the transport priority mechanism.
UserDataQosPolicy Allows the application to attach arbitrary information to a DomainParticipant, DataWriter or DataReader.
WaitSet A DDS_WaitSet maintains a set of Condition objects and allows the application to wait until one or more of them have a trigger_value of TRUE.
WriterDataLifecycleQosPolicy Specifies the lifecycle behavior of data instances managed by the DataWriter.
 

Enum Summary
DestinationOrderQosPolicyKind  
DurabilityQosPolicyKind  
HistoryQosPolicyKind  
LivelinessQosPolicyKind  
LocatorKind  
OwnershipQosPolicyKind  
PresentationQosPolicyAccessScopeKind  
ReliabilityQosPolicyKind  
ReturnCode_t  
SampleRejectedStatusKind  
 

Package com.toc.coredx.DDS Description

Welcome to the CoreDX DDS for Java API documentation from Twin Oaks Computing, Inc.

Introduction

CoreDX DDS is a small-footprint, high-performance communications middleware compliant with the OMG Data Distribution Service (DDS) standard. CoreDX DDS supports multiple hardware architectures and operating systems, and is intended to facilitate the development of robust, near real-time, highly distributed systems.

This is the CoreDX DDS for Java Reference Manual. It provides a detailed reference for the CoreDX Data Distribution Service implementation from Twin Oaks Computing, Inc. The manual includes documentation on all of the CoreDX DDS data types and Application Programming Interface (API) routines.

The CoreDX DDS Programmers Guide provides more information on using the CoreDX API and related tools to produce a complete DDS enabled application.

The CoreDX DDS software provides a high-throughput, standards compliant, data communications infrastructure. CoreDX DDS offers the tools you need to realize Open Architecture goals. Built with a focus on performance, the CoreDX DDS software delivers a quality implementation of the OMG Data Distribution Service (DDS) standard.

The CoreDX DDS software implements the essential Data-Centric Publish-Subscribe (DCPS) communications layer as documented in the OMG DDS Standard. This standalone package, provides everything needed to integrate QoS enabled, Publish-Subscribe messaging into an application. The core software is written in the C language, and is optimized to be small and fast. The core package includes C and C++ language bindings for application integration. This reference manual describes the CoreDX DDS "Java" language binding.

Intended Audience

This document is intended for software developers who are integrating the CoreDX DDS software into their application(s). The reference manual that the reader is competent in programming languages and software development concepts. CoreDX DDS supports multiple languages, and this reference manual focuses on the Java programming language.

Contents

The reference documentation includes information on the following API constructs:

  1. Entities.This includes the primary objects with which an application must interact to enable DDS publish-subscribe communications.

  2. Quality of Service. This section documents the Quality of Service (QoS) structures that configure the behavior of the CoreDX middleware.

  3. Listeners and Events. This section covers the various structures and concepts involved in delivering events to the application.

  4. Status. This section describes the types of status maintained by the infrastructure.

  5. Miscellaneous. This section includes miscellaneous support objects.


Copyright © 2010 Twin Oaks Computing, Inc,
All Rights Reserved