PlatformExtensionsWaitOneAsync(WaitHandle, Int32, CancellationToken) - метод |
Асинхронно ожидает заданный объект
WaitHandle. Возвращает признак того, что ожидание завершилось
при переходе объекта
waitHandle в сигнальное состояние, а не при наступлении таймаута.
Пространство имён:
Tessa.Platform
Сборка:
Tessa (в Tessa.dll) Версия: 3.5.0.19
Синтаксис public static Task<bool> WaitOneAsync(
this WaitHandle waitHandle,
int millisecondsTimeout = -1,
CancellationToken cancellationToken = default
)
<ExtensionAttribute>
Public Shared Function WaitOneAsync (
waitHandle As WaitHandle,
Optional millisecondsTimeout As Integer = -1,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of Boolean)
public:
[ExtensionAttribute]
static Task<bool>^ WaitOneAsync(
WaitHandle^ waitHandle,
int millisecondsTimeout = -1,
CancellationToken cancellationToken = CancellationToken()
)
[<ExtensionAttribute>]
static member WaitOneAsync :
waitHandle : WaitHandle *
?millisecondsTimeout : int *
?cancellationToken : CancellationToken
(* Defaults:
let _millisecondsTimeout = defaultArg millisecondsTimeout -1
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<bool>
Параметры
- waitHandle
- Тип: System.ThreadingWaitHandle
Объект, ожидание которого выполняется. - millisecondsTimeout (Optional)
- Тип: SystemInt32
Таймаут в миллисекундах, в течение которого выполняется ожидание до того, как ожидание будет прервано несмотря на то,
что объект waitHandle всё ещё не перешёл в сигнальное состояние.
По умолчанию, если указано значение Infinite, то таймаут не наступает,
т.е. ожидание завершится только при объекте waitHandle.
- cancellationToken (Optional)
- Тип: System.ThreadingCancellationToken
Токен отмены для асинхронного ожидания.
Возвращаемое значение
Тип:
TaskBooleantrue, если ожидание завершилось при переходе объекта
waitHandle в сигнальное состояние;
false, если ожидание завершилось при наступлении таймаута.
Примечание об использовании
В Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа
WaitHandle. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе
Методы расширения (Visual Basic) или
Методы расширения (Руководство по программированию в C#).
См. также