Inheritance diagram for org.opensplice.dds.sub.AbstractDataReader< TYPE >:

Collaboration diagram for org.opensplice.dds.sub.AbstractDataReader< TYPE >:

Public Member Functions
	AbstractDataReader (OsplServiceEnvironment environment, SubscriberImpl parent, TopicDescriptionExt< TYPE > topicDescription)

final void	close ()

abstract void	close ()
	Halt communication and dispose the resources held by this Entity. More...

void	closeContainedEntities ()
	This operation closes all the entities that were created by means of the "create" operations on the DataReader. More...

abstract Sample.Iterator<?>	createIterator (Object sampleSeqHolder, Field sampleSeqHolderValueField, DDS.SampleInfoSeqHolder info)

QueryCondition< TYPE >	createQueryCondition (String queryExpression, List< String > queryParameters)
	This operation creates a QueryCondition. More...

QueryCondition< TYPE >	createQueryCondition (DataState states, String queryExpression, List< String > queryParameters)
	This operation creates a QueryCondition. More...

QueryCondition< TYPE >	createQueryCondition (String queryExpression, String... queryParameters)
	This operation creates a QueryCondition. More...

QueryCondition< TYPE >	createQueryCondition (DataState states, String queryExpression, String... queryParameters)
	This operation creates a QueryCondition. More...

ReadCondition< TYPE >	createReadCondition (DataState states)
	This operation creates a ReadCondition. More...

void	deregisterIterator (AbstractIterator< TYPE > iterator)

void	destroyReadCondition (ReadConditionImpl< TYPE > condition)

final void	enable ()

void	enable ()
	This operation enables the Entity. More...

ServiceEnvironment	getEnvironment ()

final InstanceHandle	getInstanceHandle ()

InstanceHandle	getInstanceHandle ()

TYPE	getKeyValue (TYPE keyHolder, InstanceHandle handle)
	This operation can be used to retrieve the instance key that corresponds to an instance handle. More...

TYPE	getKeyValue (InstanceHandle handle)
	This operation can be used to retrieve the instance key that corresponds to an instance handle. More...

LISTENER	getListener ()
	This operation allows access to the existing Listener attached to the Entity. More...

final LISTENER	getListener ()

LivelinessChangedStatus	getLivelinessChangedStatus ()
	This operation obtains the LivelinessChangedStatus object of the DataReader. More...

PublicationBuiltinTopicData	getMatchedPublicationData (InstanceHandle publicationHandle)
	This operation retrieves information on a publication that is currently "associated" with the DataReader; that is, a publication with a matching org.omg.dds.topic.Topic and compatible QoS that the application has not indicated should be "ignored" by means of org.omg.dds.domain.DomainParticipant#ignorePublication(InstanceHandle). More...

Set< InstanceHandle >	getMatchedPublications ()
	This operation retrieves the list of publications currently "associated" with the DataReader; that is, publications that have a matching org.omg.dds.topic.Topic and compatible QoS that the application has not indicated should be "ignored" by means of org.omg.dds.domain.DomainParticipant#ignorePublication(InstanceHandle). More...

OLD	getOld ()

OLDPARENT	getOldParent ()

SubscriberImpl	getParent ()

abstract PreAllocator< TYPE >	getPreAllocator (List< Sample< TYPE >> samples, Class<?> sampleSeqHolderClz, Field sampleSeqHolderValueField)

String	getProperty (String key)

DataReaderQos	getQos ()

RequestedDeadlineMissedStatus	getRequestedDeadlineMissedStatus ()
	This operation obtains the RequestedDeadlineMissedStatus object of the DataReader. More...

RequestedIncompatibleQosStatus	getRequestedIncompatibleQosStatus ()
	This operation obtains the RequestedIncompatibleQosStatus object of the DataReader. More...

SampleLostStatus	getSampleLostStatus ()
	This operation obtains the SampleLostStatus object of the DataReader. More...

SampleRejectedStatus	getSampleRejectedStatus ()
	This operation obtains the SampleRejectedStatus object of the DataReader. More...

final Set< Class<? extends Status > >	getStatusChanges ()

Set< Class<? extends Status > >	getStatusChanges ()
	This operation retrieves the list of communication statuses in the Entity that are 'triggered. More...

StatusCondition< DataReader< TYPE > >	getStatusCondition ()

SubscriptionMatchedStatus	getSubscriptionMatchedStatus ()
	This operation obtains the SubscriptionMatchedStatus object of the DataReader. More...

TopicDescription< TYPE >	getTopicDescription ()

InstanceHandle	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. More...

Iterator< TYPE >	read ()
	This operation accesses a collection of samples from this DataReader. More...

Iterator< TYPE >	read (org.omg.dds.sub.DataReader.Selector< TYPE > query)

Iterator< TYPE >	read (int maxSamples)
	This operation accesses a collection of samples from this DataReader. More...

List< Sample< TYPE > >	read (List< Sample< TYPE >> samples)
	This operation accesses a collection of samples from this DataReader. More...

List< Sample< TYPE > >	read (List< Sample< TYPE >> samples, org.omg.dds.sub.DataReader.Selector< TYPE > selector)

Sample.Iterator< TYPE >	read (Selector< TYPE > query)
	This operation accesses a collection of samples from this DataReader. More...

List< Sample< TYPE > >	read (List< Sample< TYPE >> samples, Selector< TYPE > selector)
	This operation accesses a collection of samples from this DataReader. More...

boolean	readNextSample (Sample< TYPE > sample)
	This operation copies the next, non-previously accessed sample from this DataReader. More...

void	registerIterator (AbstractIterator< TYPE > iterator)

final void	retain ()

void	retain ()
	Indicates that references to this object may go out of scope but that the application expects to look it up again later. More...

void	returnLoan (Object sampleSeqHolder, DDS.SampleInfoSeqHolder infoSeqHolder)

org.omg.dds.sub.DataReader.Selector< TYPE >	select ()
	Provides a Selector that can be used to refine what read or take methods return. More...

void	setListener (LISTENER listener)
	This operation installs a Listener on the Entity. More...

void	setListener (LISTENER listener, Collection< Class<? extends Status >> statuses)
	This operation installs a Listener on the Entity. More...

void	setListener (LISTENER listener, Class<? extends Status >... statuses)
	This operation installs a Listener on the Entity. More...

void	setListener (DataReaderListener< TYPE > listener)

void	setListener (DataReaderListener< TYPE > listener, Collection< Class<? extends Status >> statuses)

void	setListener (DataReaderListener< TYPE > listener, Class<? extends Status >... statuses)

void	setProperty (String key, String value)

void	setQos (QOS qos)
	This operation is used to set the QoS policies of the Entity. More...

void	setQos (DataReaderQos qos)

Iterator< TYPE >	take ()
	This operation accesses a collection of samples from this DataReader. More...

Iterator< TYPE >	take (int maxSamples)
	This operation accesses a collection of samples from this DataReader. More...

Iterator< TYPE >	take (org.omg.dds.sub.DataReader.Selector< TYPE > query)

List< Sample< TYPE > >	take (List< Sample< TYPE >> samples)
	This operation accesses a collection of samples from this DataReader. More...

List< Sample< TYPE > >	take (List< Sample< TYPE >> samples, org.omg.dds.sub.DataReader.Selector< TYPE > selector)

Sample.Iterator< TYPE >	take (Selector< TYPE > query)
	This operation accesses a collection of samples from this DataReader. More...

List< Sample< TYPE > >	take (List< Sample< TYPE >> samples, Selector< TYPE > query)
	This operation accesses a collection of samples from this DataReader. More...

boolean	takeNextSample (Sample< TYPE > sample)
	This operation copies the next, non-previously accessed sample from this DataReader and "removes" it from the DataReader so it is no longer accessible. More...

void	waitForHistoricalData (Duration maxWait) throws TimeoutException
	This operation is intended only for DataReader entities for which org.omg.dds.core.policy.Durability#getKind() is not org.omg.dds.core.policy.Durability.Kind#VOLATILE. More...

void	waitForHistoricalData (long maxWait, TimeUnit unit) throws TimeoutException
	This operation is intended only for DataReader entities for which org.omg.dds.core.policy.Durability#getKind() is not org.omg.dds.core.policy.Durability.Kind#VOLATILE. More...

void	waitForHistoricalData (String filterExpression, List< String > filterParameters, Time minSourceTimestamp, Time maxSourceTimestamp, ResourceLimits resourceLimits, Duration maxWait) throws TimeoutException

void	waitForHistoricalData (String filterExpression, List< String > filterParameters, Time minSourceTimestamp, Time maxSourceTimestamp, Duration maxWait) throws TimeoutException

void	waitForHistoricalData (String filterExpression, List< String > filterParameters, ResourceLimits resourceLimits, Duration maxWait) throws TimeoutException

void	waitForHistoricalData (String filterExpression, List< String > filterParameters, Duration maxWait) throws TimeoutException

void	waitForHistoricalData (Time minSourceTimestamp, Time maxSourceTimestamp, ResourceLimits resourceLimits, Duration maxWait) throws TimeoutException

void	waitForHistoricalData (Time minSourceTimestamp, Time maxSourceTimestamp, Duration maxWait) throws TimeoutException

