com.netflix.turbine.utils

Class WorkerThread

java.lang.Object

com.netflix.turbine.utils.WorkerThread

public class WorkerThread
extends java.lang.Object

Helper class that manages the life cycle of a worker thread in a thread safe and idempotent manner. Implementers must provide functionality for

• Initing resources
• Doing work periodically
• Cleanup on shutdown

Users of the object do have control on how often the work happens and if there is an sleep between intervals at all.

They also have explicity control to start and stop the work in a separate thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkerThread.UnitTest
static interface	WorkerThread.Worker Interface for the functionality of a worker object

Constructor Summary

Constructors

Constructor and Description
WorkerThread(WorkerThread.Worker worker)
WorkerThread(WorkerThread.Worker worker, boolean sleep)
WorkerThread(WorkerThread.Worker worker, int sleepMillis)
WorkerThread(WorkerThread.Worker worker, int sleepMillis, boolean sleep)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isRunning() Helper to identify if worker is still running
boolean	isStopRequested() Helper to identify is work has been requested to stop
void	start() Start the work, must happen once and only once.
void	stop() Request worker to stop
void	stopAndBlock() Stop and block till worker is finished

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkerThread

public WorkerThread(WorkerThread.Worker worker)

Parameters:

worker -

WorkerThread

public WorkerThread(WorkerThread.Worker worker,
            boolean sleep)

Parameters:

worker -

sleep -

WorkerThread

public WorkerThread(WorkerThread.Worker worker,
            int sleepMillis)

Parameters:

worker -

sleepMillis -

WorkerThread

public WorkerThread(WorkerThread.Worker worker,
            int sleepMillis,
            boolean sleep)

Parameters:

worker -

sleepMillis -

sleep -

Method Detail

start

public void start()
           throws java.lang.Exception

Start the work, must happen once and only once.

Throws:

java.lang.Exception

stop

public void stop()

Request worker to stop

stopAndBlock

public void stopAndBlock()

Stop and block till worker is finished

isRunning

public boolean isRunning()

Helper to identify if worker is still running

Returns:

true/false

isStopRequested

public boolean isStopRequested()

Helper to identify is work has been requested to stop

Returns:

true/false