Task.Delay Metoda

Definice

Vytvoří úlohu, která bude dokončena po časovém intervalu.Creates a task that will complete after a time delay.

Přetížení

Delay(TimeSpan, CancellationToken)

Vytvoří úlohu zrušit, která se dokončí po zadaném časovém intervalu.Creates a cancellable task that completes after a specified time interval.

Delay(Int32, CancellationToken)

Vytvoří úlohu zrušit, která se dokončí po zadaném počtu milisekund.Creates a cancellable task that completes after a specified number of milliseconds.

Delay(Int32)

Vytvoří úlohu, která se dokončí po zadaném počtu milisekund.Creates a task that completes after a specified number of milliseconds.

Delay(TimeSpan)

Vytvoří úlohu, která se dokončí po zadaném časovém intervalu.Creates a task that completes after a specified time interval.

Delay(TimeSpan, CancellationToken)

Vytvoří úlohu zrušit, která se dokončí po zadaném časovém intervalu.Creates a cancellable task that completes after a specified time interval.

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

Parametry

delay
TimeSpan

Časový interval, který se má počkat před dokončením vrácené úlohy, nebo TimeSpan.FromMilliseconds(-1) počkat neomezenou dobu.The time span to wait before completing the returned task, or TimeSpan.FromMilliseconds(-1) to wait indefinitely.

cancellationToken
CancellationToken

Token zrušení, který se má sledovat při čekání na dokončení úlohy.A cancellation token to observe while waiting for the task to complete.

Návraty

Úkol, který představuje časovou prodlevu.A task that represents the time delay.

Výjimky

delay představuje záporný časový interval jiný než TimeSpan.FromMilliseconds(-1).delay represents a negative time interval other than TimeSpan.FromMilliseconds(-1).

-nebo--or- Vlastnost TotalMilliseconds argumentu delay je větší než MaxValue.The delay argument's TotalMilliseconds property is greater than MaxValue.

Úloha byla zrušena.The task has been canceled.

Poskytnutá cancellationToken již byla uvolněna.The provided cancellationToken has already been disposed.

Příklady

Následující příklad spustí úlohu, která obsahuje volání metody Delay(TimeSpan, CancellationToken) s druhou prodlevou 1,5.The following example launches a task that includes a call to the Delay(TimeSpan, CancellationToken) method with a 1.5 second delay. Než uplyne interval zpoždění, token se zruší.Before the delay interval elapses, the token is cancelled. Výstup z příkladu ukazuje, že v důsledku toho je vyvolána TaskCanceledException a vlastnost Tasks ' Status je nastavena na Canceled.The output from the example shows that, as a result, a TaskCanceledException is thrown, and the tasks' Status property is set to 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
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í podmínku časování: závisí na úloze, která asynchronně vykoná zpoždění při zrušení tokenu.Note that this example includes a potential race condition: it depends on the task asynchronously executing the delay when the token is cancelled. I když druhá prodleva v 1,5 od volání metody Delay(TimeSpan, CancellationToken) způsobí, že je pravděpodobné, že volání metody Delay(TimeSpan, CancellationToken) může vracet před zrušením tokenu.Although the 1.5 second delay from the call to the Delay(TimeSpan, CancellationToken) method makes that assumption likely, it is nevertheless possible that the call to the Delay(TimeSpan, CancellationToken) method could return before the token is cancelled. V takovém případě příklad generuje následující výstup:In that case, the example produces the following output:

Task t Status: RanToCompletion, Result: 42  

Poznámky

Pokud je token zrušení signalizována před určenou časovou prodlevou, TaskCanceledException výsledky výjimky a úloha je dokončena ve stavu Canceled.If the cancellation token is signaled before the specified time delay, a TaskCanceledException exception results, and the task is completed in the Canceled state. V opačném případě se úkol po uplynutí zadaného časového zpoždění dokončí ve stavu RanToCompletion.Otherwise, the task is completed in the RanToCompletion state once the specified time delay has elapsed.

Scénáře použití a další příklady naleznete v dokumentaci k přetížení Delay(Int32).For usage scenarios and additional examples, see the documentation for the Delay(Int32) overload.

Tato metoda závisí na systémových hodinách.This method depends on the system clock. To znamená, že časová prodleva bude přibližně rovna 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.This means that the time delay will approximately equal the resolution of the system clock if the delay argument is less than the resolution of the system clock, which is approximately 15 milliseconds on Windows systems.

Delay(Int32, CancellationToken)

Vytvoří úlohu zrušit, která se dokončí po zadaném počtu milisekund.Creates a cancellable task that completes after a specified number of milliseconds.

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

Parametry

millisecondsDelay
Int32

Počet milisekund, po které se má čekat před dokončením vrácené úlohy, nebo-1 pro čekání na neomezenou dobu.The number of milliseconds to wait before completing the returned task, or -1 to wait indefinitely.

cancellationToken
CancellationToken

Token zrušení, který se má sledovat při čekání na dokončení úlohy.A cancellation token to observe while waiting for the task to complete.

Návraty

Úkol, který představuje časovou prodlevu.A task that represents the time delay.

Výjimky

Argument millisecondsDelay je menší než-1.The millisecondsDelay argument is less than -1.

Úloha byla zrušena.The task has been canceled.

Poskytnutá cancellationToken již byla uvolněna.The provided cancellationToken has already been disposed.

Příklady

Následující příklad spustí úlohu, která obsahuje volání metody Delay(Int32, CancellationToken) s jednou druhou prodlevou.The following example launches a task that includes a call to the Delay(Int32, CancellationToken) method with a one second delay. Než uplyne interval zpoždění, token se zruší.Before the delay interval elapses, the token is cancelled. Výstup z příkladu ukazuje, že v důsledku toho je vyvolána TaskCanceledException a vlastnost Tasks ' Status je nastavena na Canceled.The output from the example shows that, as a result, a TaskCanceledException is thrown, and the tasks' Status property is set to 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
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í signalizována před určenou časovou prodlevou, TaskCanceledException výsledky výjimky a úloha je dokončena ve stavu Canceled.If the cancellation token is signaled before the specified time delay, a TaskCanceledException exception results, and the task is completed in the Canceled state. V opačném případě se úkol po uplynutí zadaného časového zpoždění dokončí ve stavu RanToCompletion.Otherwise, the task is completed in the RanToCompletion state once the specified time delay has elapsed.

Scénáře použití a další příklady naleznete v dokumentaci k přetížení Delay(Int32).For usage scenarios and additional examples, see the documentation for the Delay(Int32) overload.

Tato metoda závisí na systémových hodinách.This method depends on the system clock. To znamená, že časová prodleva bude přibližně rovna 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.This means that the time delay will approximately equal the resolution of the system clock if the millisecondsDelay argument is less than the resolution of the system clock, which is approximately 15 milliseconds on Windows systems.

Delay(Int32)

Vytvoří úlohu, která se dokončí po zadaném počtu milisekund.Creates a task that completes after a specified number of milliseconds.

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, po které se má čekat před dokončením vrácené úlohy, nebo-1 pro čekání na neomezenou dobu.The number of milliseconds to wait before completing the returned task, or -1 to wait indefinitely.

Návraty

Úkol, který představuje časovou prodlevu.A task that represents the time delay.

Výjimky

Argument millisecondsDelay je menší než-1.The millisecondsDelay argument is less than -1.

Příklady

Následující příklad ukazuje jednoduché použití metody Delay.The following example shows a simple use of the Delay method.

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
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á k odložení operace všech nebo částí úlohy za zadaný časový interval.The Delay method is typically used to delay the operation of all or part of a task for a specified time interval. Nejčastěji se zavedla časová prodleva:Most commonly, the time delay is introduced:

  • Na začátku úkolu, jak ukazuje následující příklad.At the beginning of the task, as the following example shows.

    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
    
    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
    
  • Při provádění úlohy dojde k nějakému dni.Sometime while the task is executing. V tomto případě se volání metody Delay spustí jako podřízená úloha v rámci úkolu, jak ukazuje následující příklad.In this case, the call to the Delay method executes as a child task within a task, as the following example shows. Vzhledem k tomu, že úloha, která volá metodu Delay, se spouští asynchronně, nadřazená úloha musí počkat na dokončení pomocí klíčového slova await.Note that since the task that calls the Delay method executes asynchronously, the parent task must wait for it to complete by using the await keyword.

    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
    
    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é časové prodlevy se úkol dokončí ve stavu RanToCompletion.After the specified time delay, the task is completed in the RanToCompletion state.

Tato metoda závisí na systémových hodinách.This method depends on the system clock. To znamená, že časová prodleva bude přibližně rovna 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.This means that the time delay will approximately equal the resolution of the system clock if the millisecondsDelay argument is less than the resolution of the system clock, which is approximately 15 milliseconds on Windows systems.

Delay(TimeSpan)

Vytvoří úlohu, která se dokončí po zadaném časovém intervalu.Creates a task that completes after a specified time interval.

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

Časový interval, který se má počkat před dokončením vrácené úlohy, nebo TimeSpan.FromMilliseconds(-1) počkat neomezenou dobu.The time span to wait before completing the returned task, or TimeSpan.FromMilliseconds(-1) to wait indefinitely.

Návraty

Úkol, který představuje časovou prodlevu.A task that represents the time delay.

Výjimky

delay představuje záporný časový interval jiný než TimeSpan.FromMilliseconds(-1).delay represents a negative time interval other than TimeSpan.FromMilliseconds(-1).

-nebo--or- Vlastnost TotalMilliseconds argumentu delay je větší než MaxValue.The delay argument's TotalMilliseconds property is greater than MaxValue.

Příklady

Následující příklad ukazuje jednoduché použití metody Delay.The following example shows a simple use of the Delay method.

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
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é časové prodlevy se úkol dokončí ve stavu RanToCompletion.After the specified time delay, the task is completed in RanToCompletion state.

Scénáře použití a další příklady naleznete v dokumentaci k přetížení Delay(Int32).For usage scenarios and additional examples, see the documentation for the Delay(Int32) overload.

Tato metoda závisí na systémových hodinách.This method depends on the system clock. To znamená, že časová prodleva bude přibližně rovna 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.This means that the time delay will approximately equal the resolution of the system clock if the delay argument is less than the resolution of the system clock, which is approximately 15 milliseconds on Windows systems.

Platí pro