void	waitForHistoricalData (ResourceLimits resourceLimits, Duration maxWait) throws TimeoutException

void	waitForHistoricalData (String filterExpression, List< String > filterParameters, Time minSourceTimestamp, Time maxSourceTimestamp, ResourceLimits resourceLimits, long maxWait, TimeUnit unit) throws TimeoutException

void	waitForHistoricalData (String filterExpression, List< String > filterParameters, Time minSourceTimestamp, Time maxSourceTimestamp, long maxWait, TimeUnit unit) throws TimeoutException

void	waitForHistoricalData (String filterExpression, List< String > filterParameters, ResourceLimits resourceLimits, long maxWait, TimeUnit unit) throws TimeoutException

void	waitForHistoricalData (String filterExpression, List< String > filterParameters, long maxWait, TimeUnit unit) throws TimeoutException

void	waitForHistoricalData (Time minSourceTimestamp, Time maxSourceTimestamp, ResourceLimits resourceLimits, long maxWait, TimeUnit unit) throws TimeoutException

void	waitForHistoricalData (Time minSourceTimestamp, Time maxSourceTimestamp, long maxWait, TimeUnit unit) throws TimeoutException

void	waitForHistoricalData (ResourceLimits resourceLimits, long maxWait, TimeUnit unit) throws TimeoutException

Static Public Member Functions
static boolean	printReferences ()

Protected Member Functions
void	destroy ()

abstract ReflectionDataReader<?, TYPE >	getReflectionReader ()

void	setOld (OLD old)

Protected Attributes
final HashMap< DDS.Condition, ReadConditionImpl< TYPE > >	conditions

final transient OsplServiceEnvironment	environment

final HashSet< AbstractIterator< TYPE > >	iterators

LISTENERIMPL	listener

PARENT	parent

final Selector< TYPE >	selector

final TopicDescriptionExt< TYPE >	topicDescription

Detailed Description

Definition at line 67 of file AbstractDataReader.java.

Constructor & Destructor Documentation

◆ AbstractDataReader()

org.opensplice.dds.sub.AbstractDataReader< TYPE >.AbstractDataReader	(	OsplServiceEnvironment	environment,
		SubscriberImpl	parent,
		TopicDescriptionExt< TYPE >	topicDescription
	)

Definition at line 78 of file AbstractDataReader.java.

Member Function Documentation

◆ close() [1/2]

final void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.close ( )

inherited

Definition at line 139 of file EntityImpl.java.

◆ close() [2/2]

abstract void org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.close ( )

abstractinherited

Halt communication and dispose the resources held by this Entity.

Closing an Entity implicitly closes all of its contained objects, if any. For example, closing a Publisher also closes all of its contained DataWriters.

An Entity cannot be closed if it has any unclosed dependent objects, not including contained objects. These include the following:

A org.omg.dds.topic.Topic cannot be closed if it is still in use by any org.omg.dds.topic.ContentFilteredTopics or org.omg.dds.topic.MultiTopics.
A Topic cannot be closed if any org.omg.dds.pub.DataWriters or org.omg.dds.sub.DataReader is still using it.
A DataReader cannot be closed if it has any outstanding loans as a result of a call to org.omg.dds.sub.DataReader#read(), org.omg.dds.sub.DataReader#take(), or one of the variants thereof.

The deletion of a org.omg.dds.pub.DataWriter will automatically unregister all instances. Depending on the settings of the org.omg.dds.core.policy.WriterDataLifecycle, the deletion of the DataWriter may also dispose all instances.

Exceptions

PreconditionNotMetException if close is called on an Entity with unclosed dependent object(s), not including contained objects.

See also: org.omg.dds.topic.TopicDescription::close()

◆ closeContainedEntities()

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.closeContainedEntities ( )

This operation closes all the entities that were created by means of the "create" operations on the DataReader.

That is, it closes all contained ReadCondition and QueryCondition objects.

Exceptions

org.omg.dds.core.PreconditionNotMetException if the any of the contained entities is in a state where it cannot be closed.

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 183 of file AbstractDataReader.java.

◆ createIterator()

abstract Sample.Iterator<?> org.opensplice.dds.sub.AbstractDataReader< TYPE >.createIterator	(	Object	sampleSeqHolder,
		Field	sampleSeqHolderValueField,
		DDS.SampleInfoSeqHolder	info
	)

abstract

◆ createQueryCondition() [1/4]

QueryCondition<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.createQueryCondition	(	String	queryExpression,
		List< String >	queryParameters
	)

This operation creates a QueryCondition.

The returned QueryCondition will be attached and belong to the DataReader. It will trigger on any sample state, view state, or instance state.

The selection of the content is done using the queryExpression with parameters queryParameters.

The queryExpression attribute is a string that specifies the criteria to select the data samples of interest. It is similar to the WHERE part of an SQL clause.
The queryParameters attribute is a sequence of strings that give values to the "parameters" (i.e., "%n" tokens) in the queryExpression. The number of supplied parameters must fit with the requested values in the queryExpression (i.e., the number of "%n" tokens).

Example:

This example assumes a Subscriber called "subscriber" and DataReader named "fooDr" has been created
and a datatype called Foo is present: class Foo { int age; String name; };
// Create a QueryCondition
// And apply a condition that only samples with age > 0 and name equals BILL are shown.
String expr = "age &gt; %0 AND name = %1");
List<String> params = new ArrayList<String>();
params.add("0");
params.add("BILL");
QueryCondition<Foo> queryCond = fooDr.createQueryCondition(expr,params);

Returns: a new QueryCondition

Parameters

queryExpression	The returned condition will only trigger on samples that pass this content-based filter expression.
queryParameters	A set of parameter values for the queryExpression.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: createQueryCondition(org.omg.dds.sub.Subscriber.DataState, String, List)

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 120 of file AbstractDataReader.java.

◆ createQueryCondition() [2/4]

QueryCondition<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.createQueryCondition	(	DataState	states,
		String	queryExpression,
		List< String >	queryParameters
	)

This operation creates a QueryCondition.

The returned QueryCondition will be attached and belong to the DataReader.

The selection of the content is done using the queryExpression with parameters queryParameters.

The queryExpression attribute is a string that specifies the criteria to select the data samples of interest. It is similar to the WHERE part of an SQL clause.
The queryParameters attribute is a sequence of strings that give values to the "parameters" (i.e., "%n" tokens) in the queryExpression. The number of supplied parameters must fit with the requested values in the queryExpression (i.e., the number of "%n" tokens).

State Masks

The result of the QueryCondition also depends on the selection of samples determined by three org.omg.dds.sub.Subscriber.DataState masks:

org.omg.dds.sub.SampleState is the mask, which selects only those samples with the desired sample states READ, NOT_READ or both.
org.omg.dds.sub.ViewState is the mask, which selects only those samples with the desired view states NEW, NOT_NEW or both
org.omg.dds.sub.InstanceState is the mask, which selects only those samples with the desired instance states ALIVE_INSTANCE, NOT_ALIVE_DISPOSED, NOT_ALIVE_NO_WRITERS or a combination of these.

Example:

This example assumes a Subscriber called "subscriber" and DataReader named "fooDr" has been created
and a datatype called Foo is present: class Foo { int age; String name; };
// Create a QueryCondition with a DataState with a sample state of not read, new view state and alive instance state.
// And apply a condition that only samples with age > 0 and name equals BILL are shown.
DataState ds = subscriber.createDataState();
ds = ds.with(SampleState.NOT_READ)
       .with(ViewState.NEW)
       .with(InstanceState.ALIVE);
String expr = "age &gt; %0 AND name = %1");
List<String> params = new ArrayList<String>();
params.add("0");
params.add("BILL");
QueryCondition<Foo> queryCond = fooDr.createQueryCondition(ds,expr,params);

Returns: a new QueryCondition

Parameters

states	The returned condition will only trigger on samples with one of these sample states, view states, and instance states.
queryExpression	The returned condition will only trigger on samples that pass this content-based filter expression.
queryParameters	A set of parameter values for the queryExpression.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: #createQueryCondition(String, List)

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 128 of file AbstractDataReader.java.

◆ createQueryCondition() [3/4]

QueryCondition<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.createQueryCondition	(	String	queryExpression,
		String...	queryParameters
	)

This operation creates a QueryCondition.

The returned QueryCondition will be attached and belong to the DataReader. It will trigger on any sample state, view state, or instance state.

The selection of the content is done using the queryExpression with parameters queryParameters.

The queryExpression attribute is a string that specifies the criteria to select the data samples of interest. It is similar to the WHERE part of an SQL clause.
The queryParameters attribute is a sequence of strings that give values to the "parameters" (i.e., "%n" tokens) in the queryExpression. The number of supplied parameters must fit with the requested values in the queryExpression (i.e., the number of "%n" tokens).

Example:

This example assumes a Subscriber called "subscriber" and DataReader named "fooDr" has been created
and a datatype called Foo is present: class Foo { int age; String name; };
// Create a QueryCondition
// And apply a condition that only samples with age > 0 and name equals BILL are shown.
String expr = "age &gt; %0 AND name = %1");
QueryCondition<Foo> queryCond = fooDr.createQueryCondition(expr,"0","BILL");

Returns: a new QueryCondition

Parameters

queryExpression	The returned condition will only trigger on samples that pass this content-based filter expression.
queryParameters	A set of parameter values for the queryExpression.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: createQueryCondition(org.omg.dds.sub.Subscriber.DataState, String, List)

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 149 of file AbstractDataReader.java.

◆ createQueryCondition() [4/4]

QueryCondition<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.createQueryCondition	(	DataState	states,
		String	queryExpression,
		String...	queryParameters
	)

This operation creates a QueryCondition.

The returned QueryCondition will be attached and belong to the DataReader.

The selection of the content is done using the queryExpression with parameters queryParameters.

The queryExpression attribute is a string that specifies the criteria to select the data samples of interest. It is similar to the WHERE part of an SQL clause.
The queryParameters attribute is a sequence of strings that give values to the "parameters" (i.e., "%n" tokens) in the queryExpression. The number of supplied parameters must fit with the requested values in the queryExpression (i.e., the number of "%n" tokens).

State Masks

The result of the QueryCondition also depends on the selection of samples determined by three org.omg.dds.sub.Subscriber.DataState masks:

org.omg.dds.sub.SampleState is the mask, which selects only those samples with the desired sample states READ, NOT_READ or both.
org.omg.dds.sub.ViewState is the mask, which selects only those samples with the desired view states NEW, NOT_NEW or both
org.omg.dds.sub.InstanceState is the mask, which selects only those samples with the desired instance states ALIVE_INSTANCE, NOT_ALIVE_DISPOSED, NOT_ALIVE_NO_WRITERS or a combination of these.

Example:

This example assumes a Subscriber called "subscriber" and DataReader named "fooDr" has been created
and a datatype called Foo is present: class Foo { int age; String name; };
// Create a QueryCondition with a DataState with a sample state of not read, new view state and alive instance state.
// And apply a condition that only samples with age > 0 and name equals BILL are shown.
DataState ds = subscriber.createDataState();
ds = ds.with(SampleState.NOT_READ)
       .with(ViewState.NEW)
       .with(InstanceState.ALIVE);
String expr = "age &gt; %0 AND name = %1");
QueryCondition<Foo> queryCond = fooDr.createQueryCondition(ds,expr,"0","BILL");

Returns: a new QueryCondition

Parameters

states	The returned condition will only trigger on samples with one of these sample states, view states, and instance states.
queryExpression	The returned condition will only trigger on samples that pass this content-based filter expression.
queryParameters	A set of parameter values for the queryExpression.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: #createQueryCondition(String, List)

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 156 of file AbstractDataReader.java.

◆ createReadCondition()

ReadCondition<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.createReadCondition ( DataState states )

This operation creates a ReadCondition.

The returned ReadCondition will be attached and belong to the DataReader.

State Masks

The result of the ReadCondition depends on the selection of samples determined by three org.omg.dds.sub.Subscriber.DataState masks:

org.omg.dds.sub.SampleState is the mask, which selects only those samples with the desired sample states READ, NOT_READ or both.
org.omg.dds.sub.ViewState is the mask, which selects only those samples with the desired view states NEW, NOT_NEW or both
org.omg.dds.sub.InstanceState is the mask, which selects only those samples with the desired instance states ALIVE_INSTANCE, NOT_ALIVE_DISPOSED, NOT_ALIVE_NO_WRITERS or a combination of these.

Example:

This example assumes a Subscriber called "subscriber" and DataReader named "fooDr" has been created
and a datatype called Foo is present: class Foo { int age; String name; };
// Create a ReadCondition with a DataState with a sample state of not read, new view state and alive instance state.
DataState ds = subscriber.createDataState();
ds = ds.with(SampleState.NOT_READ)
       .with(ViewState.NEW)
       .with(InstanceState.ALIVE);
ReadCondition<Foo> readCond = fooDr.createReadCondition(ds);

Returns: a new ReadCondition

Parameters

states The returned condition will only trigger on samples with one of these sample states, view states, and instance states.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 103 of file AbstractDataReader.java.

◆ deregisterIterator()

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.deregisterIterator ( AbstractIterator< TYPE > iterator )

Definition at line 94 of file AbstractDataReader.java.

◆ destroy()

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.destroy ( )

protected

Definition at line 209 of file AbstractDataReader.java.

◆ destroyReadCondition()

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.destroyReadCondition ( ReadConditionImpl< TYPE > condition )

Definition at line 170 of file AbstractDataReader.java.

◆ enable() [1/2]

final void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.enable ( )

inherited

Definition at line 153 of file EntityImpl.java.

◆ enable() [2/2]

void org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.enable ( )

inherited

This operation enables the Entity.

Entity objects can be created either enabled or disabled. This is controlled by the value of the org.omg.dds.core.policy.EntityFactory on the corresponding factory for the Entity.

The default setting of org.omg.dds.core.policy.EntityFactory is such that, by default, it is not necessary to explicitly call enable on newly created entities.

The enable operation is idempotent. Calling enable on an already enabled Entity has no effect.

If an Entity has not yet been enabled, the following kinds of operations may be invoked on it:

Operations to set or get an Entity's QoS policies (including default QoS policies) and listener
getStatusCondition()
'factory' operations and close()
getStatusChanges() and other get status operations (although the status of a disabled entity never changes)
'lookup' operations

Other operations may explicitly state that they may be called on disabled entities; those that do not will fail with org.omg.dds.core.NotEnabledException.

It is legal to delete an Entity that has not been enabled by calling close(). Entities created from a factory that is disabled are created disabled regardless of the setting of org.omg.dds.core.policy.EntityFactory.

Calling enable on an Entity whose factory is not enabled will fail with org.omg.dds.core.PreconditionNotMetException.

If org.omg.dds.core.policy.EntityFactory#isAutoEnableCreatedEntities() is true, the enable operation on the factory will automatically enable all entities created from the factory.

The Listeners associated with an entity are not called until the entity is enabled. org.omg.dds.core.Conditions associated with an entity that is not enabled are "inactive," that is, have a triggerValue == false.

In addition to the general description, the enable operation on a org.omg.dds.sub.Subscriber has special meaning in specific usecases. This applies only to Subscribers with PresentationQoS coherent-access set to true with access-scope set to group.

In this case the subscriber is always created in a disabled state, regardless of the factory's auto-enable created entities setting. While the subscriber remains disabled, DataReaders can be created that will participate in coherent transactions of the subscriber.

See org.omg.dds.sub.Subscriber#beginAccess() and org.omg.dds.sub.Subscriber#endAccess() for more information.

All DataReaders will also be created in a disabled state. Coherency with group access-scope requires data to be delivered as a transaction, atomically, to all eligible readers. Therefore data should not be delivered to any single DataReader immediately after it's created, as usual, but only after the application has finished creating all DataReaders for a given Subscriber. At this point, the application should enable the Subscriber which in turn enables all its DataReaders.

Note that for a DataWriter which has a corresponding Publisher with a PresentationQoS with coherent-access set to true and access-scope set to topic or group that the HistoryQoS of the DataWriter should be set to KEEP_ALL otherwise the enable operation will fail. See org.omg.dds.pub.Publisher#createDataWriter(Topic, DataWriterQos, DataWriterListener, Collection)

◆ getEnvironment()

ServiceEnvironment org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getEnvironment ( )

inherited

Definition at line 121 of file EntityImpl.java.

◆ getInstanceHandle() [1/2]

final InstanceHandle org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getInstanceHandle ( )

inherited

Definition at line 166 of file EntityImpl.java.

◆ getInstanceHandle() [2/2]

InstanceHandle org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.getInstanceHandle ( )

inherited

Returns: the org.omg.dds.core.InstanceHandle that represents the Entity.

◆ getKeyValue() [1/2]

TYPE org.omg.dds.sub.DataReader< TYPE >.getKeyValue	(	TYPE	keyHolder,
		InstanceHandle	handle
	)

inherited

This operation can be used to retrieve the instance key that corresponds to an instance handle.

The operation will only fill the fields that form the key inside the keyHolder instance.

Parameters

keyHolder	a container, into which this method shall place its result.
handle	a handle indicating the instance whose value this method should get.

Returns: keyHolder, as a convenience to facilitate chaining.

Exceptions

IllegalArgumentException	if the org.omg.dds.core.InstanceHandle does not correspond to an existing data object known to the DataReader. If the implementation is not able to check invalid handles, then the result in this situation is unspecified.
org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

Implemented in org.opensplice.dds.sub.DataReaderImpl< TYPE >.

◆ getKeyValue() [2/2]

TYPE org.omg.dds.sub.DataReader< TYPE >.getKeyValue ( InstanceHandle handle )

inherited

This operation can be used to retrieve the instance key that corresponds to an instance handle.

The operation will only fill the fields that form the key inside the keyHolder instance.

Parameters

handle a handle indicating the instance whose value this method should get.

Returns: An instance with key fields populated.

Exceptions

IllegalArgumentException	if the org.omg.dds.core.InstanceHandle does not correspond to an existing data object known to the DataReader. If the implementation is not able to check invalid handles, then the result in this situation is unspecified.
org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

Implemented in org.opensplice.dds.sub.DataReaderImpl< TYPE >.

◆ getListener() [1/2]

LISTENER org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.getListener ( )

inherited

