kieker.analysis.plugin.reader.tcp

Class SingleSocketTcpReader

java.lang.Object

kieker.analysis.analysisComponent.AbstractAnalysisComponent

kieker.analysis.plugin.AbstractPlugin

kieker.analysis.plugin.reader.AbstractReaderPlugin

kieker.analysis.plugin.reader.tcp.SingleSocketTcpReader

All Implemented Interfaces:

IAnalysisComponent, IPlugin, IReaderPlugin, IRecordReceivedListener

public final class SingleSocketTcpReader
extends AbstractReaderPlugin
implements IRecordReceivedListener

This is a reader which reads the records from a TCP port.

Since:

1.13

Author:

Christian Wulf

Nested Class Summary

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

IPlugin.PluginInputPortReference, IPlugin.STATE

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_PROPERTY_NAME_PORT The name of the configuration determining the TCP port.
static java.lang.String	OUTPUT_PORT_NAME_RECORDS The name of the output port delivering the received records.

Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

CONFIG_NAME, configuration, logger, projectContext, recordsTimeUnitFromProjectContext

Constructor Summary

Constructors

Constructor and Description
SingleSocketTcpReader(Configuration configuration, IProjectContext projectContext)

Method Summary

Modifier and Type	Method and Description
Configuration	getCurrentConfiguration() This method should deliver a Configuration object containing the current configuration of this instance.
void	onRecordReceived(IMonitoringRecord record) Listener method.
boolean	read() Starts the reader.
void	terminate(boolean error) Initiates a termination of the plugin.

Methods inherited from class kieker.analysis.plugin.reader.AbstractReaderPlugin

init

Methods inherited from class kieker.analysis.plugin.AbstractPlugin

areAllRepositoryPortsConnected, connect, connect, deliver, getAllDisplayNames, getAllInputPortNames, getAllOutputPortNames, getAllRepositoryPortNames, getConnectedPlugins, getCurrentRepositories, getDefaultConfiguration, getIncomingPlugins, getPluginDescription, getPluginName, getRepository, getState, isConnectionAllowed, notifyNewIncomingConnection, notifyNewOutgoingConnection, shutdown, start

Methods inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface kieker.analysis.plugin.IPlugin

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

Field Detail

OUTPUT_PORT_NAME_RECORDS

public static final java.lang.String OUTPUT_PORT_NAME_RECORDS

The name of the output port delivering the received records.

See Also:

Constant Field Values

CONFIG_PROPERTY_NAME_PORT

public static final java.lang.String CONFIG_PROPERTY_NAME_PORT

The name of the configuration determining the TCP port.

See Also:

Constant Field Values

Constructor Detail

SingleSocketTcpReader

public SingleSocketTcpReader(Configuration configuration,
                             IProjectContext projectContext)

Method Detail

getCurrentConfiguration

public Configuration getCurrentConfiguration()

Description copied from class: AbstractAnalysisComponent

This method should deliver a Configuration object containing the current configuration of this instance. In other words: The constructor should be able to use the given object to initialize a new instance of this class with the same intern properties.

Specified by:

getCurrentConfiguration in interface IAnalysisComponent

Specified by:

getCurrentConfiguration in interface IPlugin

Specified by:

getCurrentConfiguration in class AbstractAnalysisComponent

Returns:

A completely filled configuration object.

read

public boolean read()

Description copied from interface: IReaderPlugin

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.

Specified by:

read in interface IReaderPlugin

Returns:

true if reading was successful; false if an error occurred

onRecordReceived

public void onRecordReceived(IMonitoringRecord record)

Description copied from interface: IRecordReceivedListener

Listener method.

Specified by:

onRecordReceived in interface IRecordReceivedListener

Parameters:

record - received record

terminate

public void terminate(boolean error)

Description copied from interface: IPlugin

Initiates a termination of the plugin. This method is only used by the framework and should not be called manually. Use the method AnalysisController.terminate(boolean) instead. After receiving this notification, the plugin should terminate any running methods, e.g., read for readers.

Specified by:

terminate in interface IPlugin

Parameters:

error - Determines whether the plugin is terminated due to an error or not.