Class AsyncAutoResetEvent
Represents asynchronous version of
Inherited Members
Namespace: DotNext.Threading
Assembly: DotNext.Threading.dll
Syntax
public class AsyncAutoResetEvent : QueuedSynchronizer, IAsyncResetEvent, IAsyncEvent
Constructors
| Improve this Doc View SourceAsyncAutoResetEvent(Boolean)
Initializes a new asynchronous reset event in the specified state.
Declaration
public AsyncAutoResetEvent(bool initialState)
Parameters
Type | Name | Description |
---|---|---|
Boolean | initialState | true to set the initial state signaled; false to set the initial state to non signaled. |
AsyncAutoResetEvent(Boolean, Int32)
Initializes a new asynchronous reset event in the specified state.
Declaration
public AsyncAutoResetEvent(bool initialState, int concurrencyLevel)
Parameters
Type | Name | Description |
---|---|---|
Boolean | initialState | true to set the initial state signaled; false to set the initial state to non signaled. |
Int32 | concurrencyLevel | The expected number of concurrent flows. |
Properties
| Improve this Doc View SourceIsSet
Indicates whether this event is set.
Declaration
public bool IsSet { get; }
Property Value
Type | Description |
---|---|
Boolean |
Methods
| Improve this Doc View SourceReset()
Sets the state of this event to non signaled, causing consumers to wait asynchronously.
Declaration
public bool Reset()
Returns
Type | Description |
---|---|
Boolean | true if the operation succeeds; otherwise, false. |
Set()
Sets the state of the event to signaled, allowing one or more awaiters to proceed.
Declaration
public bool Set()
Returns
Type | Description |
---|---|
Boolean | true if the operation succeeds; otherwise, false. |
WaitAsync(CancellationToken)
Turns caller into idle state until the current event is set.
Declaration
public ValueTask WaitAsync(CancellationToken token = null)
Parameters
Type | Name | Description |
---|---|---|
CancellationToken | token | The token that can be used to abort wait process. |
Returns
Type | Description |
---|---|
ValueTask | The task representing asynchronous result. |
WaitAsync(TimeSpan, CancellationToken)
Turns caller into idle state until the current event is set.
Declaration
public ValueTask<bool> WaitAsync(TimeSpan timeout, CancellationToken token = null)
Parameters
Type | Name | Description |
---|---|---|
TimeSpan | timeout | The interval to wait for the signaled state. |
CancellationToken | token | The token that can be used to abort wait process. |
Returns
Type | Description |
---|---|
ValueTask<Boolean> | true if signaled state was set; otherwise, false. |
Explicit Interface Implementations
| Improve this Doc View SourceIAsyncEvent.Signal()
Declaration
bool IAsyncEvent.Signal()
Returns
Type | Description |
---|---|
Boolean |
IAsyncResetEvent.ResetMode
Declaration
EventResetMode IAsyncResetEvent.ResetMode { get; }
Returns
Type | Description |
---|---|
EventResetMode |