JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
ToolkitLock.java
Go to the documentation of this file.
1/**
2 * Copyright 2010 JogAmp Community. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are
5 * permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice, this list of
8 * conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
11 * of conditions and the following disclaimer in the documentation and/or other materials
12 * provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * The views and conclusions contained in the software and documentation are those of the
25 * authors and should not be interpreted as representing official policies, either expressed
26 * or implied, of JogAmp Community.
27 */
28
29package com.jogamp.nativewindow;
30
31import jogamp.nativewindow.Debug;
32
33/**
34 * Marker for a singleton global recursive blocking lock implementation,
35 * optionally locking a native windowing toolkit as well.
36 * <p>
37 * Toolkit locks are created solely via {@link NativeWindowFactory}.
38 * </p>
39 * <p>
40 * One use case is the AWT locking on X11, see {@link NativeWindowFactory#getDefaultToolkitLock(String, long)}.
41 * </p>
42 */
43public interface ToolkitLock {
44 public static final boolean DEBUG = Debug.debug("ToolkitLock");
45 public static final boolean TRACE_LOCK = Debug.isPropertyDefined("nativewindow.debug.ToolkitLock.TraceLock", true);
46
47 /**
48 * Blocking until the lock is acquired by this Thread or a timeout is reached.
49 * <p>
50 * Timeout is implementation specific, if used at all.
51 * </p>
52 *
53 * @throws RuntimeException in case of a timeout
54 */
55 public void lock();
56
57 /**
58 * Release the lock.
59 *
60 * @throws RuntimeException in case the lock is not acquired by this thread.
61 */
62 public void unlock();
63
64 /**
65 * @throws RuntimeException if current thread does not hold the lock
66 */
67 public void validateLocked() throws RuntimeException;
68
69 /**
70 * Dispose this instance.
71 * <p>
72 * Shall be called when instance is no more required.
73 * </p>
74 * This allows implementations sharing a lock via resources
75 * to decrease the reference counter.
76 */
77 public void dispose();
78}
Marker for a singleton global recursive blocking lock implementation, optionally locking a native win...
void dispose()
Dispose this instance.
void unlock()
Release the lock.
void lock()
Blocking until the lock is acquired by this Thread or a timeout is reached.