com.allanbank.mongodb

Enum LockType

java.lang.Object

java.lang.Enum<LockType>

com.allanbank.mongodb.LockType

All Implemented Interfaces:

Serializable, Comparable<LockType>

public enum LockType
extends Enum<LockType>

LockType provides an enumeration for the types of locks used at the core of the driver to hand off messages between threads.

API Notice:

This interface is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2012-2013, Allanbank Consulting, Inc., All Rights Reserved

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOW_LATENCY_SPIN Use a spin loop.
MUTEX Use a standard Java mutex for notification across threads.

Method Summary

Methods

Modifier and Type	Method and Description
static LockType	valueOf(String name) Returns the enum constant of this type with the specified name.
static LockType[]	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

LOW_LATENCY_SPIN

public static final LockType LOW_LATENCY_SPIN

Use a spin loop. This produces an extremely low latency hand-off at the expense of utilizing more CPU than a standard mutex. If the hand-off does not occur within 1 ms then this lock falls back to a mutex.

Generally only applications looking for the absolute best performance and that CPU capacity will need this type of locking.

MUTEX

public static final LockType MUTEX

Use a standard Java mutex for notification across threads.

Method Detail

values

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

Returns:

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

valueOf

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