Uses of Class
org.omg.dds.core.InstanceHandle

Packages that use InstanceHandle

Package	Description
org.omg.dds.core	The Core (Infrastructure) Module defines the abstract classes and the interfaces that are refined by the other modules.
org.omg.dds.core.status	Statuses may be classified as: Read communication statuses: i.e., those that are related to arrival of data, namely DataOnReadersEvent and DataAvailableEvent.
org.omg.dds.domain	The Domain Module contains the DomainParticipant class that acts as an entry-point of the Service and acts as a factory for many of the classes.
org.omg.dds.pub	The Publication Module contains the Publisher and DataWriter interfaces as well as the PublisherListener and DataWriterListener interfaces, and more generally, all that is needed on the publication side.
org.omg.dds.sub	The Subscription Module contains the Subscriber, DataReader, ReadCondition, and QueryCondition interfaces, as well as the SubscriberListener and DataReaderListener interfaces, and more generally, all that is needed on the subscription side.

Uses of InstanceHandle in org.omg.dds.core

Subclasses of InstanceHandle in org.omg.dds.core

Modifier and Type	Class and Description
class	ModifiableInstanceHandle

Methods in org.omg.dds.core that return InstanceHandle

Modifier and Type	Method and Description
InstanceHandle	Entity.getInstanceHandle()
abstract InstanceHandle	ModifiableInstanceHandle.immutableCopy()
InstanceHandle	ServiceEnvironment.ServiceProviderInterface.nilHandle()
static InstanceHandle	InstanceHandle.nilHandle(ServiceEnvironment env)

Methods in org.omg.dds.core with parameters of type InstanceHandle

Modifier and Type	Method and Description
abstract void	ModifiableInstanceHandle.copyFrom(InstanceHandle src) Overwrite the state of this object with that of the given object.

Uses of InstanceHandle in org.omg.dds.core.status

Methods in org.omg.dds.core.status that return InstanceHandle

Modifier and Type	Method and Description
abstract InstanceHandle	SampleRejectedStatus.getLastInstanceHandle() Handle to the instance being updated by the last sample that was rejected.
abstract InstanceHandle	RequestedDeadlineMissedStatus.getLastInstanceHandle() Handle to the last instance in the DataReader for which a deadline was detected.
abstract InstanceHandle	OfferedDeadlineMissedStatus.getLastInstanceHandle() Handle to the last instance in the DataWriter for which an offered deadline was missed.
abstract InstanceHandle	SubscriptionMatchedStatus.getLastPublicationHandle() Handle to the last DataWriter that matched the DataReader, causing the status to change.
abstract InstanceHandle	LivelinessChangedStatus.getLastPublicationHandle() Handle to the last DataWriter whose change in liveliness caused this status to change.
abstract InstanceHandle	PublicationMatchedStatus.getLastSubscriptionHandle() Handle to the last DataReader that matched the DataWriter, causing the status to change.

Uses of InstanceHandle in org.omg.dds.domain

Methods in org.omg.dds.domain that return types with arguments of type InstanceHandle

Modifier and Type	Method and Description
Set<InstanceHandle>	DomainParticipant.getDiscoveredParticipants() This operation retrieves the list of DomainParticipants that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the DomainParticipant.ignoreParticipant(InstanceHandle) operation.
Set<InstanceHandle>	DomainParticipant.getDiscoveredTopics() This operation retrieves the list of Topics that have been discovered in the domain and that the application has not indicated should be "ignored" by means of the DomainParticipant.ignoreTopic(InstanceHandle) operation.

Methods in org.omg.dds.domain with parameters of type InstanceHandle

Modifier and Type	Method and Description
boolean	DomainParticipant.containsEntity(InstanceHandle handle) This operation checks whether or not the given handle represents an Entity that was created from the DomainParticipant.
ParticipantBuiltinTopicData	DomainParticipant.getDiscoveredParticipantData(InstanceHandle participantHandle) This operation retrieves information on a DomainParticipant that has been discovered on the network.
TopicBuiltinTopicData	DomainParticipant.getDiscoveredTopicData(InstanceHandle topicHandle) This operation retrieves information on a Topic that has been discovered on the network.
void	DomainParticipant.ignoreParticipant(InstanceHandle handle) This operation allows an application to instruct the Service to locally ignore a remote domain participant.
void	DomainParticipant.ignorePublication(InstanceHandle handle) This operation allows an application to instruct the Service to locally ignore a remote publication; a publication is defined by the association of a topic name, and user data and partition set on the Publisher.
void	DomainParticipant.ignoreSubscription(InstanceHandle handle) This operation allows an application to instruct the Service to locally ignore a remote subscription; a subscription is defined by the association of a topic name, and user data and partition set on the Subscriber.
void	DomainParticipant.ignoreTopic(InstanceHandle handle) This operation allows an application to instruct the Service to locally ignore a Topic.

Uses of InstanceHandle in org.omg.dds.pub

Methods in org.omg.dds.pub that return InstanceHandle

Modifier and Type	Method and Description
InstanceHandle	DataWriter.lookupInstance(TYPE keyHolder) This operation takes as a parameter an instance and returns a handle that can be used in subsequent operations that accept an instance handle as an argument.
InstanceHandle	DataWriter.registerInstance(TYPE instanceData) This operation informs the Service that the application will be modifying a particular instance.
InstanceHandle	DataWriter.registerInstance(TYPE instanceData, long sourceTimestamp, TimeUnit unit) This operation performs the same function as DataWriter.registerInstance(Object) and can be used instead in the cases where the application desires to specify the value for the source time stamp.
InstanceHandle	DataWriter.registerInstance(TYPE instanceData, Time sourceTimestamp) This operation performs the same function as DataWriter.registerInstance(Object) and can be used instead in the cases where the application desires to specify the value for the source time stamp.

