StreamReader interface (optional). More...

Inheritance diagram for StreamReader:

Public Member Functions
void	read (List< Object > sampleList, List< Object > infoList) throws AdapterException
	Reads a collection of data samples and sample infos from an input stream. More...

void	returnLoan (List< Object > sampleList, List< Object > infoList) throws AdapterException
	Returns the loan on the read samples and infos. More...

Public Member Functions inherited from Entity
void	update (Properties properties) throws AdapterException
	Updates the configuration of an adapter entity. More...

Detailed Description

StreamReader interface (optional).

A StreamReader provides a way to read samples of a specific type from a data domain.

In the XML configuration file, StreamReaders are associated with the tag <input> within <route> and <auto_route>.

Member Function Documentation

◆ read()

void read	(	List< Object >	sampleList,
		List< Object >	infoList
	)		throws AdapterException

Reads a collection of data samples and sample infos from an input stream.

When RTI Routing Service is done using the samples, it will 'return the loan' to the StreamReader by calling com.rti.routingservice.adapter.StreamReader.returnLoan.

Required: Only when the adapter is used to read data.

Parameters

sampleList <<out>> List that will hold the output samples. The objects in the list are typically of the class com.rti.dds.dynamicdata.DynamicData (see the RTI Connext documentation). But in general, the data representation associated with the output samples will be given by the value of the connection attribute com.rti.routingservice.adapter.data_representation_kind that is obtained using the associated com.rti.routingservice.infrastructure.StreamInfo.

infoList <<out>> List that will hold the output sample infos. It can be left empty if there is no info associated to the samples. The objects in the list are typically of the class com.rti.dds.subscription.SampleInfo (see the RTI Connext documentation). But in general the info representation associated with the output sample infos will be given by the value of the connection attribute com.rti.routingservice.adapter.info_representation_kind that is obtained using the associated com.rti.routingservice.infrastructure.StreamInfo.

Exceptions

AdapterException - if an error occurs.

See also: com.rti.routingservice.adapter.StreamReader.returnLoan

◆ returnLoan()

void returnLoan	(	List< Object >	sampleList,
		List< Object >	infoList
	)		throws AdapterException

Returns the loan on the read samples and infos.

RTI Routing Service calls this method to indicate that it is done accessing the collection of data samples and sample infos obtained by an earlier invocation of com.rti.routingservice.adapter.StreamReader.read.