ch.systemsx.cisd.hdf5

Enum IHDF5WriterConfigurator.SyncMode

java.lang.Object

java.lang.Enum<IHDF5WriterConfigurator.SyncMode>

ch.systemsx.cisd.hdf5.IHDF5WriterConfigurator.SyncMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IHDF5WriterConfigurator.SyncMode>

Enclosing interface:

IHDF5WriterConfigurator

public static enum IHDF5WriterConfigurator.SyncMode
extends java.lang.Enum<IHDF5WriterConfigurator.SyncMode>

The mode of synchronizing changes (using a method like fsync(2)) to the HDF5 file with the underlying storage. As fsync(2) is blocking, the synchonization is by default performed in a separate thread to minimize latency effects on the application. In order to ensure that fsync(2) is called in the same thread, use one of the *_BLOCK modes.

Note that non-blocking modes can have unexpected interactions with mandatory locks on Windows. The symptom of that will be that the program holds a lock to the HDF5 file for some (short) time even after the file has been closed. Thus, on Windows by default a blocking mode is chosen.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO_SYNC Do not synchronize at all.
SYNC Synchronize whenever IHDF5FileLevelReadWriteHandler.flush() or IHDF5FileLevelReadOnlyHandler.close() are called.
SYNC_BLOCK Synchronize whenever IHDF5FileLevelReadWriteHandler.flush() or IHDF5FileLevelReadOnlyHandler.close() are called.
SYNC_ON_FLUSH Synchronize whenever IHDF5FileLevelReadWriteHandler.flush() is called.
SYNC_ON_FLUSH_BLOCK Synchronize whenever IHDF5FileLevelReadWriteHandler.flush() is called.

Method Summary

Modifier and Type	Method and Description
static IHDF5WriterConfigurator.SyncMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IHDF5WriterConfigurator.SyncMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_SYNC

public static final IHDF5WriterConfigurator.SyncMode NO_SYNC

Do not synchronize at all.

SYNC

public static final IHDF5WriterConfigurator.SyncMode SYNC

Synchronize whenever IHDF5FileLevelReadWriteHandler.flush() or IHDF5FileLevelReadOnlyHandler.close() are called.

SYNC_BLOCK

public static final IHDF5WriterConfigurator.SyncMode SYNC_BLOCK

Synchronize whenever IHDF5FileLevelReadWriteHandler.flush() or IHDF5FileLevelReadOnlyHandler.close() are called. Block until synchronize is finished.

SYNC_ON_FLUSH

public static final IHDF5WriterConfigurator.SyncMode SYNC_ON_FLUSH

Synchronize whenever IHDF5FileLevelReadWriteHandler.flush() is called. Default on Unix

SYNC_ON_FLUSH_BLOCK

public static final IHDF5WriterConfigurator.SyncMode SYNC_ON_FLUSH_BLOCK

Synchronize whenever IHDF5FileLevelReadWriteHandler.flush() is called. Block until synchronize is finished. Default on Windows.

Method Detail

values

public static IHDF5WriterConfigurator.SyncMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IHDF5WriterConfigurator.SyncMode c : IHDF5WriterConfigurator.SyncMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IHDF5WriterConfigurator.SyncMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null