Package org.yamcs.yarch

Class Stream

java.lang.Object

org.yamcs.yarch.Stream

Direct Known Subclasses:

HistogramReaderStream, InternalStream, LimitedStream, MergeStream, OutputStream, SelectStream, TableReaderStream

public abstract class Stream
extends Object

Streams are means to transport tuples.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Stream.ExceptionHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected Log	log
protected String	name
protected TupleDefinition	outputDefinition
static final int	QUITTING
static final int	RUNNING
static final int	SETUP
protected AtomicInteger	state
protected final Collection<StreamSubscriber>	subscribers
protected YarchDatabaseInstance	ydb

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Stream(YarchDatabaseInstance ydb, String name, TupleDefinition definition)

Method Summary

Modifier and Type	Method	Description
void	addSubscriber(StreamSubscriber s)
final void	close()	Closes the stream by changing the state, calling doClose() sand then sending the streamClosed signal to all subscribed clients.
protected abstract void	doClose()
abstract void	doStart()	Start emitting tuples.
void	emitTuple(Tuple tuple)
void	exceptionHandler(Stream.ExceptionHandler h)
ColumnDefinition	getColumnDefinition(String colName)
long	getDataCount()
TupleDefinition	getDefinition()
String	getName()
int	getState()
int	getSubscriberCount()
Collection<StreamSubscriber>	getSubscribers()
boolean	isClosed()
protected boolean	isRunning()
protected boolean	quitting()
void	removeSubscriber(StreamSubscriber s)
void	setName(String streamName)
final void	start()	Start the stream by changing the state and calling doStart()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

SETUP

public static final int SETUP

See Also:

• Constant Field Values

RUNNING

public static final int RUNNING

See Also:

• Constant Field Values

QUITTING

public static final int QUITTING

See Also:

• Constant Field Values

name

protected String name

outputDefinition

protected TupleDefinition outputDefinition

subscribers

protected final Collection<StreamSubscriber> subscribers

state

protected AtomicInteger state

log

protected Log log

ydb

protected YarchDatabaseInstance ydb

Constructor Details

Stream

protected Stream(YarchDatabaseInstance ydb,
 String name,
 TupleDefinition definition)

Method Details

doStart

public abstract void doStart()

Start emitting tuples.

getDefinition

public TupleDefinition getDefinition()

emitTuple

public void emitTuple(Tuple tuple)

getName

public String getName()

setName

public void setName(String streamName)

addSubscriber

public void addSubscriber(StreamSubscriber s)

removeSubscriber

public void removeSubscriber(StreamSubscriber s)

getColumnDefinition

public ColumnDefinition getColumnDefinition(String colName)

start

public final void start()

Start the stream by changing the state and calling doStart()

If the stream is already started, do nothing.

isRunning

protected boolean isRunning()

quitting

protected boolean quitting()

close

public final void close()

Closes the stream by changing the state, calling doClose() sand then sending the streamClosed signal to all subscribed clients.

if the stream is already closed, do nothing.

doClose

protected abstract void doClose()

getState

public int getState()

isClosed

public boolean isClosed()

getDataCount

public long getDataCount()

getSubscriberCount

public int getSubscriberCount()

getSubscribers

public Collection<StreamSubscriber> getSubscribers()

exceptionHandler

public void exceptionHandler(Stream.ExceptionHandler h)

toString

public String toString()

Overrides:

toString in class Object