net.openhft.chronicle.hash.impl.util

Class CanonicalRandomAccessFiles

java.lang.Object

net.openhft.chronicle.hash.impl.util.CanonicalRandomAccessFiles

public final class CanonicalRandomAccessFiles
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CanonicalRandomAccessFiles.FileIOAction
static class	CanonicalRandomAccessFiles.FileLockReference

Method Summary

Modifier and Type	Method and Description
static RandomAccessFile	acquire(File file)
static void	acquireExclusiveFileLock(File canonicalFile, FileChannel channel)
static void	acquireSharedFileLock(File canonicalFile, FileChannel channel)
static void	release(File file)
static void	releaseExclusiveFileLock(File canonicalFile)
static void	releaseSharedFileLock(File canonicalFile)
static void	runExclusively(File canonicalFile, FileChannel fileChannel, CanonicalRandomAccessFiles.FileIOAction fileIOAction) Executes a closure under exclusive file lock.
static boolean	tryRunExclusively(File canonicalFile, FileChannel fileChannel, CanonicalRandomAccessFiles.FileIOAction fileIOAction) Tries to execute a closure under exclusive file lock.

Methods inherited from class java.lang.Object

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

Method Detail

acquire

public static RandomAccessFile acquire(@NotNull
                                       File file)
                                throws FileNotFoundException

Throws:

FileNotFoundException

release

public static void release(@NotNull
                           File file)

acquireSharedFileLock

public static void acquireSharedFileLock(@NotNull
                                         File canonicalFile,
                                         @NotNull
                                         FileChannel channel)

acquireExclusiveFileLock

public static void acquireExclusiveFileLock(@NotNull
                                            File canonicalFile,
                                            @NotNull
                                            FileChannel channel)

releaseSharedFileLock

public static void releaseSharedFileLock(@NotNull
                                         File canonicalFile)

releaseExclusiveFileLock

public static void releaseExclusiveFileLock(@NotNull
                                            File canonicalFile)

tryRunExclusively

public static boolean tryRunExclusively(@NotNull
                                        File canonicalFile,
                                        @NotNull
                                        FileChannel fileChannel,
                                        @NotNull
                                        CanonicalRandomAccessFiles.FileIOAction fileIOAction)

Tries to execute a closure under exclusive file lock. If USE_LOCKING is false, provides synchronization only within local JVM.

Parameters:

fileIOAction - Closure to run, can throw IOExceptions.

Returns:

true if the lock was successfully acquired and IO action was executed, false otherwise.

runExclusively

public static void runExclusively(@NotNull
                                  File canonicalFile,
                                  @NotNull
                                  FileChannel fileChannel,
                                  @NotNull
                                  CanonicalRandomAccessFiles.FileIOAction fileIOAction)

Executes a closure under exclusive file lock. If USE_LOCKING is false, provides synchronization only within local JVM.

Parameters:

fileIOAction - Closure to run, can throw IOExceptions.