ActionBlock<TInput>.Completion Vlastnost

Definice

Obor názvů:

System.Threading.Tasks.Dataflow

Sestavení:

System.Threading.Tasks.Dataflow.dll

Zdroj:

ActionBlock.cs

Task Získá objekt, který představuje asynchronní operaci a dokončení bloku toku dat.

public:
 property System::Threading::Tasks::Task ^ Completion { System::Threading::Tasks::Task ^ get(); };

public System.Threading.Tasks.Task Completion { get; }

member this.Completion : System.Threading.Tasks.Task

Public ReadOnly Property Completion As Task

Hodnota vlastnosti

Task

Dokončený úkol.

Implementuje

Completion

Příklady

Následující příklad ukazuje, jak použít Completion vlastnost k čekání na šíření všech zpráv v síti. Tento příklad kódu je součástí většího příkladu poskytnutého pro téma Postupy: Určení stupně paralelismu v bloku toku dat .

// Performs several computations by using dataflow and returns the elapsed
// time required to perform the computations.
static TimeSpan TimeDataflowComputations(int maxDegreeOfParallelism,
   int messageCount)
{
   // Create an ActionBlock<int> that performs some work.
   var workerBlock = new ActionBlock<int>(
      // Simulate work by suspending the current thread.
      millisecondsTimeout => Thread.Sleep(millisecondsTimeout),
      // Specify a maximum degree of parallelism.
      new ExecutionDataflowBlockOptions
      {
         MaxDegreeOfParallelism = maxDegreeOfParallelism
      });

   // Compute the time that it takes for several messages to
   // flow through the dataflow block.

   Stopwatch stopwatch = new Stopwatch();
   stopwatch.Start();

   for (int i = 0; i < messageCount; i++)
   {
      workerBlock.Post(1000);
   }
   workerBlock.Complete();

   // Wait for all messages to propagate through the network.
   workerBlock.Completion.Wait();

   // Stop the timer and return the elapsed number of milliseconds.
   stopwatch.Stop();
   return stopwatch.Elapsed;
}

' Demonstrates how to specify the maximum degree of parallelism 
' when using dataflow.
Friend Class Program
   ' Performs several computations by using dataflow and returns the elapsed
   ' time required to perform the computations.
   Private Shared Function TimeDataflowComputations(ByVal maxDegreeOfParallelism As Integer, ByVal messageCount As Integer) As TimeSpan
      ' Create an ActionBlock<int> that performs some work.
      Dim workerBlock = New ActionBlock(Of Integer)(Function(millisecondsTimeout) Pause(millisecondsTimeout), New ExecutionDataflowBlockOptions() With { .MaxDegreeOfParallelism = maxDegreeOfParallelism})
         ' Simulate work by suspending the current thread.
         ' Specify a maximum degree of parallelism.

      ' Compute the time that it takes for several messages to 
      ' flow through the dataflow block.

      Dim stopwatch As New Stopwatch()
      stopwatch.Start()

      For i As Integer = 0 To messageCount - 1
         workerBlock.Post(1000)
      Next i
      workerBlock.Complete()

      ' Wait for all messages to propagate through the network.
      workerBlock.Completion.Wait()

      ' Stop the timer and return the elapsed number of milliseconds.
      stopwatch.Stop()
      Return stopwatch.Elapsed
   End Function

   Private Shared Function Pause(ByVal obj As Object)
      Thread.Sleep(obj)
      Return Nothing
   End Function

Poznámky

Blok toku dat se považuje za dokončený, pokud aktuálně nezpracovává zprávu a pokud je zaručeno, že nebude zpracovávat žádné další zprávy. Task Vrácený objekt přejde do dokončeného stavu po dokončení přidruženého bloku. Po úspěšném dokončení zpracování bloku podle definované sémantiky bloku toku dat přejde do RanToCompletion stavu. Do stavu přejde Faulted , když se zpracování bloku toku dat kvůli neošetřené výjimce dokončí předčasně, a do stavu přejde Canceled , když se zpracování bloku toku dat dokončí předčasně po přijetí žádosti o zrušení. Pokud je úloha dokončena ve Faulted stavu , vrátí AggregateException její Exception vlastnost výjimku, která obsahuje jednu nebo více výjimek, které způsobily selhání blokování.