Moved locking to: com.jogamp.common.util.locks ; Better abstraction ; Misc changes

1 files changed, 77 insertions, 0 deletions

diff --git a/src/java/com/jogamp/common/util/locks/Lock.java b/src/java/com/jogamp/common/util/locks/Lock.java
new file mode 100644
index 0000000..7065ff8
--- /dev/null
+++ b/src/java/com/jogamp/common/util/locks/Lock.java
@@ -0,0 +1,77 @@
+/**
+ * Copyright 2010 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ *
+ *    2. Redistributions in binary form must reproduce the above copyright notice, this list
+ *       of conditions and the following disclaimer in the documentation and/or other materials
+ *       provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+
+package com.jogamp.common.util.locks;
+
+import com.jogamp.common.impl.Debug;
+import java.security.AccessController;
+
+/**
+ * Specifying a thread blocking lock implementation
+ */
+public interface Lock {
+
+    /** Enable via the property <code>jogamp.debug.Lock</code> */
+    public static final boolean DEBUG = Debug.debug("Lock");
+
+    /** Defines the default {@link #TIMEOUT} value */
+    public static final long DEFAULT_TIMEOUT = 5000; // 5s default timeout
+    
+    /** 
+     * Defines the <code>TIMEOUT</code> for {@link #lock()} in ms,
+     * and defaults to {@link #DEFAULT_TIMEOUT}.<br>
+     * It can be overriden via the system property <code>jogamp.common.utils.locks.Lock.timeout</code>.
+     */
+    public static final long TIMEOUT = Debug.getLongProperty("jogamp.common.utils.locks.Lock.timeout", true, AccessController.getContext(), DEFAULT_TIMEOUT);
+
+    /**
+     * Blocking until the lock is acquired by this Thread or {@link #TIMEOUT} is reached.
+     *
+     * @throws RuntimeException in case of {@link #TIMEOUT}
+     */
+    void lock() throws RuntimeException;
+
+    /**
+     * Blocking until the lock is acquired by this Thread or <code>maxwait</code> in ms is reached.
+     *
+     * @param maxwait Maximum time in ms to wait to acquire the lock. If this value is zero,
+     *                the call returns immediately either without being able
+     *                to acquire the lock, or with acquiring the lock directly while ignoring any scheduling order.
+     * @return true if the lock has been acquired within <code>maxwait</code>, otherwise false
+     *
+     * @throws RuntimeException in case of {@link #TIMEOUT}
+     */
+    boolean tryLock(long maxwait) throws RuntimeException;
+
+    /**
+     * Unblocking.
+     *
+     * @throws RuntimeException in case the lock is not acquired by this thread.
+     */
+    void unlock() throws RuntimeException;
+}