Skip navigation links

com.tangosol.util
Class WrapperReentrantGate

java.lang.Object
com.tangosol.util.WrapperReentrantGate

All Implemented Interfaces:

Gate

public class WrapperReentrantGate

extends java.lang.Object

implements Gate

A Gate implementation that allows for 2^31 reentrant enter calls by a single thread.

Since:

Coherence 3.7

Author:

coh 2010.10.14

Constructor Summary

WrapperReentrantGate()
Default constructor.

WrapperReentrantGate(Gate gate)
Construct a WrapperReentrantGate around the specified underlying gate.

Method Summary

boolean	barEntry(long cMillis) Bar entry to the thread gate by other threads, but do not wait for the gate to close.
boolean	close(long cMillis) Close the gate.
boolean	enter(long cMillis) Enter the gate.
void	exit() Exit the gate.
boolean	isClosed() Determine if any thread has closed the gate and continues to hold exclusive access.
boolean	isClosedByCurrentThread() Determine if the calling thread has closed the gate and continues to hold exclusive access.
boolean	isEnteredByCurrentThread() Determines if the current thread has entered the gate and not yet exited.
void	open() Re-open the closed gate.

Constructor Detail

WrapperReentrantGate

public WrapperReentrantGate()

Default constructor.

WrapperReentrantGate

public WrapperReentrantGate(Gate gate)

Construct a WrapperReentrantGate around the specified underlying gate.

Parameters:

gate - a Gate to be wrapped

Method Detail

close

public boolean close(long cMillis)

Close the gate. A thread uses this method to obtain exclusive access to the resource represented by the gate. Each invocation of this method must ultimately have a corresponding invocation of the Gate.open() method.

Specified by:

close in interface Gate

Parameters:

cMillis - maximum number of milliseconds to wait; pass -1 to wait indefinitely or 0 to return immediately

Returns:

true iff entry into the gate was successfully closed by the calling thread and no other threads remain in the gate

open

public void open()

Re-open the closed gate. This method can be called only if the calling thread successfully closed the gate.

Specified by:

open in interface Gate

enter

public boolean enter(long cMillis)

Enter the gate. A thread uses this method to obtain non-exclusive access to the resource represented by the gate. Each invocation of this method must ultimately have a corresponding invocation of the Gate.exit() method.

Specified by:

enter in interface Gate

Parameters:

cMillis - maximum number of milliseconds to wait; pass -1 to wait indefinitely or 0 to return immediately

Returns:

true iff the calling thread successfully entered the gate

exit

public void exit()

Exit the gate. A thread must invoke this method corresponding to each invocation of the Gate.enter(long) method.

Specified by:

exit in interface Gate

barEntry

public boolean barEntry(long cMillis)

Bar entry to the thread gate by other threads, but do not wait for the gate to close. When all other threads have exited, the status of the thread gate will be closeable by the thread which barred entry. Threads that have already entered the gate at the time of this method call should be allowed to succeed in additional #enter calls.

Each successful invocation of this method must ultimately have a corresponding invocation of the open method (assuming the thread gate is not destroyed) even if the calling thread does not subsequently close the gate.

 gate.barEntry(-1);
 try
     {
     // processing that does not require the gate to be closed
     // ...
     }
 finally
     {
     gate.close(-1);
     try
         {
         // processing that does require the gate to be closed
         // ...
         }
     finally
         {
         gate.open(); // matches gate.close()
         }
     gate.open(); // matches gate.barEntry()
     }
 

Specified by:

barEntry in interface Gate

Parameters:

cMillis - maximum number of milliseconds to wait; pass -1 for forever or 0 for no wait

Returns:

true iff entry into the thread gate was successfully barred by the calling thread

isClosedByCurrentThread

public boolean isClosedByCurrentThread()

Determine if the calling thread has closed the gate and continues to hold exclusive access.

Specified by:

isClosedByCurrentThread in interface Gate

Returns:

true iff the calling thread holds exclusive access to the gate

isEnteredByCurrentThread

public boolean isEnteredByCurrentThread()

Determines if the current thread has entered the gate and not yet exited.

Specified by:

isEnteredByCurrentThread in interface Gate

Returns:

true if the current thread has entered the gate

isClosed

public boolean isClosed()

Determine if any thread has closed the gate and continues to hold exclusive access.

Specified by:

isClosed in interface Gate

Returns:

true iff there is a thread that holds exclusive access to the gate

Skip navigation links