This operation allows access to the existing Listener attached to the Entity.

Returns: The attached listener if set, or null otherwise.

See also: #setListener(EventListener); #setListener(EventListener, Collection)

◆ getListener() [2/2]

final LISTENER org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getListener ( )

inherited

Definition at line 174 of file EntityImpl.java.

◆ getLivelinessChangedStatus()

LivelinessChangedStatus org.opensplice.dds.sub.AbstractDataReader< TYPE >.getLivelinessChangedStatus ( )

This operation obtains the LivelinessChangedStatus object of the DataReader.

This object contains the information whether the liveliness of one or more DataWriter objects that were writing instances read by the DataReader has changed. In other words, some DataWriter have become "alive" or "not alive".

The LivelinessChangedStatus can also be monitored using a DataReaderListener or by using the associated StatusCondition.

Returns: the LivelinessChangedStatus object

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: org.omg.dds.core.status.LivelinessChangedStatus

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 306 of file AbstractDataReader.java.

◆ getMatchedPublicationData()

PublicationBuiltinTopicData org.opensplice.dds.sub.AbstractDataReader< TYPE >.getMatchedPublicationData ( InstanceHandle publicationHandle )

This operation retrieves information on a publication that is currently "associated" with the DataReader; that is, a publication with a matching org.omg.dds.topic.Topic and compatible QoS that the application has not indicated should be "ignored" by means of org.omg.dds.domain.DomainParticipant#ignorePublication(InstanceHandle).

The operation getMatchedPublications() can be used to find the publications that are currently matched with the DataReader.

Parameters

publicationHandle a handle to the publication, the data of which is to be retrieved.

Returns: a new object containing a copy of the information.

Exceptions

IllegalArgumentException	if the publicationHandle does not correspond to a publication currently associated with the DataReader.
UnsupportedOperationException	if the infrastructure does not hold the information necessary to fill in the publicationData.
org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.
UnsupportedOperationException	if the infrastructure does not hold the information necessary to fill in the publicationnData.

See also: getMatchedPublications()

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 480 of file AbstractDataReader.java.

◆ getMatchedPublications()

Set<InstanceHandle> org.opensplice.dds.sub.AbstractDataReader< TYPE >.getMatchedPublications ( )

This operation retrieves the list of publications currently "associated" with the DataReader; that is, publications that have a matching org.omg.dds.topic.Topic and compatible QoS that the application has not indicated should be "ignored" by means of org.omg.dds.domain.DomainParticipant#ignorePublication(InstanceHandle).

The handles returned in the 'publicationHandles' list are the ones that are used by the DDS implementation to locally identify the corresponding matched DataWriter entities. These handles match the ones that appear in org.omg.dds.sub.Sample#getInstanceHandle() when reading the "DCPSPublications" built-in topic.

Be aware that since an instance handle is an opaque datatype, it does not necessarily mean that the handles obtained from the getMatchedPublications operation have the same value as the ones that appear in the instanceHandle field of the SampleInfo when retrieving the subscription info through corresponding "DCPSPublications" built-in reader. You can't just compare two handles to determine whether they represent the same publication. If you want to know whether two handles actually do represent the same subscription, use both handles to retrieve their corresponding PublicationBuiltinTopicData samples and then compare the key field of both samples.

The operation may fail with an UnsupportedOperationException if the infrastructure does not locally maintain the connectivity information.

Returns: a new collection containing a copy of the information.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.
UnsupportedOperationException	if the infrastructure does not hold the information necessary to fill in the publicationnData.

See also: getMatchedPublicationData(InstanceHandle)

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 475 of file AbstractDataReader.java.

◆ getOld()

OLD org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getOld ( )

inherited

Definition at line 102 of file EntityImpl.java.

◆ getOldParent()

OLDPARENT org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getOldParent ( )

inherited

Definition at line 116 of file EntityImpl.java.

◆ getParent()

SubscriberImpl org.opensplice.dds.sub.AbstractDataReader< TYPE >.getParent ( )

Returns: the factory object that created this entity.

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 215 of file AbstractDataReader.java.

◆ getPreAllocator()

abstract PreAllocator<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.getPreAllocator	(	List< Sample< TYPE >>	samples,
		Class<?>	sampleSeqHolderClz,
		Field	sampleSeqHolderValueField
	)

abstract

◆ getProperty()

String org.opensplice.dds.sub.AbstractDataReader< TYPE >.getProperty ( String key )

Definition at line 268 of file AbstractDataReader.java.

◆ getQos()

DataReaderQos org.opensplice.dds.sub.AbstractDataReader< TYPE >.getQos ( )

Definition at line 291 of file AbstractDataReader.java.

◆ getReflectionReader()

abstract ReflectionDataReader<?, TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.getReflectionReader ( )

abstractprotected

◆ getRequestedDeadlineMissedStatus()

RequestedDeadlineMissedStatus org.opensplice.dds.sub.AbstractDataReader< TYPE >.getRequestedDeadlineMissedStatus ( )

This operation obtains the RequestedDeadlineMissedStatus object of the DataReader.

This object contains the information whether the deadline that the DataReader was expecting through its DeadlineQosPolicy was not respected for a specific instance.

The RequestedDeadlineMissedStatus can also be monitored using a DataReaderListener or by using the associated StatusCondition.

Returns: the RequestedDeadlineMissedStatus object

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: org.omg.dds.core.status.RequestedDeadlineMissedStatus

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 311 of file AbstractDataReader.java.

◆ getRequestedIncompatibleQosStatus()

RequestedIncompatibleQosStatus org.opensplice.dds.sub.AbstractDataReader< TYPE >.getRequestedIncompatibleQosStatus ( )

This operation obtains the RequestedIncompatibleQosStatus object of the DataReader.

This object contains the information whether a QosPolicy setting was incompatible with the offered QosPolicy setting. The Request/Offering mechanism is applicable between the DataWriter and the DataReader. If the QosPolicy settings between DataWriter and DataReader are inconsistent, no communication between them is established. In addition the DataWriter will be informed via a RequestedIncompatibleQos status change and the DataReader will be informed via an OfferedIncompatibleQos status change.

The RequestedIncompatibleQosStatus can also be monitored using a DataReaderListener or by using the associated StatusCondition.

Returns: the RequestedDeadlineMissedStatus object

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: org.omg.dds.core.status.RequestedIncompatibleQosStatus

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 316 of file AbstractDataReader.java.

◆ getSampleLostStatus()

SampleLostStatus org.opensplice.dds.sub.AbstractDataReader< TYPE >.getSampleLostStatus ( )

This operation obtains the SampleLostStatus object of the DataReader.

This object contains information whether samples have been lost. This only applies when the ReliabilityQosPolicy is set to RELIABLE. If the ReliabilityQosPolicy is set to BEST_EFFORT the Data Distribution Service will not report the loss of samples.

The SampleLostStatus can also be monitored using a DataReaderListener or by using the associated StatusCondition.

Returns: the SampleLostStatus object

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: org.omg.dds.core.status.SampleLostStatus

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 326 of file AbstractDataReader.java.

◆ getSampleRejectedStatus()

SampleRejectedStatus org.opensplice.dds.sub.AbstractDataReader< TYPE >.getSampleRejectedStatus ( )

This operation obtains the SampleRejectedStatus object of the DataReader.

This object contains the information whether a received sample has been rejected. Samples may be rejected by the DataReader when it runs out of resourceLimits to store incoming samples. Usually this means that old samples need to be 'consumed' (for example by 'taking' them instead of 'reading' them) to make room for newly incoming samples.

The SampleRejectedStatus can also be monitored using a DataReaderListener or by using the associated StatusCondition.

Returns: the SampleRejectedStatus object

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: org.omg.dds.core.status.SampleRejectedStatus

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 301 of file AbstractDataReader.java.

◆ getStatusChanges() [1/2]

final Set<Class<? extends Status> > org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.getStatusChanges ( )

inherited

Definition at line 160 of file EntityImpl.java.

◆ getStatusChanges() [2/2]

Set<Class<? extends Status> > org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.getStatusChanges ( )

inherited

This operation retrieves the list of communication statuses in the Entity that are 'triggered.

' That is, the list of statuses whose value has changed since the last time the application read the status.

When the entity is first created or if the entity is not enabled, all communication statuses are in the "untriggered" state so the list returned will be empty.

The list of statuses returned refers to the statuses that are triggered on the Entity itself and does not include statuses that apply to contained entities.

Returns: a new Set containing the triggered statuses.

◆ getStatusCondition()

StatusCondition<DataReader<TYPE> > org.opensplice.dds.sub.AbstractDataReader< TYPE >.getStatusCondition ( )

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 549 of file AbstractDataReader.java.

◆ getSubscriptionMatchedStatus()

SubscriptionMatchedStatus org.opensplice.dds.sub.AbstractDataReader< TYPE >.getSubscriptionMatchedStatus ( )

This operation obtains the SubscriptionMatchedStatus object of the DataReader.

