java.lang.Object

kieker.analysis.plugin.reader.namedRecordPipe.PipeReader

All Implemented Interfaces:: IAnalysisComponent, IPlugin, IReaderPlugin, IPipeReader

@Deprecated
public final class PipeReader
extends AbstractReaderPlugin
implements IPipeReader

Deprecated.

1.15 ported to teetime

This reader can be used to read records via an in-memory pipe.

Since:: 1.3
Author:: Andre van Hoorn

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`CONFIG_PROPERTY_NAME_PIPENAME`	Deprecated. This is the configuration-parameter for the name of the pipe to be used.
`static java.lang.String`	`CONFIG_PROPERTY_VALUE_PIPENAME_DEFAULT`	Deprecated. The default used pipe name.
`static java.lang.String`	`OUTPUT_PORT_NAME_RECORDS`	Deprecated. This is the name of the default output port.

Fields inherited from class kieker.analysis.analysisComponent.AbstractAnalysisComponent

CONFIG_NAME, configuration, logger, projectContext, recordsTimeUnitFromProjectContext

Constructor Summary

Constructors
Constructor	Description
`PipeReader(Configuration configuration, IProjectContext projectContext)`	Deprecated. Creates a new instance of this class using the given parameters.

Method Summary

Modifier and Type	Method	Description
`Configuration`	`getCurrentConfiguration()`	Deprecated. This method should deliver a `Configuration` object containing the current configuration of this instance.
`boolean`	`newMonitoringRecord(IMonitoringRecord rec)`	Deprecated. This method sends a given records directly to the output port.
`void`	`notifyPipeClosed()`	Deprecated. Called to notify the reader that the pipe is closed.
`boolean`	`read()`	Deprecated. Blocks until the associated pipe is being closed.
`void`	`terminate(boolean error)`	Deprecated. 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 Details
- OUTPUT_PORT_NAME_RECORDS
  
  public static final java.lang.String OUTPUT_PORT_NAME_RECORDS
  
  Deprecated.
  
  This is the name of the default output port.
  
  See Also:
  
  Constant Field Values
- CONFIG_PROPERTY_NAME_PIPENAME
  
  public static final java.lang.String CONFIG_PROPERTY_NAME_PIPENAME
  
  Deprecated.
  
  This is the configuration-parameter for the name of the pipe to be used.
  
  See Also:
  
  Constant Field Values
- CONFIG_PROPERTY_VALUE_PIPENAME_DEFAULT
  
  public static final java.lang.String CONFIG_PROPERTY_VALUE_PIPENAME_DEFAULT
  
  Deprecated.
  
  The default used pipe name.
  
  See Also:
  
  Constant Field Values
Constructor Details
- PipeReader
  
  public PipeReader(Configuration configuration, IProjectContext projectContext)
  
  Deprecated.
  
  Creates a new instance of this class using the given parameters.
  
  Parameters:
  
  configuration - The configuration for this component.
  
  projectContext - The project context for this component.
Method Details
- read
  
  public boolean read()
  
  Deprecated.
  
  Blocks until the associated pipe is being closed.
  
  Specified by:
  
  read in interface IReaderPlugin
  
  Returns:
  
  true if the reading terminated in a "normal" way. If an interrupt terminates the wait-method too early, false will be returned.
- newMonitoringRecord
  
  public boolean newMonitoringRecord(IMonitoringRecord rec)
  
  Deprecated.
  
  This method sends a given records directly to the output port.
  
  Specified by:
  
  newMonitoringRecord in interface IPipeReader
  
  Parameters:
  
  rec - The new record object.
  
  Returns:
  
  true if and only if the record has been delivered.
- notifyPipeClosed
  
  public void notifyPipeClosed()
  
  Deprecated.
  
  Called to notify the reader that the pipe is closed.
  
  Specified by:
  
  notifyPipeClosed in interface IPipeReader
- terminate
  
  public void terminate(boolean error)
  
  Deprecated.
  
  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.
- getCurrentConfiguration
  
  public Configuration getCurrentConfiguration()
  
  Deprecated.
  
  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.

Class PipeReader

Nested Class Summary

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