agi.foundation.compatibility

(agi.foundation.core-2024r3.jar)

Class WaitHandle

java.lang.Object

agi.foundation.compatibility.WaitHandle

All Implemented Interfaces:

IDisposable, AutoCloseable

Direct Known Subclasses:

EventWaitHandle

public abstract class WaitHandle
extends Object
implements IDisposable

Encapsulates operating system-specific objects that wait for exclusive access to shared resources.

Constructor Summary

Constructors

Constructor and Description
WaitHandle()

Method Summary

Modifier and Type	Method and Description
abstract void	close() When overridden in a derived class, releases all resources held by the current WaitHandle.
static void	waitAll(WaitHandle[] waitHandles) Waits for all the elements in the specified array to receive a signal.
abstract boolean	waitOne() Blocks the current thread until the current WaitHandle receives a signal.
abstract boolean	waitOne(int millisecondsTimeout) Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval.

Methods inherited from class java.lang.Object

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

Methods inherited from interface agi.foundation.compatibility.IDisposable

dispose

Constructor Detail

WaitHandle

public WaitHandle()

Method Detail

waitOne

public abstract boolean waitOne()

Blocks the current thread until the current WaitHandle receives a signal.

Returns:

true if the current instance receives a signal. If the current instance is never signaled, waitOne never returns.

waitOne

public abstract boolean waitOne(int millisecondsTimeout)

Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval.

Parameters:

millisecondsTimeout - The number of milliseconds to wait, or -1 to wait indefinitely.

Returns:

true if the current instance receives a signal; otherwise, false.

close

public abstract void close()

When overridden in a derived class, releases all resources held by the current WaitHandle.

Specified by:

close in interface IDisposable

Specified by:

close in interface AutoCloseable

waitAll

public static void waitAll(WaitHandle[] waitHandles)

Waits for all the elements in the specified array to receive a signal.

Parameters:

waitHandles - A WaitHandle array containing the objects for which the current instance will wait. This array cannot contain multiple references to the same object.