GlueGen Runtime 2.3.2 · com.jogamp.common.util.locks.SingletonInstance

Modifier and Type	Field and Description
protected static final boolean	DEBUG Hides com.jogamp.common.util.locks.Lock.DEBUG.
private boolean	locked
private final long	poll_ms

Access	Constructor and Description
protected	SingletonInstance(final long poll_ms)

Method Summary

Modifier and Type	Method and Description
public static SingletonInstance	createFileLock(final long poll_ms, final String lockFileBasename)
public static SingletonInstance	createFileLock(final long poll_ms, final File lockFile)
public static SingletonInstance	createServerSocket(final long poll_ms, final int to be used for this single instance server socket. portNumber) A user shall use ephemeral ports: IANA suggests 49152 to 65535 as "dynamic and/or private ports". Many GNU/Linux kernels use 32768 to 61000. FreeBSD >= 4.6 uses the IANA port range. FreeBSD < 4.6 and BSD use ports 1024 through 4999. Microsoft Windows operating systems through Server 2003 use the range 1025 to 5000 Windows Vista, Windows 7, and Server 2008 use the IANA range.
public abstract String	getName()
public final long	getPollPeriod()
protected String	infoPrefix(final long currentMillis)
protected String	infoPrefix()
public synchronized boolean	isLocked() Implements com.jogamp.common.util.locks.Lock.isLocked. Query if locked
public synchronized void	lock() Implements com.jogamp.common.util.locks.Lock.lock. Blocking until the lock is acquired by this Thread or `TIMEOUT` is reached.
public final String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public synchronized boolean	tryLock(long 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. maxwait) Implements com.jogamp.common.util.locks.Lock.tryLock. Blocking until the lock is acquired by this Thread or `maxwait` in ms is reached.
protected abstract boolean	tryLockImpl()
public void	unlock() Implements com.jogamp.common.util.locks.Lock.unlock. Release the lock.
protected abstract boolean	unlockImpl()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

DEBUG	back to summary
protected static final boolean DEBUG Hides com.jogamp.common.util.locks.Lock.DEBUG.

locked	back to summary
private boolean locked

poll_ms	back to summary
private final long poll_ms

SingletonInstance	back to summary
protected SingletonInstance(final long poll_ms)

Method Detail

createFileLock	back to summary
public static SingletonInstance createFileLock(final long poll_ms, final String lockFileBasename)

createFileLock	back to summary
public static SingletonInstance createFileLock(final long poll_ms, final File lockFile)

createServerSocket	back to summary
public static SingletonInstance createServerSocket(final long poll_ms, final int portNumber) A user shall use ephemeral ports: IANA suggests 49152 to 65535 as "dynamic and/or private ports". Many GNU/Linux kernels use 32768 to 61000. FreeBSD >= 4.6 uses the IANA port range. FreeBSD < 4.6 and BSD use ports 1024 through 4999. Microsoft Windows operating systems through Server 2003 use the range 1025 to 5000 Windows Vista, Windows 7, and Server 2008 use the IANA range. Parameters portNumber:int to be used for this single instance server socket.

createServerSocket

back to summary

public static SingletonInstance createServerSocket(final long poll_ms, final int portNumber)

A user shall use ephemeral ports:

IANA suggests 49152 to 65535 as "dynamic and/or private ports".
Many GNU/Linux kernels use 32768 to 61000.
FreeBSD >= 4.6 uses the IANA port range.
FreeBSD < 4.6 and BSD use ports 1024 through 4999.
Microsoft Windows operating systems through Server 2003 use the range 1025 to 5000
Windows Vista, Windows 7, and Server 2008 use the IANA range.

Parameters

portNumber:int: to be used for this single instance server socket.

getName	back to summary
public abstract String getName()

getPollPeriod	back to summary
public final long getPollPeriod()

infoPrefix	back to summary
protected String infoPrefix(final long currentMillis)

infoPrefix	back to summary
protected String infoPrefix()

isLocked	back to summary
public synchronized boolean isLocked() Implements com.jogamp.common.util.locks.Lock.isLocked. Doc from com.jogamp.common.util.locks.Lock.isLocked. Query if locked Annotations @Override

isLocked

back to summary

public synchronized boolean isLocked()

Implements com.jogamp.common.util.locks.Lock.isLocked.

Doc from com.jogamp.common.util.locks.Lock.isLocked.

Query if locked

Annotations

@Override

lock back to summary

lock	back to summary
public synchronized void lock() throws RuntimeException Implements com.jogamp.common.util.locks.Lock.lock. Doc from com.jogamp.common.util.locks.Lock.lock. Blocking until the lock is acquired by this Thread or `TIMEOUT` is reached. Annotations @Override Exceptions RuntimeException: in case of `TIMEOUT`

public synchronized void lock() throws RuntimeException

Implements com.jogamp.common.util.locks.Lock.lock.

Doc from com.jogamp.common.util.locks.Lock.lock.

Blocking until the lock is acquired by this Thread or TIMEOUT is reached.

Annotations

@Override

Exceptions

RuntimeException:: in case of TIMEOUT

toString	back to summary
public final String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

tryLock back to summary

tryLock	back to summary
public synchronized boolean tryLock(long maxwait) throws RuntimeException Implements com.jogamp.common.util.locks.Lock.tryLock. Doc from com.jogamp.common.util.locks.Lock.tryLock. Blocking until the lock is acquired by this Thread or `maxwait` in ms is reached. Parameters maxwait:long 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. Returns:boolean true if the lock has been acquired within `maxwait`, otherwise false Annotations @Override

public synchronized boolean tryLock(long maxwait) throws RuntimeException

Implements com.jogamp.common.util.locks.Lock.tryLock.

Doc from com.jogamp.common.util.locks.Lock.tryLock.

Blocking until the lock is acquired by this Thread or maxwait in ms is reached.

Parameters

maxwait:long: 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.

Returns:boolean

true if the lock has been acquired within maxwait, otherwise false

Annotations

@Override

tryLockImpl	back to summary
protected abstract boolean tryLockImpl()

unlock	back to summary
public void unlock() throws RuntimeException Implements com.jogamp.common.util.locks.Lock.unlock. Doc from com.jogamp.common.util.locks.Lock.unlock. Release the lock. Annotations @Override Exceptions RuntimeException: in case the lock is not acquired by this thread.

unlock

back to summary

public void unlock() throws RuntimeException

Implements com.jogamp.common.util.locks.Lock.unlock.

Doc from com.jogamp.common.util.locks.Lock.unlock.

Release the lock.

Annotations

@Override

Exceptions

RuntimeException:: in case the lock is not acquired by this thread.

unlockImpl	back to summary
protected abstract boolean unlockImpl()

public abstract Class SingletonInstance

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail