Task.Delay Metoda

Reference

Definice

Obor názvů:: System.Threading.Tasks

Sestavení:: System.Threading.Tasks.dll

Sestavení:: System.Runtime.dll

Sestavení:: mscorlib.dll

Sestavení:: netstandard.dll

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Vytvoří úkol, který se dokončí po časovém zpoždění.

Přetížení

Delay(Int32)	Vytvoří úlohu, která se dokončí po zadaném počtu milisekund.
Delay(TimeSpan)	Vytvoří úlohu, která se dokončí po zadaném časovém intervalu.
Delay(Int32, CancellationToken)	Vytvoří zrušený úkol, který se dokončí po zadaném počtu milisekund.
Delay(TimeSpan, CancellationToken)	Vytvoří zrušený úkol, který se dokončí po zadaném časovém intervalu.
Delay(TimeSpan, TimeProvider)	Vytvoří úlohu, která se dokončí po zadaném časovém intervalu.
Delay(TimeSpan, TimeProvider, CancellationToken)	Vytvoří zrušený úkol, který se dokončí po zadaném časovém intervalu.

Delay(Int32)

Zdroj:: Task.cs

Zdroj:: Task.cs

Zdroj:: Task.cs

Vytvoří úlohu, která se dokončí po zadaném počtu milisekund.

public:
 static System::Threading::Tasks::Task ^ Delay(int millisecondsDelay);

public static System.Threading.Tasks.Task Delay (int millisecondsDelay);

static member Delay : int -> System.Threading.Tasks.Task

Public Shared Function Delay (millisecondsDelay As Integer) As Task

Parametry

millisecondsDelay: Int32

Počet milisekund, které se mají počkat před dokončením vráceného úkolu, nebo -1 čekat na neomezenou dobu.

Návraty

Task

Úkol, který představuje časové zpoždění.

Výjimky

ArgumentOutOfRangeException

Argument millisecondsDelay je menší než -1.

Příklady

Následující příklad ukazuje jednoduché použití Delay metody.

using System;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      var t = Task.Run(async delegate
              {
                 await Task.Delay(1000);
                 return 42;
              });
      t.Wait();
      Console.WriteLine("Task t Status: {0}, Result: {1}",
                        t.Status, t.Result);
   }
}
// The example displays the following output:
//        Task t Status: RanToCompletion, Result: 42

open System.Threading.Tasks

let t =
    Task.Run<int>(fun () ->
        task {
            do! Task.Delay 1000
            return 42
        })

t.Wait()
printfn $"Task t Status: {t.Status}, Result: {t.Result}"

// The example displays the following output:
//        Task t Status: RanToCompletion, Result: 42

Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      Dim t = Task.Run(Async Function()
                                Await Task.Delay(1000)
                                Return 42
                       End Function)
      t.Wait()
      Console.WriteLine("Task t Status: {0}, Result: {1}",
                        t.Status, t.Result)
   End Sub
End Module
' The example displays the following output:
'       Task t Status: RanToCompletion, Result: 42

Poznámky

Metoda Delay se obvykle používá ke zpoždění operace všech úloh nebo jeho části pro zadaný časový interval. Nejčastěji se zavádí časové zpoždění:

Na začátku úkolu, jak ukazuje následující příklad.

Stopwatch sw = Stopwatch.StartNew();
var delay = Task.Delay(1000).ContinueWith(_ =>
                           { sw.Stop();
                             return sw.ElapsedMilliseconds; } );

Console.WriteLine("Elapsed milliseconds: {0}", delay.Result);
// The example displays output like the following:
//        Elapsed milliseconds: 1013

    let sw = Stopwatch.StartNew()

    let delay =
        Task
            .Delay(1000)
            .ContinueWith(fun _ ->
                sw.Stop()
                sw.ElapsedMilliseconds)

    printfn $"Elapsed milliseconds: {delay.Result}"
// The example displays output like the following:
//        Elapsed milliseconds: 1013

Dim sw As Stopwatch = Stopwatch.StartNew()
Dim delay1 = Task.Delay(1000)
Dim delay2 = delay1.ContinueWith( Function(antecedent)
                        sw.Stop()
                        Return sw.ElapsedMilliseconds
                      End Function)

Console.WriteLine("Elapsed milliseconds: {0}", delay2.Result)
' The example displays output like the following:
'        Elapsed milliseconds: 1013

