com.cosylab.acs.maci.manager

Class ProfilingReentrantLock

java.lang.Object

com.cosylab.acs.maci.manager.ProfilingReentrantLock

All Implemented Interfaces:

java.util.concurrent.locks.Lock

public class ProfilingReentrantLock
extends java.lang.Object
implements java.util.concurrent.locks.Lock

A Lock that internally delegates to a ReentrantLock and profiles the time it takes a thread to acquire the lock, and the time for which the lock is held. When a thread calls unlock() then these times are printed, together with the code location which used the lock.

This lock can be used as an alternative to "synchronized" blocks, when we want to detect lock contention. It may also be used as an alternative to some other Lock, although at the moment only methods Lock.lock() and Lock.unlock() are implemented. For the other Lock methods we throw UnsupportedOperationException, but it should be easy enough to also implement them when needed.

This class is added to jmanager for work on http://jira.alma.cl/browse/COMP-6488. Later it should be moved to module jacsutil.

Since:

ACS 10.2

Author:

hsommer

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	isProfilingEnabled
static java.lang.String	PROFILING_ENABLED_PROPERTYNAME

Constructor Summary

Constructors

Constructor and Description
ProfilingReentrantLock(java.lang.String lockName)

Method Summary

Modifier and Type	Method and Description
static java.util.concurrent.locks.Lock	createReentrantLock(java.lang.String lockName) Factory method that encapsulates the checking of property PROFILING_ENABLED_PROPERTYNAME and the corresponding creation of either a ProfilingReentrantLock or a ReentrantLock.
void	lock()
void	lockInterruptibly()
java.util.concurrent.locks.Condition	newCondition()
boolean	tryLock()
boolean	tryLock(long timeout, java.util.concurrent.TimeUnit unit)
void	unlock()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROFILING_ENABLED_PROPERTYNAME

public static final java.lang.String PROFILING_ENABLED_PROPERTYNAME

See Also:

Constant Field Values

isProfilingEnabled

public static final boolean isProfilingEnabled

Constructor Detail

ProfilingReentrantLock

public ProfilingReentrantLock(java.lang.String lockName)

Method Detail

createReentrantLock

public static java.util.concurrent.locks.Lock createReentrantLock(java.lang.String lockName)

Factory method that encapsulates the checking of property PROFILING_ENABLED_PROPERTYNAME and the corresponding creation of either a ProfilingReentrantLock or a ReentrantLock.

We return only the base type "Lock" to keep the implementation of ProfilingReentrantLock simple for the time being. Some methods of ReentrantLock are final, so that delegation anyway is easier than subtyping. If we really need the additional methods, we could refactor ProfilingReentrantLock to inherit from ReentrantLock and change the return type to ReentrantLock.

Parameters:

lockName - Only used for the profiling variant, for log output.

lock

public void lock()

Specified by:

lock in interface java.util.concurrent.locks.Lock

lockInterruptibly

public void lockInterruptibly()
                       throws java.lang.InterruptedException

Specified by:

lockInterruptibly in interface java.util.concurrent.locks.Lock

Throws:

java.lang.InterruptedException

tryLock

public boolean tryLock()

Specified by:

tryLock in interface java.util.concurrent.locks.Lock

tryLock

public boolean tryLock(long timeout,
                       java.util.concurrent.TimeUnit unit)
                throws java.lang.InterruptedException

Specified by:

tryLock in interface java.util.concurrent.locks.Lock

Throws:

java.lang.InterruptedException

unlock

public void unlock()

Specified by:

unlock in interface java.util.concurrent.locks.Lock

newCondition

public java.util.concurrent.locks.Condition newCondition()

Specified by:

newCondition in interface java.util.concurrent.locks.Lock