Read contents from a Java InputStream. More...

Public Member Functions
	ReadInputStream (InputStream is)
	Creates a new input stream processor. More...

ReadInputStream	setChunkSize (int size)
	Sets the size of chunks (in bytes) that the stream reader will try to read from the source at each attempt. More...

ReadInputStream	setIsFile (boolean b)
	Tells this reader whether it is reading from a file or some other input source. More...

ReadInputStream	duplicate (boolean with_state)
	Duplicates an object. More...

Public Member Functions inherited from ca.uqac.lif.cep.tmf.Source
	Source (int out_arity)

final void	push ()
	Tells the source to push events into the pipeline. More...

Public Member Functions inherited from ca.uqac.lif.cep.SynchronousProcessor
	SynchronousProcessor (int in_arity, int out_arity)
	Initializes a processor. More...

synchronized Pushable	getPushableInput (int index)

synchronized Pullable	getPullableOutput (int index)

final SynchronousProcessor	setEventTracker (EventTracker tracker)

Public Member Functions inherited from ca.uqac.lif.cep.Processor
	Processor (int in_arity, int out_arity)
	Initializes a processor. More...

final synchronized Object	getContext (String key)
	Retrieves an object from the processor's context. More...

synchronized Context	getContext ()
	Gets the context associated to this object. More...

synchronized void	setContext (String key, Object value)
	Adds an object to the object's context. More...

synchronized void	setContext (Context context)
	Adds a complete context to this object. More...

final int	hashCode ()
	Implementation of hashCode() specific to processors. More...

final boolean	equals (Object o)
	Implementation of equals() specific to processors. More...

final int	getId ()
	Fetches the processor instance's unique ID. More...

synchronized void	reset ()
	Resets the processor. More...

abstract Pushable	getPushableInput (int index)
	Returns the Pushable corresponding to the processor's i-th input trace. More...

final synchronized Pushable	getPushableInput ()
	Returns the Pushable corresponding to the processor's first input trace. More...

abstract Pullable	getPullableOutput (int index)
	Returns the Pullable corresponding to the processor's i-th output trace. More...

final synchronized Pullable	getPullableOutput ()
	Returns the Pullable corresponding to the processor's first output trace. More...

synchronized void	setPullableInput (int i, Pullable p)
	Assigns a Pullable to the processor's i-th input. More...

synchronized Pullable	getPullableInput (int i)
	Returns the Pullable corresponding to the processor's i-th input. More...

synchronized void	setPushableOutput (int i, Pushable p)
	Assigns a Pushable to the processor's i-th output. More...

synchronized Pushable	getPushableOutput (int i)
	Retrieves the Pushable associated to the processor's i-th output. More...

final int	getInputArity ()
	Returns the processor's input arity. More...

final int	getOutputArity ()
	Returns the processor's output arity. More...

void	duplicateInto (Processor p)
	Copies the contents and state of the current processor into another. More...

final Set< Class<?> >	getInputType (int index)
	Gets the type of events the processor accepts for its i-th input trace. More...

void	getInputTypesFor (Set< Class<?>> classes, int index)
	Populates the set of classes accepted by the processor for its i-th input. More...

Class<?>	getOutputType (int index)
	Returns the type of the events produced by the processor for its i-th output. More...

void	start ()
	Starts the processor. More...

void	stop ()
	Stops the processor. More...

final EventTracker	getEventTracker ()
	Gets the instance of event tracker associated to this processor. More...

Processor	setEventTracker (EventTracker tracker)
	Associates an event tracker to this processor. More...

void	associateToInput (int in_stream_index, int in_stream_pos, int out_stream_index, int out_stream_pos)
	Associates an input event to an output event. More...

void	associateTo (NodeFunction f, int out_stream_index, int out_stream_pos)
	Associates a node function to a particular event of processor's output stream. More...

void	associateToOutput (int in_stream_index, int in_stream_pos, int out_stream_index, int out_stream_pos)
	Associates an input event to an output event. More...

final int	getInputCount ()
	Gets the number of event fronts received so far by this processor. More...

final int	getOutputCount ()
	Gets the number of event fronts produced so far by this processor. More...

final Object	print (ObjectPrinter<?> printer) throws ProcessorException
	Prints the contents of this processor into an object printer. More...

final Processor	read (ObjectReader<?> reader, Object o) throws ProcessorException
	Reads the content of a processor from a serialized object. More...

final Processor	duplicate ()
	Duplicates an object and sets it to its initial state. More...

void	copyInputQueue (int index, Collection< Object > to)
	Copies the content of one of the processor's input queue to a collection. More...

void	copyOutputQueue (int index, Collection< Object > to)
	Copies the content of one of the processor's output queue to a collection. More...

abstract Processor	duplicate (boolean with_state)
	Duplicates an object. More...

Processor	or (Processor p)
	Connects the first output pipe of this processor to the first input pipe of another processor. More...

Processor	or (Pushable p)
	Connects the output at index 0 of the current processor to the input of another processor. More...

Pushable	getAt (int index)
	Gets the Pushable object corresponding to the processor's input pipe for a given index. More...

Static Public Attributes
static final transient String	END_CHARACTER = String.valueOf((char) 4)
	Character indicating the closing of a pipe. More...

Static Public Attributes inherited from ca.uqac.lif.cep.Processor
static final transient String	s_versionString = "0.10.5"
	A string used to identify the program's version. More...

static final transient int	MAX_PULL_RETRIES = 10000000
	Number of times the Pullable#hasNext() method tries to produce an output from the input before giving up. More...

Protected Attributes
InputStream	m_inputStream
	The input stream this processor is reading from. More...

int	m_chunkSize = 16384
	The size of chunks. More...

boolean	m_isFile = false
	Whether the input stream to read is connected to a file. More...

boolean	m_hasReadEot = false
	Whether the EOT character has been received. More...

Protected Attributes inherited from ca.uqac.lif.cep.SynchronousProcessor
final transient Queue< Object[]>	m_tempQueue
	A queue object that will be passed to the compute(Object[], Queue) method. More...

final transient Pushable []	m_inputPushables
	An array of input pushables. More...

transient Pullable []	m_outputPullables
	An array of output pullables. More...

Protected Attributes inherited from ca.uqac.lif.cep.Processor
int	m_inputArity
	The processor's input arity, i.e. More...

int	m_outputArity
	The processor's output arity, i.e. More...

transient Queue< Object > []	m_inputQueues
	An array of input event queues. More...

transient EventTracker	m_eventTracker = null
	An object that keeps track of the relationship between input and output events. More...

transient Queue< Object > []	m_outputQueues
	An array of output event queues. More...

transient Pullable []	m_inputPullables
	An array of Pullables, one for each input trace this processor receives. More...

transient Pushable []	m_outputPushables
	An array of Pushables, one for each output trace this processor produces. More...

int	m_inputCount = 0
	A counter incremented upon each input front processed. More...

int	m_outputCount = 0
	A counter incremented upon each output front processed. More...

Context	m_context = null
	The context in which the processor is instantiated. More...

boolean []	m_hasBeenNotifiedOfEndOfTrace
	Indicates whether the processor has been notified of the end of trace or not. More...

Additional Inherited Members
Static Public Member Functions inherited from ca.uqac.lif.cep.Processor
static boolean	allNull (Object[] v)
	Checks if all objects in the array are null. More...

static Queue< Object[]>	getEmptyQueue ()
	Gets an instance of an empty event queue. More...

static void	startAll (Processor ... procs)
	Starts all processors given as an argument. More...

static void	stopAll (Processor ... procs)
	Stops all processors given as an argument. More...

static List< ProvenanceNode >	getLeaves (ProvenanceNode root)
	Gets the leaves of a provenance tree. More...

Protected Member Functions inherited from ca.uqac.lif.cep.SynchronousProcessor
abstract boolean	compute (Object[] inputs, Queue< Object[]> outputs)
	Computes one or more output events from its input events. More...

Protected Member Functions inherited from ca.uqac.lif.cep.Processor
boolean	allNotifiedEndOfTrace ()
	Determines if all the upstream pushables have sent the end of trace notification. More...

final Context	newContext ()
	Creates a new empty context map. More...

boolean	onEndOfTrace (Queue< Object[]> outputs) throws ProcessorException
	Allows to describe a specific behavior when the trace of input fronts has reached its end. More...