This object contains the information whether a new match has been discovered for the current subscription, or whether an existing match has ceased to exist. This means that the status represents that either a DataWriter object has been discovered by the DataReader with the same Topic and a compatible Qos, or that a previously discovered DataWriter has ceased to be matched to the current DataReader. A DataWriter may cease to match when it gets deleted, when it changes its Qos to a value that is incompatible with the current DataReader or when either the DataReader or the DataWriter has chosen to put its matching counterpart on its ignore-list using the ignorePublication or ignoreSubcription operations on the DomainParticipant. The operation may fail if the infrastructure does not hold the information necessary to fill in the SubscriptionMatchedStatus. This is the case when OpenSplice is configured not to maintain discovery information in the Networking Service. (See the description for the NetworkingService/Discovery/enabled property in the Deployment Manual for more information about this subject.) In this case the operation will return an UnsupportedOperationException.

The SubscriptionMatchedStatus can also be monitored using a DataReaderListener or by using the associated StatusCondition.

Returns: the SubscriptionMatchedStatus object

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: org.omg.dds.core.status.SubscriptionMatchedStatus

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 321 of file AbstractDataReader.java.

◆ getTopicDescription()

TopicDescription<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.getTopicDescription ( )

Returns: the TopicDescription associated with the DataReader. This is the same TopicDescription that was used to create the DataReader.

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 256 of file AbstractDataReader.java.

◆ lookupInstance()

InstanceHandle org.omg.dds.sub.DataReader< TYPE >.lookupInstance ( TYPE keyHolder )

inherited

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.

The instance parameter is only used for the purpose of examining the fields that define the key.

This operation does not register the instance in question. If the instance has not been previously registered, or if for any other reason the Service is unable to provide an instance handle, the Service will return a nil handle.

Parameters

keyHolder a sample of the instance whose handle this method should look up.

Returns: an immutable handle to the instance.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

Implemented in org.opensplice.dds.sub.DataReaderImpl< TYPE >.

◆ printReferences()

static boolean org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.printReferences ( )

staticinherited

Definition at line 66 of file EntityImpl.java.

◆ read() [1/7]

Iterator<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.read ( )

This operation accesses a collection of samples from this DataReader.

It behaves exactly like read(Selector) except that the collection of returned samples is not constrained by any Selector. These samples contain the actual data and meta information.

Invalid Data
Some elements in the returned sequence may not have valid data: the valid_data field in the SampleInfo indicates whether the corresponding data value contains any meaningful data. If not, the data value is just a 'dummy' sample for which only the keyfields have been assigned. It is used to accompany the SampleInfo that communicates a change in the instanceState of an instance for which there is no 'real' sample available.

For example, when an application always 'takes' all available samples of a particular instance, there is no sample available to report the disposal of that instance. In such a case the DataReader will insert a dummy sample into the data values sequence to accompany the SampleInfo element that communicates the disposal of the instance.

The act of reading a sample sets its sample_state to SampleState.READ. If the sample belongs to the most recent generation of the instance, it also sets the viewState of the instance to ViewState.NOT_NEW. It does not affect the instanceState of the instance.

Example:


// Read samples
Iterator<Sample<Foo>> samples = fooDr.read();
// Process each Sample and print its name and production time.
while (samples.hasNext()) {
    Sample sample = samples.next();
    Foo foo = sample.getData();
    if (foo != null) { //Check if the sample is valid.
         Time t = sample.getSourceTimestamp(); // meta information
         System.out.println("Name: " + foo.myName + " is produced at " + time.getTime(TimeUnit.SECONDS));
    }
}

Returns: a non-null unmodifiable iterator over loaned samples.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: #read(Selector); #read(List); #read(List, Selector); #readNextSample(Sample); take()

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 497 of file AbstractDataReader.java.

◆ read() [2/7]

Iterator<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.read ( org.omg.dds.sub.DataReader.Selector< TYPE > query )

Definition at line 502 of file AbstractDataReader.java.

◆ read() [3/7]

Iterator<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.read ( int maxSamples )

This operation accesses a collection of samples from this DataReader.

It behaves exactly like read() except that the returned samples are no more than #maxSamples.

Parameters

maxSamples The maximum number of samples to read

Returns: a non-null unmodifiable iterator over loaned samples.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: read(); #read(Selector); #read(List, Selector); #readNextSample(Sample); #take(List)

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 507 of file AbstractDataReader.java.

◆ read() [4/7]

List<Sample<TYPE> > org.opensplice.dds.sub.AbstractDataReader< TYPE >.read ( List< Sample< TYPE >> samples )

This operation accesses a collection of samples from this DataReader.

It behaves exactly like read() except that the returned samples are not "on loan" from the Service; they are deeply copied to the application.

If the number of samples read are fewer than the current length of the list, the list will be trimmed to fit the samples read. If list is null, a new list will be allocated and its size may be zero or unbounded depending upon the number of samples read. If there are no samples, the list reference will be non-null and the list will contain zero samples.

The read operation will copy the data and meta-information into the elements already inside the given collection, overwriting any samples that might already be present. The use of this variant forces a copy but the application can control where the copy is placed and the application will not need to "return the loan."


// Read samples and store them in a pre allocated collection
List<Sample<Foo>> samples = new ArrayList<Sample<Foo>>();
fooDr.read(samples);
// Process each Sample and print its name and production time.
for (Sample<Foo> sample : samples) {
    Foo foo = sample.getData();
    if (foo != null) { //Check if the sample is valid.
         Time t = sample.getSourceTimestamp();
         System.out.println("Name: " + foo.myName + " is produced at " + time.getTime(TimeUnit.SECONDS));
    }
}

Parameters

samples A pre allocated collection to store the samples in

Returns: samples, for convenience.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: read(); #read(Selector); #read(List, Selector); #readNextSample(Sample); #take(List)

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 512 of file AbstractDataReader.java.

◆ read() [5/7]

List<Sample<TYPE> > org.opensplice.dds.sub.AbstractDataReader< TYPE >.read	(	List< Sample< TYPE >>	samples,
		org.omg.dds.sub.DataReader.Selector< TYPE >	selector
	)

Definition at line 517 of file AbstractDataReader.java.

◆ read() [6/7]

Sample.Iterator<TYPE> org.omg.dds.sub.DataReader< TYPE >.read ( Selector< TYPE > query )

inherited

This operation accesses a collection of samples from this DataReader.

The returned samples will be limited by the given Selector. The setting of the org.omg.dds.core.policy.Presentation may impose further limits on the returned samples.

If org.omg.dds.core.policy.Presentation#getAccessScope() is org.omg.dds.core.policy.Presentation.AccessScopeKind#INSTANCE, then samples belonging to the same data instance are consecutive.
If org.omg.dds.core.policy.Presentation#getAccessScope() is org.omg.dds.core.policy.Presentation.AccessScopeKind#TOPIC and org.omg.dds.core.policy.Presentation#isOrderedAccess() is set to false, then samples belonging to the same data instance are consecutive.
If org.omg.dds.core.policy.Presentation#getAccessScope() is org.omg.dds.core.policy.Presentation.AccessScopeKind#TOPIC and org.omg.dds.core.policy.Presentation#isOrderedAccess() is set to true, then samples belonging to the same instance may or may not be consecutive. This is because to preserve order it may be necessary to mix samples from different instances.
If org.omg.dds.core.policy.Presentation#getAccessScope() is org.omg.dds.core.policy.Presentation.AccessScopeKind#GROUP and org.omg.dds.core.policy.Presentation#isOrderedAccess() is set to false, then samples belonging to the same data instance are consecutive.
If org.omg.dds.core.policy.Presentation#getAccessScope() is org.omg.dds.core.policy.Presentation.AccessScopeKind#GROUP and org.omg.dds.core.policy.Presentation#isOrderedAccess() is set to true, then the returned collection contains at most one sample. The difference in this case is due to the fact that it is required that the application is able to read samples belonging to different DataReader objects in a specific order.

In any case, the relative order between the samples of one instance is consistent with the org.omg.dds.core.policy.DestinationOrder:

If org.omg.dds.core.policy.DestinationOrder#getKind() is org.omg.dds.core.policy.DestinationOrder.Kind#BY_RECEPTION_TIMESTAMP, samples belonging to the same instances will appear in the relative order in which they were received (FIFO, earlier samples ahead of the later samples).
If org.omg.dds.core.policy.DestinationOrder#getKind() is org.omg.dds.core.policy.DestinationOrder.Kind#BY_SOURCE_TIMESTAMP, samples belonging to the same instances will appear in the relative order implied by the result of org.omg.dds.sub.Sample#getSourceTimestamp() (FIFO, smaller values of the source time stamp ahead of the larger values).

In addition to the sample data, the read operation also provides sample meta-information ("sample info"). See org.omg.dds.sub.Sample.

The returned samples are "loaned" by the DataReader. The use of this variant allows for zero-copy (assuming the implementation supports it) access to the data and the application will need to "return the loan" to the DataReader using the Sample.Iterator#close() operation.

Some elements in the returned collection may not have valid data. If the instance state in the Sample is org.omg.dds.sub.InstanceState#NOT_ALIVE_DISPOSED or org.omg.dds.sub.InstanceState#NOT_ALIVE_NO_WRITERS, then the last sample for that instance in the collection, that is, the one with org.omg.dds.sub.Sample#getSampleRank() == 0, does not contain valid data. Samples that contain no data do not count towards the limits imposed by the org.omg.dds.core.policy.ResourceLimits.

