org.omg.dds.core.event.DataAvailableEvent< TYPE > Class Template Reference

The DataAvailableEvent status change becomes TRUE when either a data-sample arrives or else the ViewState, SampleState, or InstanceState of any existing sample changes for any reason other than a call to DataReader#read(), DataReader#take() or their variants. More...

Inheritance diagram for org.omg.dds.core.event.DataAvailableEvent< TYPE >:

Collaboration diagram for org.omg.dds.core.event.DataAvailableEvent< TYPE >:

Public Member Functions
abstract DataAvailableEvent< TYPE >	clone ()
abstract SOURCE	getSource ()
abstract DataAvailableStatus	getStatus ()

Protected Member Functions
	DataAvailableEvent (DataReader< TYPE > source)
void	setSource (SOURCE source)

Detailed Description

The DataAvailableEvent status change becomes TRUE when either a data-sample arrives or else the ViewState, SampleState, or InstanceState of any existing sample changes for any reason other than a call to DataReader#read(), DataReader#take() or their variants.

Specifically any of the following events will cause the DataAvailableStatus to become TRUE:

• The arrival of new data.
• A change in the InstanceState of a contained instance. This can be caused by either:
  • The arrival of the notification that an instance has been disposed by:
    • the DataWriter that owns it if Ownership QoS kind= OwnershipQosPolicyKind
    • or by any DataWriter if Ownership QoS kind=SHARED.
• The loss of liveliness of the DataWriter of an instance for which there is no other DataWriter.
• The arrival of the notification that an instance has been unregistered by the only DataWriter that is known to be writing the instance.

Any of the following events will cause the DataAvailableStatus to become FALSE:

• The DataAvailableStatus becomes FALSE when either the corresponding listener operation (onDataAvailable) is called or the read or take operation (or their variants) is called on the associated DataReader.
• The DataOnReadersStatus becomes FALSE when any of the following events occurs:
  • The corresponding listener operation (onDataOnReaders) is called.
  • The onDataAvailable listener operation is called on any DataReader belonging to the Subscriber.
  • The read or take operation (or their variants) is called on any DataReader belonging to the Subscriber.

Parameters

<TYPE>

The data type of the source org.omg.dds.sub.DataReader.

See also

DataOnReadersEvent

DataAvailableStatus

Definition at line 66 of file DataAvailableEvent.java.

Constructor & Destructor Documentation

DataAvailableEvent()

org.omg.dds.core.event.DataAvailableEvent< TYPE >.DataAvailableEvent ( DataReader< TYPE >  source )

protected

Definition at line 85 of file DataAvailableEvent.java.

Member Function Documentation

clone()

abstract DataAvailableEvent<TYPE> org.omg.dds.core.event.DataAvailableEvent< TYPE >.clone ( )

abstract

getSource()

abstract SOURCE org.omg.dds.core.event.StatusChangedEvent< SOURCE extends Entity<?, ?>.getSource ( )

abstractinherited

getStatus()

abstract DataAvailableStatus org.omg.dds.core.event.DataAvailableEvent< TYPE >.getStatus ( )

abstract

setSource()

void org.omg.dds.core.event.StatusChangedEvent< SOURCE extends Entity<?, ?>.setSource ( SOURCE  source )

protectedinherited

Definition at line 68 of file StatusChangedEvent.java.

---

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

• java5/common/java/code/org/omg/dds/core/event/DataAvailableEvent.java