RTI Routing Service  Version 7.0.0
StreamWriter Interface Reference

StreamWriter interface (optional). More...

Inheritance diagram for StreamWriter:
Entity

Public Member Functions

int write (List< Object > sampleList, List< Object > infoList) throws AdapterException
 Writes a collection of data samples to an output stream. More...
 
- Public Member Functions inherited from Entity
void update (Properties properties) throws AdapterException
 Updates the configuration of an adapter entity. More...
 

Detailed Description

StreamWriter interface (optional).

A StreamWriter provides a way to write samples of a specific type in a data domain.

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

Member Function Documentation

◆ write()

int write ( List< Object >  sampleList,
List< Object >  infoList 
) throws AdapterException

Writes a collection of data samples to an output stream.

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

Parameters
sampleList<<in>> List of samples. The data representation associated with the 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<<in>> List of samples info. The info representation associated with the 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.
Returns
Number of samples written.
Exceptions
AdapterException- if an error occurs.