The act of reading a sample sets its sample state to org.omg.dds.sub.SampleState#READ. If the sample belongs to the most recent generation of the instance, it will also set the view state of the instance to org.omg.dds.sub.ViewState#NOT_NEW. It will not affect the instance state of the instance.

If the DataReader has no samples that meet the constraints, the return value will be a non-null iterator that provides no samples.

Invalid Data
Some elements in the returned sequence may not have valid data: the valid_data field in the SampleInfo indicates whether the corresponding data value contains any meaningful data. If not, the data value is just a 'dummy' sample for which only the keyfields have been assigned. It is used to accompany the SampleInfo that communicates a change in the instanceState of an instance for which there is no 'real' sample available.

For example, when an application always 'takes' all available samples of a particular instance, there is no sample available to report the disposal of that instance. In such a case the DataReader will insert a dummy sample into the data values sequence to accompany the SampleInfo element that communicates the disposal of the instance.

The act of reading a sample sets its sample_state to SampleState.READ. If the sample belongs to the most recent generation of the instance, it also sets the viewState of the instance to ViewState.NOT_NEW. It does not affect the instanceState of the instance.

Example:

 
 // create a dataState that only reads not read, new and alive samples
 DataState ds = subscriber.createDataState();
 ds = ds.with(SampleState.NOT_READ)
        .with(ViewState.NEW)
        .with(InstanceState.ALIVE);
 // Read samples through an selector with the set dataState
 Selector<Foo> query = fooDr.select();
 query.dataState(ds);
 Iterator<Sample<Foo>> samples = fooDr.read(query);
 // Process each Sample and print its name and production time.
 while (samples.hasNext()) {
     Sample sample = samples.next();
     Foo foo = sample.getData();
     if (foo != null) { //Check if the sample is valid.
          Time t = sample.getSourceTimestamp(); // meta information
          System.out.println("Name: " + foo.myName + " is produced at " + time.getTime(TimeUnit.SECONDS));
     }
 }

Parameters

query a selector to be used on the read

Returns: a non-null unmodifiable iterator over loaned samples.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: read(); #read(List); #read(List, Selector); #readNextSample(Sample); #take(Selector)

◆ read() [7/7]

List<Sample<TYPE> > org.omg.dds.sub.DataReader< TYPE >.read	(	List< Sample< TYPE >>	samples,
		Selector< TYPE >	selector
	)

inherited

This operation accesses a collection of samples from this DataReader.

It behaves exactly like read(Selector) except that the returned samples are not "on loan" from the Service; they are deeply copied to the application.

The number of samples are specified as the minimum of Selector#getMaxSamples() and the length of the list. If the number of samples read are fewer than the current length of the list, the list will be trimmed to fit the samples read. If list is null, a new list will be allocated and its size may be zero or unbounded depending upon the number of samples read. If there are no samples, the list reference will be non-null and the list will contain zero samples.

The read operation will copy the data and meta-information into the elements already inside the given collection, overwriting any samples that might already be present. The use of this variant forces a copy but the application can control where the copy is placed and the application will not need to "return the loan."

Parameters

samples	A pre allocated collection to store the samples in
selector	A selector to be used on the read

Returns: samples, for convenience.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: read(); #read(Selector); #read(List); #readNextSample(Sample); #take(List, Selector)

◆ readNextSample()

boolean org.omg.dds.sub.DataReader< TYPE >.readNextSample ( Sample< TYPE > sample )

inherited

This operation copies the next, non-previously accessed sample from this DataReader.

The implied order among the samples stored in the DataReader is the same as for read(List, Selector).

This operation is semantically equivalent to read(List, Selector) where Selector#getMaxSamples() is 1, Selector#getDataState() followed by Subscriber.DataState#getSampleStates() == org.omg.dds.sub.SampleState#NOT_READ, Selector#getDataState() followed by Subscriber.DataState#getViewStates() contains all view states, and Selector#getDataState() followed by Subscriber.DataState#getInstanceStates() contains all instance states.

This operation provides a simplified API to "read" samples avoiding the need for the application to manage iterators and specify queries.

If there is no unread data in the DataReader, the operation will return false and the provided sample is not modified.

Returns: true if data was read or false if no data was available.

Parameters

sample A valid sample that will contain the new data.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: read(); #read(Selector); #read(List); #read(List, Selector); #takeNextSample(Sample)

Implemented in org.opensplice.dds.sub.DataReaderImpl< TYPE >.

◆ registerIterator()

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.registerIterator ( AbstractIterator< TYPE > iterator )

Definition at line 88 of file AbstractDataReader.java.

◆ retain() [1/2]

final void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.retain ( )

inherited

Definition at line 126 of file EntityImpl.java.

◆ retain() [2/2]

void org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.retain ( )

inherited

Indicates that references to this object may go out of scope but that the application expects to look it up again later.

Therefore, the Service must consider this object to be still in use and may not close it automatically.

◆ returnLoan()

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.returnLoan	(	Object	sampleSeqHolder,
		DDS.SampleInfoSeqHolder	infoSeqHolder
	)

Definition at line 491 of file AbstractDataReader.java.

◆ select()

org.omg.dds.sub.DataReader.Selector<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.select ( )

Provides a Selector that can be used to refine what read or take methods return.

Returns: The Selector object returned by this method is the default selector. By default it selects org.omg.dds.core.policy.ResourceLimits#LENGTH_UNLIMITED samples. This is equivalent to calling org.omg.dds.sub.DataReader#read without any parameters.

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 487 of file AbstractDataReader.java.

◆ setListener() [1/6]

void org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.setListener ( LISTENER listener )

inherited

This operation installs a Listener on the Entity.

The listener will only be invoked on all communication statuses pertaining to the concrete type of this entity.

It is permitted to use null as the value of the listener. The null listener behaves as a Listener whose operations perform no action.

Only one listener can be attached to each Entity. If a listener was already set, the operation will replace it with the new one. Consequently if the value null is passed for the listener parameter, any existing listener will be removed.

Parameters

listener the listener to attach.

See also: getListener(); #setListener(EventListener, Collection)

◆ setListener() [2/6]

void org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.setListener	(	LISTENER	listener,
		Collection< Class<? extends Status >>	statuses
	)

inherited

This operation installs a Listener on the Entity.

The listener will only be invoked on the changes of communication status indicated by the specified mask.

It is permitted to use null as the value of the listener. The null listener behaves as a Listener whose operations perform no action.

Only one listener can be attached to each Entity. If a listener was already set, the operation will replace it with the new one. Consequently if the value null is passed for the listener parameter, any existing listener will be removed.

See also: getListener(); #setListener(EventListener)

◆ setListener() [3/6]

void org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.setListener	(	LISTENER	listener,
		Class<? extends Status >...	statuses
	)

inherited

This operation installs a Listener on the Entity.

The listener will only be invoked on the changes of communication status indicated by the specified mask.

It is permitted to use null as the value of the listener. The null listener behaves as a Listener whose operations perform no action.

Only one listener can be attached to each Entity. If a listener was already set, the operation will replace it with the new one. Consequently if the value null is passed for the listener parameter, any existing listener will be removed.

See also: getListener(); #setListener(EventListener)

◆ setListener() [4/6]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.setListener ( DataReaderListener< TYPE > listener )

Definition at line 237 of file AbstractDataReader.java.

◆ setListener() [5/6]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.setListener	(	DataReaderListener< TYPE >	listener,
		Collection< Class<? extends Status >>	statuses
	)

Definition at line 242 of file AbstractDataReader.java.

◆ setListener() [6/6]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.setListener	(	DataReaderListener< TYPE >	listener,
		Class<? extends Status >...	statuses
	)

Definition at line 249 of file AbstractDataReader.java.

◆ setOld()

void org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.setOld ( OLD old )

protectedinherited

Definition at line 112 of file EntityImpl.java.

◆ setProperty()

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.setProperty	(	String	key,
		String	value
	)

Definition at line 261 of file AbstractDataReader.java.

◆ setQos() [1/2]

void org.omg.dds.core.Entity< LISTENER extends EventListener, QOS extends EntityQos<?>.setQos ( QOS qos )

inherited

This operation is used to set the QoS policies of the Entity.

This operation must be provided by each of the derived Entity classes (org.omg.dds.domain.DomainParticipant, org.omg.dds.topic.Topic, org.omg.dds.pub.Publisher, org.omg.dds.pub.DataWriter, org.omg.dds.sub.Subscriber, org.omg.dds.sub.DataReader) so that the policies that are meaningful to each Entity can be set.

The set of policies specified as the parameter are applied on top of the existing QoS, replacing the values of any policies previously set.

Certain policies are "immutable"; they can only be set at Entity creation time, or before the entity is made enabled. If setQos is invoked after the Entity is enabled and it attempts to change the value of an "immutable" policy, the operation will fail with org.omg.dds.core.ImmutablePolicyException.

Certain values of QoS policies can be incompatible with the settings of the other policies. The setQos operation will also fail if it specifies a set of values that once combined with the existing values would result in an inconsistent set of policies. In this case, it shall fail with org.omg.dds.core.InconsistentPolicyException.

If the application supplies a non-default value for a QoS policy that is not supported by the implementation of the service, the setQos operation will fail with UnsupportedOperationException.

