alluxio.master

Class StateLockOptions

java.lang.Object

alluxio.master.StateLockOptions

public class StateLockOptions
extends Object

Used to define state-lock options for taking it exclusively. A typical framework for obtaining the state-lock exclusively is: 1- Run a grace-cycle: cycle of Lock.tryLock() - Thread.sleep(long) calls. 2- Call Lock.tryLock(long, TimeUnit) for a long duration a- Duration configured by PropertyKey.MASTER_BACKUP_STATE_LOCK_FORCED_DURATION. b- Shared lock holders/waiter will regularly be interrupted if PropertyKey.MASTER_BACKUP_STATE_LOCK_INTERRUPT_CYCLE_ENABLED is true. - Interrupt interval defined by PropertyKey.MASTER_BACKUP_STATE_LOCK_INTERRUPT_CYCLE_INTERVAL.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StateLockOptions.GraceMode Defines the grace mode of exclusive locking of the state-lock.

Constructor Summary

Constructors

Constructor and Description
StateLockOptions(StateLockOptions.GraceMode graceMode, long graceCycleTryMs, long graceCycleSleepMs, long graceCycleTimeoutMs) Creates an option class that is consulted while taking a state-lock exclusively from StateLockManager.

Method Summary

Modifier and Type	Method and Description
static StateLockOptions	defaults() This default instance is effectively the same as locking on write-lock.
static StateLockOptions	defaultsForDailyBackup()
static StateLockOptions	defaultsForShellBackup()
long	getGraceCycleSleepMs()
long	getGraceCycleTimeoutMs()
long	getGraceCycleTryMs()
StateLockOptions.GraceMode	getGraceMode()

Methods inherited from class java.lang.Object

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

Constructor Detail

StateLockOptions

public StateLockOptions(StateLockOptions.GraceMode graceMode,
                        long graceCycleTryMs,
                        long graceCycleSleepMs,
                        long graceCycleTimeoutMs)

Creates an option class that is consulted while taking a state-lock exclusively from StateLockManager.

Parameters:

graceMode - the mode for grace-cycle

graceCycleTryMs - grace-cycle try duration

graceCycleSleepMs - grace-cycle sleep duration

graceCycleTimeoutMs - total grace-cycle duration

Method Detail

getGraceMode

public StateLockOptions.GraceMode getGraceMode()

Returns:

the StateLockOptions.GraceMode of this options

getGraceCycleTryMs

public long getGraceCycleTryMs()

Returns:

try duration of grace-cycle

getGraceCycleSleepMs

public long getGraceCycleSleepMs()

Returns:

sleep duration of grace-cycle

getGraceCycleTimeoutMs

public long getGraceCycleTimeoutMs()

Returns:

total duration of grace-cycle

defaultsForShellBackup

public static StateLockOptions defaultsForShellBackup()

Returns:

StateLockOptions default instance for shell backups

defaultsForDailyBackup

public static StateLockOptions defaultsForDailyBackup()

Returns:

StateLockOptions default instance for daily backups

defaults

public static StateLockOptions defaults()

This default instance is effectively the same as locking on write-lock.

Returns:

StateLockOptions default