org.omg.dds.sub.Sample< TYPE >.Iterator< IT_DATA > Interface Template Reference

Inheritance diagram for org.omg.dds.sub.Sample< TYPE >.Iterator< IT_DATA >:

Collaboration diagram for org.omg.dds.sub.Sample< TYPE >.Iterator< IT_DATA >:

Public Member Functions
void	add (Sample< IT_DATA > o)
abstract void	close () throws java.io.IOException
	This operation indicates to that the application is done accessing the list of Samples obtained by some earlier invocation of org.omg.dds.sub.DataReader#read() or org.omg.dds.sub.DataReader#take(). More...
void	remove ()
void	set (Sample< IT_DATA > o)

Detailed Description

Definition at line 419 of file Sample.java.

Member Function Documentation

add()

void org.omg.dds.sub.Sample< TYPE >.Iterator< IT_DATA >.add

(

Sample< IT_DATA >

o

)

Exceptions

UnsupportedOperationException

always.

close()

abstract void org.omg.dds.sub.Sample< TYPE >.Iterator< IT_DATA >.close ( ) throws java.io.IOException

abstract

This operation indicates to that the application is done accessing the list of Samples obtained by some earlier invocation of org.omg.dds.sub.DataReader#read() or org.omg.dds.sub.DataReader#take().

The operation allows implementations to "loan" buffers from the DataReader to the application and in this manner provide "zero-copy" access to the data. During the loan, the DataReader will guarantee that the data and sample information are not modified.

It is not necessary for an application to return the loans immediately after the read or take calls. However, as these buffers correspond to internal resources inside the DataReader, the application should not retain them indefinitely.

The use of the operation is only necessary if the read or take calls "loaned" buffers to the application. The situations in which this occurs are described in the documentation for org.omg.dds.sub.DataReader#read() and org.omg.dds.sub.DataReader#take(). However, calling close on a collection that does not have a loan is safe and has no side effects.

See also

DataReader::read()

DataReader::take()

remove()

void org.omg.dds.sub.Sample< TYPE >.Iterator< IT_DATA >.remove

(

)

Exceptions

UnsupportedOperationException

always.

set()

void org.omg.dds.sub.Sample< TYPE >.Iterator< IT_DATA >.set

(

Sample< IT_DATA >

o

)

Exceptions

UnsupportedOperationException

always.

---

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

• java5/common/java/code/org/omg/dds/sub/Sample.java