Někdy, když se úloha spouští. V tomto případě se volání metody Delay spustí jako podřízený úkol v rámci úkolu, jak ukazuje následující příklad. Všimněte si, že vzhledem k tomu, že úloha, která volá metodu Delay spouští asynchronně, musí nadřazená úloha počkat na dokončení pomocí klíčového slova await.

var delay = Task.Run( async () => { Stopwatch sw = Stopwatch.StartNew();
                                    await Task.Delay(2500);
                                    sw.Stop();
                                    return sw.ElapsedMilliseconds; });

Console.WriteLine("Elapsed milliseconds: {0}", delay.Result);
// The example displays output like the following:
//        Elapsed milliseconds: 2501

    let delay =
        Task.Run<int64>(fun () ->
            task {
                let sw = Stopwatch.StartNew()
                do! Task.Delay 2500
                sw.Stop()
                return sw.ElapsedMilliseconds
            })

    printfn $"Elapsed milliseconds: {delay.Result}"
// The example displays output like the following:
//        Elapsed milliseconds: 2501

Dim delay = Task.Run( Async Function()
                         Dim sw As Stopwatch = Stopwatch.StartNew()
                         Await Task.Delay(2500)
                         sw.Stop()
                         Return sw.ElapsedMilliseconds
                      End Function )

Console.WriteLine("Elapsed milliseconds: {0}", delay.Result)
' The example displays output like the following:
'        Elapsed milliseconds: 2501

Po uplynutí zadaného časového zpoždění se úkol dokončí v RanToCompletion stavu.

Tato metoda závisí na systémových hodinách. To znamená, že časové zpoždění se přibližně rovná rozlišení systémových hodin, pokud je argument millisecondsDelay menší než rozlišení systémových hodin, což je přibližně 15 milisekund v systémech Windows.

Poznámka

Systémové hodiny používané GetTickCount, které nejsou ovlivněny změnami provedenými timeBeginPeriod a timeEndPeriod.

Platí pro

Delay(TimeSpan)

Zdroj:: Task.cs

Zdroj:: Task.cs

Zdroj:: Task.cs

Vytvoří úlohu, která se dokončí po zadaném časovém intervalu.

public:
 static System::Threading::Tasks::Task ^ Delay(TimeSpan delay);

public static System.Threading.Tasks.Task Delay (TimeSpan delay);

static member Delay : TimeSpan -> System.Threading.Tasks.Task

Public Shared Function Delay (delay As TimeSpan) As Task

Parametry

delay: TimeSpan

Doba trvání čekání před dokončením vráceného úkolu nebo Timeout.InfiniteTimeSpan čekání na neomezenou dobu.

Návraty

Task

Úkol, který představuje časové zpoždění.

Výjimky

ArgumentOutOfRangeException

delay představuje záporný časový interval jiný než Timeout.InfiniteTimeSpan.

-nebo-

Vlastnost TotalMilliseconds argumentu delay je větší než 4294967294 v .NET 6 a novějších verzích nebo Int32.MaxValue ve všech předchozích verzích.

Příklady

Následující příklad ukazuje jednoduché použití Delay metody.

using System;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      var t = Task.Run(async delegate
              {
                 await Task.Delay(TimeSpan.FromSeconds(1.5));
                 return 42;
              });
      t.Wait();
      Console.WriteLine("Task t Status: {0}, Result: {1}",
                        t.Status, t.Result);
   }
}
// The example displays the following output:
//        Task t Status: RanToCompletion, Result: 42

open System
open System.Threading.Tasks

let t =
    Task.Run<int>(fun () ->
        task {
            do! Task.Delay(TimeSpan.FromSeconds 1.5)
            return 42
        })

t.Wait()
printfn $"Task t Status: {t.Status}, Result: {t.Result}"

// The example displays the following output:
//        Task t Status: RanToCompletion, Result: 42

Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      Dim t = Task.Run(Async Function()
                                Await Task.Delay(TimeSpan.FromSeconds(1.5))
                                Return 42
                       End Function)
      t.Wait()
      Console.WriteLine("Task t Status: {0}, Result: {1}",
                        t.Status, t.Result)
   End Sub
End Module
' The example displays the following output:
'       Task t Status: RanToCompletion, Result: 42

Poznámky

Po uplynutí zadaného časového zpoždění se úkol dokončí v RanToCompletion stavu.

Scénáře použití a další příklady najdete v dokumentaci k přetížení Delay(Int32).

Tato metoda závisí na systémových hodinách. To znamená, že časové zpoždění se přibližně rovná rozlišení systémových hodin, pokud je argument delay menší než rozlišení systémových hodin, což je přibližně 15 milisekund v systémech Windows.

Poznámka

Systémové hodiny používané GetTickCount, které nejsou ovlivněny změnami provedenými timeBeginPeriod a timeEndPeriod.

Platí pro

Delay(Int32, CancellationToken)

Zdroj:: Task.cs

Zdroj:: Task.cs

Zdroj:: Task.cs

Vytvoří zrušený úkol, který se dokončí po zadaném počtu milisekund.

public:
 static System::Threading::Tasks::Task ^ Delay(int millisecondsDelay, System::Threading::CancellationToken cancellationToken);

public static System.Threading.Tasks.Task Delay (int millisecondsDelay, System.Threading.CancellationToken cancellationToken);

static member Delay : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function Delay (millisecondsDelay As Integer, cancellationToken As CancellationToken) As Task

Parametry

millisecondsDelay: Int32

Počet milisekund, které se mají počkat před dokončením vráceného úkolu, nebo -1 čekat na neomezenou dobu.

cancellationToken: CancellationToken

Token zrušení, který se má sledovat při čekání na dokončení úkolu.

Návraty

Task

Úkol, který představuje časové zpoždění.

Výjimky

ArgumentOutOfRangeException

Argument millisecondsDelay je menší než -1.

OperationCanceledException

Úkol byl zrušen. Tato výjimka je uložena do vrácené úlohy.

ObjectDisposedException

Poskytnutá cancellationToken již byla odstraněna.

TaskCanceledException

Úkol byl zrušen.

Příklady

Následující příklad spustí úlohu, která zahrnuje volání metody Delay(Int32, CancellationToken) s jedním druhým zpožděním. Před uplynutím intervalu zpoždění se token zruší. Výstup z příkladu ukazuje, že se v důsledku toho vyvolá TaskCanceledException a vlastnost Status úkolů je nastavena na Canceled.

using System;
using System.Threading;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      CancellationTokenSource source = new CancellationTokenSource();

      var t = Task.Run(async delegate
              {
                 await Task.Delay(1000, source.Token);
                 return 42;
              });
      source.Cancel();
      try {
         t.Wait();
      }
      catch (AggregateException ae) {
         foreach (var e in ae.InnerExceptions)
            Console.WriteLine("{0}: {1}", e.GetType().Name, e.Message);
      }
      Console.Write("Task t Status: {0}", t.Status);
      if (t.Status == TaskStatus.RanToCompletion)
         Console.Write(", Result: {0}", t.Result);
      source.Dispose();
   }
}
// The example displays the following output:
//       TaskCanceledException: A task was canceled.
//       Task t Status: Canceled

open System
open System.Threading
open System.Threading.Tasks

let source = new CancellationTokenSource()

let t =
    Task.Run<int>(fun () ->
        task {
            do! Task.Delay(1000, source.Token)
            return 42
        })

source.Cancel()

try
    t.Wait()

with :? AggregateException as ae ->
    for e in ae.InnerExceptions do
        printfn $"{e.GetType().Name}: {e.Message}"

printf $"Task t Status: {t.Status}"

if t.Status = TaskStatus.RanToCompletion then
    printf $", Result: {t.Result}"

source.Dispose()


// The example displays the following output:
//       TaskCanceledException: A task was canceled.
//       Task t Status: Canceled

Imports System.Threading
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      Dim source As New CancellationTokenSource()
      
      Dim t = Task.Run(Async Function()
                                Await Task.Delay(1000, source.Token)
                                Return 42
                       End Function)
      source.Cancel()
      Try
         t.Wait()
      Catch ae As AggregateException
         For Each e In ae.InnerExceptions
            Console.WriteLine("{0}: {1}", e.GetType().Name, e.Message)
         Next
      End Try
      Console.Write("Task t Status: {0}", t.Status)
      If t.Status = TaskStatus.RanToCompletion Then
         Console.Write(", Result: {0}", t.Result)
      End If
      source.Dispose()
   End Sub
End Module
' The example displays the following output:
'       TaskCanceledException: A task was canceled.
'       Task t Status: Canceled

Poznámky

Pokud je token zrušení signalován před zadaným časovým zpožděním, TaskCanceledException výsledky výjimky a úkol je dokončen v Canceled stavu. V opačném případě se úkol dokončí ve stavu RanToCompletion po uplynutí zadaného časového zpoždění.