Object	printState ()
	Produces an object that represents the state of the current processor. More...

Processor	readState (Object o)
	Reads the state of a processor and uses it to create a new instance. More...

Static Protected Member Functions inherited from ca.uqac.lif.cep.Processor
static void	getLeaves (ProvenanceNode root, List< ProvenanceNode > leaves)
	Accumulates the leaves of a provenance tree in a list. More...

Detailed Description

Read contents from a Java InputStream.

It is represented graphically as:

Author: Sylvain Hallé

Since: 0.7

Definition at line 32 of file ReadInputStream.java.

Constructor & Destructor Documentation

◆ ReadInputStream()

ca.uqac.lif.cep.io.ReadInputStream.ReadInputStream ( InputStream is )

Creates a new input stream processor.

Parameters

is	The input stream to read from

Definition at line 45 of file ReadInputStream.java.

Member Function Documentation

◆ duplicate()

ReadInputStream ca.uqac.lif.cep.io.ReadInputStream.duplicate ( boolean with_state )

Duplicates an object.

Optionally, set the object into the same state as the source object.

Parameters

with_state Set to true to replicate the object's state, false to create a new copy in the initial state.

Returns: Another object

Implements ca.uqac.lif.cep.Duplicable.

Definition at line 112 of file ReadInputStream.java.

◆ setChunkSize()

ReadInputStream ca.uqac.lif.cep.io.ReadInputStream.setChunkSize ( int size )

Sets the size of chunks (in bytes) that the stream reader will try to read from the source at each attempt.

Parameters

size	The size, in bytes. Must be greater than 0.

Returns: This stream reader

Definition at line 90 of file ReadInputStream.java.

◆ setIsFile()

ReadInputStream ca.uqac.lif.cep.io.ReadInputStream.setIsFile ( boolean b )

Tells this reader whether it is reading from a file or some other input source.

Parameters

b	Set to `true` to tell the reader it is reading a file, `false` otherwise

Returns: This stream reader

Definition at line 105 of file ReadInputStream.java.

Member Data Documentation

◆ END_CHARACTER

final transient String ca.uqac.lif.cep.io.ReadInputStream.END_CHARACTER = String.valueOf((char) 4)

static

Character indicating the closing of a pipe.

By default, we use ASCII 4, which is traditionally interpreted as the end of transmission character (EOT). This has no effect when the underlying input is not a pipe.

Definition at line 58 of file ReadInputStream.java.

◆ m_chunkSize

int ca.uqac.lif.cep.io.ReadInputStream.m_chunkSize = 16384

protected

The size of chunks.

The processor will try to read this number of bytes every time it queries the underlying input stream. Setting it to a too small value will cause the reader to loop uselessly to process tiny bits of the string. Setting it to a too large value (i.e. 1 MB) has an equally adverse effect. Experimentally, a sweet spot seems to be 16 kB.

Definition at line 67 of file ReadInputStream.java.

◆ m_hasReadEot

boolean ca.uqac.lif.cep.io.ReadInputStream.m_hasReadEot = false

protected

Whether the EOT character has been received.

Definition at line 80 of file ReadInputStream.java.

◆ m_inputStream

InputStream ca.uqac.lif.cep.io.ReadInputStream.m_inputStream

protected

The input stream this processor is reading from.

Definition at line 37 of file ReadInputStream.java.

◆ m_isFile

boolean ca.uqac.lif.cep.io.ReadInputStream.m_isFile = false

protected

Whether the input stream to read is connected to a file.

This matters when attempting to read from the stream fails. If the source is a file, this means the file is over. Otherwise, it simply means there is no data ready to be read right now.

Definition at line 75 of file ReadInputStream.java.

The documentation for this class was generated from the following file:

/home/sylvain/Workspaces/BeepBeep/beepbeep-3/Core/src/ca/uqac/lif/cep/io/ReadInputStream.java

Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ReadInputStream()

Member Function Documentation

◆ duplicate()

◆ setChunkSize()

◆ setIsFile()

Member Data Documentation

◆ END_CHARACTER

◆ m_chunkSize

◆ m_hasReadEot

◆ m_inputStream

◆ m_isFile