org.graylog.scheduler.worker

Class JobWorkerPool

java.lang.Object

org.graylog.scheduler.worker.JobWorkerPool

All Implemented Interfaces:

GracefulShutdownHook

public class JobWorkerPool
extends Object
implements GracefulShutdownHook

Worker pool to execute jobs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobWorkerPool.Factory

Constructor Summary

Constructors

Constructor and Description
JobWorkerPool(String name, int poolSize, GracefulShutdownService gracefulShutdownService, com.codahale.metrics.MetricRegistry metricRegistry)

Method Summary

Modifier and Type	Method and Description
void	awaitTermination(long timeout, TimeUnit unit) Blocks until all jobs have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.
void	doGracefulShutdown() Execute shutdown tasks for the service that implements this interface.
boolean	execute(Runnable job) Exeute the given job in the worker pool if there are any free slots.
int	freeSlots() Returns the number of free slots in the worker pool.
boolean	hasFreeSlots() Checks if there are free slots in the worker pool
void	shutdown() Shutdown the worker pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobWorkerPool

@Inject
public JobWorkerPool(String name,
                             int poolSize,
                             GracefulShutdownService gracefulShutdownService,
                             com.codahale.metrics.MetricRegistry metricRegistry)

Method Detail

freeSlots

public int freeSlots()

Returns the number of free slots in the worker pool.

Returns:

numer of free slots

hasFreeSlots

public boolean hasFreeSlots()

Checks if there are free slots in the worker pool

Returns:

true if there are free slots, false otherwise

execute

public boolean execute(Runnable job)

Exeute the given job in the worker pool if there are any free slots.

Parameters:

job - the job to execute

Returns:

true if the job could be executed, false otherwise

doGracefulShutdown

public void doGracefulShutdown()
                        throws Exception

Description copied from interface: GracefulShutdownHook

Execute shutdown tasks for the service that implements this interface.

Warning:

• This method is called from another thread so the class that implements GracefulShutdownHook must be thread-safe.
• The server shutdown is waiting for this method call to complete. Blocking this method will block the server shutdown!

Specified by:

doGracefulShutdown in interface GracefulShutdownHook

Throws:

Exception

shutdown

public void shutdown()

Shutdown the worker pool. This doesn't wait for currently running jobs to complete. Use awaitTermination(long, TimeUnit) to do that.

awaitTermination

public void awaitTermination(long timeout,
                             TimeUnit unit)
                      throws InterruptedException

Blocks until all jobs have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Throws:

InterruptedException - if interrupted while waiting