net.openhft.posix

Enum LockfFlag

java.lang.Object

java.lang.Enum<LockfFlag>

net.openhft.posix.LockfFlag

All Implemented Interfaces:

Serializable, Comparable<LockfFlag>

public enum LockfFlag
extends Enum<LockfFlag>

This enum represents the different flags for file locking (lockf) operations. It defines the operations to be performed on file locks, such as locking, unlocking, and testing locks.

Enum Constant Summary

Enum Constants

Enum Constant and Description
F_LOCK Set an exclusive lock on the specified section of the file.
F_TEST Test the lock: return 0 if the specified section is unlocked or locked by this process; return -1, set errno to EAGAIN (EACCES on some other systems), if another process holds a lock.
F_TLOCK Same as F_LOCK but the call never blocks and returns an error instead if the file is already locked.
F_ULOCK Unlock the indicated section of the file.

Method Summary

Modifier and Type	Method and Description
int	value() This method is a getter for the value instance variable.
static LockfFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static LockfFlag[]	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

F_ULOCK

public static final LockfFlag F_ULOCK

Unlock the indicated section of the file. This may cause a locked section to be split into two locked sections.

F_LOCK

public static final LockfFlag F_LOCK

Set an exclusive lock on the specified section of the file. If (part of) this section is already locked, the call blocks until the previous lock is released. If this section overlaps an earlier locked section, both are merged. File locks are released as soon as the process holding the locks closes some file descriptor for the file. A child process does not inherit these locks.

F_TLOCK

public static final LockfFlag F_TLOCK

Same as F_LOCK but the call never blocks and returns an error instead if the file is already locked.

F_TEST

public static final LockfFlag F_TEST

Test the lock: return 0 if the specified section is unlocked or locked by this process; return -1, set errno to EAGAIN (EACCES on some other systems), if another process holds a lock.

Method Detail

values

public static LockfFlag[] 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 (LockfFlag c : LockfFlag.values())
    System.out.println(c);

Returns:

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

valueOf

public static LockfFlag 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

value

public int value()

This method is a getter for the value instance variable. It returns the current integer value of this LockfFlag object.

Returns:

The current integer value of this LockfFlag object