H2 Database Engine 2.3.232 · org.h2.store.FileLock · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private static final String	FILE
private volatile String	fileName The lock file name.
private long	lastWrite The last time the lock file was written.
private volatile boolean	locked Whether the file is locked.
private static final String	MAGIC
private String	method
private Properties	properties
private static final int	RANDOM_BYTES
private volatile ServerSocket	serverSocket The server socket (only used when using the SOCKET mode).
private final int	sleep The number of milliseconds to sleep after checking a file.
private static final int	SLEEP_GAP
private static final String	SOCKET
private static final int	TIME_GRANULARITY
private final Trace	trace The trace object.
private String	uniqueId
private Thread	watchdog

Constructor Summary

Access	Constructor and Description
public	FileLock(TraceSystem the trace system to use traceSystem, String the file name fileName, int the number of milliseconds to sleep sleep) Create a new file locking object.

Method Summary

Modifier and Type	Method and Description
private static long	Returns: last modified date/time in milliseconds UTC aggressiveLastModified(String file name to check fileName) Aggressively read last modified time, to work-around remote filesystems.
private void	checkServer()
private DbException	getExceptionAlreadyInUse(String reason)
private static DbException	getExceptionFatal(String reason, Throwable t)
public static FileLockMethod	Returns: the method type getFileLockMethod(String the method name method) Get the file locking method type given a method name.
public String	getUniqueId()
public Properties	Returns: the properties load() Load the properties file.
public synchronized void	lock(FileLockMethod the file locking method to use fileLockMethod) Lock the file if possible.
private void	lockFile()
private void	lockSocket()
public void	run() Implements java.lang.Runnable.run. Runs this operation.
public Properties	Returns: the saved properties save() Save the lock file.
public void	setProperty(String the key key, String the value value) Add or change a setting to the properties.
private void	setUniqueId()
private static void	sleep(int time)
public synchronized void	unlock() Unlock the file.
private void	waitUntilOld()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

FILE	back to summary
private static final String FILE

fileName	back to summary
private volatile String fileName The lock file name.

lastWrite	back to summary
private long lastWrite The last time the lock file was written.

locked	back to summary
private volatile boolean locked Whether the file is locked.

MAGIC	back to summary
private static final String MAGIC

method	back to summary
private String method

properties	back to summary
private Properties properties

RANDOM_BYTES	back to summary
private static final int RANDOM_BYTES

serverSocket	back to summary
private volatile ServerSocket serverSocket The server socket (only used when using the SOCKET mode).

sleep	back to summary
private final int sleep The number of milliseconds to sleep after checking a file.

SLEEP_GAP	back to summary
private static final int SLEEP_GAP

SOCKET	back to summary
private static final String SOCKET

TIME_GRANULARITY	back to summary
private static final int TIME_GRANULARITY

trace	back to summary
private final Trace trace The trace object.

uniqueId	back to summary
private String uniqueId

watchdog	back to summary
private Thread watchdog

Constructor Detail

FileLock	back to summary
public FileLock(TraceSystem traceSystem, String fileName, int sleep) Create a new file locking object. Parameters traceSystem:TraceSystem the trace system to use fileName:String the file name sleep:int the number of milliseconds to sleep

FileLock

back to summary

public FileLock(TraceSystem traceSystem, String fileName, int sleep)

Create a new file locking object.

Parameters

traceSystem:TraceSystem: the trace system to use
fileName:String: the file name
sleep:int: the number of milliseconds to sleep

Method Detail

aggressiveLastModified	back to summary
private static long aggressiveLastModified(String fileName) Aggressively read last modified time, to work-around remote filesystems. Parameters fileName:String file name to check Returns:long last modified date/time in milliseconds UTC

aggressiveLastModified

back to summary

private static long aggressiveLastModified(String fileName)

Aggressively read last modified time, to work-around remote filesystems.

Parameters

fileName:String: file name to check

Returns:long

last modified date/time in milliseconds UTC

checkServer	back to summary
private void checkServer()

getExceptionAlreadyInUse	back to summary
private DbException getExceptionAlreadyInUse(String reason)

getExceptionFatal	back to summary
private static DbException getExceptionFatal(String reason, Throwable t)

getFileLockMethod	back to summary
public static FileLockMethod getFileLockMethod(String method) Get the file locking method type given a method name. Parameters method:String the method name Returns:FileLockMethod the method type Exceptions DbException: if the method name is unknown

getFileLockMethod

back to summary

public static FileLockMethod getFileLockMethod(String method)

Get the file locking method type given a method name.

Parameters

method:String: the method name

Returns:FileLockMethod

the method type

Exceptions

DbException:: if the method name is unknown

getUniqueId	back to summary
public String getUniqueId()

load	back to summary
public Properties load() Load the properties file. Returns:Properties the properties

load

back to summary

public Properties load()

Load the properties file.

Returns:Properties: the properties

lock	back to summary
public synchronized void lock(FileLockMethod fileLockMethod) Lock the file if possible. A file may only be locked once. Parameters fileLockMethod:FileLockMethod the file locking method to use Exceptions DbException: if locking was not successful

lock

back to summary

public synchronized void lock(FileLockMethod fileLockMethod)

Lock the file if possible. A file may only be locked once.

Parameters

fileLockMethod:FileLockMethod: the file locking method to use

Exceptions

DbException:: if locking was not successful

lockFile	back to summary
private void lockFile()

lockSocket	back to summary
private void lockSocket()

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation. Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

save	back to summary
public Properties save() Save the lock file. Returns:Properties the saved properties

save

back to summary

public Properties save()

Save the lock file.

Returns:Properties: the saved properties

setProperty	back to summary
public void setProperty(String key, String value) Add or change a setting to the properties. This call does not save the file. Parameters key:String the key value:String the value

setProperty

back to summary

public void setProperty(String key, String value)

Add or change a setting to the properties. This call does not save the file.

Parameters

key:String: the key
value:String: the value

setUniqueId	back to summary
private void setUniqueId()

sleep	back to summary
private static void sleep(int time)

unlock	back to summary
public synchronized void unlock() Unlock the file. The watchdog thread is stopped. This method does nothing if the file is already unlocked.

waitUntilOld	back to summary
private void waitUntilOld()

public Class FileLock

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail