KGy SOFT Core Libraries Help
Wait
Waits for a signal asynchronously on the provided handle.
Definition
Namespace: KGySoft.Threading
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 10.0.0
, if the specified handle receives a signal before timing out or canceling; otherwise, .
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 10.0.0
C#
public static Task<bool> WaitOneAsync(
this WaitHandle handle,
int timeout = -1,
CancellationToken cancellationToken = default
)VB
<ExtensionAttribute>
Public Shared Function WaitOneAsync (
handle As WaitHandle,
Optional timeout As Integer = -1,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of Boolean)C++
public:
[ExtensionAttribute]
static Task<bool>^ WaitOneAsync(
WaitHandle^ handle,
int timeout = -1,
CancellationToken cancellationToken = CancellationToken()
)F#
[<ExtensionAttribute>]
static member WaitOneAsync :
handle : WaitHandle *
?timeout : int *
?cancellationToken : CancellationToken
(* Defaults:
let _timeout = defaultArg timeout -1
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<bool> Parameters
- handle WaitHandle
- The handle to wait on.
- timeout Int32 (Optional)
- The timeout in milliseconds. This parameter is optional.
Default value: Timeout.Infinite - cancellationToken CancellationToken (Optional)
- A token for cancellation. This parameter is optional.
Default value: CancellationToken.None
Return Value
TaskBoolean, if the specified handle receives a signal before timing out or canceling; otherwise, .