Methods in org.omg.dds.pub that return types with arguments of type InstanceHandle

Modifier and Type	Method and Description
Set<InstanceHandle>	DataWriter.getMatchedSubscriptions() This operation retrieves the list of subscriptions currently "associated" with the DataWriter; that is, subscriptions that have a matching Topic and compatible QoS that the application has not indicated should be "ignored" by means of DomainParticipant.ignoreSubscription(InstanceHandle).

Methods in org.omg.dds.pub with parameters of type InstanceHandle

Modifier and Type	Method and Description
void	DataWriter.dispose(InstanceHandle instanceHandle) This operation requests the middleware to delete the data (the actual deletion is postponed until there is no more use for that data in the whole system).
void	DataWriter.dispose(InstanceHandle instanceHandle, TYPE instanceData) This operation requests the middleware to delete the data (the actual deletion is postponed until there is no more use for that data in the whole system).
void	DataWriter.dispose(InstanceHandle instanceHandle, TYPE instanceData, long sourceTimestamp, TimeUnit unit) This operation performs the same functions as DataWriter.dispose(InstanceHandle, Object) except that the application provides the value for the source time stamp that is made available to DataReader objects by means of Sample.getSourceTimestamp().
void	DataWriter.dispose(InstanceHandle instanceHandle, TYPE instanceData, Time sourceTimestamp) This operation performs the same functions as DataWriter.dispose(InstanceHandle, Object) except that the application provides the value for the source time stamp that is made available to DataReader objects by means of Sample.getSourceTimestamp().
TYPE	DataWriter.getKeyValue(InstanceHandle handle) This operation can be used to retrieve the instance key that corresponds to an instance handle.
TYPE	DataWriter.getKeyValue(TYPE keyHolder, InstanceHandle handle) This operation can be used to retrieve the instance key that corresponds to an instance handle.
SubscriptionBuiltinTopicData	DataWriter.getMatchedSubscriptionData(InstanceHandle subscriptionHandle) This operation retrieves information on a subscription that is currently "associated" with the DataWriter; that is, a subscription with a matching Topic and compatible QoS that the application has not indicated should be "ignored" by means of DomainParticipant.ignoreSubscription(InstanceHandle).
void	DataWriter.unregisterInstance(InstanceHandle handle) This operation reverses the action of DataWriter.registerInstance(Object).
void	DataWriter.unregisterInstance(InstanceHandle handle, TYPE instanceData) This operation reverses the action of DataWriter.registerInstance(Object).
void	DataWriter.unregisterInstance(InstanceHandle handle, TYPE instanceData, long sourceTimestamp, TimeUnit unit) This operation performs the same function as DataWriter.unregisterInstance(InstanceHandle, Object) and can be used instead in the cases where the application desires to specify the value for the source time stamp.
void	DataWriter.unregisterInstance(InstanceHandle handle, TYPE instanceData, Time sourceTimestamp) This operation performs the same function as DataWriter.unregisterInstance(InstanceHandle, Object) and can be used instead in the cases where the application desires to specify the value for the source time stamp.
void	DataWriter.write(TYPE instanceData, InstanceHandle handle) This operation modifies the value of a data instance.
void	DataWriter.write(TYPE instanceData, InstanceHandle handle, long sourceTimestamp, TimeUnit unit) This operation performs the same function as DataWriter.write(Object, InstanceHandle) except that it also provides the value for the source time stamp that is made available to DataReader objects by means of Sample.getSourceTimestamp().
void	DataWriter.write(TYPE instanceData, InstanceHandle handle, Time sourceTimestamp) This operation performs the same function as DataWriter.write(Object, InstanceHandle) except that it also provides the value for the source time stamp that is made available to DataReader objects by means of Sample.getSourceTimestamp().

Uses of InstanceHandle in org.omg.dds.sub

Methods in org.omg.dds.sub that return InstanceHandle

Modifier and Type	Method and Description
InstanceHandle	DataReader.Selector.getInstance()
InstanceHandle	DataReader.lookupInstance(TYPE keyHolder) This operation takes as a parameter an instance and returns a handle that can be used in subsequent operations that accept an instance handle as an argument.

Methods in org.omg.dds.sub that return types with arguments of type InstanceHandle

Modifier and Type	Method and Description
Set<InstanceHandle>	DataReader.getMatchedPublications() This operation retrieves the list of publications currently "associated" with the DataReader; that is, publications that have a matching Topic and compatible QoS that the application has not indicated should be "ignored" by means of DomainParticipant.ignorePublication(InstanceHandle).

Methods in org.omg.dds.sub with parameters of type InstanceHandle

Modifier and Type	Method and Description
TYPE	DataReader.getKeyValue(TYPE keyHolder, InstanceHandle handle) This operation can be used to retrieve the instance key that corresponds to an instance handle.
PublicationBuiltinTopicData	DataReader.getMatchedPublicationData(InstanceHandle publicationHandle) This operation retrieves information on a publication that is currently "associated" with the DataReader; that is, a publication with a matching Topic and compatible QoS that the application has not indicated should be "ignored" by means of DomainParticipant.ignorePublication(InstanceHandle).
DataReader.Selector<T>	DataReader.Selector.instance(InstanceHandle handle)