agi.foundation.compatibility

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

Class EventWaitHandle

java.lang.Object

agi.foundation.compatibility.WaitHandle

agi.foundation.compatibility.EventWaitHandle

All Implemented Interfaces:

IDisposable, AutoCloseable

Direct Known Subclasses:

ManualResetEvent

public class EventWaitHandle
extends WaitHandle
implements IDisposable

Represents a thread synchronization event.

Constructor Summary

Constructors

Constructor and Description
EventWaitHandle(boolean initialState, EventResetMode mode) Initializes a new instance of the EventWaitHandle class, specifying whether the wait handle is initially signaled, and whether it resets automatically or manually.

Method Summary

Modifier and Type	Method and Description
void	close() When overridden in a derived class, releases all resources held by the current WaitHandle.
void	dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
boolean	reset() Sets the state of the event to nonsignaled, causing threads to block.
boolean	set() Sets the state of the event to signaled, allowing one or more waiting threads to proceed.
boolean	waitOne() Blocks the current thread until the current WaitHandle receives a signal.
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 agi.foundation.compatibility.WaitHandle

waitAll

Methods inherited from class java.lang.Object

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

Constructor Detail

EventWaitHandle

public EventWaitHandle(boolean initialState,
                       @Nonnull
                       EventResetMode mode)

Initializes a new instance of the EventWaitHandle class, specifying whether the wait handle is initially signaled, and whether it resets automatically or manually.

Parameters:

initialState - true to set the initial state to signaled; false to set it to nonsignaled.

mode - One of the EventResetMode values that determines whether the event resets automatically or manually.

Method Detail

set

public boolean set()

Sets the state of the event to signaled, allowing one or more waiting threads to proceed.

Returns:

true if the operation succeeds; otherwise, false.

reset

public boolean reset()

Sets the state of the event to nonsignaled, causing threads to block.

Returns:

true if the operation succeeds; otherwise, false.

waitOne

public boolean waitOne()

Description copied from class: WaitHandle

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

Specified by:

waitOne in class WaitHandle

Returns:

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

waitOne

public boolean waitOne(int millisecondsTimeout)

Description copied from class: WaitHandle

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

Specified by:

waitOne in class WaitHandle

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 void close()

Description copied from class: WaitHandle

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

Specified by:

close in class WaitHandle

dispose

public void dispose()

Description copied from interface: IDisposable

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Specified by:

dispose in interface IDisposable