org.apache.hadoop.hbase.procedure2

Class CompletedProcedureCleaner<TEnvironment>

java.lang.Object

org.apache.hadoop.hbase.procedure2.Procedure<TEnvironment>

org.apache.hadoop.hbase.procedure2.ProcedureInMemoryChore<TEnvironment>

org.apache.hadoop.hbase.procedure2.CompletedProcedureCleaner<TEnvironment>

All Implemented Interfaces:

Comparable<Procedure<TEnvironment>>

@InterfaceAudience.Private
class CompletedProcedureCleaner<TEnvironment>
extends ProcedureInMemoryChore<TEnvironment>

Internal cleaner that removes the completed procedure results after a TTL.

NOTE: This is a special case handled in timeoutLoop().

Since the client code looks more or less like:

   procId = master.doOperation()
   while (master.getProcResult(procId) == ProcInProgress);
 

The master should not throw away the proc result as soon as the procedure is done but should wait a result request from the client (see executor.removeResult(procId)) The client will call something like master.isProcDone() or master.getProcResult() which will return the result/state to the client, and it will mark the completed proc as ready to delete. note that the client may not receive the response from the master (e.g. master failover) so, if we delay a bit the real deletion of the proc result the client will be able to get the result the next try.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.procedure2.Procedure

Procedure.LockState

Field Summary

Fields

Modifier and Type	Field and Description
private static String	BATCH_SIZE_CONF_KEY
(package private) static String	CLEANER_INTERVAL_CONF_KEY
private Map<Long,CompletedProcedureRetainer<TEnvironment>>	completed
private org.apache.hadoop.conf.Configuration	conf
private static int	DEFAULT_BATCH_SIZE
private static int	DEFAULT_CLEANER_INTERVAL
private static org.slf4j.Logger	LOG
private Map<NonceKey,Long>	nonceKeysToProcIdsMap
private IdLock	procExecutionLock
private ProcedureStore	store

Fields inherited from class org.apache.hadoop.hbase.procedure2.Procedure

NO_PROC_ID, NO_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
CompletedProcedureCleaner(org.apache.hadoop.conf.Configuration conf, ProcedureStore store, IdLock procExecutionLock, Map<Long,CompletedProcedureRetainer<TEnvironment>> completedMap, Map<NonceKey,Long> nonceKeysToProcIdsMap)

Method Summary

Modifier and Type	Method and Description
protected void	periodicExecute(TEnvironment env)

Methods inherited from class org.apache.hadoop.hbase.procedure2.ProcedureInMemoryChore

abort, deserializeStateData, execute, rollback, serializeStateData

Methods inherited from class org.apache.hadoop.hbase.procedure2.Procedure

acquireLock, addStackIndex, afterReplay, beforeReplay, bypass, compareTo, completionCleanup, doAcquireLock, doExecute, doReleaseLock, doRollback, elapsedTime, getChildrenLatch, getException, getLastUpdate, getNonceKey, getOwner, getParentProcId, getProcedureMetrics, getProcId, getProcIdHashCode, getProcName, getResult, getRootProcedureId, getRootProcId, getStackIndexes, getState, getSubmittedTime, getTimeout, getTimeoutTimestamp, hasChildren, hasException, hasLock, hasOwner, hasParent, hasTimeout, haveSameParent, holdLock, incChildrenLatch, isBypass, isFailed, isFinished, isInitializing, isLockedWhenLoading, isRunnable, isSuccess, isWaiting, isYieldAfterExecutionStep, lockedWhenLoading, needPersistence, releaseLock, removeStackIndex, resetPersistence, restoreLock, setAbortFailure, setChildrenLatch, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, setTimeoutFailure, shouldWaitClientAck, skipPersistence, toString, toStringClass, toStringClassDetails, toStringDetails, toStringSimpleSB, toStringState, tryRunnable, updateMetricsOnFinish, updateMetricsOnSubmit, updateTimestamp, waitInitialized, wasExecuted

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

CLEANER_INTERVAL_CONF_KEY

static final String CLEANER_INTERVAL_CONF_KEY

See Also:

Constant Field Values

DEFAULT_CLEANER_INTERVAL

private static final int DEFAULT_CLEANER_INTERVAL

See Also:

Constant Field Values

BATCH_SIZE_CONF_KEY

private static final String BATCH_SIZE_CONF_KEY

See Also:

Constant Field Values

DEFAULT_BATCH_SIZE

private static final int DEFAULT_BATCH_SIZE

See Also:

Constant Field Values

completed

private final Map<Long,CompletedProcedureRetainer<TEnvironment>> completed

nonceKeysToProcIdsMap

private final Map<NonceKey,Long> nonceKeysToProcIdsMap

store

private final ProcedureStore store

procExecutionLock

private final IdLock procExecutionLock

conf

private org.apache.hadoop.conf.Configuration conf

Constructor Detail

CompletedProcedureCleaner

public CompletedProcedureCleaner(org.apache.hadoop.conf.Configuration conf,
                                 ProcedureStore store,
                                 IdLock procExecutionLock,
                                 Map<Long,CompletedProcedureRetainer<TEnvironment>> completedMap,
                                 Map<NonceKey,Long> nonceKeysToProcIdsMap)

Method Detail

periodicExecute

protected void periodicExecute(TEnvironment env)

Specified by:

periodicExecute in class ProcedureInMemoryChore<TEnvironment>