Scénáře použití a další příklady najdete v dokumentaci k přetížení Delay(Int32).

Poznámka

Systémové hodiny používané GetTickCount, které nejsou ovlivněny změnami provedenými timeBeginPeriod a timeEndPeriod.

Platí pro

Delay(TimeSpan, CancellationToken)

Zdroj:: Task.cs

Zdroj:: Task.cs

Zdroj:: Task.cs

Vytvoří zrušený úkol, který se dokončí po zadaném časovém intervalu.

public:
 static System::Threading::Tasks::Task ^ Delay(TimeSpan delay, System::Threading::CancellationToken cancellationToken);

public static System.Threading.Tasks.Task Delay (TimeSpan delay, System.Threading.CancellationToken cancellationToken);

static member Delay : TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function Delay (delay As TimeSpan, cancellationToken As CancellationToken) As Task

Parametry

delay: TimeSpan

Doba trvání čekání před dokončením vráceného úkolu nebo Timeout.InfiniteTimeSpan čekání na neomezenou dobu.

cancellationToken: CancellationToken

Token zrušení, který se má sledovat při čekání na dokončení úkolu.

Návraty

Task

Úkol, který představuje časové zpoždění.

Výjimky

ArgumentOutOfRangeException

delay představuje záporný časový interval jiný než Timeout.InfiniteTimeSpan.

-nebo-

Vlastnost TotalMilliseconds argumentu delay je větší než 4294967294 v .NET 6 a novějších verzích nebo Int32.MaxValue ve všech předchozích verzích.

OperationCanceledException

Úkol byl zrušen. Tato výjimka je uložena do vrácené úlohy.

ObjectDisposedException

Poskytnutá cancellationToken již byla odstraněna.

TaskCanceledException

Úkol byl zrušen.

Příklady

Následující příklad spustí úlohu, která zahrnuje volání metody Delay(TimeSpan, CancellationToken) se zpožděním 1,5 sekundy. Před uplynutím intervalu zpoždění se token zruší. Výstup z příkladu ukazuje, že se v důsledku toho vyvolá TaskCanceledException a vlastnost Status úkolů je nastavena na Canceled.

using System;
using System.Threading;
using System.Threading.Tasks;

public class Example
{
   public static void Main()
   {
      CancellationTokenSource source = new CancellationTokenSource();

      var t = Task.Run(async delegate
              {
                 await Task.Delay(TimeSpan.FromSeconds(1.5), source.Token);
                 return 42;
              });
      source.Cancel();
      try {
         t.Wait();
      }
      catch (AggregateException ae) {
         foreach (var e in ae.InnerExceptions)
            Console.WriteLine("{0}: {1}", e.GetType().Name, e.Message);
      }
      Console.Write("Task t Status: {0}", t.Status);
      if (t.Status == TaskStatus.RanToCompletion)
         Console.Write(", Result: {0}", t.Result);
      source.Dispose();
   }
}
// The example displays output like the following:
//       TaskCanceledException: A task was canceled.
//       Task t Status: Canceled

open System
open System.Threading
open System.Threading.Tasks

let source = new CancellationTokenSource()

let t =
    Task.Run<int>(fun () ->
        task {

            do! Task.Delay(TimeSpan.FromSeconds(1.5), source.Token)
            return 42
        })

source.Cancel()

try
    t.Wait()

with :? AggregateException as ae ->
    for e in ae.InnerExceptions do
        printfn $"{e.GetType().Name}: {e.Message}"

printf $"Task t Status: {t.Status}"

if t.Status = TaskStatus.RanToCompletion then
    printf $", Result: {t.Result}"

source.Dispose()

// The example displays output like the following:
//       TaskCanceledException: A task was canceled.
//       Task t Status: Canceled

Imports System.Threading
Imports System.Threading.Tasks

Module Example
   Public Sub Main()
      Dim source As New CancellationTokenSource()
      
      Dim t = Task.Run(Async Function()
                                Await Task.Delay(TimeSpan.FromSeconds(1.5),
                                                 source.Token)
                                Return 42
                       End Function)
      source.Cancel()
      Try
         t.Wait()
      Catch ae As AggregateException
         For Each e In ae.InnerExceptions
            Console.WriteLine("{0}: {1}", e.GetType().Name, e.Message)
         Next
      End Try
      Console.Write("Task t Status: {0}", t.Status)
      If t.Status = TaskStatus.RanToCompletion Then
         Console.Write(", Result: {0}", t.Result)
      End If
      source.Dispose()
   End Sub