The existing set of policies are only changed if the setQos operation succeeds. In all other cases, none of the policies is modified.

Exceptions

ImmutablePolicyException	if an immutable policy changes its value.
InconsistentPolicyException	if a combination of policies is inconsistent with one another.
UnsupportedOperationException	if an unsupported policy has a non-default value.

See also: getQos()

◆ setQos() [2/2]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.setQos ( DataReaderQos qos )

Definition at line 296 of file AbstractDataReader.java.

◆ take() [1/7]

Iterator<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.take ( )

This operation accesses a collection of samples from this DataReader.

The behavior is identical to read except for that the samples are removed from the DataReader.

Invalid Data
Some elements in the returned sequence may not have valid data: the valid_data field in the SampleInfo indicates whether the corresponding data value contains any meaningful data. If not, the data value is just a 'dummy' sample for which only the keyfields have been assigned. It is used to accompany the SampleInfo that communicates a change in the instanceState of an instance for which there is no 'real' sample available.

For example, when an application always 'takes' all available samples of a particular instance, there is no sample available to report the disposal of that instance. In such a case the DataReader will insert a dummy sample into the data values sequence to accompany the SampleInfo element that communicates the disposal of the instance.

Example:


// Take samples
Iterator<Sample<Foo>> samples = fooDr.take();
// Process each Sample and print its name and production time.
while (samples.hasNext()) {
    Sample sample = samples.next();
    Foo foo = sample.getData();
    if (foo != null) { //Check if the sample is valid.
         Time t = sample.getSourceTimestamp(); // meta information
         System.out.println("Name: " + foo.myName + " is produced at " + time.getTime(TimeUnit.SECONDS));
    }
}

Returns: a non-null unmodifiable iterator over loaned samples.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: #take(Selector); #take(List); #take(List, Selector); #takeNextSample(Sample); read()

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 523 of file AbstractDataReader.java.

◆ take() [2/7]

Iterator<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.take ( int maxSamples )

This operation accesses a collection of samples from this DataReader.

It behaves exactly like take(Selector) except that the collection of returned samples is not constrained by any Selector.

The number of samples accessible via the iterator will not be more than #maxSamples.

Returns: a non-null unmodifiable iterator over loaned samples.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: #take(Selector); #take(List); #take(List, Selector); #takeNextSample(Sample); read()

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 528 of file AbstractDataReader.java.

◆ take() [3/7]

Iterator<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.take ( org.omg.dds.sub.DataReader.Selector< TYPE > query )

Definition at line 533 of file AbstractDataReader.java.

◆ take() [4/7]

List<Sample<TYPE> > org.opensplice.dds.sub.AbstractDataReader< TYPE >.take ( List< Sample< TYPE >> samples )

This operation accesses a collection of samples from this DataReader.

It behaves exactly like take() except that the returned samples are not "on loan" from the Service; they are deeply copied to the application.

The take operation will copy the data and meta-information into the elements already inside the given collection, overwriting any samples that might already be present. The use of this variant forces a copy but the application can control where the copy is placed and the application will not need to "return the loan."


// Take samples and store them in a pre allocated collection
List<Sample<Foo>> samples = new ArrayList<Sample<Foo>>();
fooDr.take(samples);
// Process each Sample and print its name and production time.
for (Sample<Foo> sample : samples) {
    Foo foo = sample.getData();
    if (foo != null) { //Check if the sample is valid.
         Time t = sample.getSourceTimestamp();
         System.out.println("Name: " + foo.myName + " is produced at " + time.getTime(TimeUnit.SECONDS));
    }
}

Parameters

samples A pre allocated collection to store the samples in

Returns: samples, for convenience.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: take(); #take(Selector); #take(List, Selector); #takeNextSample(Sample); #read(List)

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 538 of file AbstractDataReader.java.

◆ take() [5/7]

List<Sample<TYPE> > org.opensplice.dds.sub.AbstractDataReader< TYPE >.take	(	List< Sample< TYPE >>	samples,
		org.omg.dds.sub.DataReader.Selector< TYPE >	selector
	)

Definition at line 543 of file AbstractDataReader.java.

◆ take() [6/7]

Sample.Iterator<TYPE> org.omg.dds.sub.DataReader< TYPE >.take ( Selector< TYPE > query )

inherited

This operation accesses a collection of samples from this DataReader.

The number of samples returned is controlled by the org.omg.dds.core.policy.Presentation and other factors using the same logic as for read(Selector).

The act of taking a sample removes it from the DataReader so it cannot be "read" or "taken" again. If the sample belongs to the most recent generation of the instance, it will also set the view state of the instance to org.omg.dds.sub.ViewState#NOT_NEW. It will not affect the instance state of the instance.

The behavior of the take operation follows the same rules than the read operation regarding the preconditions and postconditions for the arguments and return results. Similar to read, the take operation will "loan" elements to the application; this loan must then be returned by means of Sample.Iterator#close(). The only difference with read is that, as stated, the sample returned by take will no longer be accessible to successive calls to read or take.

If the DataReader has no samples that meet the constraints, the return value will be a non-null iterator that provides no samples.

Example:


// create a dataState that only reads not read, new and alive samples
DataState ds = subscriber.createDataState();
ds = ds.with(SampleState.NOT_READ)
       .with(ViewState.NEW)
       .with(InstanceState.ALIVE);
// Take samples through an selector with the set dataState
Selector<Foo> query = fooDr.select();
query.dataState(ds);
Iterator<Sample<Foo>> samples = fooDr.take(query);
// Process each Sample and print its name and production time.
while (samples.hasNext()) {
    Sample sample = samples.next();
    Foo foo = sample.getData();
    if (foo != null) { //Check if the sample is valid.
         Time t = sample.getSourceTimestamp(); // meta information
         System.out.println("Name: " + foo.myName + " is produced at " + time.getTime(TimeUnit.SECONDS));
    }
}

Parameters

query a selector to be used on the read

Returns: a non-null unmodifiable iterator over loaned samples.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: take(); #take(List); #take(List, Selector); #takeNextSample(Sample); #read(Selector)

◆ take() [7/7]

List<Sample<TYPE> > org.omg.dds.sub.DataReader< TYPE >.take	(	List< Sample< TYPE >>	samples,
		Selector< TYPE >	query
	)

inherited

This operation accesses a collection of samples from this DataReader.

It behaves exactly like take(Selector) except that the returned samples are not "on loan" from the Service; they are deeply copied to the application.

The take operation will copy the data and meta-information into the elements already inside the given collection, overwriting any samples that might already be present. The use of this variant forces a copy but the application can control where the copy is placed and the application will not need to "return the loan."

Parameters

samples	A pre allocated collection to store the samples in
query	A selector to be used on the take

Returns: samples, for convenience.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: take(); #take(Selector); #take(List); #takeNextSample(Sample); #read(List, Selector)

◆ takeNextSample()

boolean org.omg.dds.sub.DataReader< TYPE >.takeNextSample ( Sample< TYPE > sample )

inherited

This operation copies the next, non-previously accessed sample from this DataReader and "removes" it from the DataReader so it is no longer accessible.

This operation is analogous to readNextSample(Sample) except for the fact that the sample is "removed" from the DataReader.

This operation is semantically equivalent to take(List, Selector) where Selector#getMaxSamples() is 1, Selector#getDataState() followed by Subscriber.DataState#getSampleStates() == org.omg.dds.sub.SampleState#NOT_READ, Selector#getDataState() followed by Subscriber.DataState#getViewStates() contains all view states, and Selector#getDataState() followed by Subscriber.DataState#getInstanceStates() contains all instance states.

This operation provides a simplified API to "take" samples avoiding the need for the application to manage iterators and specify queries.

If there is no unread data in the DataReader, the operation will return false and the provided sample is not modified.

Returns: true if data was taken or false if no data was available.

Parameters

sample A valid sample that will contain the new data.

Exceptions

org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.

See also: take(); #take(Selector); #take(List); #take(List, Selector); #readNextSample(Sample)

Implemented in org.opensplice.dds.sub.DataReaderImpl< TYPE >.

