Package org.jgrapes.io

Class InputStreamMonitor

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.io.InputStreamMonitor

All Implemented Interfaces:

Iterable<ComponentType>, Runnable, Channel, ComponentType, Eligible, Manager

public class InputStreamMonitor
extends Component
implements Runnable

A component that watches for new input on an InputStream.

If new input becomes available, it is fired as Input event.

This component should only be used to monitor an input stream that is available during the complete lifetime of the application. A typical usage is to make data from System.in available as events.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jgrapes.core.Channel

Channel.Default

Field Summary

Fields inherited from class org.jgrapes.core.Component

logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
InputStreamMonitor(Channel componentChannel, InputStream input)	Creates a new input stream monitor with its channel set to the given channel.
InputStreamMonitor(Channel componentChannel, InputStream input, Channel dataChannel)	Creates a new input stream monitor with its channel set to the given channel.

Method Summary

Modifier and Type	Method	Description
int	getBufferSize()	Returns the buffer size.
void	onConfigurationUpdate(ConfigurationUpdate event)	The component can be configured with events that include a path (see @link ConfigurationUpdate.paths()) that matches this components path (see Manager.componentPath()).
void	onStart(Start event)	Starts a thread that continuously reads available data from the input stream.
void	onStop(Stop event)	Stops the thread that reads data from the input stream.
void	run()
InputStreamMonitor	setBufferSize(int bufferSize)	Sets the buffer size.

Methods inherited from class org.jgrapes.core.Component

channel, component, defaultCriterion, isEligibleFor, setName

Methods inherited from class org.jgrapes.core.internal.ComponentVertex

activeEventPipeline, addHandler, attach, children, componentPath, componentVertex, detach, fire, initComponentsHandlers, iterator, name, newEventPipeline, newEventPipeline, parent, registerAsGenerator, root, toString, unregisterAsGenerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jgrapes.core.Manager

stream

Constructor Details

InputStreamMonitor

public InputStreamMonitor(Channel componentChannel,
 InputStream input,
 Channel dataChannel)

Creates a new input stream monitor with its channel set to the given channel.

The channel is also used for firing the Input events.

Parameters:

componentChannel - the component channel

input - the input stream

dataChannel - the data channel

InputStreamMonitor

public InputStreamMonitor(Channel componentChannel,
 InputStream input)

Creates a new input stream monitor with its channel set to the given channel.

The channel is also used for firing the Input events.

Parameters:

componentChannel - the component channel

input - the input

Method Details

setBufferSize

public InputStreamMonitor setBufferSize(int bufferSize)

Sets the buffer size.

Parameters:

bufferSize - the buffer size

Returns:

the input stream monitor for easy chaining

getBufferSize

public int getBufferSize()

Returns the buffer size.

Returns:

the buffer size

onConfigurationUpdate

@Handler
public void onConfigurationUpdate(ConfigurationUpdate event)

The component can be configured with events that include a path (see @link ConfigurationUpdate.paths()) that matches this components path (see Manager.componentPath()).

The following properties are recognized:

bufferSize

See setBufferSize(int).

Parameters:

event - the event

onStart

@Handler
public void onStart(Start event)

Starts a thread that continuously reads available data from the input stream.

Parameters:

event - the event

onStop

@Handler(priority=-10000)
public void onStop(Stop event)
            throws InterruptedException

Stops the thread that reads data from the input stream.

Note that the input stream is not closed.

Parameters:

event - the event

Throws:

InterruptedException - the interrupted exception

run

public void run()

Specified by:

run in interface Runnable