Package ch.rswk.meta.engine

Class AbstractEngineWorkQueueService<C,T,R>

java.lang.Object

com.google.common.util.concurrent.AbstractExecutionThreadService

ch.rswk.meta.engine.AbstractEngineExecutionThreadService<C>

ch.rswk.meta.engine.AbstractEngineWorkQueueService<C,T,R>

All Implemented Interfaces:

EngineServices.ConfigurableService<C>, EngineServices.InfoProvidingService, com.google.common.util.concurrent.Service

Direct Known Subclasses:

LuceneService

public abstract class AbstractEngineWorkQueueService<C,T,R>
extends AbstractEngineExecutionThreadService<C>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	AbstractEngineWorkQueueService.QueueHealthCheck
static enum	AbstractEngineWorkQueueService.ShutdownType
private static final record	AbstractEngineWorkQueueService.WorkUnitWrapper<T,R>

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	capacity
private com.codahale.metrics.Meter	offerErrorMeter
protected final long	offerTimeout
private static final AbstractEngineWorkQueueService.WorkUnitWrapper	POISON_UNIT
private com.codahale.metrics.Meter	processErrorMeter
private com.codahale.metrics.Timer	processTimer
protected final String	serviceId
protected final AbstractEngineWorkQueueService.ShutdownType	shutdownType
private static final Protocol.ErrorReplyFactory	WORK_QUEUE_ERROR
private static final Protocol.ErrorReplyFactory	WORK_QUEUE_FULL_ERROR
private static final Protocol.ErrorReplyFactory	WORK_UNIT_ERROR
protected BlockingQueue<AbstractEngineWorkQueueService.WorkUnitWrapper<T,R>>	workQueue
private com.codahale.metrics.Timer	workUnitTimer

Fields inherited from class ch.rswk.meta.engine.AbstractEngineExecutionThreadService

runtime

Constructor Summary

Constructors

Constructor	Description
AbstractEngineWorkQueueService(int capacity, C config, long offerTimeout, EngineRuntime runtime, @Nullable String serviceId, AbstractEngineWorkQueueService.ShutdownType shutdownType)

Method Summary

Modifier and Type	Method	Description
protected void	afterProcessWorkUnit(T unit)
protected void	beforeProcessWorkUnit(T unit)
protected int	getCapacityThreshold()
protected int	getRemainingCapacity()
protected com.google.common.util.concurrent.ListenableFuture<R>	offerWorkUnit(T unit)
protected abstract R	processWorkUnit(T unit)
protected void	run()
protected String	serviceName()
protected void	startUp()
protected void	triggerShutdown()

Methods inherited from class ch.rswk.meta.engine.AbstractEngineExecutionThreadService

configClass, configReference, shutDown

Methods inherited from class com.google.common.util.concurrent.AbstractExecutionThreadService

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, executor, failureCause, isRunning, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.rswk.meta.engine.EngineServices.ConfigurableService

config, onConfigChanged

Methods inherited from interface ch.rswk.meta.engine.EngineServices.InfoProvidingService

getServiceInfo

Field Details

POISON_UNIT

private static final AbstractEngineWorkQueueService.WorkUnitWrapper POISON_UNIT

WORK_QUEUE_ERROR

private static final Protocol.ErrorReplyFactory WORK_QUEUE_ERROR

WORK_QUEUE_FULL_ERROR

private static final Protocol.ErrorReplyFactory WORK_QUEUE_FULL_ERROR

WORK_UNIT_ERROR

private static final Protocol.ErrorReplyFactory WORK_UNIT_ERROR

capacity

protected final int capacity

offerTimeout

protected final long offerTimeout

serviceId

protected final String serviceId

shutdownType

protected final AbstractEngineWorkQueueService.ShutdownType shutdownType

workQueue

protected BlockingQueue<AbstractEngineWorkQueueService.WorkUnitWrapper<T,R>> workQueue

offerErrorMeter

private com.codahale.metrics.Meter offerErrorMeter

processErrorMeter

private com.codahale.metrics.Meter processErrorMeter

processTimer

private com.codahale.metrics.Timer processTimer

workUnitTimer

private com.codahale.metrics.Timer workUnitTimer

Constructor Details

AbstractEngineWorkQueueService

public AbstractEngineWorkQueueService(int capacity,
 C config,
 long offerTimeout,
 EngineRuntime runtime,
 @Nullable String serviceId,
 AbstractEngineWorkQueueService.ShutdownType shutdownType)

Method Details

startUp

protected void startUp()
                throws Exception

Overrides:

startUp in class AbstractEngineExecutionThreadService<C>

Throws:

Exception

triggerShutdown

protected void triggerShutdown()

Overrides:

triggerShutdown in class com.google.common.util.concurrent.AbstractExecutionThreadService

offerWorkUnit

protected com.google.common.util.concurrent.ListenableFuture<R> offerWorkUnit(T unit)

getRemainingCapacity

protected int getRemainingCapacity()

getCapacityThreshold

protected int getCapacityThreshold()

run

protected void run()
            throws Exception

Specified by:

run in class com.google.common.util.concurrent.AbstractExecutionThreadService

Throws:

Exception

beforeProcessWorkUnit

protected void beforeProcessWorkUnit(T unit)

processWorkUnit

protected abstract R processWorkUnit(T unit)
                              throws ErrorReplyException

Throws:

ErrorReplyException

afterProcessWorkUnit

protected void afterProcessWorkUnit(T unit)

serviceName

protected String serviceName()

Overrides:

serviceName in class AbstractEngineExecutionThreadService<C>