kieker.analysis.plugin.reader
Interface IReaderPlugin

All Known Implementing Classes:

AbstractReaderPlugin, DbReader, FSReader, FSReaderRealtime, JMSReader, JMXReader, PipeReader

public interface IReaderPlugin

Author:

Andre van Hoorn

Method Summary

boolean	read() Starts the reader.
void	terminate(boolean error) Initiates a termination of the reader.

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 terminate(boolean) method can be used to initiate the termination of this method.

Returns:

true if reading was successful; false if an error occurred

terminate

void terminate(boolean error)

Initiates a termination of the reader. This method is only used by the framework and should not be called manually to register a receiver. Use the method AnalysisController.terminate(boolean) instead. After receiving this notification, the reader should terminate its read() method.