org.apache.hadoop.hbase.wal

Class AbstractWALRoller<T extends Abortable>

java.lang.Object

java.lang.Thread

org.apache.hadoop.hbase.wal.AbstractWALRoller<T>

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

LogRoller, MasterRegionWALRoller

@InterfaceAudience.Private
public abstract class AbstractWALRoller<T extends Abortable>
extends Thread
implements Closeable

Runs periodically to determine if the WAL should be rolled.

NOTE: This class extends Thread rather than Chore because the sleep time can be interrupted when there is something to do, rather than the Chore sleep time which is invariant.

The scheduleFlush(String, List) is abstract here, as sometimes we hold a region without a region server but we still want to roll its WAL.

TODO: change to a pool of threads

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractWALRoller.RollController Independently control the roll of each wal.

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected T	abortable
static long	DEFAULT_WAL_ROLL_WAIT_TIMEOUT
protected static String	WAL_ROLL_PERIOD_KEY
protected static String	WAL_ROLL_RETRIES Configure for the max count of log rolling retry.
static String	WAL_ROLL_WAIT_TIMEOUT Configure for the timeout of log rolling retry.
protected ConcurrentMap<WAL,AbstractWALRoller.RollController>	wals

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWALRoller(String name, org.apache.hadoop.conf.Configuration conf, T abortable)

Method Summary

Modifier and Type	Method and Description
void	addWAL(WAL wal)
protected void	afterWALArchive(org.apache.hadoop.fs.Path oldPath, org.apache.hadoop.fs.Path newPath)
void	close()
void	requestRollAll()
void	run()
protected abstract void	scheduleFlush(String encodedRegionName, List<byte[]> families)
void	waitUntilWalRollFinished() Wait until all wals have been rolled after calling requestRollAll().
boolean	walRollFinished() Returns true if all WAL roll finished

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

WAL_ROLL_PERIOD_KEY

protected static final String WAL_ROLL_PERIOD_KEY

See Also:

Constant Field Values

WAL_ROLL_WAIT_TIMEOUT

public static final String WAL_ROLL_WAIT_TIMEOUT

Configure for the timeout of log rolling retry.

See Also:

Constant Field Values

DEFAULT_WAL_ROLL_WAIT_TIMEOUT

public static final long DEFAULT_WAL_ROLL_WAIT_TIMEOUT

See Also:

Constant Field Values

WAL_ROLL_RETRIES

protected static final String WAL_ROLL_RETRIES

Configure for the max count of log rolling retry. The real retry count is also limited by the timeout of log rolling via WAL_ROLL_WAIT_TIMEOUT

See Also:

Constant Field Values

wals

protected final ConcurrentMap<WAL,AbstractWALRoller.RollController> wals

abortable

protected final T extends Abortable abortable

Constructor Detail

AbstractWALRoller

protected AbstractWALRoller(String name,
                            org.apache.hadoop.conf.Configuration conf,
                            T abortable)

Method Detail

addWAL

public void addWAL(WAL wal)

requestRollAll

public void requestRollAll()

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

afterWALArchive

protected void afterWALArchive(org.apache.hadoop.fs.Path oldPath,
                               org.apache.hadoop.fs.Path newPath)

scheduleFlush

protected abstract void scheduleFlush(String encodedRegionName,
                                      List<byte[]> families)

Parameters:

encodedRegionName - Encoded name of region to flush.

families - stores of region to flush.

walRollFinished

public boolean walRollFinished()

Returns true if all WAL roll finished

waitUntilWalRollFinished

public void waitUntilWalRollFinished()
                              throws InterruptedException

Wait until all wals have been rolled after calling requestRollAll().

Throws:

InterruptedException

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable