net.openhft.chronicle.bytes

Enum SyncMode

java.lang.Object

java.lang.Enum<SyncMode>

net.openhft.chronicle.bytes.SyncMode

All Implemented Interfaces:

Serializable, Comparable<SyncMode>

public enum SyncMode
extends Enum<SyncMode>

An enumeration of sync modes for disk operations. This enum controls whether the write operations are synchronized with the disk, and if so, whether to wait for the synchronization to complete before continuing with the program execution.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASYNC Synchronization is scheduled but the program does not wait for it to complete before proceeding.
NONE No synchronization is performed.
SYNC Synchronization is performed, and the program waits for the sync operation to complete before proceeding.

Method Summary

Modifier and Type	Method and Description
net.openhft.posix.MSyncFlag	mSyncFlag() Returns the MSyncFlag associated with this sync mode.
static SyncMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static 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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final SyncMode NONE

No synchronization is performed. The write operations are not explicitly synced with the disk.

SYNC

public static final SyncMode SYNC

Synchronization is performed, and the program waits for the sync operation to complete before proceeding. This mode guarantees that the write operation is completed before the next operation is carried out. However, this mode may not be supported on all platforms.

ASYNC

public static final SyncMode ASYNC

Synchronization is scheduled but the program does not wait for it to complete before proceeding. This mode allows the write operation to be carried out asynchronously. The actual write to the disk happens later and does not block the program execution. However, this mode may not be supported on all platforms.

Method Detail

values

public static 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 (SyncMode c : 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 SyncMode valueOf(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:

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

NullPointerException - if the argument is null

mSyncFlag

public net.openhft.posix.MSyncFlag mSyncFlag()

Returns the MSyncFlag associated with this sync mode.

Returns:

the MSyncFlag value, may be null for NONE