End Module
' The example displays output like the following:
'       TaskCanceledException: A task was canceled.
'       Task t Status: Canceled

Všimněte si, že tento příklad obsahuje potenciální časovou podmínku: závisí na úkolu, který asynchronně spouští zpoždění při zrušení tokenu. I když 1,5 sekundy od volání metody Delay(TimeSpan, CancellationToken) je pravděpodobné, že je pravděpodobné, že volání metody Delay(TimeSpan, CancellationToken) by se mohlo vrátit před zrušením tokenu. V takovém případě příklad vytvoří následující výstup:

Task t Status: RanToCompletion, Result: 42

Poznámky

Scénáře použití a další příklady najdete v dokumentaci k přetížení Delay(Int32).

Poznámka

Systémové hodiny používané GetTickCount, které nejsou ovlivněny změnami provedenými timeBeginPeriod a timeEndPeriod.

Platí pro

Delay(TimeSpan, TimeProvider)

Zdroj:: Task.cs

Zdroj:: Task.cs

Vytvoří úlohu, která se dokončí po zadaném časovém intervalu.

public:
 static System::Threading::Tasks::Task ^ Delay(TimeSpan delay, TimeProvider ^ timeProvider);

public static System.Threading.Tasks.Task Delay (TimeSpan delay, TimeProvider timeProvider);

static member Delay : TimeSpan * TimeProvider -> System.Threading.Tasks.Task

Public Shared Function Delay (delay As TimeSpan, timeProvider As TimeProvider) As Task

Parametry

delay: TimeSpan

TimeSpan čekat před dokončením vrácené úlohy nebo InfiniteTimeSpan čekat na neomezenou dobu.

timeProvider: TimeProvider

TimeProvider, s níž se mají interpretovat delay.

Návraty

Task

Úkol, který představuje časové zpoždění.

Výjimky

ArgumentOutOfRangeException

delay představuje záporný časový interval jiný než InfiniteTimeSpan.

-nebo-

vlastnost TotalMillisecondsdelayje větší než 4294967294.

ArgumentNullException

Argument timeProvider je null.

Platí pro

Delay(TimeSpan, TimeProvider, CancellationToken)

Zdroj:: Task.cs

Zdroj:: Task.cs

Vytvoří zrušený úkol, který se dokončí po zadaném časovém intervalu.

public:
 static System::Threading::Tasks::Task ^ Delay(TimeSpan delay, TimeProvider ^ timeProvider, System::Threading::CancellationToken cancellationToken);

public static System.Threading.Tasks.Task Delay (TimeSpan delay, TimeProvider timeProvider, System.Threading.CancellationToken cancellationToken);

static member Delay : TimeSpan * TimeProvider * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function Delay (delay As TimeSpan, timeProvider As TimeProvider, cancellationToken As CancellationToken) As Task

Parametry

delay: TimeSpan

TimeSpan čekat před dokončením vrácené úlohy nebo InfiniteTimeSpan čekat na neomezenou dobu.

timeProvider: TimeProvider

TimeProvider, s níž se mají interpretovat delay.

cancellationToken: CancellationToken

Token zrušení, který se má sledovat při čekání na dokončení úkolu.

Návraty

Task

Úkol, který představuje časové zpoždění.

Výjimky

ArgumentOutOfRangeException

delay představuje záporný časový interval jiný než InfiniteTimeSpan.

-nebo-

vlastnost TotalMillisecondsdelayje větší než 4294967294.

ArgumentNullException

Argument timeProvider je null.

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena do vrácené úlohy.

Platí pro

Sdílet prostřednictvím

Task.Delay Metoda

Definice

Přetížení

Delay(Int32)

Parametry

Návraty

Výjimky

Příklady

Poznámky

Platí pro

Delay(TimeSpan)

Parametry

Návraty

Výjimky

Příklady

Poznámky

Platí pro

Delay(Int32, CancellationToken)

Parametry

Návraty

Výjimky

Příklady

Poznámky

Platí pro

Delay(TimeSpan, CancellationToken)

Parametry

Návraty

Výjimky

Příklady

Poznámky

Platí pro

Delay(TimeSpan, TimeProvider)

Parametry

Návraty

Výjimky

Platí pro

Delay(TimeSpan, TimeProvider, CancellationToken)

Parametry

Návraty

Výjimky

Platí pro

Další materiály