Skip navigation links

Oracle® Coherence Java API Reference
Release 3.7.0.0

E18683-01


com.tangosol.util
Interface Gate

All Known Implementing Classes:
ThreadGate, ThreadGateLite, WrapperReentrantGate

public interface Gate

The Gate interface acts as an abstraction between the ThreadGate implementation that preceeds JDK 1.5 locks and the ThreadGateLite that uses the ReentrantReadWriteLock.

Note: the Gate's method names have been chosen to be backwards compatible with the legacy ThreadGate implementation.

Since:
Coherence 3.7
Author:
coh 2010-08-13

Method Summary
 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.
 boolean isClosedByCurrentThread()
          Determine if the current thread has closed the gate.
 boolean isEnteredByCurrentThread()
          Determines if the current thread has entered the gate and not yet exited.
 void open()
          Re-open the closed gate.

 

Method Detail

close

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 open() method.
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

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

enter

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 exit() method.
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

void exit()
Exit the gate. A thread must invoke this method corresponding to each invocation of the enter(long) method.
Throws:
java.lang.IllegalMonitorStateException - if the gate is not entered by the current thread

isClosedByCurrentThread

boolean isClosedByCurrentThread()
Determine if the current thread has closed the gate.
Returns:
true iff the gate was closed by the calling thread

isEnteredByCurrentThread

boolean isEnteredByCurrentThread()
Determines if the current thread has entered the gate and not yet exited.
Returns:
true if the current thread has entered the gate

isClosed

boolean isClosed()
Determine if any thread has closed the gate.
Returns:
true iff the gate has been closed by any thread

Skip navigation links

Oracle® Coherence Java API Reference
Release 3.7.0.0

E18683-01


Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved.