1 /*
2 * #%L
3 * LockType.java - mongodb-async-driver - Allanbank Consulting, Inc.
4 * %%
5 * Copyright (C) 2011 - 2014 Allanbank Consulting, Inc.
6 * %%
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * #L%
19 */
20 package com.allanbank.mongodb;
21
22 /**
23 * LockType provides an enumeration for the types of locks used at the core of
24 * the driver to hand off messages between threads.
25 *
26 * @api.yes This interface is part of the driver's API. Public and protected
27 * members will be deprecated for at least 1 non-bugfix release
28 * (version numbers are <major>.<minor>.<bugfix>)
29 * before being removed or modified.
30 * @copyright 2012-2013, Allanbank Consulting, Inc., All Rights Reserved
31 */
32 public enum LockType {
33
34 /**
35 * Use a spin loop. This produces an extremely low latency hand-off at the
36 * expense of utilizing more CPU than a standard mutex. If the hand-off does
37 * not occur within 1 ms then this lock falls back to a mutex.
38 * <p>
39 * Generally only applications looking for the absolute best performance and
40 * that CPU capacity will need this type of locking.
41 * </p>
42 */
43 LOW_LATENCY_SPIN,
44
45 /** Use a standard Java mutex for notification across threads. */
46 MUTEX;
47 }