◆ waitForHistoricalData() [1/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData ( Duration maxWait ) throws TimeoutException

This operation is intended only for DataReader entities for which org.omg.dds.core.policy.Durability#getKind() is not org.omg.dds.core.policy.Durability.Kind#VOLATILE.

As soon as an application enables a non-VOLATILE DataReader it will start receiving both "historical" data, i.e., the data that was written prior to the time the DataReader joined the domain, as well as any new data written by the DataWriter entities. There are situations where the application logic may require the application to wait until all "historical" data is received. This is the purpose of this operation.

The operation blocks the calling thread until either all "historical" data is received, or else the duration specified by the maxWait parameter elapses, whichever happens first.

Parameters

maxWait the maximum duration to block for the waitForHistoricalData, after which the application thread is unblocked.

Exceptions

TimeoutException	if maxWait elapsed before all the data was received.
org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.
org.omg.dds.core.PreconditionNotMetException	Can happen when requesting conditional alignment on non-volatile readers or Historical data request already in progress or complete.

See also: waitForHistoricalData(long, TimeUnit)

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 331 of file AbstractDataReader.java.

◆ waitForHistoricalData() [2/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	long	maxWait,
		TimeUnit	unit
	)		throws TimeoutException

This operation is intended only for DataReader entities for which org.omg.dds.core.policy.Durability#getKind() is not org.omg.dds.core.policy.Durability.Kind#VOLATILE.

As soon as an application enables a non-VOLATILE DataReader it will start receiving both "historical" data, i.e., the data that was written prior to the time the DataReader joined the domain, as well as any new data written by the DataWriter entities. There are situations where the application logic may require the application to wait until all "historical" data is received. This is the purpose of this operation.

The operation blocks the calling thread until either all "historical" data is received, or else the duration specified by the maxWait parameter elapses, whichever happens first.

Parameters

maxWait	The maximum duration to block for the waitForHistoricalData, after which the application thread is unblocked.
unit	The TimeUnit which the sourceTimestamp describes (i.e. TimeUnit.SECONDS or TimeUnit.MILLISECONDS)

Exceptions

TimeoutException	if maxWait elapsed before all the data was received.
org.omg.dds.core.DDSException	An internal error has occurred.
org.omg.dds.core.AlreadyClosedException	The corresponding DataReader has been closed.
org.omg.dds.core.OutOfResourcesException	The Data Distribution Service ran out of resources to complete this operation.
org.omg.dds.core.PreconditionNotMetException	Can happen when requesting conditional alignment on non-volatile readers or Historical data request already in progress or complete.

See also: waitForHistoricalData(Duration)

Implements org.omg.dds.sub.DataReader< TYPE >.

Definition at line 336 of file AbstractDataReader.java.

◆ waitForHistoricalData() [3/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	String	filterExpression,
		List< String >	filterParameters,
		Time	minSourceTimestamp,
		Time	maxSourceTimestamp,
		ResourceLimits	resourceLimits,
		Duration	maxWait
	)		throws TimeoutException

Definition at line 342 of file AbstractDataReader.java.

◆ waitForHistoricalData() [4/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	String	filterExpression,
		List< String >	filterParameters,
		Time	minSourceTimestamp,
		Time	maxSourceTimestamp,
		Duration	maxWait
	)		throws TimeoutException

Definition at line 352 of file AbstractDataReader.java.

◆ waitForHistoricalData() [5/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	String	filterExpression,
		List< String >	filterParameters,
		ResourceLimits	resourceLimits,
		Duration	maxWait
	)		throws TimeoutException

Definition at line 361 of file AbstractDataReader.java.

◆ waitForHistoricalData() [6/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	String	filterExpression,
		List< String >	filterParameters,
		Duration	maxWait
	)		throws TimeoutException

Definition at line 370 of file AbstractDataReader.java.

◆ waitForHistoricalData() [7/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	Time	minSourceTimestamp,
		Time	maxSourceTimestamp,
		ResourceLimits	resourceLimits,
		Duration	maxWait
	)		throws TimeoutException

Definition at line 380 of file AbstractDataReader.java.

◆ waitForHistoricalData() [8/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	Time	minSourceTimestamp,
		Time	maxSourceTimestamp,
		Duration	maxWait
	)		throws TimeoutException

Definition at line 390 of file AbstractDataReader.java.

◆ waitForHistoricalData() [9/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	ResourceLimits	resourceLimits,
		Duration	maxWait
	)		throws TimeoutException

Definition at line 399 of file AbstractDataReader.java.

◆ waitForHistoricalData() [10/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	String	filterExpression,
		List< String >	filterParameters,
		Time	minSourceTimestamp,
		Time	maxSourceTimestamp,
		ResourceLimits	resourceLimits,
		long	maxWait,
		TimeUnit	unit
	)		throws TimeoutException

Definition at line 408 of file AbstractDataReader.java.

◆ waitForHistoricalData() [11/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	String	filterExpression,
		List< String >	filterParameters,
		Time	minSourceTimestamp,
		Time	maxSourceTimestamp,
		long	maxWait,
		TimeUnit	unit
	)		throws TimeoutException

Definition at line 418 of file AbstractDataReader.java.

◆ waitForHistoricalData() [12/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	String	filterExpression,
		List< String >	filterParameters,
		ResourceLimits	resourceLimits,
		long	maxWait,
		TimeUnit	unit
	)		throws TimeoutException

Definition at line 428 of file AbstractDataReader.java.

◆ waitForHistoricalData() [13/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	String	filterExpression,
		List< String >	filterParameters,
		long	maxWait,
		TimeUnit	unit
	)		throws TimeoutException

Definition at line 438 of file AbstractDataReader.java.

◆ waitForHistoricalData() [14/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	Time	minSourceTimestamp,
		Time	maxSourceTimestamp,
		ResourceLimits	resourceLimits,
		long	maxWait,
		TimeUnit	unit
	)		throws TimeoutException

Definition at line 448 of file AbstractDataReader.java.

◆ waitForHistoricalData() [15/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	Time	minSourceTimestamp,
		Time	maxSourceTimestamp,
		long	maxWait,
		TimeUnit	unit
	)		throws TimeoutException

Definition at line 457 of file AbstractDataReader.java.

◆ waitForHistoricalData() [16/16]

void org.opensplice.dds.sub.AbstractDataReader< TYPE >.waitForHistoricalData	(	ResourceLimits	resourceLimits,
		long	maxWait,
		TimeUnit	unit
	)		throws TimeoutException

Definition at line 466 of file AbstractDataReader.java.

Member Data Documentation

◆ conditions

final HashMap<DDS.Condition, ReadConditionImpl<TYPE> > org.opensplice.dds.sub.AbstractDataReader< TYPE >.conditions

protected

Definition at line 73 of file AbstractDataReader.java.

◆ environment

final transient OsplServiceEnvironment org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.environment

protectedinherited

Definition at line 36 of file EntityImpl.java.

◆ iterators

final HashSet<AbstractIterator<TYPE> > org.opensplice.dds.sub.AbstractDataReader< TYPE >.iterators

protected

Definition at line 74 of file AbstractDataReader.java.

◆ listener

LISTENERIMPL org.opensplice.dds.core.EntityImpl< OLD extends DDS.Entity, OLDPARENT, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.listener

protectedinherited

Definition at line 39 of file EntityImpl.java.

◆ parent

PARENT org.opensplice.dds.core.DomainEntityImpl< OLD extends DDS.Entity, PARENT extends EntityImpl<?, ?, ?, ?, ?, OLDPARENT extends DDS.Entity, QOS extends EntityQos<?, LISTENER extends EventListener, LISTENERIMPL extends Listener< LISTENER >.parent

protectedinherited

Definition at line 40 of file DomainEntityImpl.java.

◆ selector

final Selector<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.selector

protected

Definition at line 75 of file AbstractDataReader.java.

◆ topicDescription

final TopicDescriptionExt<TYPE> org.opensplice.dds.sub.AbstractDataReader< TYPE >.topicDescription

protected

Definition at line 72 of file AbstractDataReader.java.

The documentation for this class was generated from the following file:

java5/common/java/code/org/opensplice/dds/sub/AbstractDataReader.java

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AbstractDataReader()

Member Function Documentation

◆ close() [1/2]

◆ close() [2/2]

◆ closeContainedEntities()

◆ createIterator()

◆ createQueryCondition() [1/4]

◆ createQueryCondition() [2/4]

◆ createQueryCondition() [3/4]

◆ createQueryCondition() [4/4]

◆ createReadCondition()

◆ deregisterIterator()

◆ destroy()

◆ destroyReadCondition()

◆ enable() [1/2]

◆ enable() [2/2]

◆ getEnvironment()

◆ getInstanceHandle() [1/2]

◆ getInstanceHandle() [2/2]

◆ getKeyValue() [1/2]

◆ getKeyValue() [2/2]

◆ getListener() [1/2]

◆ getListener() [2/2]

◆ getLivelinessChangedStatus()

◆ getMatchedPublicationData()

◆ getMatchedPublications()

◆ getOld()

◆ getOldParent()

◆ getParent()

◆ getPreAllocator()

◆ getProperty()

◆ getQos()

◆ getReflectionReader()

◆ getRequestedDeadlineMissedStatus()

◆ getRequestedIncompatibleQosStatus()

◆ getSampleLostStatus()

◆ getSampleRejectedStatus()

◆ getStatusChanges() [1/2]

◆ getStatusChanges() [2/2]

◆ getStatusCondition()

◆ getSubscriptionMatchedStatus()

◆ getTopicDescription()

◆ lookupInstance()

◆ printReferences()

◆ read() [1/7]

◆ read() [2/7]

◆ read() [3/7]

◆ read() [4/7]

◆ read() [5/7]

◆ read() [6/7]

◆ read() [7/7]

◆ readNextSample()

◆ registerIterator()

◆ retain() [1/2]

◆ retain() [2/2]

◆ returnLoan()

◆ select()

◆ setListener() [1/6]

◆ setListener() [2/6]

◆ setListener() [3/6]

◆ setListener() [4/6]

◆ setListener() [5/6]

◆ setListener() [6/6]

◆ setOld()

◆ setProperty()

◆ setQos() [1/2]

◆ setQos() [2/2]

◆ take() [1/7]

◆ take() [2/7]

◆ take() [3/7]

◆ take() [4/7]

◆ take() [5/7]

◆ take() [6/7]

◆ take() [7/7]