Class MonitoredPipeline

java.lang.Object

io.aleph0.yap.core.pipeline.MonitoredPipeline

All Implemented Interfaces:

Measureable<Pipeline.Metrics>, Pipeline

public class MonitoredPipeline
extends Object
implements Pipeline

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MonitoredPipeline.MetricsReporter

Nested classes/interfaces inherited from interface io.aleph0.yap.core.Pipeline

Pipeline.LifecycleListener, Pipeline.Metrics

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	DEFAULT_PERIOD

Constructor Summary

Constructors

Constructor	Description
MonitoredPipeline(Pipeline delegate, MonitoredPipeline.MetricsReporter reporter)
MonitoredPipeline(Pipeline delegate, MonitoredPipeline.MetricsReporter reporter, Duration period)
MonitoredPipeline(ScheduledExecutorService scheduler, Pipeline delegate, MonitoredPipeline.MetricsReporter reporter, Duration period)

Method Summary

Modifier and Type	Method	Description
void	addLifecycleListener(Pipeline.LifecycleListener listener)
void	await()
void	cancel()
Pipeline.Metrics	checkMetrics()	Non-destructive check of the metrics.
Pipeline.Metrics	flushMetrics()	Destructive read of the metrics.
int	getId()
static PipelineWrapper	newWrapper()
static PipelineWrapper	newWrapper(MonitoredPipeline.MetricsReporter reporter)
static PipelineWrapper	newWrapper(MonitoredPipeline.MetricsReporter reporter, Duration period)
void	removeLifecycleListener(Pipeline.LifecycleListener listener)
void	start()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PERIOD

public static final Duration DEFAULT_PERIOD

Constructor Details

MonitoredPipeline

public MonitoredPipeline(Pipeline delegate,
 MonitoredPipeline.MetricsReporter reporter)

MonitoredPipeline

public MonitoredPipeline(Pipeline delegate,
 MonitoredPipeline.MetricsReporter reporter,
 Duration period)

MonitoredPipeline

public MonitoredPipeline(ScheduledExecutorService scheduler,
 Pipeline delegate,
 MonitoredPipeline.MetricsReporter reporter,
 Duration period)

Method Details

newWrapper

public static PipelineWrapper newWrapper()

newWrapper

public static PipelineWrapper newWrapper(MonitoredPipeline.MetricsReporter reporter)

newWrapper

public static PipelineWrapper newWrapper(MonitoredPipeline.MetricsReporter reporter,
 Duration period)

getId

public int getId()

Specified by:

getId in interface Pipeline

addLifecycleListener

public void addLifecycleListener(Pipeline.LifecycleListener listener)

Specified by:

addLifecycleListener in interface Pipeline

removeLifecycleListener

public void removeLifecycleListener(Pipeline.LifecycleListener listener)

Specified by:

removeLifecycleListener in interface Pipeline

start

public void start()

Specified by:

start in interface Pipeline

cancel

public void cancel()

Specified by:

cancel in interface Pipeline

await

public void await()
           throws InterruptedException,
ExecutionException,
CancellationException

Specified by:

await in interface Pipeline

Throws:

InterruptedException

ExecutionException

CancellationException

checkMetrics

public Pipeline.Metrics checkMetrics()

Description copied from interface: Measureable

Non-destructive check of the metrics. This should be used to check the state of metrics without clearing them, for example in a TaskController.

Specified by:

checkMetrics in interface Measureable<Pipeline.Metrics>

Returns:

the metrics

flushMetrics

public Pipeline.Metrics flushMetrics()

Description copied from interface: Measureable

Destructive read of the metrics. This should be used to check and reset the state of metrics, for example by the metrics checking thread.

Specified by:

flushMetrics in interface Measureable<Pipeline.Metrics>

Returns:

the metrics