kieker.analysis.plugin.reader

Interface IReaderPlugin

All Superinterfaces:

IAnalysisComponent, IPlugin

All Known Implementing Classes:

AbstractRawDataReader, AbstractReaderPlugin, AbstractStringRegistryReaderPlugin, AmqpReader, AsciiLogReader, BinaryLogReader, DbReader, DualSocketTcpReader, FSReader, JmsReader, JmxReader, KafkaReader, ListReader, PipeReader, RawDataReaderPlugin, SingleSocketTcpReader, TCPReader, TimeReader

public interface IReaderPlugin
extends IPlugin

This is the interface for reader plugins.

Since:

0.95a

Author:

Andre van Hoorn

Nested Class Summary

Nested classes/interfaces inherited from interface kieker.analysis.plugin.IPlugin

IPlugin.PluginInputPortReference, IPlugin.STATE

Method Summary

Modifier and Type	Method and Description
boolean	read() Starts the reader.

Methods inherited from interface kieker.analysis.plugin.IPlugin

connect, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentConfiguration, getCurrentRepositories, getName, getPluginDescription, getPluginName, getState, init, terminate

Method Detail

read

boolean read()

Starts the reader. This method is intended to be a blocking operation, i.e., it is assumed that reading has finished before this method returns. The method should indicate an error by the return value false. In asynchronous scenarios, the IPlugin.terminate(boolean) method can be used to initiate the termination of this method.

Returns:

true if reading was successful; false if an error occurred

Since:

1.2