Click or drag to resize

ThreadGate Class

Oracle® Fusion Middleware .NET API Reference for Oracle Coherence
14c (14.1.1.0)
F23534-02

Note: This API is now obsolete.

Use this class in cases that large numbers of threads can operate concurrently with an additional requirement that all threads be blocked for certain operations.
Inheritance Hierarchy
SystemObject
  Tangosol.UtilThreadGate

Namespace:  Tangosol.Util
Assembly:  Coherence (in Coherence.dll) Version: 14.1.1.14 (14.1.1.14)
Syntax
C#
Copy
[ObsoleteAttribute("Use GateFactory.NewGate to obtain a Gate.")]
public class ThreadGate : Gate

The ThreadGate type exposes the following members.

Constructors
  NameDescription
Public methodThreadGate
Allocates unnamed data slots on threads to store local thread counter values and returns new instance of ThreadGate.
Top
Properties
  NameDescription
Public propertyActiveCount
The number of unmatched completed Enter calls.
Public propertyCloseCount
The number of unmatched completed Close/BarEntry calls.
Protected propertyClosingThread
The thread that is closing the gates.
Public propertyIsActiveThread
Determine if the current thread has entered and not exited the thread gate.
Public propertyIsClosedByCurrentThread
Determines if the current thread have Closed the gate but not yet Opened the Gate.
Public propertyIsClosingThread
Determine if the current thread has closed and not opened the the thread gate.
Public propertyIsEnteredByCurrentThread
Determine if the current thread has entered and not exited the thread gate.
Public propertyStatus
The current thread gate status.
Protected propertyVersion
The total number of times the gate has been fully opened.
Top
Methods
  NameDescription
Public methodBarEntry
Bar entry of the thread gate by other threads, but do not wait for the gate to close.
Public methodClose
Close the thread gate.
Protected methodDecrementThreadLocalCount
Decrement the long value of the LocalDataStoreSlot for the current thread by one.
Public methodDestroy
Destroy the thread gate.
Protected methodDoWait
Wait up to the specified number of milliseconds for notification.
Public methodEnter
Enter the thread gate.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExit
Exit the gate.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetThreadLocalCount
Obtain the long value stored in the LocalDataStoreSlot.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodIncrementThreadLocalCount
Increment the long value from the LocalDataStoreSlot for the current thread by one.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOpen
After entry into the ThreadGate is restricted by a call to BarEntry() or Close(), it can be re-opened by calling this method.
Protected methodSetThreadLocalCount
Set the long value to be stored in the LocalDataStoreSlot.
Public methodToString
Provide a human-readable representation of this ThreadGate.
(Overrides ObjectToString.)
Protected methodUpdateStatus
Update the current thread gate status, without changing the active count.
Top
Remarks
The algorithm is based on a gate concept, allowing threads in Enter(Int64) and out Exit, but occasionally shutting the gate Close(Int64) such that other threads cannot enter and exit. However, since threads may "be inside", the gate cannot fully close until they leave Exit. Once all threads are out, the gate is closed, and can be re-opened Open or permanently closed Destroy.

Each call to Enter requires a corresponding call to Exit. For example, the following would ensure proper clean-up using a ThreadGate:

            gate.Enter();
            try
            {
                ...
            }
            finally
            {
                gate.Exit();
            }

Similarly, each call to Close should be matched with a call to Open, unless the gate is being destroyed:

            gate.Close();
            try
            {
                ...
            }
            finally
            {
                gate.Open();
            }

or:

            gate.Close();
            gate.Destroy();

The Enter/Exit calls can be nested; the same thread can invoke Enter multiple times as long as Exit is invoked a corresponding number of times. The Close/Open calls work in the same manner. Lastly, the thread that closes the gate may continue to Enter/Exit the gate even when it is closed since that thread has exclusive control of the gate.

See Also